is set to \c YES. Level 0 represents 16 directories, and every level increment
doubles the number of directories, resulting in 4096 directories at level 8 which is the
default and also the maximum value. The sub-directories are organized in 2 levels, the first
- level always has a fixed numer of 16 directories.
+ level always has a fixed number of 16 directories.
]]>
</docs>
</option>
]]>
</docs>
</option>
+ <option type='enum' id='MARKDOWN_ID_STYLE' defval='DOXYGEN' depends='MARKDOWN_SUPPORT'>
+ <docs>
+<![CDATA[
+ The \c MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to generate identifiers for the Markdown headings.
+ Note: Every identifier is unique.
+]]>
+ </docs>
+ <value name="DOXYGEN" desc="use a fixed 'autotoc_md' string followed by a sequence number starting at 0"/>
+ <value name="GITHUB" desc="use the lower case version of title with any whitespace replaced by '-' and punctuation characters removed"/>
+ </option>
<option type='bool' id='AUTOLINK_SUPPORT' defval='1'>
<docs>
<![CDATA[
]]>
</docs>
</option>
+ <option type='enum' id='TIMESTAMP' defval='NO'>
+ <docs>
+<![CDATA[
+ If the \c TIMESTAMP tag is set different from \c NO then
+ each generated page will contain the date or date and time when the page
+ was generated. Setting this to \c NO can help when comparing the output of
+ multiple runs.
+]]>
+ </docs>
+ <value name="YES" />
+ <value name="NO" />
+ <value name="DATETIME" />
+ <value name="DATE" />
+ </option>
</group>
<group name='Build' docs='Build related configuration options'>
<option type='bool' id='EXTRACT_ALL' defval='0'>
If the \c HIDE_UNDOC_CLASSES tag is set to \c YES, doxygen will hide all
undocumented classes that are normally visible in the class hierarchy.
If set to \c NO, these classes will be included in the
- various overviews.
+ various overviews. This option will also hide undocumented C++ concepts
+ if enabled.
This option has no effect if \ref cfg_extract_all "EXTRACT_ALL" is enabled.
]]>
</docs>
<option type='bool' id='SHOW_GROUPED_MEMB_INC' defval='0'>
<docs>
<![CDATA[
- If the SHOW_GROUPED_MEMB_INC tag is set to \c YES then Doxygen
+ If the \c SHOW_GROUPED_MEMB_INC tag is set to \c YES then Doxygen
will add for each grouped member an include statement to the documentation,
telling the reader which file to include in order to use the member.
]]>
]]>
</docs>
</option>
+ <option type='bool' id='WARN_IF_UNDOC_ENUM_VAL' defval='0'>
+ <docs>
+<![CDATA[
+ If \c WARN_IF_UNDOC_ENUM_VAL option is set to \c YES, doxygen will warn
+ about undocumented enumeration values.
+ If set to \c NO, doxygen will accept undocumented enumeration values.
+ If \ref cfg_extract_all "EXTRACT_ALL" is set to \c YES then this flag will
+ automatically be disabled.
+]]>
+ </docs>
+ </option>
<option type='enum' id='WARN_AS_ERROR' defval='NO'>
<docs>
<![CDATA[
If the \c WARN_AS_ERROR tag is set to \c FAIL_ON_WARNINGS then doxygen will continue
running as if \c WARN_AS_ERROR tag is set to \c NO, but at the end of the doxygen
process doxygen will return with a non-zero status.
+ If the \c WARN_AS_ERROR tag is set to \c FAIL_ON_WARNINGS_PRINT then doxygen behaves like
+ \c FAIL_ON_WARNINGS but in case no \ref cfg_warn_logfile "WARN_LOGFILE" is defined
+ doxygen will not write the warning messages in between other
+ messages but write them at the end of a run, in case a
+ \ref cfg_warn_logfile "WARN_LOGFILE" is defined the warning messages will be
+ besides being in the defined file also be shown at the end of a run, unless the
+ \ref cfg_warn_logfile "WARN_LOGFILE" is defined as `-` i.e. standard output (`stdout`)
+ in that case the behavior will remain as with the setting \c FAIL_ON_WARNINGS.
]]>
</docs>
<value name="NO"/>
<value name="YES" />
<value name="FAIL_ON_WARNINGS" />
+ <value name="FAIL_ON_WARNINGS_PRINT" />
</option>
<option type='string' id='WARN_FORMAT' format='string' defval='$file:$line: $text'>
<docs>
<value name='*.c'/>
<value name='*.cc'/>
<value name='*.cxx'/>
+ <value name='*.cxxm'/>
<value name='*.cpp'/>
+ <value name='*.cppm'/>
<value name='*.c++'/>
+ <value name='*.c++m'/>
<value name='*.java'/>
<value name='*.ii'/>
<value name='*.ixx'/>
<value name='*.hxx'/>
<value name='*.hpp'/>
<value name='*.h++'/>
+ <value name='*.ixx'/>
<value name='*.l'/>
<value name='*.cs'/>
<value name='*.d'/>
output. The symbol name can be a fully qualified name, a word, or if the
wildcard `*` is used, a substring. Examples: `ANamespace`, `AClass`,
`ANamespace::AClass`, `ANamespace::*Test`
- <br>Note that the wildcards are matched against the file with absolute path,
- so to exclude all test directories use the pattern
- `*``/test/``*`
]]>
</docs>
</option>
<option type='bool' id='SOURCE_TOOLTIPS' defval='1' depends='SOURCE_BROWSER'>
<docs>
<![CDATA[
-If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+If \c SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
source code will show a tooltip with additional information such as prototype,
brief description and links to the definition and documentation. Since this will
make the HTML file larger and loading of large files a bit slower, you can opt
<option type='list' id='IGNORE_PREFIX' format='string' depends='ALPHABETICAL_INDEX'>
<docs>
<![CDATA[
- In case all classes in a project start with a common prefix, all classes will
- be put under the same header in the alphabetical index.
- The \c IGNORE_PREFIX tag can be used to specify a prefix
+ The \c IGNORE_PREFIX tag can be used to specify a prefix
(or a list of prefixes) that should be ignored while generating the index headers.
+ The \c IGNORE_PREFIX tag works for classes, function and member names.
+ The entity will be placed in the alphabetical list under the first letter of the entity name that remains
+ after removing the prefix.
]]>
</docs>
</option>
The following markers have a special meaning inside the header and footer:
<dl>
<dt><code>$title</code><dd>will be replaced with the title of the page.
- <dt><code>$datetime</code><dd>will be replaced with current the date and time.
+ <dt><code>$datetime</code><dd>will be replaced with the current date and time.
<dt><code>$date</code><dd>will be replaced with the current date.
+ <dt><code>$time</code><dd>will be replaced with the current time.
<dt><code>$year</code><dd>will be replaces with the current year.
+ <dt><code>$showdate(<format>)</code><dd>will be replaced with the current date
+ and time according to the format as specified by `<format>`. The
+ `<format>` follows the rules as specified for the
+ \ref cmdshowdate "\\showdate" command with the exception that no `)`
+ is allowed in the `<format>`.
<dt><code>$doxygenversion</code><dd>will be replaced with the version of doxygen
<dt><code>$projectname</code><dd>will be replaced with the name of
the project (see \ref cfg_project_name "PROJECT_NAME")
(see \ref cfg_project_logo "PROJECT_LOGO")
<dt><code>$generatedby</code><dd>will be replaced with the output language dependent
version of the text "Generated by" or when the
- \ref cfg_html_timestamp "HTML_TIMESTAMP" is set by the output language
+ \ref cfg_timestamp "TIMESTAMP" is set by the output language
dependent version of the text "Generated on `$datetime` for `$projectname` by".
<dt><code>$stylesheet</code><dd>will be replaced with the setting of
\ref cfg_html_stylesheet "HTML_STYLESHEET" unless it is empty or the file in which case
the output directory.
\note The order of the extra style sheet files is of importance (e.g. the last
style sheet in the list overrules the setting of the previous ones in the list).
+ \note Since the styling of scrollbars can currently not be overruled in Webkit/Chromium, the
+ styling will be left out of the default doxygen.css if one or more extra stylesheets
+ have been specified.
+ So if scrollbar customization is desired it has to be added explicitly.
]]>
</docs>
<docs doxywizard='0' doxyfile='0'>
<docs>
<![CDATA[
The \c HTML_COLORSTYLE tag can be used to specify if the generated HTML output should be rendered with
- a dark or light theme. Default setting \c AUTO_LIGHT enables light output unless the user preference is dark output.
- Other options are \c DARK to always use dark mode, \c LIGHT to always use light mode, \c AUTO_DARK to default to dark
- mode unless the user prefers light mode, and \c TOGGLE to let the user toggle between dark and light mode via a button.
+ a dark or light theme.
]]>
</docs>
- <value name="LIGHT" desc="Always generate light output."/>
- <value name="DARK" desc="Always generate dark output."/>
- <value name="AUTO_LIGHT" desc="Automatically set the mode according to the user preference, use light mode if no preference is set (the default)."/>
- <value name="AUTO_DARK" desc="Automatically set the mode according to the user preference, use dark mode if no preference is set."/>
- <value name="TOGGLE" desc="Allow to user to switch between light and dark mode via a button."/>
+ <value name="LIGHT" desc="always generate light mode output"/>
+ <value name="DARK" desc="always generate dark mode output"/>
+ <value name="AUTO_LIGHT" desc="automatically set the mode according to the user preference, use light mode if no preference is set (the default)"/>
+ <value name="AUTO_DARK" desc="automatically set the mode according to the user preference, use dark mode if no preference is set"/>
+ <value name="TOGGLE" desc="allow to user to switch between light and dark mode via a button"/>
</option>
<option type='int' id='HTML_COLORSTYLE_HUE' minval='0' maxval='359' defval='220' depends='GENERATE_HTML'>
<docs>
]]>
</docs>
</option>
- <option type='bool' id='HTML_TIMESTAMP' defval='0' depends='GENERATE_HTML'>
- <docs>
-<![CDATA[
- If the \c HTML_TIMESTAMP tag is set to \c YES then the footer of
- each generated HTML page will contain the date and time when the page
- was generated. Setting this to \c YES can help to show when doxygen was last run
- and thus if the documentation is up to date.
-]]>
- </docs>
- </option>
<option type='bool' id='HTML_DYNAMIC_MENUS' defval='1' depends='GENERATE_HTML'>
<docs>
<![CDATA[
]]>
</docs>
</option>
+ <option type='bool' id='HTML_CODE_FOLDING' defval='1' depends='GENERATE_HTML'>
+ <docs>
+<![CDATA[
+ If the \c HTML_CODE_FOLDING tag is set to \c YES then classes and functions can
+ be dynamically folded and expanded in the generated HTML source code.
+]]>
+ </docs>
+ </option>
<option type='int' id='HTML_INDEX_NUM_ENTRIES' minval='0' maxval='9999' defval='100' depends='GENERATE_HTML'>
<docs>
<![CDATA[
]]>
</docs>
</option>
+ <option type='string' id='SITEMAP_URL' format='string' depends='GENERATE_HTML'>
+ <docs>
+<![CDATA[
+ The \c SITEMAP_URL tag is used to specify the full URL of the place where the
+ generated documentation will be placed on the server by the user during the deployment
+ of the documentation.
+ The generated sitemap is called `sitemap.xml` and placed on the directory specified by
+ \ref cfg_html_output "HTML_OUTPUT". In case no \c SITEMAP_URL is specified no
+ sitemap is generated.
+ For information about the sitemap protocol see https://www.sitemaps.org
+]]>
+ </docs>
+ </option>
<option type='bool' id='GENERATE_QHP' defval='0' depends='GENERATE_HTML'>
<docs>
<![CDATA[
<![CDATA[
<dl>
<dt><code>$title</code><dd>will be replaced with the project name.
- <dt><code>$datetime</code><dd>will be replaced with current the date and time.
+ <dt><code>$datetime</code><dd>will be replaced with the current date and time.
<dt><code>$date</code><dd>will be replaced with the current date.
+ <dt><code>$time</code><dd>will be replaced with the current time.
<dt><code>$year</code><dd>will be replaces with the current year.
+ <dt><code>$showdate(<format>)</code><dd>will be replaced with the current date
+ and time according to the format as specified by `<format>`. The
+ `<format>` follows the rules as specified for the
+ \ref cmdshowdate "\\showdate" command with the exception that no `)`
+ is allowed in the `<format>`.
<dt><code>$doxygenversion</code><dd>will be replaced with the version of doxygen
<dt><code>$projectname</code><dd>will be replaced with the name of
the project (see \ref cfg_project_name "PROJECT_NAME")
Commonly used together with `$latexdocumentpre` in the header.
<dt><code>$generatedby</code><dd>will be replaced with the output language dependent
version of the text "Generated by" or when the
- \ref cfg_latex_timestamp "LATEX_TIMESTAMP" is set by the output language
+ \ref cfg_timestamp "TIMESTAMP" is set by the output language
dependent version of the text "Generated on `$datetime` for `$projectname` by".
<dt><code>$latexcitereference</code><dd>will be replaced by the output language dependent$
version of the word "Bibliography".
when the \ref cfg_use_pdflatex "USE_PDFLATEX" option is enabled.
<dt><code>LATEX_BATCHMODE</code><dd>Content within this block is copied to the output
when the \ref cfg_latex_batchmode "LATEX_BATCHMODE" option is enabled.
- <dt><code>LATEX_TIMESTAMP</code><dd>Content within this block is copied to the output
- when the \ref cfg_latex_timestamp "LATEX_TIMESTAMP" option is enabled.
+ <dt><code>TIMESTAMP</code><dd>Content within this block is copied to the output
+ when the \ref cfg_timestamp "TIMESTAMP" option is enabled.
</dl>
The following block names are set based on the fact whether or not the tag has a
value in the used configuration file:
]]>
</docs>
</option>
- <option type='bool' id='LATEX_BATCHMODE' defval='0' depends='GENERATE_LATEX'>
+ <option type='enum' id='LATEX_BATCHMODE' defval='NO' depends='GENERATE_LATEX'>
<docs>
<![CDATA[
- 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.
+ The \c LATEX_BATCHMODE tag signals the behavior of \f$\mbox{\LaTeX}\f$ in case of an error.
]]>
</docs>
+ <value name="NO" desc='same as ERROR_STOP' />
+ <value name="YES" desc='same as BATCH' />
+ <value name="BATCH" desc='In batch mode nothing is printed on the terminal, errors are scrolled as if \<return\> is hit at every error; missing files that TeX tries to input or request from keyboard input (\\read on a not open input stream) cause the job to abort' />
+ <value name="NON_STOP" desc='In nonstop mode the diagnostic message will appear on the terminal, but there is no possibility of user interaction just like in batch mode' />
+ <value name="SCROLL" desc='In scroll mode, TeX will stop only for missing files to input or if keyboard input is necessary' />
+ <value name="ERROR_STOP" desc='In errorstop mode, TeX will stop at each error, asking for user intervention' />
</option>
<option type='bool' id='LATEX_HIDE_INDICES' defval='0' depends='GENERATE_LATEX'>
<docs>
]]>
</docs>
</option>
- <option type='bool' id='LATEX_TIMESTAMP' defval='0' depends='GENERATE_LATEX'>
- <docs>
-<![CDATA[
- If the \c LATEX_TIMESTAMP tag is set to \c YES then the footer of
- each generated page will contain the date and time when the page
- was generated. Setting this to \c NO can help when comparing the output of
- multiple runs.
-]]>
- </docs>
- </option>
<option type='string' id='LATEX_EMOJI_DIRECTORY' format='dir' defval='' depends='GENERATE_LATEX'>
<docs>
<![CDATA[
<docs>
<![CDATA[
If the \c GENERATE_AUTOGEN_DEF tag is set to \c YES, doxygen will
- generate an AutoGen Definitions (see http://autogen.sourceforge.net/) file
+ generate an AutoGen Definitions (see https://autogen.sourceforge.net/) file
that captures the structure of the code including all
documentation. Note that this feature is still experimental
and incomplete at the moment.
</docs>
</option>
</group>
- <group name='Sqlite3' setting='USE_SQLITE3' docs='Configuration options related to Sqlite3 output'>
- <option type='bool' id='GENERATE_SQLITE3' setting='USE_SQLITE3' defval='0'>
+ <group name='Sqlite3' docs='Configuration options related to Sqlite3 output'>
+ <option type='bool' id='GENERATE_SQLITE3' defval='0'>
<docs>
<![CDATA[
If the \c GENERATE_SQLITE3 tag is set to \c YES doxygen will generate a
\c Sqlite3 database with symbols found by doxygen stored in tables.
-
- @note The availability of this option depends on whether or not doxygen
- was generated with the `-Duse_sqlite3=ON` option for CMake.
]]>
</docs>
</option>
- <option type='string' id='SQLITE3_OUTPUT' format='dir' defval='sqlite3' setting='USE_SQLITE3' depends='GENERATE_SQLITE3'>
+ <option type='string' id='SQLITE3_OUTPUT' format='dir' defval='sqlite3' depends='GENERATE_SQLITE3'>
<docs>
<![CDATA[
The \c SQLITE3_OUTPUT tag is used to specify where the \c Sqlite3 database 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.
-
- @note The availability of this option depends on whether or not doxygen
- was generated with the `-Duse_sqlite3=ON` option for CMake.
]]>
</docs>
</option>
- <option type='bool' id='SQLITE3_RECREATE_DB' defval='1' setting='USE_SQLITE3' depends='GENERATE_SQLITE3'>
+ <option type='bool' id='SQLITE3_RECREATE_DB' defval='1' depends='GENERATE_SQLITE3'>
<docs>
<![CDATA[
The \c SQLITE3_OVERWRITE_DB tag is set to \c YES, the existing doxygen_sqlite3.db
database file will be recreated with each doxygen run.
If set to \c NO, doxygen will warn if an a database file is already found and not modify it.
-
- @note The availability of this option depends on whether or not doxygen
- was generated with the `-Duse_sqlite3=ON` option for CMake.
]]>
</docs>
</option>
<option type='bool' id='ALLEXTERNALS' defval='0'>
<docs>
<![CDATA[
- If the \c ALLEXTERNALS tag is set to \c YES, all external class will be listed
- in the class index. If set to \c NO, only the inherited external classes
- will be listed.
+ If the \c ALLEXTERNALS tag is set to \c YES, all external classes and namespaces
+ will be listed in the class and namespace index.
+ If set to \c NO, only the inherited external classes will be listed.
]]>
</docs>
</option>
<docs>
<![CDATA[
If the \c EXTERNAL_GROUPS tag is set to \c YES, all external groups will be listed
- in the modules index. If set to \c NO, only the current project's groups will
+ in the topic index. If set to \c NO, only the current project's groups will
be listed.
]]>
</docs>
</docs>
</option>
</group>
- <group name='Dot' docs='Configuration options related to the dot tool'>
- <option type='string' id='DIA_PATH' format='dir' defval=''>
- <docs>
-<![CDATA[
-You can include diagrams made with dia in doxygen documentation. Doxygen will then run
-dia to produce the diagram and insert it in the documentation. The DIA_PATH tag allows
-you to specify the directory where the dia binary resides. If left empty dia is assumed
-to be found in the default search path.
-]]>
- </docs>
- </option>
+ <group name='Dot' docs='Configuration options related to diagram generator tools'>
<option type='bool' id='HIDE_UNDOC_RELATIONS' defval='1'>
<docs>
<![CDATA[
<![CDATA[
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
+ <a href="https://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
]]>
<option type='enum' id='CLASS_GRAPH' defval='YES'>
<docs>
<![CDATA[
- If the \c CLASS_GRAPH tag is set to \c YES (or \c GRAPH) then doxygen
+ If the \c CLASS_GRAPH tag is set to \c YES or \c GRAPH or \c BUILTIN then doxygen
will generate a graph for each documented class showing the direct and
- indirect inheritance relations. In case \ref cfg_have_dot "HAVE_DOT" is set as well
- `dot` will be used to draw the graph, otherwise the built-in generator will be used.
+ indirect inheritance relations.
+ In case the \c CLASS_GRAPH tag is set to \c YES or \c GRAPH and \ref cfg_have_dot "HAVE_DOT" is
+ enabled as well, then `dot` will be used to draw the graph.
+ In case the \c CLASS_GRAPH tag is set to \c YES and \ref cfg_have_dot "HAVE_DOT" is disabled
+ or if the \c CLASS_GRAPH tag is set to \c BUILTIN, then the built-in generator will be used.
If the \c CLASS_GRAPH tag is set to \c TEXT the direct and indirect inheritance relations
will be shown as texts / links.
]]>
<value name="YES" bool_representation="YES" />
<value name="TEXT" bool_representation="YES" />
<value name="GRAPH" bool_representation="YES" />
+ <value name="BUILTIN" bool_representation="YES" />
</option>
<option type='bool' id='COLLABORATION_GRAPH' defval='1' depends='HAVE_DOT'>
<docs>
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.
+ Explicit enabling a collaboration graph, when \c COLLABORATION_GRAPH is set to \c NO, can be
+ accomplished by means of the command \ref cmdcollaborationgraph "\\collaborationgraph".
+ Disabling a collaboration graph can be accomplished by means of the command
+ \ref cmdhidecollaborationgraph "\\hidecollaborationgraph".
]]>
</docs>
</option>
<![CDATA[
If the \c GROUP_GRAPHS tag is set to \c YES then doxygen
will generate a graph for groups, showing the direct groups dependencies.
+ Explicit enabling a group dependency graph, when \c GROUP_GRAPHS is set to \c NO, can be
+ accomplished by means of the command \ref cmdgroupgraph "\\groupgraph".
+ Disabling a directory graph can be accomplished by means of the command
+ \ref cmdhidegroupgraph "\\hidegroupgraph".
See also the chapter \ref grouping "Grouping" in the manual.
]]>
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.
+ Explicit enabling an include graph, when \c INCLUDE_GRAPH is is set to \c NO, can be
+ accomplished by means of the command \ref cmdincludegraph "\\includegraph".
+ Disabling an include graph can be accomplished by means of the command
+ \ref cmdhideincludegraph "\\hideincludegraph".
]]>
</docs>
</option>
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.
+ Explicit enabling an included by graph, when \c INCLUDED_BY_GRAPH is set to \c NO, can be
+ accomplished by means of the command \ref cmdincludedbygraph "\\includedbygraph".
+ Disabling an included by graph can be accomplished by means of the command
+ \ref cmdhideincludedbygraph "\\hideincludedbygraph".
]]>
</docs>
</option>
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 \c \#include
relations between the files in the directories.
+ Explicit enabling a directory graph, when \c DIRECTORY_GRAPH is set to \c NO, can be
+ accomplished by means of the command \ref cmddirectorygraph "\\directorygraph".
+ Disabling a directory graph can be accomplished by means of the command
+ \ref cmdhidedirectorygraph "\\hidedirectorygraph".
+
]]>
</docs>
</option>
The \c DOT_IMAGE_FORMAT tag can be used to set the image format of the images
generated by \c dot. For an explanation of the image formats see the section output formats
in the documentation of the \c dot tool
- (<a href="http://www.graphviz.org/">Graphviz</a>).
+ (<a href="https://www.graphviz.org/">Graphviz</a>).
\note If you choose \c svg you need to set
\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).
]]>
</docs>
</option>
- <option type='list' id='MSCFILE_DIRS' format='dir'>
+ <option type='string' id='DIA_PATH' format='dir' defval=''>
<docs>
<![CDATA[
- The \c MSCFILE_DIRS 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).
+You can include diagrams made with dia in doxygen documentation. Doxygen will then run
+dia to produce the diagram and insert it in the documentation. The DIA_PATH tag allows
+you to specify the directory where the dia binary resides. If left empty dia is assumed
+to be found in the default search path.
]]>
</docs>
</option>
]]>
</docs>
</option>
+ <option type='string' id='MSCGEN_TOOL' format='file' defval=''>
+ <docs>
+<![CDATA[
+ You can define message sequence charts within doxygen comments using the \ref cmdmsc "\\msc"
+ command. If the \c MSCGEN_TOOL tag is left empty (the default), then doxygen will use a built-in
+ version of mscgen tool to produce the charts.
+ Alternatively, the \c MSCGEN_TOOL tag can also specify the name an external tool.
+ For instance, specifying `prog` as the value, doxygen will call the tool
+ as `prog -T <outfile_format> -o <outputfile> <inputfile>`. The external tool
+ should support output file formats "png", "eps", "svg", and "ismap".
+]]>
+ </docs>
+ </option>
+ <option type='list' id='MSCFILE_DIRS' format='dir'>
+ <docs>
+<![CDATA[
+ The \c MSCFILE_DIRS 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).
+]]>
+ </docs>
+ </option>
<option type='obsolete' orgtype='bool' id='USE_WINDOWS_ENCODING'/>
<option type='obsolete' orgtype='bool' id='DETAILS_AT_TOP'/>
<option type='obsolete' orgtype='string' id='QTHELP_FILE'/>
<option type='obsolete' orgtype='string' id='DOT_FONTNAME'/>
<option type='obsolete' orgtype='bool' id='FORMULA_TRANSPARENT'/>
<option type='obsolete' orgtype='bool' id='DOT_TRANSPARENT'/>
+ <option type='obsolete' orgtype='bool' id='HTML_TIMESTAMP'/>
+ <option type='obsolete' orgtype='bool' id='LATEX_TIMESTAMP'/>
</group>
+ <generator>
+ <message name='minmaxdef'><![CDATA[<br/> Minimum value: {0}, maximum value: {1}, default value: {2}.]]></message>
+ <message name='minmaxdefcode'><![CDATA[ Minimum value: <code>{0}</code>, maximum value: <code>{1}</code>, default value: <code>{2}</code>.]]></message>
+ <message name='possible'><![CDATA[Possible values are: ]]></message>
+ <message name='defvaltxt'><![CDATA[The default value is: {0}.]]></message>
+ <message name='defvalcode'><![CDATA[The default value is: <code>{0}</code>.]]></message>
+ <message name='sysdep'><![CDATA[system dependent]]></message>
+ <message name='defdir'><![CDATA[The default directory is: <code>{0}</code>.]]></message>
+ <message name='deffile'><![CDATA[The default file is: <code>{0}</code>.]]></message>
+ <message name='deffileabs'><![CDATA[The default file (with absolute path) is <code>{0}</code>]]></message>
+ <message name='deffilefull'><![CDATA[The file has to be specified with full path.]]></message>
+ <message name='defimg'><![CDATA[The default image is: <code>{0}</code>.]]></message>
+ <message name='defimgabs'><![CDATA[The default image (with absolute path) is <code>{0}</code>]]></message>
+ <message name='defimgfull'><![CDATA[The image has to be specified with full path.]]></message>
+ <message name='depstxt'><![CDATA[This tag requires that the tag \ref cfg_{0} "{1}" is set to \c YES.]]></message>
+ <message name='andtxt'><![CDATA[ and ]]></message>
+ </generator>
</doxygenconfig>
projects / platform / upstream / doxygen.git / blobdiff