From 44a3a78fb6a3863c0c7f3c1193837337e68a67e4 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 20 Nov 2008 23:24:08 -0600 Subject: Merge from fe-moved (bzr r6891) --- src/doxygen-main.cpp | 163 ++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 149 insertions(+), 14 deletions(-) (limited to 'src/doxygen-main.cpp') diff --git a/src/doxygen-main.cpp b/src/doxygen-main.cpp index 035d83a14..bfca9b21a 100644 --- a/src/doxygen-main.cpp +++ b/src/doxygen-main.cpp @@ -1,15 +1,147 @@ -/** \file - * Contains Doxygen documentation - main page. - * - * Authors: +/** @file + * @brief Doxygen documentation - main page and namespace documentation. + */ +/* Authors: * Ralf Stephan + * Krzysztof Kosiński * - * Copyright (C) 2005-2006 authors + * Copyright (C) 2005-2008 authors * * Released under GNU GPL, read the file 'COPYING' for more information */ -/** \mainpage The Inkscape Source Code Documentation +// Note: % before a word prevents that word from being linkified + +/** + * @brief Main %Inkscape namespace + * + * This namespace contains all code internal to %Inkscape. + */ +namespace Inkscape { + +/** + * @brief Some STL-style algorithms + * + * This namespace contains a few generic algorithms used with the %XML tree. + */ +namespace Algorithms {} + + +/** + * @brief Debugging utilities + * + * This namespace contains various debugging code which can help developers + * to pinpoint problems with their (or others') code. + */ +namespace Debug {} + +/** + * @brief Rendering-related code + * + * This namespace contains code related to the renderer. + */ +namespace Display {} + +/** + * @brief Extension support + * + * This namespace contains the extension subsystem and implementations + * of the internal extensions. This includes input and output filters, bitmap + * extensions, and printing. + */ +namespace Extension {} + +/** + * @brief Boehm-GC based garbage collector + * + * This namespace contains code related to the garbage collector and base + * classes for %GC-managed objects. + */ +namespace GC {} + +/** + * @brief Low-level IO code + * + * This namespace contains low level IO-related code, including a homegrown + * streams implementation, routines for formatting SVG output, and some + * file handling utility functions. + */ +namespace IO {} + +/** + * @brief Live Path Effects code + * + * This namespace contains classes and functions related to the implementation + * of Live Path Effects, which apply arbitrary transformation to a path and + * update whenever the original path is modified. + */ +namespace LivePathEffect {} + +/** + * @brief Tracing backend + * + * This namespace contains the integrated potrace-based tracing backend, used + * in the Trace Bitmap and Paint Bucket features. + */ +namespace Trace {} + +/** + * @brief User interface code + * + * This namespace contains everything related to the user interface of Inkscape. + */ +namespace UI { + +/** + * @brief Dialog code + * + * This namespace contains all code related to dialogs. + */ +namespace Dialog {} + +/** + * @brief Custom widgets + * + * This namespace contains custom user interface widgets used thorought + * Inkscape. + */ +namespace Widget {} + +} // namespace UI + +/** + * @brief Miscellaneous supporting code + * + * This namespace contains miscellaneous low-level code: an implementation of + * garbage-collected lists, tuples, generic pointer iterators and length unit + * handling. + */ +namespace Util {} + +/** + * @brief %Inkscape %XML tree + * + * This namespace contains classes and functions that comprise the XML tree + * of Inkscape documents. + * + * SVG documents in Inkscape are represented as two parallel hierarchies + * of nodes: the object tree, which contains all information about + * the document's state when loaded, and the %XML tree, which contains all + * information about the document's %XML representation. For this reason + * this tree is also called the "repr tree", and %XML nodes are called "reprs". + * + * The central class is XML::Node, which provides all operations. It should be + * noted that nodes are currently typeless and operations not valid for their + * type simply do nothing (like trying to iterate over children of a text node). + * In addition to standard DOM operations, the %XML tree supports observers - + * objects derived from Xml::NodeObserver which receive notifications about + * changes in the document tree. + */ +namespace XML {} + +} // namespace Inkscape + +/** \mainpage Inkscape Source Code Documentation * While the standard doxygen documentation can be accessed through the links * in the header, the following documents are additionally available to the * interested reader. @@ -32,23 +164,26 @@ * * \subsection liblinks External documentation on libraries used in inkscape * - * Gtkmm - * atkmm - * gdkmm - * pangomm - * libsigc++ + * C++: + * gtkmm + * atkmm + * gdkmm + * glibmm + * pangomm + * libsigc++ + * C: * GTK+ * gdk-pixbuf * GObject * atk * pango - * GnomeVFS - * libsigc * ORBit * bonobo * bonobo-activation * libxslt * libxml2 + * Legacy: + * GnomeVFS * * \subsection stdlinks External standards documentation * @@ -58,7 +193,7 @@ * SVGTest * PNG * XSLT - * PS + * PostScript * Gnome-HIG */ -- cgit v1.2.3