diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile | 2 | ||||
| -rw-r--r-- | doc/config.doc | 22 | ||||
| -rw-r--r-- | doc/index.doc | 1 | ||||
| -rw-r--r-- | doc/install.doc | 20 | ||||
| -rw-r--r-- | doc/xmlcmds.doc | 7 |
5 files changed, 38 insertions, 14 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile index ee3eb96..7ea5784 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -33,7 +33,7 @@ CASE_SENSE_NAMES = NO IMAGE_PATH = . INPUT = index.doc install.doc starting.doc docblocks.doc lists.doc \ grouping.doc formulas.doc diagrams.doc preprocessing.doc \ - autolink.doc output.doc external.doc faq.doc trouble.doc history.doc features.doc \ + autolink.doc output.doc custcmd.doc external.doc faq.doc trouble.doc history.doc features.doc \ doxygen_usage.doc doxytag_usage.doc \ doxywizard_usage.doc installdox_usage.doc \ config.doc commands.doc htmlcmds.doc xmlcmds.doc language.doc \ diff --git a/doc/config.doc b/doc/config.doc index 16fe662..9eaf7a4 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -163,6 +163,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_man_extension MAN_EXTENSION \refitem cfg_man_links MAN_LINKS \refitem cfg_man_output MAN_OUTPUT +\refitem cfg_max_dot_graph_depth MAX_DOT_GRAPH_DEPTH \refitem cfg_max_initializer_lines MAX_INITIALIZER_LINES \refitem cfg_mscgen_path MSCGEN_PATH \refitem cfg_multiline_cpp_is_brief MULTILINE_CPP_IS_BRIEF @@ -1771,10 +1772,23 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> <dt>\c DOT_GRAPH_MAX_NODES <dd> \addindex DOT_GRAPH_MAX_NODES The \c MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of - nodes that will be shown in the graph. If the number of nodes in a graph - becomes larger than this value, doxygen will truncate the graph, which is - visualized by representing a node as a red box. Note that doxygen will always - show the root nodes and its direct children regardless of this setting. + nodes that will be shown in the graph. If the number of nodes in a graph + becomes larger than this value, doxygen will truncate the graph, which is + visualized by representing a node as a red box. Note that doxygen if the number + of direct children of the root node in a graph is already larger than + \c MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note + that the size of a graph can be further restricted by \c MAX_DOT_GRAPH_DEPTH. + +\anchor cfg_max_dot_graph_depth +<dt>\c MAX_DOT_GRAPH_DEPTH <dd> + \addindex MAX_DOT_GRAPH_DEPTH + The \c MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the + graphs generated by dot. A depth value of 3 means that only nodes reachable + from the root by following a path via at most 3 edges will be shown. Nodes + that lay further from the root node will be omitted. Note that setting this + option to 1 or 2 may greatly reduce the computation time needed for large + code bases. Also note that the size of a graph can be further restricted by + \c DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction (the default). \anchor cfg_dot_image_format <dt>\c DOT_IMAGE_FORMAT <dd> diff --git a/doc/index.doc b/doc/index.doc index 7dce69d..faed772 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -75,6 +75,7 @@ The first part forms a user manual: and members in the documentation. <li>Section \ref output shows how to generate the various output formats supported by doxygen. +<li>Section \ref custcmd show how to define and use custom commands in your comments. <li>Section \ref external explains how to let doxygen create links to externally generated documentation. <li>Section \ref faq gives answers to frequently asked questions. <li>Section \ref trouble tells you what to do when you have problems. diff --git a/doc/install.doc b/doc/install.doc index b9ce3e0..3c75386 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -38,14 +38,17 @@ If you downloaded the source distribution, you need at least the following to build the executable: <ul> <li>The <a href="ftp://prep.ai.mit.edu/pub/gnu/">GNU</a> tools - flex, bison and make + flex, bison and GNU make, and strip \addindex flex \addindex bison \addindex make + \addindex strip <li>In order to generate a Makefile for your platform, you need <a href="http://www.perl.com/">perl</a> \latexonly(see {\tt http://www.perl.com/})\endlatexonly. \addindex perl +<li>The configure script assume the availibility of standard Unix tools such + as sed, date, find, uname, mv, cp, cat, echo, tr, cd, and rm. </ul> To take full advantage of doxygen's features the following additional @@ -56,7 +59,7 @@ tools should be installed. <A HREF="http://www.trolltech.com/products/qt.html">Qt</A> \latexonly(see {\tt http://www.trolltech.com/products/qt.html})\endlatexonly \addindex Qt - version 3.2 or higher. + version 3.3 or higher. This is needed to build the GUI front-end doxywizard. <li>A \f$\mbox{\LaTeX}\f$ distribution: for instance <a href="http://www.tug.org/interest.html#free">teTeX 1.0</a> @@ -70,8 +73,11 @@ tools should be installed. If you compile graphviz yourself, make sure you do include freetype support (which requires the freetype library and header files), otherwise the graphs will not render proper text labels. -<li>The ghostscript interpreter. To be found at +<li>For formulas or if you do not wish to use pdflatex, the ghostscript interpreter + is needed. You can find it at <a href="http://www.ghostscript.com/">www.ghostscript.com</a>. +<li>In order to generate doxygen's own documentation, Python is needed, you + can find it at <a href="http://www.python.org">www.python.org</a>. </ul> Compilation is now done by performing the following steps: @@ -104,7 +110,7 @@ Compilation is now done by performing the following steps: See the <code>PLATFORMS</code> file for a list of possible platform options. - If you have Qt-3.2.x or higher installed and want to build the GUI + If you have Qt-3.3.x installed and want to build the GUI front-end, you should run the configure script with the <code>--with-doxywizard</code> option: @@ -136,13 +142,11 @@ Compilation is now done by performing the following steps: To let doxygen generate the HTML documentation. - \note You will need the stream editor <code>sed</code> for this, - but this should be available on any Unix platform. - The HTML directory of the distribution will now contain the html documentation (just point a HTML browser to the file <code>index.html</code> in the - html directory). + html directory). You will need the <code>python</code> interpreter + for this. <li>Optional: Generate a PDF version of the manual (you will need <code>pdflatex</code>, <code>makeindex</code>, and diff --git a/doc/xmlcmds.doc b/doc/xmlcmds.doc index 415b00e..8a446e2 100644 --- a/doc/xmlcmds.doc +++ b/doc/xmlcmds.doc @@ -39,7 +39,11 @@ Here is the list of tags supported by doxygen: file. Ignored by doxygen at the moment. <li><tt>\<item\></tt> List item. Can only be used inside a <tt>\<list\></tt> context. <li><tt>\<list type="type"\></tt> Starts a list, supported types are <tt>bullet</tt> - or <tt>number</tt>. A list consists of a number of <tt>\<item\></tt> tags. + or <tt>number</tt> and <tt>table</tt>. + A list consists of a number of <tt>\<item\></tt> tags. + A list of type table, is a two column table which can have + a header. +<li><tt>\<listheader\></tt> Starts the header of a list of type "table". <li><tt>\<para\></tt> Identifies a paragraph of text. <li><tt>\<param name="paramName"\></tt> Marks a piece of text as the documentation for parameter "paramName". Similar to @@ -56,6 +60,7 @@ Here is the list of tags supported by doxygen: to "member". Similar to using \ref cmdsa "\\sa" member. <li><tt>\<summary\></tt> Identifies the brief description. Similar to using \ref cmdbrief "\\brief". +<li><tt>\<term\></tt> Part of a <tt>\<list\></tt> command. <li><tt>\<value\></tt> Identifies a property. Ignored by doxygen. </ul> |