summaryrefslogtreecommitdiffstats
path: root/doc/config.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2010-09-20 18:19:55 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2010-09-20 18:19:55 (GMT)
commit6dbef217c477d43fb61e90b429531ee109bf0e75 (patch)
treec3964e8a42bc4dfecf5a99d6de94650878e67a0f /doc/config.doc
parent20bc00a80ad6bcda730a1762c3700c8f63fa16eb (diff)
downloadDoxygen-6dbef217c477d43fb61e90b429531ee109bf0e75.zip
Doxygen-6dbef217c477d43fb61e90b429531ee109bf0e75.tar.gz
Doxygen-6dbef217c477d43fb61e90b429531ee109bf0e75.tar.bz2
Release-1.7.1-20100920
Diffstat (limited to 'doc/config.doc')
-rw-r--r--doc/config.doc47
1 files changed, 31 insertions, 16 deletions
diff --git a/doc/config.doc b/doc/config.doc
index aff842a..eb8a8bb 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -103,6 +103,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_example_recursive EXAMPLE_RECURSIVE
\refitem cfg_exclude EXCLUDE
\refitem cfg_exclude_patterns EXCLUDE_PATTERNS
+\refitem cfg_exclude_symbols EXCLUDE_SYMBOLS
\refitem cfg_exclude_symlinks EXCLUDE_SYMLINKS
\refitem cfg_expand_as_defined EXPAND_AS_DEFINED
\refitem cfg_expand_only_predef EXPAND_ONLY_PREDEF
@@ -189,6 +190,7 @@ followed by the descriptions of the tags grouped by category.
\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_mscfile_dirs MSCFILE_DIRS
\refitem cfg_mscgen_path MSCGEN_PATH
\refitem cfg_multiline_cpp_is_brief MULTILINE_CPP_IS_BRIEF
\refitem cfg_optimize_for_fortran OPTIMIZE_FOR_FORTRAN
@@ -442,7 +444,7 @@ followed by the descriptions of the tags grouped by category.
If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
include (a tag file for) the STL sources as input, then you should
set this tag to \c YES in order to let doxygen match functions declarations and
- definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+ definitions whose arguments contain STL classes (e.g. func(std::string); versus
func(std::string) {}). This also make the inheritance and collaboration
diagrams that involve STL classes more complete and accurate.
@@ -483,9 +485,9 @@ followed by the descriptions of the tags grouped by category.
\addindex MULTILINE_CPP_IS_BRIEF
The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
treat a multi-line C++ special comment block (i.e. a block of //! or ///
- comments) as a brief description. This used to be the default behaviour.
+ comments) as a brief description. This used to be the default behavior.
The new default is to treat a multi-line C++ comment block as a detailed
- description. Set this tag to YES if you prefer the old behaviour instead.
+ description. Set this tag to YES if you prefer the old behavior instead.
Note that setting this tag to YES also means that rational rose comments
are not recognized any more.
@@ -605,10 +607,10 @@ followed by the descriptions of the tags grouped by category.
For small to medium size projects (<1000 input files) the default value is
probably good enough. For larger projects a too small cache size can cause
doxygen to be busy swapping symbols to and from disk most of the time
- causing a significant performance penality.
+ causing a significant performance penalty.
If the system has enough physical memory increasing the cache will improve the
performance by keeping more symbols in memory. Note that the value works on
- a logarithmic scale so increasing the size by one will rougly double the
+ a logarithmic scale so increasing the size by one will roughly double the
memory usage. The cache size is given by this formula:
\f$2^{(16+\mbox{SYMBOL\_CACHE\_SIZE})}\f$. The valid range is 0..9, the default is 0,
corresponding to a cache size of \f$2^{16} = 65536\f$ symbols.
@@ -899,7 +901,7 @@ function's detailed documentation block.
\anchor cfg_warn_no_paramdoc
<dt>\c WARN_NO_PARAMDOC <dd>
\addindex WARN_NO_PARAMDOC
- This \c WARN_NO_PARAMDOC option can be abled to get warnings for
+ This \c WARN_NO_PARAMDOC option can be enabled to get warnings for
functions that are documented, but have no documentation for their parameters
or return value. If set to \c NO (the default) doxygen will only warn about
wrong or incomplete parameter documentation, but not about the absence of
@@ -1029,6 +1031,14 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
\c EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
certain files from those directories.
+\anchor cfg_exclude_symbols
+<dt>\c EXCLUDE_SYMBOLS <dd>
+The \c EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+(namespaces, classes, functions, etc.) that should be excluded from the
+output. The symbol name can be a fully qualified name, a word, or if the
+wildcard * is used, a substring. Examples: ANamespace, AClass,
+AClass::ANamespace, ANamespace::*Test
+
Note that the wildcards are matched against the file with absolute path,
so to exclude all test directories use the pattern
<code>*</code><code>/test/</code><code>*</code>
@@ -1527,7 +1537,7 @@ implemented using a PHP enabled web server instead of at the web client
using Javascript. Doxygen will generate the search PHP script and index
file to put on the web server. The advantage of the server
based approach is that it scales better to large projects and also allows
-full text search. The disadvances is that it is more difficult to setup
+full text search. The disadvantages are that it is more difficult to setup
and does not have live searching capabilities.
\anchor cfg_disable_index
@@ -1559,7 +1569,7 @@ and does not have live searching capabilities.
Windows users are probably better off using the HTML help feature.
Via custom stylesheets (see \ref cfg_html_stylesheet "HTML_STYLESHEET")
- one can further \ref doxygen_finetune "fine tune" the look of the index.
+ one can further \ref doxygen_finetune "fine-tune" the look of the index.
As an example, the default style sheet generated by doxygen has an
example that shows how to put an image at the root of the tree instead of
the \ref cfg_project_name "project name".
@@ -1649,12 +1659,11 @@ and Class Hierarchy pages using a tree view instead of an ordered list.
by the printer. Possible values are:
<ul>
<li><code>a4</code> (210 x 297 mm).
- <li><code>a4wide</code> (same as a4, but including the a4wide package).
<li><code>letter</code> (8.5 x 11 inches).
<li><code>legal</code> (8.5 x 14 inches).
<li><code>executive</code> (7.25 x 10.5 inches)
</ul>
- If left blank a4wide will be used.
+ If left blank a4 will be used.
\anchor cfg_extra_packages
<dt>\c EXTRA_PACKAGES <dd>
@@ -2044,16 +2053,15 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre>
\addindex CLASS_DIAGRAMS
If the \c CLASS_DIAGRAMS tag is set to \c YES (the default) doxygen will
generate a class diagram (in HTML and \f$\mbox{\LaTeX}\f$) for classes with base or
- super classes. Setting the tag to \c NO turns the diagrams off.
- Note that this option is superseded by the HAVE_DOT option below.
- This is only a fallback. It is recommended to install and use dot,
- since it yields more powerful graphs.
+super classes. Setting the tag to NO turns the diagrams off. Note that
+this option also works with HAVE_DOT disabled, but it is recommended to
+install and use dot, since it yields more powerful graphs.
\anchor cfg_mscgen_path
<dt>\c MSCGEN_PATH <dd>
\addindex MSCGEN_PATH
You can define message sequence charts within doxygen comments using the \ref cmdmsc "\\msc"
- command. Doxygen will then run the <a href="http://www.mcternan.me.uk/mscgen/">msgen tool</a>) to
+ command. Doxygen will then run the <a href="http://www.mcternan.me.uk/mscgen/">mscgen tool</a>) to
produce the chart and insert it in the documentation. The <code>MSCGEN_PATH</code> tag allows you to
specify the directory where the mscgen tool resides. If left empty the tool is assumed to
be found in the default search path.
@@ -2249,7 +2257,14 @@ The default size is 10pt.
\addindex DOTFILE_DIRS
This tag can be used to specify one or more directories that
contain dot files that are included in the documentation (see the
- \\dotfile command).
+ \ref cmddotfile "\\dotfile" command).
+
+\anchor cfg_mscfile_dirs
+<dt>\c MSCFILE_DIRS <dd>
+ \addindex MSCFILE_DIRS
+ This tag can be used to specify one or more directories that
+ contain msc files that are included in the documentation (see the
+ \ref cmdmscfile "\\mscfile" command).
\anchor cfg_dot_transparent
<dt>\c DOT_TRANSPARENT <dd>