diff options
Diffstat (limited to 'doc/config.doc')
| -rw-r--r-- | doc/config.doc | 33 |
1 files changed, 24 insertions, 9 deletions
diff --git a/doc/config.doc b/doc/config.doc index 9ec918b..c84b19f 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -16,6 +16,7 @@ */ /*! \page config Configuration +\tableofcontents \section config_format Format A configuration file is a free-form ASCII text file with a structure @@ -45,7 +46,7 @@ file using a <code>\@INCLUDE</code> tag as follows: The include file is searched in the current working directory. You can also specify a list of directories that should be searched before looking in the current working directory. Do this by putting a <code>\@INCLUDE_PATH</code> tag -with these paths before the <code>\@INCLUDE</code> tag, e.g: +with these paths before the <code>\@INCLUDE</code> tag, e.g.: \verbatim @INCLUDE_PATH = my_config_dir \endverbatim @@ -274,6 +275,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_toc_expand TOC_EXPAND \refitem cfg_treeview_width TREEVIEW_WIDTH \refitem cfg_typedef_hides_struct TYPEDEF_HIDES_STRUCT +\refitem cfg_uml_limit_num_fields UML_LIMIT_NUM_FIELDS \refitem cfg_uml_look UML_LOOK \refitem cfg_use_htags USE_HTAGS \refitem cfg_use_inline_trees USE_INLINE_TREES @@ -1181,7 +1183,7 @@ AClass::ANamespace, ANamespace::*Test filter if there is a match. The filters are a list of the form: pattern=filter (like `*.cpp=my_cpp_filter`). See \c INPUT_FILTER for further info on how filters are used. If \c FILTER_PATTERNS is empty or if - non of the patterns match the file name, \c INPUT_FILTER is applied. + none of the patterns match the file name, \c INPUT_FILTER is applied. \anchor cfg_filter_source_files <dt>\c FILTER_SOURCE_FILES <dd> @@ -1808,8 +1810,9 @@ and Class Hierarchy pages using a tree view instead of an ordered list. (see http://www.mathjax.org) which uses client side Javascript for the rendering instead of using prerendered bitmaps. Use this if you do not have LaTeX installed or if you want to formulas look prettier in the HTML - output. When enabled you also need to install MathJax separately and - configure the path to it using the \ref cfg_mathjax_relpath "MATHJAX_RELPATH" option. + output. When enabled you may also need to install MathJax separately and + configure the path to it using the \ref cfg_mathjax_relpath "MATHJAX_RELPATH" + option. \anchor cfg_mathjax_relpath <dt>\c MATHJAX_RELPATH <dd> @@ -1819,9 +1822,9 @@ and Class Hierarchy pages using a tree view instead of an ordered list. directory should contain the MathJax.js script. For instance, if the mathjax directory is located at the same level as the HTML output directory, then \c MATHJAX_RELPATH should be <code>../mathjax</code>. The default value points to - the http://www.mathjax.org site, so you can quickly see the result without installing - MathJax, but it is strongly recommended to install a local copy of MathJax - before deployment. + the MathJax Content Delivery Network so you can quickly see the result without + installing MathJax. However, it is strongly recommended to install a local + copy of MathJax from http://www.mathjax.org before deployment. \anchor cfg_mathjax_extensions <dt>\c MATHJAX_EXTENSIONS <dd> @@ -2352,7 +2355,7 @@ The default size is 10pt. \addindex CLASS_GRAPH If the \c CLASS_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen will generate a graph for each documented class showing the direct and - indirect inheritance relations. Setting this tag to \c YES will force the + indirect inheritance relations. Setting this tag to \c YES will force the \c CLASS_DIAGRAMS tag to NO. \anchor cfg_collaboration_graph @@ -2376,6 +2379,18 @@ The default size is 10pt. collaboration diagrams in a style similar to the OMG's Unified Modeling Language. +\anchor cfg_uml_limit_num_fields +<dt>\c UML_LIMIT_NUM_FIELDS <dd> + \addindex UML_LIMIT_NUM_FIELDS + If the \c UML_LOOK tag is enabled, the fields and methods are shown inside + the class node. If there are many fields or methods and many nodes the + graph may become too big to be useful. The \c UML_LIMIT_NUM_FIELDS + threshold limits the number of items for each type to make the size more + managable. Set this to 0 for no limit. Note that the threshold may be + exceeded by 50% before the limit is enforced. So when you set the threshold + to 10, up to 15 fields may appear, but if the number exceeds 15, the + total amount of fields shown is limited to 10. + \anchor cfg_template_relations <dt>\c TEMPLATE_RELATIONS <dd> \addindex TEMPLATE_RELATIONS |