diff -r 000000000000 -r 42188c7ea2d9 Orb/Doxygen/doc/diagrams.doc --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Orb/Doxygen/doc/diagrams.doc Thu Jan 21 17:29:01 2010 +0000 @@ -0,0 +1,148 @@ +/****************************************************************************** + * + * + * + * Copyright (C) 1997-2008 by Dimitri van Heesch. + * + * Permission to use, copy, modify, and distribute this software and its + * documentation under the terms of the GNU General Public License is hereby + * granted. No representations are made about the suitability of this software + * for any purpose. It is provided "as is" without express or implied warranty. + * See the GNU General Public License for more details. + * + * Documents produced by Doxygen are derivative works derived from the + * input used in their production; they are not affected by this license. + * + */ +/*! \page diagrams Graphs and diagrams + + Doxygen has built-in support to generate inheritance diagrams for C++ + classes. + + Doxygen can use the "dot" tool from graphviz to generate + more advanced diagrams and graphs. Graphviz is an open-source, + cross-platform graph drawing toolkit and can be found + at http://www.graphviz.org/ + + If you have the "dot" tool in the path, you can set + \ref cfg_have_dot "HAVE_DOT" to \c YES in the configuration file to + let doxygen use it. + + Doxygen uses the "dot" tool to generate the following graphs: + + + Using a \ref customize "layout file" you can determine which of the + graphs are actually shown. + + The options \ref cfg_dot_graph_max_nodes "DOT_GRAPH_MAX_NODES" and + \ref cfg_max_dot_graph_depth "MAX_DOT_GRAPH_DEPTH" can be used to + limit the size of the various graphs. + + The elements in the class diagrams in HTML and RTF + have the following meaning: + + + The elements in the class diagram in \f$\mbox{\LaTeX}\f$ have the + following meaning: + + + The elements in the graphs generated by the dot tool have the following + meaning: + + + +Here are a couple of header files that together show the various diagrams +that doxygen can generate: + +diagrams_a.h +\verbinclude diagrams_a.h +diagrams_b.h +\verbinclude diagrams_b.h +diagrams_c.h +\verbinclude diagrams_c.h +diagrams_d.h +\verbinclude diagrams_d.h +diagrams_e.h +\verbinclude diagrams_e.h + + \htmlonly + Click here + for the corresponding HTML documentation that is generated by doxygen
+ (EXTRACT_ALL = YES is used here). + \endhtmlonly + +\htmlonly +Go to the next section or return to the + index. +\endhtmlonly + +*/ +