diff options
Diffstat (limited to 'src/config.xml')
| -rw-r--r-- | src/config.xml | 203 |
1 files changed, 150 insertions, 53 deletions
diff --git a/src/config.xml b/src/config.xml index f40744d..c0b846a 100644 --- a/src/config.xml +++ b/src/config.xml @@ -174,7 +174,6 @@ FILE_PATTERNS = *.cpp *.h q*.doc RECURSIVE = YES EXCLUDE_PATTERNS = *codec.cpp moc_* */compat/* */3rdparty/* ALPHABETICAL_INDEX = YES -COLS_IN_ALPHA_INDEX = 3 IGNORE_PREFIX = Q ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES @@ -513,6 +512,16 @@ Go to the <a href="commands.html">next</a> section or return to the ]]> </docs> </option> + <option type='bool' id='PYTHON_DOCSTRING' defval='1'> + <docs> +<![CDATA[ + By default Python docstrings are displayed as preformatted text + and doxygen's special commands cannot be used. By setting \c PYTHON_DOCSTRING to + \c NO the doxygen's special commands can be used and the contents of the docstring + documentation blocks is shown as doxygen documentation. +]]> + </docs> + </option> <option type='bool' id='INHERIT_DOCS' defval='1'> <docs> <![CDATA[ @@ -585,16 +594,6 @@ Go to the <a href="commands.html">next</a> section or return to the ]]> </docs> </option> - <option type='list' id='TCL_SUBST' format='string'> - <docs> -<![CDATA[ - This tag can be used to specify a number of word-keyword mappings (TCL only). - A mapping has the form <code>"name=value"</code>. For example adding - <code>"class=itcl::class"</code> will allow you to use the command class in the - <code>itcl::class</code> meaning. -]]> - </docs> - </option> <option type='bool' id='OPTIMIZE_OUTPUT_FOR_C' defval='0'> <docs> <![CDATA[ @@ -649,10 +648,10 @@ Go to the <a href="commands.html">next</a> section or return to the Doxygen has a built-in mapping, but you can override or extend it using this tag. The format is <code>ext=language</code>, where \c ext is a file extension, and language is one of the parsers supported by doxygen: IDL, Java, JavaScript, Csharp (C#), C, C++, D, PHP, - md (Markdown), Objective-C, Python, Slice, Fortran (fixed format Fortran: FortranFixed, + md (Markdown), Objective-C, Python, Slice, VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: Fortran. In the later case the parser tries to guess whether the code is fixed or free - formatted code, this is the default for Fortran type files), VHDL, tcl. + formatted code, this is the default for Fortran type files). For instance to make doxygen treat <code>.inc</code> files as Fortran files (default is PHP), and <code>.f</code> files as C (default is Fortran), @@ -660,7 +659,9 @@ Go to the <a href="commands.html">next</a> section or return to the <br>Note: For files without extension you can use `no_extension` as a placeholder. <br>Note that for custom extensions you also need to set \ref cfg_file_patterns "FILE_PATTERNS" otherwise the - files are not read by doxygen. + files are not read by doxygen. When specifying `no_extension` you should add `*` + to the \ref cfg_file_patterns "FILE_PATTERNS". + <br>Note see also the list of \ref default_file_extension_mapping "default file extension mappings". ]]> </docs> </option> @@ -822,6 +823,21 @@ Go to the <a href="commands.html">next</a> section or return to the ]]> </docs> </option> + <option type='int' id='NUM_PROC_THREADS' defval='1' minval='0' maxval='32'> + <docs> +<![CDATA[ + The \c NUM_PROC_THREADS specifies the number threads doxygen is allowed to use during + processing. When set to \c 0 doxygen will based this on the number of cores + available in the system. You can set it explicitly to a value larger than 0 + to get more control over the balance between CPU load and processing speed. + At this moment only the input processing can be done using multiple threads. + Since this is still an experimental feature the default is set to 1, + which efficively disables parallel processing. Please report any issues you + encounter. + Generating dot graphs in parallel is controlled by the \c DOT_NUM_THREADS setting. +]]> + </docs> + </option> </group> <group name='Build' docs='Build related configuration options'> <option type='bool' id='EXTRACT_ALL' defval='0'> @@ -901,6 +917,15 @@ Go to the <a href="commands.html">next</a> section or return to the ]]> </docs> </option> + <option type='bool' id='RESOLVE_UNNAMED_PARAMS' defval='1'> + <docs> +<![CDATA[ + If this flag is set to \c YES, the name of an unnamed parameter in a declaration will be + determined by the corresponding definition. By default unnamed parameters remain unnamed + in the output. +]]> + </docs> + </option> <option type='bool' id='HIDE_UNDOC_MEMBERS' defval='0'> <docs> <![CDATA[ @@ -956,12 +981,20 @@ Go to the <a href="commands.html">next</a> section or return to the <option type='bool' id='CASE_SENSE_NAMES' defval='0' altdefval='Portable::fileSystemIsCaseSensitive()'> <docs> <![CDATA[ - If the \c CASE_SENSE_NAMES tag is set to \c NO then doxygen - will only generate file names in lower-case letters. If set to - \c YES, upper-case letters are also allowed. This is useful if you have - classes or files whose names only differ in case and if your file system - supports case sensitive file names. Windows (including Cygwin) ands - Mac users are advised to set this option to \c NO. + With the correct setting of option \c CASE_SENSE_NAMES doxygen will better be able to match the + capabilities of the underlying filesystem. + + In case the filesystem is case sensitive (i.e. it supports files in the same directory + whose names only differ in casing), the option must be set to \c YES to properly deal with such files + in case they appear in the input. + + For filesystems that are not case sensitive the option should be be set to \c NO to properly + deal with output files written for symbols that only differ in casing, such as for two classes, + one named \c CLASS and the other named \c Class, and to also support references to files without + having to specify the exact matching casing. + + On Windows (including Cygwin) and MacOS, users should typically set this option to \c NO, + whereas on Linux or other Unix flavors it should typically be set to \c YES. ]]> </docs> </option> @@ -1302,13 +1335,19 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn" ]]> </docs> </option> - <option type='bool' id='WARN_AS_ERROR' defval='0'> + <option type='enum' id='WARN_AS_ERROR' defval='NO'> <docs> <![CDATA[ If the \c WARN_AS_ERROR tag is set to \c YES then doxygen will immediately stop when a warning is encountered. + 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. ]]> </docs> + <value name="NO"/> + <value name="YES" /> + <value name="FAIL_ON_WARNINGS" /> </option> <option type='string' id='WARN_FORMAT' format='string' defval='$file:$line: $text'> <docs> @@ -1371,6 +1410,8 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn" Note that for custom extensions or not directly supported extensions you also need to set \ref cfg_extension_mapping "EXTENSION_MAPPING" for the extension otherwise the files are not read by doxygen.<br> + Note the list of default checked file patterns might differ from the list of + \ref default_file_extension_mapping "default file extension mappings".<br> If left blank the following patterns are tested: ]]> </docs> @@ -1405,17 +1446,15 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn" <value name='*.md'/> <value name='*.mm'/> <value name='*.dox' desc='(to be provided as doxygen C comment)'/> - <value name='*.doc' desc='(to be provided as doxygen C comment)'/> - <value name='*.txt' desc='(to be provided as doxygen C comment)'/> <value name='*.py'/> <value name='*.pyw'/> <value name='*.f90'/> <value name='*.f95'/> <value name='*.f03'/> <value name='*.f08'/> + <value name='*.f18'/> <value name='*.f'/> <value name='*.for'/> - <value name='*.tcl'/> <value name='*.vhd'/> <value name='*.vhdl'/> <value name='*.ucf'/> @@ -1701,6 +1740,15 @@ to disable this feature. ]]> </docs> </option> + <option type='bool' id='CLANG_ADD_INC_PATHS' setting='USE_LIBCLANG' defval='1'> + <docs> +<![CDATA[ + If clang assisted parsing is enabled and the \c CLANG_ADD_INC_PATHS tag + is set to \c YES then doxygen will add the directory of each input to the + include path. +]]> + </docs> + </option> <option type='list' id='CLANG_OPTIONS' format='string' setting='USE_LIBCLANG' depends='CLANG_ASSISTED_PARSING'> <docs> <![CDATA[ @@ -1715,10 +1763,12 @@ to disable this feature. <docs> <![CDATA[ If clang assisted parsing is enabled you can provide the clang parser with the - path to the <a href="http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html"> - compilation database</a> used when the files were built. This is equivalent to - specifying the "-p" option to a clang tool, such as clang-check. These options - will then be passed to the parser. + path to the directory containing a file called `compile_commands.json`. + This file is the <a href="http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html"> + compilation database</a> containing the options used when the source files were built. + This is equivalent to specifying the `-p` option to a clang tool, such as `clang-check`. + These options will then be passed to the parser. Any options specified with + \ref cfg_clang_options "CLANG_OPTIONS" will be added as well. @note The availability of this option depends on whether or not doxygen was generated with the `-Duse_libclang=ON` option for CMake. @@ -1736,14 +1786,6 @@ to disable this feature. ]]> </docs> </option> - <option type='int' id='COLS_IN_ALPHA_INDEX' minval='1' maxval='20' defval='5' depends='ALPHABETICAL_INDEX'> - <docs> -<![CDATA[ - The \c COLS_IN_ALPHA_INDEX tag can be - used to specify the number of columns in which the alphabetical index list will be split. -]]> - </docs> - </option> <option type='list' id='IGNORE_PREFIX' format='string' depends='ALPHABETICAL_INDEX'> <docs> <![CDATA[ @@ -2164,7 +2206,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. <![CDATA[ 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). + it should be included in the main `.chm` file (\c NO). ]]> </docs> </option> @@ -2262,7 +2304,9 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. <option type='string' id='QHG_LOCATION' format='file' defval='' depends='GENERATE_QHP'> <docs> <![CDATA[ - The \c QHG_LOCATION tag can be used to specify the location of Qt's qhelpgenerator. + The \c QHG_LOCATION tag can + be used to specify the location (absolute path including file name) of + Qt's qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the generated `.qhp` file. ]]> </docs> @@ -2357,6 +2401,18 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. ]]> </docs> </option> + <option type='enum' id='HTML_FORMULA_FORMAT' defval='png' depends='GENERATE_HTML'> + <docs> +<![CDATA[ + If the \c HTML_FORMULA_FORMAT option is set to \c svg, doxygen will use the pdf2svg + tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see https://inkscape.org) + to generate formulas as SVG images instead of + PNGs for the HTML output. These images will generally look nicer at scaled resolutions. +]]> + </docs> + <value name="png" desc="(the default)"/> + <value name="svg" desc="(looks nicer but requires the pdf2svg or inkscape tool)"/> + </option> <option type='int' id='FORMULA_FONTSIZE' minval='8' maxval='50' defval='10' depends='GENERATE_HTML'> <docs> <![CDATA[ @@ -2382,7 +2438,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. <option type='string' id='FORMULA_MACROFILE' format='file' defval=''> <docs> <![CDATA[ - The \c FORMULA_MACROFILE can contain \f$\mbox{\LaTeX}\f$ `\newcommand` and + The \c FORMULA_MACROFILE can contain \f$\mbox{\LaTeX}\f$ `\newcommand` and `\renewcommand` commands to create new \f$\mbox{\LaTeX}\f$ commands to be used in formulas as building blocks. See the section \ref formulas for details. @@ -2407,7 +2463,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. <![CDATA[ When MathJax is enabled you can set the default output format to be used for the MathJax output. - See <a href="http://docs.mathjax.org/en/latest/output.html">the MathJax site</a> + See <a href="http://docs.mathjax.org/en/v2.7-latest/output.html">the MathJax site</a> for more details. ]]> </docs> @@ -2415,7 +2471,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. <value name="NativeMML" desc="(i.e. MathML)"/> <value name="SVG"/> </option> - <option type='string' id='MATHJAX_RELPATH' format='string' defval='https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/' depends='USE_MATHJAX'> + <option type='string' id='MATHJAX_RELPATH' format='string' defval='https://cdn.jsdelivr.net/npm/mathjax@2' depends='USE_MATHJAX'> <docs> <![CDATA[ When MathJax is enabled you need to specify the location relative to the @@ -2446,7 +2502,7 @@ MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols The \c MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces of code that will be used on startup of the MathJax code. See -<a href="http://docs.mathjax.org/en/latest/output.html">the MathJax site</a> +<a href="http://docs.mathjax.org/en/v2.7-latest/output.html">the MathJax site</a> for more details. ]]> </docs> @@ -2754,9 +2810,12 @@ or <option type='bool' id='USE_PDFLATEX' defval='1' depends='GENERATE_LATEX'> <docs> <![CDATA[ - If the \c USE_PDFLATEX tag is set to \c YES, doxygen will use - \c pdflatex to generate the PDF file directly from the \f$\mbox{\LaTeX}\f$ + If the \c USE_PDFLATEX tag is set to \c YES, doxygen will use the engine + as specified with \ref cfg_latex_cmd_name "LATEX_CMD_NAME" + to generate the PDF file directly from the \f$\mbox{\LaTeX}\f$ files. Set this option to \c YES, to get a higher quality PDF documentation. +<br> + See also section \ref cfg_latex_cmd_name "LATEX_CMD_NAME" for selecting the engine. ]]> </docs> </option> @@ -2813,7 +2872,7 @@ or <option type='string' id='LATEX_EMOJI_DIRECTORY' format='dir' defval='' depends='GENERATE_LATEX'> <docs> <![CDATA[ - The \c LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) + The \c LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) path from which the emoji images will be read. If a relative path is entered, it will be relative to the \ref cfg_latex_output "LATEX_OUTPUT" directory. If left blank the \ref cfg_latex_output "LATEX_OUTPUT" directory will be used. @@ -3027,9 +3086,8 @@ front of it. </docs> </option> </group> -<!-- - <group name='Sqlite3' docs='Configuration options related to Sqlite3 output'> - <option type='bool' id='GENERATE_SQLITE3' defval='0'> + <group name='Sqlite3' setting='USE_SQLITE3' docs='Configuration options related to Sqlite3 output'> + <option type='bool' id='GENERATE_SQLITE3' setting='USE_SQLITE3' defval='0'> <docs> <![CDATA[ If the \c GENERATE_SQLITE3 tag is set to \c YES doxygen will generate a @@ -3037,7 +3095,7 @@ If the \c GENERATE_SQLITE3 tag is set to \c YES doxygen will generate a ]]> </docs> </option> - <option type='string' id='SQLITE3_OUTPUT' format='dir' defval='sqlite3' depends='GENERATE_SQLITE3'> + <option type='string' id='SQLITE3_OUTPUT' format='dir' defval='sqlite3' setting='USE_SQLITE3' depends='GENERATE_SQLITE3'> <docs> <![CDATA[ The \c SQLITE3_OUTPUT tag is used to specify where the \c Sqlite3 database will be put. @@ -3046,9 +3104,17 @@ put in front of it. ]]> </docs> </option> + <option type='bool' id='SQLITE3_RECREATE_DB' defval='1' setting='USE_SQLITE3' 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. +]]> + </docs> + </option> </group> ---> <group name='PerlMod' docs='Configuration options related to the Perl module output'> <option type='bool' id='GENERATE_PERLMOD' defval='0'> <docs> @@ -3370,7 +3436,7 @@ to be found in the default search path. ]]> </docs> </option> - <option type='int' id='UML_LIMIT_NUM_FIELDS' defval='10' minval='0' maxval='100' depends='HAVE_DOT'> + <option type='int' id='UML_LIMIT_NUM_FIELDS' defval='10' minval='0' maxval='100' depends='UML_LOOK'> <docs> <![CDATA[ If the \ref cfg_uml_look "UML_LOOK" tag is enabled, the fields and methods are shown inside @@ -3384,6 +3450,32 @@ to be found in the default search path. ]]> </docs> </option> + <option type='enum' id='DOT_UML_DETAILS' defval='NO' depends='UML_LOOK'> + <docs> +<![CDATA[ +If the \c DOT_UML_DETAILS tag is set to \c NO, doxygen will +show attributes and methods without types and arguments in the UML graphs. +If the \c DOT_UML_DETAILS tag is set to \c YES, doxygen will +add type and arguments for attributes and methods in the UML graphs. +If the \c DOT_UML_DETAILS tag is set to \c NONE, doxygen will not generate +fields with class member information in the UML graphs. +The class diagrams will look similar to the default class diagrams but using +UML notation for the relationships. +]]> + </docs> + <value name="NO" /> + <value name="YES" /> + <value name="NONE" /> + </option> + <option type='int' id='DOT_WRAP_THRESHOLD' defval='17' minval='0' maxval='1000' depends='HAVE_DOT'> + <docs> +<![CDATA[ + The \c DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters to display on + a single line. If the actual line length exceeds this threshold significantly it will wrapped + across multiple lines. Some heuristics are apply to avoid ugly line breaks. +]]> + </docs> + </option> <option type='bool' id='TEMPLATE_RELATIONS' defval='0' depends='HAVE_DOT'> <docs> <![CDATA[ @@ -3614,11 +3706,14 @@ to be found in the default search path. ]]> </docs> </option> - <option type='bool' id='DOT_CLEANUP' defval='1' depends='HAVE_DOT'> + <option type='bool' id='DOT_CLEANUP' defval='1'> <docs> <![CDATA[ If the \c DOT_CLEANUP tag is set to \c YES, doxygen will -remove the intermediate dot files that are used to generate the various graphs. +remove the intermediate files that are used to generate the various graphs. + <br>Note: +This setting is not only used for dot files but also for msc and plantuml +temporary files. ]]> </docs> </option> @@ -3643,5 +3738,7 @@ remove the intermediate dot files that are used to generate the various graphs. <option type='obsolete' id='XML_DTD'/> <option type='obsolete' id='PERL_PATH'/> <option type='obsolete' id='MSCGEN_PATH'/> + <option type='obsolete' id='TCL_SUBST'/> + <option type='obsolete' id='COLS_IN_ALPHA_INDEX'/> </group> </doxygenconfig> |