diff options
Diffstat (limited to 'doc/config.doc')
| -rw-r--r-- | doc/config.doc | 497 |
1 files changed, 262 insertions, 235 deletions
diff --git a/doc/config.doc b/doc/config.doc index a32f225..6bd0b84 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -20,25 +20,25 @@ e****************************************************************************** \section config_format Format A configuration file is a free-form ASCII text file with a structure -that is similar to that of a Makefile, with the default name \c Doxyfile. It is -parsed by \c doxygen. The file may contain tabs and newlines for -formatting purposes. The statements in the file are case-sensitive. +that is similar to that of a \c Makefile, with the default name \c Doxyfile. It is +parsed by \c doxygen. The file may contain tabs and newlines for +formatting purposes. The statements in the file are case-sensitive. Comments may be placed anywhere within the file (except within quotes). -Comments beginning with two hash characters (\#\#) are kept when updating +Comments beginning with two hash characters (\c \#\#) are kept when updating the configuration file and are placed in front of the TAG are in front of. -Comments beginning with two hash characters (\#\#) at the end of the +Comments beginning with two hash characters (\c \#\#) at the end of the configuration file are also kept and placed at the end of the file. -Comments begin with the \# character and end at the end of the line. +Comments begin with the hash character (\c \#) and ends at the end of the line. The file essentially consists of a list of assignment statements. Each statement consists of a \c TAG_NAME written in capitals, -followed by the <code>=</code> character and one or more values. If the same tag +followed by the equal sign (<code>=</code>) and one or more values. If the same tag is assigned more than once, the last assignment overwrites any earlier -assignment. For options that take a list as their argument, +assignment. For tags that take a list as their argument, the <code>+=</code> operator can be used instead of <code>=</code> to append new values to the list. Values are sequences of non-blanks. If the value should -contain one or more blanks it must be surrounded by quotes ("..."). -Multiple lines can be concatenated by inserting a backslash (\\) +contain one or more blanks it must be surrounded by quotes (<code>"..."</code>). +Multiple lines can be concatenated by inserting a backslash (\c \\) as the last character of a line. Environment variables can be expanded using the pattern <code>\$(ENV_VARIABLE_NAME)</code>. @@ -75,6 +75,8 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_chm_file CHM_FILE \refitem cfg_chm_index_encoding CHM_INDEX_ENCODING \refitem cfg_cite_bib_files CITE_BIB_FILES +\refitem cfg_clang_assisted_parsig CLANG_ASSISTED_PARSING +\refitem cfg_clang_options CLANG_OPTIONS \refitem cfg_class_diagrams CLASS_DIAGRAMS \refitem cfg_class_graph CLASS_GRAPH \refitem cfg_collaboration_graph COLLABORATION_GRAPH @@ -322,8 +324,8 @@ followed by the descriptions of the tags grouped by category. \addindex DOXYFILE_ENCODING This tag specifies the encoding used for all characters in the config file that follow. The default is UTF-8 which is also the encoding used for all text before - the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into - libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of + the first occurrence of this tag. Doxygen uses \c libiconv (or the iconv built into + \c libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of possible encodings. \anchor cfg_project_name @@ -389,7 +391,7 @@ followed by the descriptions of the tags grouped by category. \addindex BRIEF_MEMBER_DESC If the \c BRIEF_MEMBER_DESC tag is set to \c YES (the default) doxygen will include brief member descriptions after the members that are listed in - the file and class documentation (similar to JavaDoc). + the file and class documentation (similar to \c Javadoc). Set to \c NO to disable this. \anchor cfg_repeat_brief @@ -400,7 +402,8 @@ followed by the descriptions of the tags grouped by category. description \par Note: - If both \c HIDE_UNDOC_MEMBERS and \c BRIEF_MEMBER_DESC are set to \c NO, the + If both \ref cfg_hide_undoc_members "HIDE_UNDOC_MEMBERS" and + \ref cfg_brief_member_desc "BRIEF_MEMBER_DESC" are set to \c NO, the brief descriptions will be completely suppressed. \anchor cfg_abbreviate_brief @@ -409,9 +412,9 @@ followed by the descriptions of the tags grouped by category. This tag implements a quasi-intelligent brief description abbreviator that is used to form the text in various listings. Each string in this list, if found as the leading text of the brief description, will be - stripped from the text and the result after processing the whole list, is used + stripped from the text and the result, after processing the whole list, is used as the annotated text. Otherwise, the brief description is used as-is. If left - blank, the following values are used ("\$name" is automatically replaced with the + blank, the following values are used ("$name" is automatically replaced with the name of the entity): "The $name class" "The $name widget" "The $name file" "is" "provides" "specifies" "contains" "represents" "a" "an" "the". @@ -441,7 +444,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_strip_from_path <dt>\c STRIP_FROM_PATH <dd> \addindex STRIP_FROM_PATH - If the \c FULL_PATH_NAMES tag is set to \c YES then the \c STRIP_FROM_PATH tag + If the \ref cfg_full_path_names "FULL_PATH_NAMES" tag is set to \c YES then the \c STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. Stripping is only done if one of the specified strings matches the left-hand part of the path. The tag can be used to show relative paths in the file list. @@ -469,7 +472,7 @@ followed by the descriptions of the tags grouped by category. <dt>\c JAVADOC_AUTOBRIEF <dd> \addindex JAVADOC_AUTOBRIEF If the \c JAVADOC_AUTOBRIEF is set to \c YES then doxygen - will interpret the first line (until the first dot) of a JavaDoc-style + will interpret the first line (until the first dot) of a Javadoc-style comment as the brief description. If set to \c NO (the default), the Javadoc-style will behave just like regular Qt-style comments (thus requiring an explicit \ref cmdbrief "\@brief" command for a brief description.) @@ -481,7 +484,7 @@ followed by the descriptions of the tags grouped by category. will interpret the first line (until the first dot) of a Qt-style comment as the brief description. If set to \c NO (the default), the Qt-style will behave just like regular Qt-style comments (thus - requiring an explicit \\brief command for a brief description.) + requiring an explicit \ref cmdbrief "\\brief" command for a brief description.) \anchor cfg_markdown_support <dt>\c MARKDOWN_SUPPORT <dd> @@ -498,7 +501,7 @@ followed by the descriptions of the tags grouped by category. \addindex AUTOLINK_SUPPORT When enabled doxygen tries to link words that correspond to documented classes, or namespaces to their corresponding documentation. Such a link can be - prevented in individual cases by by putting a % sign in front of the word or + prevented in individual cases by by putting a \c % sign in front of the word or globally by setting \c AUTOLINK_SUPPORT to \c NO. \anchor cfg_builtin_stl_support @@ -528,7 +531,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_idl_property_support <dt>\c IDL_PROPERTY_SUPPORT <dd> \addindex IDL_PROPERTY_SUPPORT - For Microsoft's IDL there are propget and propput attributes to indicate getter + For Microsoft's IDL there are \c propget and \c propput attributes to indicate getter and setter methods for a property. Setting this option to \c YES (the default) will make doxygen to replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or @@ -546,8 +549,8 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_multiline_cpp_is_brief <dt>\c MULTILINE_CPP_IS_BRIEF <dd> \addindex MULTILINE_CPP_IS_BRIEF - The \c MULTILINE_CPP_IS_BRIEF tag can be set to \c YES to make Doxygen - treat a multi-line C++ special comment block (i.e. a block of //! or /// + The \c MULTILINE_CPP_IS_BRIEF tag can be set to \c YES to make doxygen + treat a multi-line C++ special comment block (i.e. a block of \c //! or \c /// 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 \c YES if you prefer the old behavior instead. @@ -558,8 +561,8 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_details_at_top <dt>\c DETAILS_AT_TOP <dd> \addindex DETAILS_AT_TOP - If the \c DETAILS_AT_TOP tag is set to \c YES then Doxygen - will output the detailed description near the top, like JavaDoc. + If the \c DETAILS_AT_TOP tag is set to \c YES then doxygen + will output the detailed description near the top, like \c Javadoc. If set to \c NO, the detailed description appears after the member documentation. --> @@ -599,7 +602,7 @@ followed by the descriptions of the tags grouped by category. will allow you to put the command \\sideeffect (or \@sideeffect) in the documentation, which will result in a user-defined paragraph with heading "Side Effects:". - You can put \\n's in the value part of an alias to insert newlines. + You can put \ref cmdn "\\n"'s in the value part of an alias to insert newlines. \anchor cfg_tcl_subst <dt>\c TCL_SUBST <dd> @@ -667,8 +670,8 @@ followed by the descriptions of the tags grouped by category. \addindex INLINE_GROUPED_CLASSES When the \c INLINE_GROUPED_CLASSES tag is set to \c YES, classes, structs and unions are shown inside the group in which they are included -(e.g. using @@ingroup) instead of on a separate page (for HTML and Man pages) -or section (for LaTeX and RTF). Note that this feature does not work in +(e.g. using \ref cmdingroup "\\ingroup") instead of on a separate page (for HTML and Man pages) +or section (for \f$\mbox{\LaTeX}\f$ and RTF). Note that this feature does not work in combination with \ref cfg_separate_member_pages "SEPARATE_MEMBER_PAGES". \anchor cfg_inline_simple_structs @@ -679,7 +682,7 @@ unions with only public data fields or simple typedef fields will be shown inline in the documentation of the scope in which they are defined (i.e. file, namespace, or group documentation), provided this scope is documented. If set to \c NO (the default), structs, classes, and unions are shown on a separate -page (for HTML and Man pages) or section (for LaTeX and RTF). +page (for HTML and Man pages) or section (for \f$\mbox{\LaTeX}\f$ and RTF). \anchor cfg_typedef_hides_struct <dt>\c TYPEDEF_HIDES_STRUCT <dd> @@ -717,11 +720,12 @@ page (for HTML and Man pages) or section (for LaTeX and RTF). If the \c EXTRACT_ALL tag is set to \c YES doxygen will assume all entities in documentation are documented, even if no documentation was available. Private class members and static file members will be hidden - unless the \c EXTRACT_PRIVATE and \c EXTRACT_STATIC tags are set to \c YES + unless the \ref cfg_extract_private "EXTRACT_PRIVATE" respectively + \ref cfg_extract_static "EXTRACT_STATIC" tags are set to \c YES - \par Note: - This will also disable the warnings about undocumented members - that are normally produced when \c WARNINGS is set to \c YES + \note This will also disable the warnings about undocumented members + that are normally produced when \ref cfg_warnings "WARNINGS" is + set to \c YES \anchor cfg_extract_private <dt>\c EXTRACT_PRIVATE <dd> @@ -772,7 +776,7 @@ page (for HTML and Man pages) or section (for LaTeX and RTF). undocumented members inside documented classes or files. If set to \c NO (the default) these members will be included in the various overviews, but no documentation section is generated. - This option has no effect if \c EXTRACT_ALL is enabled. + This option has no effect if \ref cfg_extract_all "EXTRACT_ALL" is enabled. \anchor cfg_hide_undoc_classes <dt>\c HIDE_UNDOC_CLASSES <dd> @@ -781,12 +785,12 @@ page (for HTML and Man pages) or section (for LaTeX and RTF). undocumented classes. If set to \c NO (the default) these classes will be included in the various overviews. - This option has no effect if \c EXTRACT_ALL is enabled. + This option has no effect if \ref cfg_extract_all "EXTRACT_ALL" is enabled. \anchor cfg_hide_friend_compounds <dt>\c HIDE_FRIEND_COMPOUNDS <dd> \addindex HIDE_FRIEND_COMPOUNDS - If the \c HIDE_FRIEND_COMPOUNDS tag is set to \c YES, Doxygen will hide all + If the \c HIDE_FRIEND_COMPOUNDS tag is set to \c YES, doxygen will hide all friend (class|struct|union) declarations. If set to \c NO (the default) these declarations will be included in the documentation. @@ -794,7 +798,7 @@ page (for HTML and Man pages) or section (for LaTeX and RTF). \anchor cfg_hide_in_body_docs <dt>\c HIDE_IN_BODY_DOCS <dd> \addindex HIDE_IN_BODY_DOCS -If the \c HIDE_IN_BODY_DOCS tag is set to \c YES, Doxygen will hide any +If the \c HIDE_IN_BODY_DOCS tag is set to \c YES, doxygen will hide any documentation blocks found inside the body of a function. If set to \c NO (the default) these blocks will be appended to the function's detailed documentation block. @@ -834,7 +838,7 @@ function's detailed documentation block. \anchor cfg_force_local_includes <dt>\c FORCE_LOCAL_INCLUDES <dd> \addindex FORCE_LOCAL_INCLUDES - If the \c FORCE_LOCAL_INCLUDES tag is set to \c YES then Doxygen + If the \c FORCE_LOCAL_INCLUDES tag is set to \c YES then doxygen will list include files with double quotes in the documentation rather than with sharp brackets. @@ -873,22 +877,12 @@ function's detailed documentation block. \addindex SORT_BY_SCOPE_NAME If the \c SORT_BY_SCOPE_NAME tag is set to \c YES, the class list will be sorted by fully-qualified names, including namespaces. If set to - NO (the default), the class list will be sorted only by class name, + \c NO (the default), the class list will be sorted only by class name, not including the namespace part. - @note This option is not very useful if \c HIDE_SCOPE_NAMES is set to \c YES. + @note This option is not very useful if \ref cfg_hide_scope_names "HIDE_SCOPE_NAMES" is set to \c YES. @note This option applies only to the class list, not to the alphabetical list. -\anchor cfg_strict_proto_matching -<dt>\c STRICT_PROTO_MATCHING <dd> - \addindex STRICT_PROTO_MATCHING - If the \c STRICT_PROTO_MATCHING option is enabled and doxygen fails to - do proper type resolution of all parameters of a function it will reject a - match between the prototype and the implementation of a member function even - if there is only one candidate or it is obvious which candidate to choose - by doing a simple string match. By disabling \c STRICT_PROTO_MATCHING doxygen - will still accept a match between prototype and implementation in such cases. - \anchor cfg_sort_members_constructors_first <dt>\c SORT_MEMBERS_CTORS_1ST <dd> \addindex SORT_MEMBERS_CTORS_1ST @@ -897,16 +891,16 @@ function's detailed documentation block. constructors and destructors are listed first. If set to \c NO (the default) the constructors will appear in the respective orders defined by \c SORT_MEMBER_DOCS and \c SORT_BRIEF_DOCS. - @note If \c SORT_BRIEF_DOCS is set to \c NO this option is ignored for + @note If \ref cfg_sort_brief_docs "SORT_BRIEF_DOCS" is set to \c NO this option is ignored for sorting brief member documentation. - @note If \c SORT_MEMBER_DOCS is set to \c NO this option is ignored for + @note If \ref cfg_sort_member_docs "SORT_MEMBER_DOCS" is set to \c NO this option is ignored for sorting detailed member documentation. \anchor cfg_generate_deprecatedlist <dt>\c GENERATE_DEPRECATEDLIST <dd> \addindex GENERATE_DEPRECATEDLIST - The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or - disable (NO) the deprecated list. This list is created by + The GENERATE_DEPRECATEDLIST tag can be used to enable (\c YES) or + disable (\c NO) the deprecated list. This list is created by putting \ref cmddeprecated "\\deprecated" commands in the documentation. @@ -924,7 +918,7 @@ function's detailed documentation block. <dt>\c GENERATE_TODOLIST <dd> \addindex GENERATE_TODOLIST The GENERATE_TODOLIST tag can be used to enable (YES) or - disable (NO) the todo list. This list is created by + disable (\c NO) the todo list. This list is created by putting \ref cmdtodo "\\todo" commands in the documentation. @@ -932,14 +926,14 @@ function's detailed documentation block. <dt>\c GENERATE_TESTLIST <dd> \addindex GENERATE_TESTLIST The GENERATE_TESTLIST tag can be used to enable (YES) or - disable (NO) the test list. This list is created by + disable (\c NO) the test list. This list is created by putting \ref cmdtest "\\test" commands in the documentation. \anchor cfg_generate_buglist <dt>\c GENERATE_BUGLIST <dd> \addindex GENERATE_BUGLIST The GENERATE_BUGLIST tag can be used to enable (YES) or - disable (NO) the bug list. This list is created by + disable (\c NO) the bug list. This list is created by putting \ref cmdbug "\\bug" commands in the documentation. \anchor cfg_enabled_sections @@ -987,7 +981,7 @@ function's detailed documentation block. The \c FILE_VERSION_FILTER tag can be used to specify a program or script that doxygen should invoke to get the current version for each file (typically from the version control system). Doxygen will invoke the program by executing (via - popen()) the command <code>command input-file</code>, where \c command is + <code>popen()</code>) the command <code>command input-file</code>, where \c command is the value of the \c FILE_VERSION_FILTER tag, and \c input-file is the name of an input file provided by doxygen. Whatever the program writes to standard output is used as the file version. @@ -1020,19 +1014,19 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" doxygen. The layout file controls the global structure of the generated output files in an output format independent way. To create the layout file that represents doxygen's defaults, run doxygen with the -l option. You can optionally specify a - file name after the option, if omitted DoxygenLayout.xml will be used as the name + file name after the option, if omitted \c DoxygenLayout.xml will be used as the name of the layout file. Note that if you run doxygen from a directory containing - a file called `DoxygenLayout.xml`, doxygen will parse it automatically even if + a file called \c DoxygenLayout.xml, doxygen will parse it automatically even if the \c LAYOUT_FILE tag is left empty. \anchor cfg_cite_bib_files <dt>\c CITE_BIB_FILES <dd> \addindex CITE_BIB_FILES The \c CITE_BIB_FILES tag can be used to specify one or more bib files - containing the reference definitions. This must be a list of .bib files. The - .bib extension is automatically appended if omitted. This requires the - bibtex tool to be installed. See also http://en.wikipedia.org/wiki/BibTeX - for more info. For LaTeX the style of the bibliography can be controlled + containing the reference definitions. This must be a list of <code>.bib</code> files. The + <code>.bib</code> extension is automatically appended if omitted. This requires the + \c bibtex tool to be installed. See also http://en.wikipedia.org/wiki/BibTeX + for more info. For \f$\mbox{\LaTeX}\f$ the style of the bibliography can be controlled using \ref cfg_latex_bib_style "LATEX_BIB_STYLE". See also \ref cmdcite "\\cite" for info how to create references. @@ -1062,7 +1056,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" <dt>\c WARN_IF_UNDOCUMENTED <dd> \addindex WARN_IF_UNDOCUMENTED If \c WARN_IF_UNDOCUMENTED is set to \c YES, then doxygen will generate warnings - for undocumented members. If \c EXTRACT_ALL is set to \c YES then this flag will + for undocumented members. If \ref cfg_extract_all "EXTRACT_ALL" is set to \c YES then this flag will automatically be disabled. \anchor cfg_warn_if_doc_error @@ -1096,7 +1090,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" \addindex WARN_LOGFILE The \c WARN_LOGFILE tag can be used to specify a file to which warning and error messages should be written. If left blank the output is written - to stderr. + to \c stderr. </dl> @@ -1111,7 +1105,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" \c myfile.cpp or directories like \c /usr/src/myproject. Separate the files or directories with spaces.<br> - \note Note If this tag is empty the current directory is searched. + \note If this tag is empty the current directory is searched. \anchor cfg_input_encoding <dt>\c INPUT_ENCODING <dd> @@ -1125,7 +1119,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" \anchor cfg_file_patterns <dt>\c FILE_PATTERNS <dd> \addindex FILE_PATTERNS - If the value of the \c INPUT tag contains directories, you can use the + If the value of the \ref cfg_input "INPUT" tag contains directories, you can use the \c FILE_PATTERNS tag to specify one or more wildcard patterns (like `*.cpp` and `*.h`) to filter out the source-files in the directories. If left blank the following patterns are tested: @@ -1146,8 +1140,8 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" <dt>\c EXCLUDE <dd> \addindex EXCLUDE The \c EXCLUDE tag can be used to specify files and/or directories that should be - excluded from the \c INPUT source files. This way you can easily exclude a - subdirectory from a directory tree whose root is specified with the \c INPUT tag. + excluded from the \ref cfg_input "INPUT" source files. This way you can easily exclude a + subdirectory from a directory tree whose root is specified with the \ref cfg_input "INPUT" tag. Note that relative paths are relative to the directory from which doxygen is run. \anchor cfg_exclude_symlinks @@ -1159,7 +1153,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" \anchor cfg_exclude_patterns <dt>\c EXCLUDE_PATTERNS <dd> \addindex EXCLUDE_PATTERNS - If the value of the \c INPUT tag contains directories, you can use the + If the value of the \ref cfg_input "INPUT" tag contains directories, you can use the \c EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude certain files from those directories. @@ -1186,7 +1180,8 @@ wildcard `*` is used, a substring. Examples: `ANamespace`, `AClass`, <dt>\c EXAMPLE_RECURSIVE <dd> \addindex EXAMPLE_RECURSIVE If the \c EXAMPLE_RECURSIVE tag is set to \c YES then subdirectories will be - searched for input files to be used with the \\include or \\dontinclude + searched for input files to be used with the \ref cmdinclude "\\include" or + \ref cmddontinclude "\\dontinclude" commands irrespective of the value of the \ref cfg_recursive "RECURSIVE" tag. Possible values are \c YES and \c NO. If left blank \c NO is used. @@ -1211,12 +1206,12 @@ wildcard `*` is used, a substring. Examples: `ANamespace`, `AClass`, \addindex INPUT_FILTER The \c INPUT_FILTER tag can be used to specify a program that doxygen should invoke to filter for each input file. Doxygen will invoke the filter program - by executing (via popen()) the command: + by executing (via <code>popen()</code>) the command: \verbatim <filter> <input-file> \endverbatim - where \<filter\> - is the value of the \c INPUT_FILTER tag, and \<input-file\> is the name of an + where <code>\<filter\></code> + is the value of the \c INPUT_FILTER tag, and <code>\<input-file\></code> is the name of an input file. Doxygen will then use the output that the filter program writes to standard output. @@ -1301,8 +1296,9 @@ the introduction page also for the doxygen output. <dt>\c REFERENCES_LINK_SOURCE <dd> \addindex REFERENCES_LINK_SOURCE If the \c REFERENCES_LINK_SOURCE tag is set to \c YES (the default) - and SOURCE_BROWSER tag is set to \c YES, then the hyperlinks from - functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will + and \ref cfg_source_browser "SOURCE_BROWSER" tag is set to \c YES, then the hyperlinks from + functions in \ref cfg_references_relation "REFERENCES_RELATION" and + \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION" lists will link to the source code. Otherwise they will link to the documentation. \anchor cfg_verbatim_headers @@ -1313,25 +1309,45 @@ the introduction page also for the doxygen output. which an include is specified. Set to \c NO to disable this. \sa Section \ref cmdclass "\\class". +\anchor cfg_clang_assisted_parsig +<dt>\c CLANG_ASSISTED_PARSING <dd> + \addindex CLANG_ASSISTED_PARSING + If \c CLANG_ASSISTED_PARSING is set to \c YES, then doxygen will use the + <a href="http://clang.llvm.org/">clang parser</a> for more acurate parsing + at the cost of reduced performance. This can be particularly helpful with + template rich C++ code for which doxygen's built-in parser lacks the + necessairy type information. + + @note The availability of this option depends on whether or not doxygen + was compiled with the `--with-libclang` option. + +\anchor cfg_clang_options +<dt>\c CLANG_OPTIONS <dd> + \addindex CLANG_OPTIONS + If clang assisted parsing is enabled you can provide the compiler with command + line options that you would normally use when invoking the compiler. Note that + the include paths will already be set by doxygen for the files and directories + specified at \c INPUT and \c INCLUDE_PATH. + \anchor cfg_use_htags <dt>\c USE_HTAGS <dd> \addindex USE_HTAGS If the \c USE_HTAGS tag is set to \c YES then the references to source code - will point to the HTML generated by the htags(1) tool instead of doxygen - built-in source browser. The htags tool is part of GNU's global source + will point to the HTML generated by the \c htags(1) tool instead of doxygen + built-in source browser. The \c htags tool is part of GNU's global source tagging system (see http://www.gnu.org/software/global/global.html). To use it do the following: -# Install the latest version of global (i.e. 4.8.6 or better) - -# Enable SOURCE_BROWSER and USE_HTAGS in the config file - -# Make sure the INPUT points to the root of the source tree + -# Enable \ref cfg_source_browser "SOURCE_BROWSER" and \c USE_HTAGS in the config file + -# Make sure the \ref cfg_input "INPUT" points to the root of the source tree -# Run doxygen as normal - Doxygen will invoke htags (and that will in turn invoke gtags), so these tools + Doxygen will invoke \c htags (and that will in turn invoke \c gtags), so these tools must be available from the command line (i.e. in the search path). The result: instead of the source browser generated by doxygen, the links to - source code will now point to the output of htags. + source code will now point to the output of \c htags. </dl> @@ -1349,7 +1365,7 @@ the introduction page also for the doxygen output. \anchor cfg_cols_in_alpha_index \addindex COLS_IN_ALPHA_INDEX If the alphabetical index is enabled - (see \c ALPHABETICAL_INDEX) then the \c COLS_IN_ALPHA_INDEX tag can be + (see \ref cfg_alphabetical_index "ALPHABETICAL_INDEX") then the \c COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in which this list will be split (can be a number in the range [1..20]) \anchor cfg_ignore_prefix @@ -1375,15 +1391,15 @@ the introduction page also for the doxygen output. <dt>\c HTML_OUTPUT <dd> \addindex HTML_OUTPUT The \c HTML_OUTPUT tag is used to specify where the HTML docs will be put. - If a relative path is entered the value of \c OUTPUT_DIRECTORY will be - put in front of it. If left blank 'html' will be used as the default path. + If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be + put in front of it. If left blank '<code>html</code>' will be used as the default path. \anchor cfg_html_file_extension <dt>\c HTML_FILE_EXTENSION <dd> \addindex HTML_FILE_EXTENSION The \c HTML_FILE_EXTENSION tag can be used to specify the file extension for - each generated HTML page (for example: .htm, .php, .asp). If it is left blank - doxygen will generate files with .html extension. + each generated HTML page (for example: <code>.htm, .php, .asp</code>). If it is left blank + doxygen will generate files with <code>.html</code> extension. \anchor cfg_html_header <dt>\c HTML_HEADER <dd> @@ -1428,9 +1444,9 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil the javascript and style sheets needed for the MathJax feature (or an empty string when \ref cfg_use_mathjax "USE_MATHJAX" is disabled). <dt><code>\$relpath^</code><dd> - If \c CREATE_SUBDIRS is enabled, the command <code>\$relpath^</code> can be + If \ref cfg_create_subdirs "CREATE_SUBDIRS" is enabled, the command <code>\$relpath^</code> can be used to produce a relative path to the root of the HTML output directory, - e.g. use \$relpath^doxygen.css, to refer to the standard style sheet. + e.g. use <code>\$relpath^doxygen.css</code>, to refer to the standard style sheet. </dl> To cope with differences in the layout of the header and footer that depend on @@ -1503,7 +1519,8 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil the style sheet that doxygen normally uses. \note It is recommended to use - \c HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and + \ref cfg_html_extra_stylesheet "HTML_EXTRA_STYLESHEET" instead of this tag, + as it is more robust and this tag will in the future become obsolete. \anchor cfg_html_extra_stylesheet @@ -1512,7 +1529,7 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-defined cascading style sheet that is included after the standard style sheets created by doxygen. Using this option one can overrule - certain style aspects. This is preferred over using \c HTML_STYLESHEET + certain style aspects. This is preferred over using \ref cfg_html_stylesheet "HTML_STYLESHEET" since it does not replace the standard style sheet and is therefor more robust against future updates. Doxygen will copy the style sheet file to the output directory. @@ -1554,8 +1571,9 @@ hr.footer { The \c HTML_EXTRA_FILES tag can be used to specify one or more extra images or other source files which should be copied to the HTML output directory. Note that these files will be copied to the base HTML output directory. Use the - $relpath^ marker in the \c HTML_HEADER and/or \c HTML_FOOTER files to load these - files. In the \c HTML_STYLESHEET file, use the file name only. Also note that + <code>$relpath^</code> marker in the \ref cfg_html_header "HTML_HEADER" and/or + \ref cfg_html_footer "HTML_FOOTER" files to load these + files. In the \ref cfg_html_stylesheet "HTML_STYLESHEET" file, use the file name only. Also note that the files will be copied as-is; there are no commands or markers available. \anchor cfg_html_colorstyle_hue @@ -1641,27 +1659,28 @@ hr.footer { \anchor cfg_docset_feedname <dt>\c DOCSET_FEEDNAME <dd> \addindex DOCSET_FEEDNAME - When \c GENERATE_DOCSET tag is set to \c YES, this tag determines the name of the + When \ref cfg_generate_docset "GENERATE_DOCSET" tag is set to \c YES, this tag determines the name of the feed. A documentation feed provides an umbrella under which multiple documentation sets from a single provider (such as a company or product suite) can be grouped. \anchor cfg_docset_bundle_id <dt>\c DOCSET_BUNDLE_ID <dd> - When \c GENERATE_DOCSET tag is set to \c YES, this tag specifies a string that + When \ref cfg_generate_docset "GENERATE_DOCSET" tag is set to \c YES, this tag specifies a string that should uniquely identify the documentation set bundle. This should be a reverse domain-name style string, e.g. <code>com.mycompany.MyDocSet</code>. Doxygen will append <code>.docset</code> to the name. \anchor cfg_docset_publisher_id <dt>\c DOCSET_PUBLISHER_ID <dd> -When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +When \ref cfg_generate_docset "GENERATE_DOCSET" tag is set to \c YES \c DOCSET_PUBLISHER_ID +tag specifies a string that should uniquely identify the documentation publisher. This should be a reverse domain-name style string, e.g. com.mycompany.MyDocSet.documentation. \anchor cfg_docset_publisher_name <dt>\c DOCSET_PUBLISHER_NAME <dd> -The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. +The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. \anchor cfg_generate_htmlhelp <dt>\c GENERATE_HTMLHELP <dd> @@ -1670,14 +1689,14 @@ The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. doxygen generates three additional HTML index files: \c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a project file that can be read by - <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/vsconHH1Start.asp"> + <a href="http://www.microsoft.com/en-us/download/details.aspx?id=21138"> Microsoft's HTML Help Workshop</a> on Windows. The HTML Help Workshop contains a compiler that can convert all HTML output - generated by doxygen into a single compiled HTML file (.chm). Compiled + generated by doxygen into a single compiled HTML file (`.chm`). Compiled HTML files are now used as the Windows 98 help format, and will replace - the old Windows help format (.hlp) on all Windows platforms in the future. + the old Windows help format (`.hlp`) on all Windows platforms in the future. Compressed HTML files also contain an index, a table of contents, and you can search for words in the documentation. The HTML workshop also contains a viewer for compressed HTML files. @@ -1685,39 +1704,39 @@ The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. \anchor cfg_chm_file <dt>\c CHM_FILE <dd> \addindex CHM_FILE - If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c CHM_FILE tag can - be used to specify the file name of the resulting .chm file. You + If the \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" tag is set to \c YES, the \c CHM_FILE tag can + be used to specify the file name of the resulting `.chm` file. You can add a path in front of the file if the result should not be written to the html output directory. \anchor cfg_hhc_location <dt>\c HHC_LOCATION <dd> \addindex HHC_LOCATION - If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c HHC_LOCATION tag can + If the \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" tag is set to \c YES, the \c HHC_LOCATION tag can be used to specify the location (absolute path including file name) of - the HTML help compiler (hhc.exe). If non-empty doxygen will try to run - the HTML help compiler on the generated index.hhp. + the HTML help compiler (\c hhc.exe). If non-empty doxygen will try to run + the HTML help compiler on the generated \c index.hhp. \anchor cfg_generate_chi <dt>\c GENERATE_CHI <dd> \addindex GENERATE_CHI - If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c GENERATE_CHI flag - controls if a separate .chi index file is generated (<code>YES</code>) or that - it should be included in the master .chm file (<code>NO</code>). + If the \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" tag is set to \c YES, the \c GENERATE_CHI flag + controls if a separate `.chi` index file is generated (\c YES) or that + it should be included in the master `.chm` file (\c NO). \anchor cfg_chm_index_encoding <dt>\c CHM_INDEX_ENCODING <dd> \addindex CHM_INDEX_ENCODING - If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c CHM_INDEX_ENCODING - is used to encode HtmlHelp index (hhk), content (hhc) and project file + If the \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" tag is set to \c YES, the \c CHM_INDEX_ENCODING + is used to encode HtmlHelp index (\c hhk), content (\c hhc) and project file content. \anchor cfg_binary_toc <dt>\c BINARY_TOC <dd> \addindex BINARY_TOC - If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c BINARY_TOC flag - controls whether a binary table of contents is generated (<code>YES</code>) or a - normal table of contents (<code>NO</code>) in the .chm file. + If the \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" tag is set to \c YES, the \c BINARY_TOC flag + controls whether a binary table of contents is generated (\c YES) or a + normal table of contents (\c NO) in the .chm file. \anchor cfg_toc_expand <dt>\c TOC_EXPAND <dd> @@ -1729,79 +1748,79 @@ The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. \anchor cfg_generate_qhp <dt>\c GENERATE_QHP <dd> \addindex GENERATE_QHP - If the GENERATE_QHP tag is set to \c YES and both \c QHP_NAMESPACE - and QHP_VIRTUAL_FOLDER are set, an additional index file will + If the \c GENERATE_QHP tag is set to \c YES and both \ref cfg_qhp_namespace "QHP_NAMESPACE" + and \ref cfg_qhp_virtual_folder "QHP_VIRTUAL_FOLDER" are set, an additional index file will be generated that can be used as input for Qt's qhelpgenerator - to generate a Qt Compressed Help (.qch) of the generated HTML + to generate a Qt Compressed Help (`.qch`) of the generated HTML documentation. \anchor cfg_qch_file <dt>\c QCH_FILE <dd> \addindex QCH_FILE - If the QHG_LOCATION tag is specified, the QCH_FILE tag can - be used to specify the file name of the resulting .qch file. + If the \ref cfg_qhg_location "QHG_LOCATION" tag is specified, the \c QCH_FILE tag can + be used to specify the file name of the resulting `.qch` file. The path specified is relative to the HTML output folder. \anchor cfg_qhp_namespace <dt>\c QHP_NAMESPACE <dd> \addindex QHP_NAMESPACE - The QHP_NAMESPACE tag specifies the namespace to use when generating + The \c QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help Project output. For more information please see <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace">Qt Help Project / Namespace</a>. \anchor cfg_qhp_virtual_folder <dt>\c QHP_VIRTUAL_FOLDER <dd> \addindex QHP_VIRTUAL_FOLDER - The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when + The \c QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt Help Project output. For more information please see <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>. \anchor cfg_qhp_cust_filter_name <dt>\c QHP_CUST_FILTER_NAME <dd> \addindex QHP_CUST_FILTER_NAME - If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. For more information please see + If \c QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. For more information please see <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. \anchor cfg_qhp_cust_filter_attrs <dt>\c QHP_CUST_FILTER_ATTRS <dd> \addindex QHP_CUST_FILTER_ATTRS - The QHP_CUST_FILTER_ATTRIBUTES tag specifies the list of the attributes of the custom filter to add. + The \c QHP_CUST_FILTER_ATTRIBUTES tag specifies the list of the attributes of the custom filter to add. For more information please see <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. \anchor cfg_qhp_sect_filter_attrs <dt>\c QHP_SECT_FILTER_ATTRS <dd> \addindex QHP_SECT_FILTER_ATTRS - The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's filter section matches. + The \c QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's filter section matches. <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. \anchor cfg_qhg_location <dt>\c QHG_LOCATION <dd> \addindex QHG_LOCATION - If the GENERATE_QHP tag is set to \c YES, the \c QHG_LOCATION tag can + If the \ref cfg_generate_qhp "GENERATE_QHP" tag is set to \c YES, the \c QHG_LOCATION tag can be used to specify the location of Qt's qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the generated - .qhp file. + `.qhp` file. \anchor cfg_generate_eclipsehelp <dt>\c GENERATE_ECLIPSEHELP <dd> \addindex GENERATE_ECLIPSEHELP If the \c GENERATE_ECLIPSEHELP tag is set to \c YES, additional index files - will be generated, which together with the HTML files, form an Eclipse help + will be generated, which together with the HTML files, form an `Eclipse` help plugin. To install this plugin and make it available under the help contents - menu in Eclipse, the contents of the directory containing the HTML and XML + menu in `Eclipse`, the contents of the directory containing the HTML and XML files needs to be copied into the plugins directory of eclipse. The name of the directory within the plugins directory should be the same as the \ref cfg_eclipse_doc_id "ECLIPSE_DOC_ID" value. - After copying Eclipse needs to be restarted before the help appears. + After copying `Eclipse` needs to be restarted before the help appears. \anchor cfg_eclipse_doc_id <dt>\c ECLIPSE_DOC_ID <dd> \addindex ECLIPSE_DOC_ID - A unique identifier for the eclipse help plugin. When installing the plugin + A unique identifier for the `Eclipse` help plugin. When installing the plugin the directory name containing the HTML and XML files should also have this name. Each documentation set should have its own identifier. @@ -1827,7 +1846,7 @@ The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. \anchor cfg_generate_treeview <dt>\c GENERATE_TREEVIEW <dd> \addindex GENERATE_TREEVIEW - The GENERATE_TREEVIEW tag is used to specify whether a tree-like index + The \c GENERATE_TREEVIEW tag is used to specify whether a tree-like index structure should be generated to display hierarchical information. If the tag value is set to \c YES, a side panel will be generated containing a tree-like index structure (just like the one that @@ -1835,16 +1854,16 @@ The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). Windows users are probably better off using the HTML help feature. - Via custom stylesheets (see \ref cfg_html_stylesheet "HTML_STYLESHEET") + Via custom stylesheets (see \ref cfg_html_extra_stylesheet "HTML_EXTRA_STYLESHEET") 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". + the \ref cfg_project_name "PROJECT_NAME". \anchor cfg_treeview_width <dt>\c TREEVIEW_WIDTH <dd> \addindex TREEVIEW_WIDTH - If the treeview is enabled (see \c GENERATE_TREEVIEW) then this tag can be + If the treeview is enabled (see \ref cfg_generate_treeview "GENERATE_TREEVIEW") then this tag can be used to set the initial width (in pixels) of the frame in which the tree is shown. @@ -1857,7 +1876,7 @@ The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. \anchor cfg_formula_fontsize <dt>\c FORMULA_FONTSIZE <dd> \addindex FORMULA_FONTSIZE - Use this tag to change the font size of Latex formulas included + Use this tag to change the font size of \f$\mbox{\LaTeX}\f$ formulas included as images in the HTML documentation. The default is 10. when you change the font size after a successful doxygen run you need to manually remove any `form_*.png` images from the HTML @@ -1875,10 +1894,10 @@ The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. \anchor cfg_use_mathjax <dt>\c USE_MATHJAX <dd> \addindex USE_MATHJAX - Enable the \c USE_MATHJAX option to render LaTeX formulas using MathJax + Enable the \c USE_MATHJAX option to render \f$\mbox{\LaTeX}\f$ formulas using MathJax (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 + have \f$\mbox{\LaTeX}\f$ installed or if you want to formulas look prettier in the HTML 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. @@ -1917,7 +1936,7 @@ MATHJAX_CODEFILE = disableRenderer \addindex MATHJAX_RELPATH When MathJax is enabled you need to specify the location relative to the HTML output directory using the \c MATHJAX_RELPATH option. The destination - directory should contain the MathJax.js script. For instance, if the mathjax + directory should contain the `MathJax.js` script. For instance, if the \c 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 MathJax Content Delivery Network so you can quickly see the result without @@ -1927,7 +1946,7 @@ MATHJAX_CODEFILE = disableRenderer \anchor cfg_mathjax_extensions <dt>\c MATHJAX_EXTENSIONS <dd> \addindex MATHJAX_EXTENSIONS - The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension + The \c MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension names that should be enabled during MathJax rendering. For example \verbatim MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols @@ -1949,14 +1968,14 @@ MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols better solution. It is possible to search using the keyboard; - to jump to the search box use access key + S (what the access key is - depends on the OS and browser, but it is typically CTRL, ALT/option, or both). - Inside the search box use the cursor down key to jump into the search - results window, the results can be navigated using the cursor keys. - Press Enter to select an item or escape to cancel the search. The + to jump to the search box use `<access key> + S` (what the `<access key>` is + depends on the OS and browser, but it is typically `<CTRL>`, `<ALT>`/`<option>`, or both). + Inside the search box use the `<cursor down key>` to jump into the search + results window, the results can be navigated using the `<cursor keys>`. + Press `<Enter>` to select an item or `<escape>` to cancel the search. The filter options can be selected when the cursor is inside the search box - by pressing Shift+cursor down. Also here use the cursor keys to - select a filter and enter or escape to activate or cancel the filter option. + by pressing `<Shift>+<cursor down>`. Also here use the `<cursor keys>` to + select a filter and `<Enter>` or `<escape>` to activate or cancel the filter option. \anchor cfg_server_based_search <dt>\c SERVER_BASED_SEARCH <dd> @@ -1999,13 +2018,14 @@ When \ref cfg_server_based_search "SERVER_BASED_SEARCH" and \ref cfg_external_search "EXTERNAL_SEARCH" are both enabled the unindexed search data is written to a file for indexing by an external tool. With the \c SEARCHDATA_FILE tag the name of this file can be specified. -The default is searchdata.xml. +The default is `searchdata.xml`. \anchor cfg_external_search_id <dt>\c EXTERNAL_SEARCH_ID <dd> \addindex EXTERNAL_SEARCH_ID -When \c SERVER_BASED_SEARCH AND \c EXTERNAL_SEARCH are both enabled the +When \ref cfg_server_based_search "SERVER_BASED_SEARCH" and +\ref cfg_external_search "EXTERNAL_SEARCH" are both enabled the \c EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is useful in combination with \ref cfg_extra_search_mappings "EXTRA_SEARCH_MAPPINGS" to search through multiple projects and redirect the results back to the right project. @@ -2042,23 +2062,23 @@ EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... \addindex LATEX_OUTPUT The \c LATEX_OUTPUT tag is used to specify where the \f$\mbox{\LaTeX}\f$ docs will be put. - If a relative path is entered the value of \c OUTPUT_DIRECTORY will be - put in front of it. If left blank 'latex' will be used as the default path. + If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be + put in front of it. If left blank '`latex`' will be used as the default path. \anchor cfg_latex_cmd_name <dt>\c LATEX_CMD_NAME <dd> \addindex LATEX_CMD_NAME - The \c LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. + The \c LATEX_CMD_NAME tag can be used to specify the \f$\mbox{\LaTeX}\f$ command name to be invoked. If left blank 'latex' will be used as the default command name. - Note that when enabling USE_PDFLATEX this option is only used for + Note that when enabling \ref cfg_use_pdflatex "USE_PDFLATEX" this option is only used for generating bitmaps for formulas in the HTML output, but not in the - Makefile that is written to the output directory. + \c Makefile that is written to the output directory. \anchor cfg_makeindex_cmd_name <dt>\c MAKEINDEX_CMD_NAME <dd> \addindex MAKEINDEX_CMD_NAME The MAKEINDEX_CMD_NAME tag can be used to specify the command name to - generate index for LaTeX. If left blank 'makeindex' will be used as the + generate index for \f$\mbox{\LaTeX}\f$. If left blank '`makeindex`' will be used as the default command name. \anchor cfg_compact_latex @@ -2079,7 +2099,7 @@ EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... <li><code>legal</code> (8.5 x 14 inches). <li><code>executive</code> (7.25 x 10.5 inches) </ul> - If left blank a4 will be used. + If left blank \c a4 will be used. \anchor cfg_extra_packages <dt>\c EXTRA_PACKAGES <dd> @@ -2112,22 +2132,25 @@ EXTRA_PACKAGES = times <code>\$projectnumber</code>. Doxygen will replace them by respectively the title of the page, the current date and time, only the current date, - the version number of doxygen, the project name (see \c PROJECT_NAME), or the - project number (see \c PROJECT_NUMBER). + the version number of doxygen, the project name (see \ref cfg_project_name "PROJECT_NAME"), or the + project number (see \ref cfg_project_number "PROJECT_NUMBER"). \anchor cfg_latex_footer <dt>\c LATEX_FOOTER <dd> \addindex LATEX_FOOTER - The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for - the generated latex document. The footer should contain everything after + The LATEX_FOOTER tag can be used to specify a personal \f$\mbox{\LaTeX}\f$ footer for + the generated \f$\mbox{\LaTeX}\f$ document. The footer should contain everything after the last chapter. If it is left blank doxygen will generate a - standard footer. Notice: only use this tag if you know what you are doing! + standard footer. + + \par Note: + Only use a user-defined footer if you know what you are doing! \anchor cfg_latex_extra_files <dt>\c LATEX_EXTRA_FILES <dd> \addindex LATEX_EXTRA_FILES The \c LATEX_EXTRA_FILES tag can be used to specify one or more extra images - or other source files which should be copied to the LaTeX output directory. + or other source files which should be copied to the \f$\mbox{\LaTeX}\f$ output directory. Note that the files will be copied as-is; there are no commands or markers available. @@ -2136,7 +2159,7 @@ EXTRA_PACKAGES = times \addindex PDF_HYPERLINKS If the \c PDF_HYPERLINKS tag is set to \c YES, the \f$\mbox{\LaTeX}\f$ that - is generated is prepared for conversion to PDF (using ps2pdf or pdflatex). + is generated is prepared for conversion to PDF (using \c ps2pdf or \c pdflatex). The PDF file will contain links (just like the HTML output) instead of page references. This makes the output suitable for online browsing using a PDF viewer. @@ -2146,14 +2169,14 @@ EXTRA_PACKAGES = times \addindex LATEX_PDFLATEX If the \c LATEX_PDFLATEX tag is set to \c YES, doxygen will use - pdflatex to generate the PDF file directly from the \f$\mbox{\LaTeX}\f$ + \c pdflatex to generate the PDF file directly from the \f$\mbox{\LaTeX}\f$ files. \anchor cfg_latex_batchmode <dt>\c LATEX_BATCHMODE <dd> \addindex LATEX_BATCHMODE - If the \c LATEX_BATCHMODE tag is set to \c YES, doxygen will add the \\batchmode. + If the \c LATEX_BATCHMODE tag is set to \c YES, doxygen will add the \c \\batchmode command to the generated \f$\mbox{\LaTeX}\f$ files. This will instruct \f$\mbox{\LaTeX}\f$ to keep running if errors occur, instead of asking the user for help. This option is also used when generating formulas @@ -2179,7 +2202,7 @@ EXTRA_PACKAGES = times \anchor cfg_latex_source_code <dt>\c LATEX_SOURCE_CODE <dd> If \c LATEX_SOURCE_CODE is set to \c YES then doxygen will include - source code with syntax highlighting in the LaTeX output. + source code with syntax highlighting in the \f$\mbox{\LaTeX}\f$ output. Note that which sources are shown also depends on other settings such as \ref cfg_source_browser "SOURCE_BROWSER". @@ -2198,8 +2221,8 @@ EXTRA_PACKAGES = times <dt>\c RTF_OUTPUT <dd> \addindex RTF_OUTPUT The \c RTF_OUTPUT tag is used to specify where the RTF docs will be put. - If a relative path is entered the value of \c OUTPUT_DIRECTORY will be - put in front of it. If left blank \c rtf will be used as the default path. + If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be + put in front of it. If left blank '`rtf`' will be used as the default path. \anchor cfg_compact_rtf <dt>\c COMPACT_RTF <dd> @@ -2252,9 +2275,9 @@ EXTRA_PACKAGES = times <dt>\c MAN_OUTPUT <dd> \addindex MAN_OUTPUT The \c MAN_OUTPUT tag is used to specify where the man pages will be put. - If a relative path is entered the value of \c OUTPUT_DIRECTORY will be - put in front of it. If left blank 'man' will be used as the default path. - A directory man3 will be created inside the directory specified by + If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be + put in front of it. If left blank '`man`' will be used as the default path. + A directory \c man3 will be created inside the directory specified by \c MAN_OUTPUT. \anchor cfg_man_extension @@ -2263,7 +2286,7 @@ EXTRA_PACKAGES = times The \c MAN_EXTENSION tag determines the extension that is added to the generated man pages (default is the subroutine's section .3). In case the manual section does not start with a number, the number 3 is prepended. - The dot (.) at the beginning of the MAN_EXTENSION is optional. + The dot (.) at the beginning of the \c MAN_EXTENSION is optional. \anchor cfg_man_links <dt>\c MAN_LINKS <dd> @@ -2282,7 +2305,7 @@ EXTRA_PACKAGES = times <dt>\c GENERATE_XML <dd> \addindex GENERATE_XML - If the \c GENERATE_XML tag is set to \c YES Doxygen will + If the \c GENERATE_XML tag is set to \c YES doxygen will generate an XML file that captures the structure of the code including all documentation. @@ -2290,27 +2313,27 @@ EXTRA_PACKAGES = times <dt>\c XML_OUTPUT <dd> \addindex XML_OUTPUT The \c XML_OUTPUT tag is used to specify where the XML pages will be put. - If a relative path is entered the value of \c OUTPUT_DIRECTORY will be - put in front of it. If left blank \c xml will be used as the default path. + If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be + put in front of it. If left blank '`xml`' will be used as the default path. \anchor cfg_xml_schema <dt>\c XML_SCHEMA <dd> \addindex XML_SCHEMA - The \c XML_SCHEMA tag can be used to specify an XML schema, + The \c XML_SCHEMA tag can be used to specify a XML schema, which can be used by a validating XML parser to check the syntax of the XML files. \anchor cfg_xml_dtd <dt>\c XML_DTD <dd> \addindex XML_DTD - The \c XML_DTD tag can be used to specify an XML DTD, + The \c XML_DTD tag can be used to specify a XML DTD, which can be used by a validating XML parser to check the syntax of the XML files. \anchor cfg_xml_programlisting <dt>\c XML_PROGRAMLISTING <dd> \addindex XML_PROGRAMLISTING - If the \c XML_PROGRAMLISTING tag is set to \c YES Doxygen will + If the \c XML_PROGRAMLISTING tag is set to \c YES doxygen will dump the program listings (including syntax highlighting and cross-referencing information) to the XML output. Note that enabling this will significantly increase the size of the XML output. @@ -2323,7 +2346,7 @@ EXTRA_PACKAGES = times <dt>\c GENERATE_DOCBOOK <dd> \addindex GENERATE_DOCBOOK -If the \c GENERATE_DOCBOOK tag is set to \c YES Doxygen will generate Docbook files +If the \c GENERATE_DOCBOOK tag is set to \c YES doxygen will generate Docbook files that can be used to generate PDF. \anchor cfg_docbook_output @@ -2331,7 +2354,7 @@ that can be used to generate PDF. \addindex DOCBOOK_OUTPUT The \c DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be put in -front of it. If left blank docbook will be used as the default path. +front of it. If left blank '`docbook`' will be used as the default path. </dl> @@ -2341,7 +2364,7 @@ front of it. If left blank docbook will be used as the default path. <dt>\c GENERATE_AUTOGEN_DEF <dd> \addindex GENERATE_AUTOGEN_DEF - If the \c GENERATE_AUTOGEN_DEF tag is set to \c YES Doxygen will + If the \c GENERATE_AUTOGEN_DEF tag is set to \c YES doxygen will generate an AutoGen Definitions (see http://autogen.sf.net) file that captures the structure of the code including all documentation. Note that this feature is still experimental @@ -2355,7 +2378,7 @@ front of it. If left blank docbook will be used as the default path. <dt>\c GENERATE_PERLMOD <dd> \addindex GENERATE_PERLMOD - If the \c GENERATE_PERLMOD tag is set to \c YES Doxygen will + If the \c GENERATE_PERLMOD tag is set to \c YES doxygen will generate a Perl module file that captures the structure of the code including all documentation. Note that this feature is still experimental and incomplete at the @@ -2364,8 +2387,8 @@ front of it. If left blank docbook will be used as the default path. \anchor cfg_perlmod_latex <dt>\c PERLMOD_LATEX <dd> \addindex PERLMOD_LATEX - If the \c PERLMOD_LATEX tag is set to \c YES Doxygen will generate - the necessary Makefile rules, Perl scripts and LaTeX code to be able + If the \c PERLMOD_LATEX tag is set to \c YES doxygen will generate + the necessary Makefile rules, Perl scripts and \f$\mbox{\LaTeX}\f$ code to be able to generate PDF and DVI output from the Perl module output. \anchor cfg_perlmod_pretty @@ -2380,10 +2403,10 @@ front of it. If left blank docbook will be used as the default path. \anchor cfg_perlmod_makevar_prefix <dt>\c PERLMOD_MAKEVAR_PREFIX <dd> \addindex PERLMOD_MAKEVAR_PREFIX - The names of the make variables in the generated doxyrules.make file + The names of the make variables in the generated `doxyrules.make` file are prefixed with the string contained in \c PERLMOD_MAKEVAR_PREFIX. - This is useful so different doxyrules.make files included by the same - Makefile don't overwrite each other's variables. + This is useful so different `doxyrules.make` files included by the same + `Makefile` don't overwrite each other's variables. </dl> @@ -2403,20 +2426,20 @@ front of it. If left blank docbook will be used as the default path. If the \c MACRO_EXPANSION tag is set to \c YES doxygen will expand all macro names in the source code. If set to \c NO (the default) only conditional compilation will be performed. Macro expansion can be done in a controlled - way by setting \c EXPAND_ONLY_PREDEF to \c YES. + way by setting \ref cfg_expand_only_predef "EXPAND_ONLY_PREDEF" to \c YES. \anchor cfg_expand_only_predef <dt>\c EXPAND_ONLY_PREDEF <dd> \addindex EXPAND_ONLY_PREDEF - If the \c EXPAND_ONLY_PREDEF and \c MACRO_EXPANSION tags are both set to \c YES + If the \c EXPAND_ONLY_PREDEF and \ref cfg_macro_expansion "MACRO_EXPANSION" tags are both set to \c YES then the macro expansion is limited to the macros specified with the - \c PREDEFINED and \c EXPAND_AS_DEFINED tags. + \ref cfg_predefined "PREDEFINED" and \ref cfg_expand_as_defined "EXPAND_AS_DEFINED" tags. \anchor cfg_search_includes <dt>\c SEARCH_INCLUDES <dd> \addindex SEARCH_INCLUDES If the \c SEARCH_INCLUDES tag is set to \c YES (the default) the includes files - in the \c INCLUDE_PATH (see below) will be searched if a \#include is found. + in the \ref cfg_include_path "INCLUDE_PATH" will be searched if a \c \#include is found. \anchor cfg_include_path <dt>\c INCLUDE_PATH <dd> @@ -2430,27 +2453,28 @@ front of it. If left blank docbook will be used as the default path. \addindex INCLUDE_FILE_PATTERNS You can use the \c INCLUDE_FILE_PATTERNS tag to specify one or more wildcard patterns (like `*.h` and `*.hpp`) to filter out the header-files in the - directories. If left blank, the patterns specified with \c FILE_PATTERNS will + directories. If left blank, the patterns specified with \ref cfg_file_patterns "FILE_PATTERNS" will be used. \anchor cfg_predefined <dt>\c PREDEFINED <dd> \addindex PREDEFINED The \c PREDEFINED tag can be used to specify one or more macro names that - are defined before the preprocessor is started (similar to the -D option of - gcc). The argument of the tag is a list of macros of the form: + are defined before the preprocessor is started (similar to the `-D` option of + \c gcc). The argument of the tag is a list of macros of the form: <code>name</code> or <code>name=definition</code> (no spaces). If the definition and the "=" are omitted, "=1" is assumed. To prevent - a macro definition from being undefined via \#undef or recursively expanded - use the := operator instead of the = operator. + a macro definition from being undefined via \c \#undef or recursively expanded + use the \c := operator instead of the \c = operator. \anchor cfg_expand_as_defined <dt>\c EXPAND_AS_DEFINED <dd> \addindex EXPAND_AS_DEFINED - If the \c MACRO_EXPANSION and \c EXPAND_ONLY_PREDEF tags are set to \c YES then + If the \ref cfg_macro_expansion "MACRO_EXPANSION" and + \ref cfg_expand_only_predef "EXPAND_ONLY_PREDEF" tags are set to \c YES then this tag can be used to specify a list of macro names that should be expanded. The macro definition that is found in the sources will be used. - Use the \c PREDEFINED tag if you want to use a different macro definition. + Use the \ref cfg_predefined "PREDEFINED" tag if you want to use a different macro definition. \anchor cfg_skip_function_macros <dt>\c SKIP_FUNCTION_MACROS <dd> @@ -2473,7 +2497,7 @@ front of it. If left blank docbook will be used as the default path. See \ref external for more information about the use of tag files. \note - Each tag file must have a unique name + Each tag file must have an unique name (where the name does \e not include the path). If a tag file is not located in the directory in which doxygen is run, you must also specify the path to the tagfile here. @@ -2523,8 +2547,8 @@ front of it. If left blank docbook will be used as the default path. 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 also works with \c HAVE_DOT disabled, but it is recommended to -install and use dot, since it yields more powerful graphs. +this option also works with \ref cfg_have_dot "HAVE_DOT" disabled, but it is recommended to +install and use \c dot, since it yields more powerful graphs. \anchor cfg_mscgen_path <dt>\c MSCGEN_PATH <dd> @@ -2538,16 +2562,16 @@ install and use dot, since it yields more powerful graphs. \anchor cfg_have_dot <dt>\c HAVE_DOT <dd> \addindex HAVE_DOT - If you set the \c HAVE_DOT tag to \c YES then doxygen will assume the dot tool is - available from the path. This tool is part of - <a href="http://www.research.att.com/sw/tools/graphviz/">Graphviz</a>, a graph + If you set the \c HAVE_DOT tag to \c YES then doxygen will assume the \c dot tool is + available from the \c path. This tool is part of + <a href=" http://www.graphviz.org/">Graphviz</a>, a graph visualization toolkit from AT\&T and Lucent Bell Labs. The other options in this section have no effect if this option is set to \c NO (the default) \anchor cfg_dot_num_threads <dt>\c DOT_NUM_THREADS <dd> \addindex DOT_NUM_THREADS - The \c DOT_NUM_THREADS specifies the number of dot invocations doxygen is + The \c DOT_NUM_THREADS specifies the number of \c dot invocations doxygen is allowed to run in parallel. When set to 0 (the default) doxygen will base this on the number of processors available in the system. You can set it explicitly to a value larger than 0 to get control over the balance @@ -2561,7 +2585,7 @@ install and use dot, since it yields more powerful graphs. When you want a differently looking font you can specify the font name using \c DOT_FONTNAME. You need to make sure dot is able to find the font, which can be done by putting it in a standard location or by setting the - \c DOTFONTPATH environment variable or by setting \c DOT_FONTPATH to the + \c DOTFONTPATH environment variable or by setting \ref cfg_dot_fontpath "DOT_FONTPATH" to the directory containing the font. \anchor cfg_dot_fontsize @@ -2572,23 +2596,23 @@ The default size is 10pt. \anchor cfg_dot_fontpath <dt>\c DOT_FONTPATH <dd> \addindex DOT_FONTPATH - By default doxygen will tell dot to use the output directory to look for the + By default doxygen will tell \c dot to use the output directory to look for the \c FreeSans.ttf font (which doxygen will put there itself). If you specify a - different font using \c DOT_FONTNAME you can set the path where dot + different font using \ref cfg_dot_fontname "DOT_FONTNAME" you can set the path where \c dot can find it using this tag. \anchor cfg_class_graph <dt>\c CLASS_GRAPH <dd> \addindex CLASS_GRAPH - If the \c CLASS_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen + If the \c CLASS_GRAPH and \ref cfg_have_dot "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 \c CLASS_DIAGRAMS tag to \c NO. + the \ref cfg_class_diagrams "CLASS_DIAGRAMS" tag to \c NO. \anchor cfg_collaboration_graph <dt>\c COLLABORATION_GRAPH <dd> \addindex COLLABORATION_GRAPH - If the \c COLLABORATION_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen + If the \c COLLABORATION_GRAPH and \ref cfg_have_dot "HAVE_DOT" are set to \c YES then doxygen will generate a graph for each documented class showing the direct and indirect implementation dependencies (inheritance, containment, and class references variables) of the class with other documented classes. @@ -2596,20 +2620,20 @@ The default size is 10pt. \anchor cfg_group_graphs <dt>\c GROUP_GRAPHS <dd> \addindex GROUP_GRAPHS - If the GROUP_GRAPHS and HAVE_DOT tags are set to \c YES then doxygen + If the \c GROUP_GRAPHS and \ref cfg_have_dot "HAVE_DOT" tags are set to \c YES then doxygen will generate a graph for groups, showing the direct groups dependencies. \anchor cfg_uml_look <dt>\c UML_LOOK <dd> \addindex UML_LOOK - If the UML_LOOK tag is set to \c YES doxygen will generate inheritance and + If the \c UML_LOOK tag is set to \c YES doxygen will generate inheritance and 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 + If the \ref cfg_uml_look "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 @@ -2621,7 +2645,7 @@ The default size is 10pt. \anchor cfg_template_relations <dt>\c TEMPLATE_RELATIONS <dd> \addindex TEMPLATE_RELATIONS - If the \c TEMPLATE_RELATIONS and \c HAVE_DOT tags are set to \c YES then + If the \c TEMPLATE_RELATIONS and \ref cfg_have_dot "HAVE_DOT" tags are set to \c YES then doxygen will show the relations between templates and their instances. \anchor cfg_hide_undoc_relations @@ -2634,7 +2658,9 @@ The default size is 10pt. \anchor cfg_include_graph <dt>\c INCLUDE_GRAPH <dd> \addindex INCLUDE_GRAPH - If the \c ENABLE_PREPROCESSING, \c SEARCH_INCLUDES, \c INCLUDE_GRAPH, and \c HAVE_DOT + If the \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING", + \ref cfg_search_includes "SEARCH_INCLUDES", \ref cfg_include_graph "INCLUDE_GRAPH", + and \ref cfg_have_dot "HAVE_DOT" tags are set to \c YES then doxygen will generate a graph for each documented file showing the direct and indirect include dependencies of the file with other documented files. @@ -2642,41 +2668,42 @@ The default size is 10pt. \anchor cfg_included_by_graph <dt>\c INCLUDED_BY_GRAPH <dd> \addindex INCLUDED_BY_GRAPH - If the \c ENABLE_PREPROCESSING, \c SEARCH_INCLUDES, \c INCLUDED_BY_GRAPH, and - \c HAVE_DOT tags are set to \c YES then doxygen will generate a graph for each + If the \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING", + \ref cfg_search_includes "SEARCH_INCLUDES", \ref cfg_include_graph "INCLUDED_BY_GRAPH", and + \ref cfg_have_dot "HAVE_DOT" tags are set to \c YES then doxygen will generate a graph for each documented header file showing the documented files that directly or indirectly include this file. \anchor cfg_call_graph <dt>\c CALL_GRAPH <dd> \addindex CALL_GRAPH - If the \c CALL_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen will + If the \c CALL_GRAPH and \ref cfg_have_dot "HAVE_DOT" tags are set to \c YES then doxygen will generate a call dependency graph for every global function or class method. Note that enabling this option will significantly increase the time of a run. So in most cases it will be better to enable call graphs for selected - functions only using the \\callgraph command. + functions only using the \ref cmdcallgraph "\\callgraph" command. \anchor cfg_caller_graph <dt>\c CALLER_GRAPH <dd> \addindex CALLER_GRAPH - If the \c CALLER_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen will + If the \c CALLER_GRAPH and \ref cfg_have_dot "HAVE_DOT" tags are set to \c YES then doxygen will generate a caller dependency graph for every global function or class method. Note that enabling this option will significantly increase the time of a run. So in most cases it will be better to enable caller graphs for selected - functions only using the \\callergraph command. + functions only using the \ref cmdcallergraph "\\callergraph" command. \anchor cfg_graphical_hierarchy <dt>\c GRAPHICAL_HIERARCHY <dd> \addindex GRAPHICAL_HIERARCHY - If the \c GRAPHICAL_HIERARCHY and \c HAVE_DOT tags are set to \c YES then + If the \c GRAPHICAL_HIERARCHY and \ref cfg_have_dot "HAVE_DOT" tags are set to \c YES then doxygen will graphical hierarchy of all classes instead of a textual one. \anchor cfg_directory_graph <dt>\c DIRECTORY_GRAPH <dd> \addindex DIRECTORY_GRAPH - If the \c DIRECTORY_GRAPH, and \c HAVE_DOT options are set + If the \c DIRECTORY_GRAPH, and \ref cfg_have_dot "HAVE_DOT" options are set to \c YES then doxygen will show the dependencies a directory has on other directories - in a graphical way. The dependency relations are determined by the \#include + in a graphical way. The dependency relations are determined by the \c \#include relations between the files in the directories. \anchor cfg_dot_graph_max_nodes @@ -2688,43 +2715,43 @@ The default size is 10pt. 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 DOT_GRAPH_MAX_NODES 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. + that the size of a graph can be further restricted by \ref cfg_max_dot_graph_depth "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 + graphs generated by \c 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). + \ref cfg_dot_graph_max_nodes "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> \addindex DOT_IMAGE_FORMAT The \c DOT_IMAGE_FORMAT tag can be used to set the image format of the images - generated by dot. Possible values are svg, png, jpg, or gif. + generated by \c dot. Possible values are \c svg, \c png, \c jpg, or \c gif. If left blank png will be used. \note If you choose \c svg you need to set - HTML_FILE_EXTENSION to xhtml in order to make the SVG files + \ref cfg_html_file_extension "HTML_FILE_EXTENSION" to \c xhtml in order to make the SVG files visible in IE 9+ (other browsers do not have this requirement). \anchor cfg_interactive_svg <dt>\c INTERACTIVE_SVG <dd> - If DOT_IMAGE_FORMAT is set to svg, then this option can be set to \c YES to + If \ref cfg_dot_image_format "DOT_IMAGE_FORMAT" is set to \c svg, then this option can be set to \c YES to enable generation of interactive SVG images that allow zooming and panning. Note that this requires a modern browser other than Internet Explorer. Tested and working are Firefox, Chrome, Safari, and Opera. - \note For IE 9+ you need to set \c HTML_FILE_EXTENSION to xhtml in order + \note For IE 9+ you need to set \ref cfg_html_file_extension "HTML_FILE_EXTENSION" to xhtml in order to make the SVG files visible. Older versions of IE do not have SVG support. \anchor cfg_dot_path <dt>\c DOT_PATH <dd> \addindex DOT_PATH - This tag can be used to specify the path where the dot tool can be found. - If left blank, it is assumed the dot tool can be found on the path. + This tag can be used to specify the path where the \c dot tool can be found. + If left blank, it is assumed the \c dot tool can be found in the \c path. \anchor cfg_dotfile_dirs <dt>\c DOTFILE_DIRS <dd> @@ -2754,7 +2781,7 @@ The default size is 10pt. \addindex DOT_MULTI_TARGET Set the \c DOT_MULTI_TARGETS tag to \c YES allow dot to generate multiple output files in one run (i.e. multiple -o and -T options on the command line). This - makes dot run faster, but since only newer versions of dot (>1.8.10) + makes \c dot run faster, but since only newer versions of \c dot (>1.8.10) support this, this feature is disabled by default. \anchor cfg_generate_legend @@ -2781,7 +2808,7 @@ Then a minimal configuration file is as simple as: INPUT = example.cc example.h \endverbatim -Assuming the example makes use of Qt classes and perl is located +Assuming the example makes use of Qt classes and \c perl is located in <code>/usr/bin</code>, a more realistic configuration file would be: \verbatim PROJECT_NAME = Example |