diff options
Diffstat (limited to 'src/config.xml')
| -rw-r--r-- | src/config.xml | 71 |
1 files changed, 56 insertions, 15 deletions
diff --git a/src/config.xml b/src/config.xml index b3718be..fb48c63 100644 --- a/src/config.xml +++ b/src/config.xml @@ -660,7 +660,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> @@ -916,6 +918,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[ @@ -971,12 +982,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) and - 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> @@ -1386,6 +1405,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> @@ -1420,8 +1441,6 @@ 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'/> @@ -1730,10 +1749,10 @@ to disable this feature. <docs> <![CDATA[ If clang assisted parsing is enabled you can provide the clang parser with the - path to the directory containing a file called compile_commands.json. + 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. + 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. @@ -2279,7 +2298,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> @@ -3409,7 +3430,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 @@ -3423,6 +3444,23 @@ to be found in the default search path. ]]> </docs> </option> + <option type='bool' id='DOT_UML_DETAILS' defval='0' depends='UML_LOOK'> + <docs> +<![CDATA[ +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. +]]> + </docs> + </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[ @@ -3653,11 +3691,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> |