From 83fc120e5575446b1161e9ffb8168d55c423f7ac Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Thu, 8 Aug 2013 19:23:30 +0200 Subject: Minor changes to the way the code for config options is generated (thanks to Albert for the patch) --- addon/doxywizard/config.h | 9 + addon/doxywizard/configdoc.cpp | 774 ++++++++++++++++++++-------------------- addon/doxywizard/expert.cpp | 104 ++++-- doc/config.doc | 342 +++++++++++++++++- src/config.xml | 25 +- src/configgen.py | 52 +-- src/configoptions.cpp | 776 ++++++++++++++++++++--------------------- src/doxygen.cpp | 2 +- src/doxygen.md | 4 +- 9 files changed, 1219 insertions(+), 869 deletions(-) diff --git a/addon/doxywizard/config.h b/addon/doxywizard/config.h index d40f1f4..147056a 100644 --- a/addon/doxywizard/config.h +++ b/addon/doxywizard/config.h @@ -15,4 +15,13 @@ bool parseConfig( void writeStringValue(QTextStream &t,QTextCodec *codec,const QString &s); +// directly copied from ../../src/config.h to be consistent +enum +{ + /*! Maximum length of an option in the config file. Used for + * alignment purposes. + */ + MAX_OPTION_LENGTH = 23 +}; + #endif diff --git a/addon/doxywizard/configdoc.cpp b/addon/doxywizard/configdoc.cpp index 8f4c9e4..c439322 100644 --- a/addon/doxywizard/configdoc.cpp +++ b/addon/doxywizard/configdoc.cpp @@ -27,15 +27,16 @@ void addConfigDocs(DocIntf *doc) "that follow. The default is UTF-8 which is also the encoding used for all text\n" "before the first occurrence of this tag. Doxygen uses libiconv (or the iconv\n" "built into libc) for the transcoding. See http://www.gnu.org/software/libiconv\n" - "for the list of possible encodings.The default value is: UTF-8." + "for the list of possible encodings.\n" + "The default value is: UTF-8." ); doc->add( "PROJECT_NAME", "The PROJECT_NAME tag is a single word (or a sequence of words surrounded by\n" "double-quotes, unless you are using Doxywizard) that should identify the\n" "project for which the documentation is generated. This name is used in the\n" - "title of most generated pages and in a few other places.The default value is:\n" - "My Project." + "title of most generated pages and in a few other places.\n" + "The default value is: My Project." ); doc->add( "PROJECT_NUMBER", @@ -70,28 +71,28 @@ void addConfigDocs(DocIntf *doc) "will distribute the generated files over these directories. Enabling this\n" "option can be useful when feeding doxygen a huge amount of source files, where\n" "putting all generated files in the same directory would otherwise causes\n" - "performance problems for the file system.Default value: NO." + "performance problems for the file system.\n" + "The default value is: NO." ); doc->add( "OUTPUT_LANGUAGE", "The OUTPUT_LANGUAGE tag is used to specify the language in which all\n" "documentation generated by doxygen is written. Doxygen will use this\n" - "information to generate all constant output in the proper language.Possible\n" - "values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-\n" + "information to generate all constant output in the proper language.\n" + "Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-\n" "Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,\n" "Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,\n" "Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,\n" "Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,\n" "Turkish, Ukrainian and Vietnamese.\n" - "\n" "The default value is: English." ); doc->add( "BRIEF_MEMBER_DESC", "If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member\n" "descriptions after the members that are listed in the file and class\n" - "documentation (similar to Javadoc). Set to NO to disable this.Default value:\n" - "YES." + "documentation (similar to Javadoc). Set to NO to disable this.\n" + "The default value is: YES." ); doc->add( "REPEAT_BRIEF", @@ -99,7 +100,8 @@ void addConfigDocs(DocIntf *doc) "description of a member or function before the detailed description\n" "\n" "Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the\n" - "brief descriptions will be completely suppressed.Default value: YES." + "brief descriptions will be completely suppressed.\n" + "The default value is: YES." ); doc->add( "ABBREVIATE_BRIEF", @@ -116,20 +118,23 @@ void addConfigDocs(DocIntf *doc) "ALWAYS_DETAILED_SEC", "If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then\n" "doxygen will generate a detailed section even if there is only a brief\n" - "description.Default value: NO." + "description.\n" + "The default value is: NO." ); doc->add( "INLINE_INHERITED_MEMB", "If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all\n" "inherited members of a class in the documentation of that class as if those\n" "members were ordinary class members. Constructors, destructors and assignment\n" - "operators of the base classes will not be shown.Default value: NO." + "operators of the base classes will not be shown.\n" + "The default value is: NO." ); doc->add( "FULL_PATH_NAMES", "If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path\n" "before files name in the file list and in the header files. If set to NO the\n" - "shortest path that makes the file name unique will be usedDefault value: YES." + "shortest path that makes the file name unique will be used\n" + "The default value is: YES." ); doc->add( "STRIP_FROM_PATH", @@ -141,7 +146,6 @@ void addConfigDocs(DocIntf *doc) "\n" "Note that you can specify absolute paths here, but also relative paths, which\n" "will be relative from the directory where doxygen is started.\n" - "\n" "This tag requires that the tag FULL_PATH_NAMES is set to YES." ); doc->add( @@ -157,7 +161,8 @@ void addConfigDocs(DocIntf *doc) "SHORT_NAMES", "If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but\n" "less readable) file names. This can be useful is your file systems doesn't\n" - "support long names like on DOS, Mac, or CD-ROM.Default value: NO." + "support long names like on DOS, Mac, or CD-ROM.\n" + "The default value is: NO." ); doc->add( "JAVADOC_AUTOBRIEF", @@ -165,15 +170,16 @@ void addConfigDocs(DocIntf *doc) "first line (until the first dot) of a Javadoc-style comment as the brief\n" "description. If set to NO, the Javadoc-style will behave just like regular Qt-\n" "style comments (thus requiring an explicit @brief command for a brief\n" - "description.)Default value: NO." + "description.)\n" + "The default value is: NO." ); doc->add( "QT_AUTOBRIEF", "If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first\n" "line (until the first dot) of a Qt-style comment as the brief description. If\n" "set to NO, the Qt-style will behave just like regular Qt-style comments (thus\n" - "requiring an explicit \\brief command for a brief description.)Default value:\n" - "NO." + "requiring an explicit \\brief command for a brief description.)\n" + "The default value is: NO." ); doc->add( "MULTILINE_CPP_IS_BRIEF", @@ -184,25 +190,27 @@ void addConfigDocs(DocIntf *doc) "tag to YES if you prefer the old behavior instead.\n" "\n" "Note that setting this tag to YES also means that rational rose comments are\n" - "not recognized any more.Default value: NO." + "not recognized any more.\n" + "The default value is: NO." ); doc->add( "INHERIT_DOCS", "If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the\n" - "documentation from any documented member that it re-implements.Default value:\n" - "YES." + "documentation from any documented member that it re-implements.\n" + "The default value is: YES." ); doc->add( "SEPARATE_MEMBER_PAGES", "If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a\n" "new page for each member. If set to NO, the documentation of a member will be\n" - "part of the file/class/namespace that contains it.Default value: NO." + "part of the file/class/namespace that contains it.\n" + "The default value is: NO." ); doc->add( "TAB_SIZE", "The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen\n" - "uses this value to replace tabs by spaces in code fragments. Minimum value: 1,\n" - "maximum value: 16, default value: 4." + "uses this value to replace tabs by spaces in code fragments.\n" + "Minimum value: 1, maximum value: 16, default value: 4." ); doc->add( "ALIASES", @@ -227,26 +235,28 @@ void addConfigDocs(DocIntf *doc) "Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources\n" "only. Doxygen will then generate output that is more tailored for C. For\n" "instance, some of the names that are used will be different. The list of all\n" - "members will be omitted, etc.Default value: NO." + "members will be omitted, etc.\n" + "The default value is: NO." ); doc->add( "OPTIMIZE_OUTPUT_JAVA", "Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or\n" "Python sources only. Doxygen will then generate output that is more tailored\n" "for that language. For instance, namespaces will be presented as packages,\n" - "qualified scopes will look different, etc.Default value: NO." + "qualified scopes will look different, etc.\n" + "The default value is: NO." ); doc->add( "OPTIMIZE_FOR_FORTRAN", "Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran\n" - "sources. Doxygen will then generate output that is tailored for\n" - "Fortran.Default value: NO." + "sources. Doxygen will then generate output that is tailored for Fortran.\n" + "The default value is: NO." ); doc->add( "OPTIMIZE_OUTPUT_VHDL", "Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL\n" - "sources. Doxygen will then generate output that is tailored for VHDL.Default\n" - "value: NO." + "sources. Doxygen will then generate output that is tailored for VHDL.\n" + "The default value is: NO." ); doc->add( "EXTENSION_MAPPING", @@ -271,14 +281,16 @@ void addConfigDocs(DocIntf *doc) "documentation. See http://daringfireball.net/projects/markdown/ for details.\n" "The output of markdown processing is further processed by doxygen, so you can\n" "mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in\n" - "case of backward compatibilities issues.Default value: YES." + "case of backward compatibilities issues.\n" + "The default value is: YES." ); doc->add( "AUTOLINK_SUPPORT", "When enabled doxygen tries to link words that correspond to documented\n" "classes, or namespaces to their corresponding documentation. Such a link can\n" "be prevented in individual cases by by putting a % sign in front of the word\n" - "or globally by setting AUTOLINK_SUPPORT to NO.Default value: YES." + "or globally by setting AUTOLINK_SUPPORT to NO.\n" + "The default value is: YES." ); doc->add( "BUILTIN_STL_SUPPORT", @@ -287,21 +299,22 @@ void addConfigDocs(DocIntf *doc) "tag to YES in order to let doxygen match functions declarations and\n" "definitions whose arguments contain STL classes (e.g. func(std::string);\n" "versus func(std::string) {}). This also make the inheritance and collaboration\n" - "diagrams that involve STL classes more complete and accurate.Default value:\n" - "NO." + "diagrams that involve STL classes more complete and accurate.\n" + "The default value is: NO." ); doc->add( "CPP_CLI_SUPPORT", "If you use Microsoft's C++/CLI language, you should set this option to YES to\n" - "enable parsing support.Default value: NO." + "enable parsing support.\n" + "The default value is: NO." ); doc->add( "SIP_SUPPORT", "Set the SIP_SUPPORT tag to YES if your project consists of sip (see:\n" "http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen\n" "will parse them like normal C++ but will assume all classes use public instead\n" - "of private inheritance when no explicit protection keyword is present.Default\n" - "value: NO." + "of private inheritance when no explicit protection keyword is present.\n" + "The default value is: NO." ); doc->add( "IDL_PROPERTY_SUPPORT", @@ -310,14 +323,16 @@ void addConfigDocs(DocIntf *doc) "doxygen to replace the get and set methods by a property in the documentation.\n" "This will only work if the methods are indeed getting or setting a simple\n" "type. If this is not the case, or you want to show the methods anyway, you\n" - "should set this option to NO.Default value: YES." + "should set this option to NO.\n" + "The default value is: YES." ); doc->add( "DISTRIBUTE_GROUP_DOC", "If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC\n" "tag is set to YES, then doxygen will reuse the documentation of the first\n" "member in the group (if any) for the other members of the group. By default\n" - "all members of a group must be documented explicitly.Default value: NO." + "all members of a group must be documented explicitly.\n" + "The default value is: NO." ); doc->add( "SUBGROUPING", @@ -325,7 +340,8 @@ void addConfigDocs(DocIntf *doc) "(for instance a group of public functions) to be put as a subgroup of that\n" "type (e.g. under the Public Functions section). Set it to NO to prevent\n" "subgrouping. Alternatively, this can be done per class using the\n" - "\\nosubgrouping command.Default value: YES." + "\\nosubgrouping command.\n" + "The default value is: YES." ); doc->add( "INLINE_GROUPED_CLASSES", @@ -335,7 +351,8 @@ void addConfigDocs(DocIntf *doc) "and RTF).\n" "\n" "Note that this feature does not work in combination with\n" - "SEPARATE_MEMBER_PAGES.Default value: NO." + "SEPARATE_MEMBER_PAGES.\n" + "The default value is: NO." ); doc->add( "INLINE_SIMPLE_STRUCTS", @@ -344,7 +361,8 @@ void addConfigDocs(DocIntf *doc) "the documentation of the scope in which they are defined (i.e. file,\n" "namespace, or group documentation), provided this scope is documented. If set\n" "to NO, structs, classes, and unions are shown on a separate page (for HTML and\n" - "Man pages) or section (for LaTeX and RTF).Default value: NO." + "Man pages) or section (for LaTeX and RTF).\n" + "The default value is: NO." ); doc->add( "TYPEDEF_HIDES_STRUCT", @@ -354,8 +372,8 @@ void addConfigDocs(DocIntf *doc) "with name TypeT. When disabled the typedef will appear as a member of a file,\n" "namespace, or class. And the struct will be named TypeS. This can typically be\n" "useful for C code in case the coding convention dictates that all compound\n" - "types are typedef'ed and only the typedef is referenced, never the tag\n" - "name.Default value: NO." + "types are typedef'ed and only the typedef is referenced, never the tag name.\n" + "The default value is: NO." ); doc->add( "LOOKUP_CACHE_SIZE", @@ -367,46 +385,52 @@ void addConfigDocs(DocIntf *doc) "cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range\n" "is 0..9, the default is 0, corresponding to a cache size of 2^16=65536\n" "symbols. At the end of a run doxygen will report the cache usage and suggest\n" - "the optimal cache size from a speed point of view. Minimum value: 0, maximum\n" - "value: 9, default value: 0." + "the optimal cache size from a speed point of view.\n" + "Minimum value: 0, maximum value: 9, default value: 0." ); doc->add( "EXTRACT_ALL", "If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in\n" "documentation are documented, even if no documentation was available. Private\n" "class members and static file members will be hidden unless the\n" - "EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES\n" + "EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.\n" "Note: This will also disable the warnings about undocumented members that are\n" - "normally produced when WARNINGS is set to YESDefault value: NO." + "normally produced when WARNINGS is set to YES.\n" + "The default value is: NO." ); doc->add( "EXTRACT_PRIVATE", "If the EXTRACT_PRIVATE tag is set to YES all private members of a class will\n" - "be included in the documentation.Default value: NO." + "be included in the documentation.\n" + "The default value is: NO." ); doc->add( "EXTRACT_PACKAGE", "If the EXTRACT_PACKAGE tag is set to YES all members with package or internal\n" - "scope will be included in the documentation.Default value: NO." + "scope will be included in the documentation.\n" + "The default value is: NO." ); doc->add( "EXTRACT_STATIC", "If the EXTRACT_STATIC tag is set to YES all static members of a file will be\n" - "included in the documentation.Default value: NO." + "included in the documentation.\n" + "The default value is: NO." ); doc->add( "EXTRACT_LOCAL_CLASSES", "If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined\n" "locally in source files will be included in the documentation. If set to NO\n" "only classes defined in header files are included. Does not have any effect\n" - "for Java sources.Default value: YES." + "for Java sources.\n" + "The default value is: YES." ); doc->add( "EXTRACT_LOCAL_METHODS", "This flag is only useful for Objective-C code. When set to YES local methods,\n" "which are defined in the implementation section but not in the interface are\n" "included in the documentation. If set to NO only methods in the interface are\n" - "included.Default value: NO." + "included.\n" + "The default value is: NO." ); doc->add( "EXTRACT_ANON_NSPACES", @@ -414,42 +438,45 @@ void addConfigDocs(DocIntf *doc) "extracted and appear in the documentation as a namespace called\n" "'anonymous_namespace{file}', where file will be replaced with the base name of\n" "the file that contains the anonymous namespace. By default anonymous namespace\n" - "are hidden.Default value: NO." + "are hidden.\n" + "The default value is: NO." ); doc->add( "HIDE_UNDOC_MEMBERS", "If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all\n" "undocumented members inside documented classes or files. If set to NO these\n" "members will be included in the various overviews, but no documentation\n" - "section is generated. This option has no effect if EXTRACT_ALL is\n" - "enabled.Default value: NO." + "section is generated. This option has no effect if EXTRACT_ALL is enabled.\n" + "The default value is: NO." ); doc->add( "HIDE_UNDOC_CLASSES", "If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all\n" "undocumented classes that are normally visible in the class hierarchy. If set\n" "to NO these classes will be included in the various overviews. This option has\n" - "no effect if EXTRACT_ALL is enabled.Default value: NO." + "no effect if EXTRACT_ALL is enabled.\n" + "The default value is: NO." ); doc->add( "HIDE_FRIEND_COMPOUNDS", "If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend\n" "(class|struct|union) declarations. If set to NO these declarations will be\n" - "included in the documentation.Default value: NO." + "included in the documentation.\n" + "The default value is: NO." ); doc->add( "HIDE_IN_BODY_DOCS", "If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any\n" "documentation blocks found inside the body of a function. If set to NO these\n" - "blocks will be appended to the function's detailed documentation block.Default\n" - "value: NO." + "blocks will be appended to the function's detailed documentation block.\n" + "The default value is: NO." ); doc->add( "INTERNAL_DOCS", "The INTERNAL_DOCS tag determines if documentation that is typed after a\n" "\\internal command is included. If the tag is set to NO then the documentation\n" - "will be excluded. Set it to YES to include the internal documentation.Default\n" - "value: NO." + "will be excluded. Set it to YES to include the internal documentation.\n" + "The default value is: NO." ); doc->add( "CASE_SENSE_NAMES", @@ -457,45 +484,47 @@ void addConfigDocs(DocIntf *doc) "names in lower-case letters. If set to YES upper-case letters are also\n" "allowed. This is useful if you have classes or files whose names only differ\n" "in case and if your file system supports case sensitive file names. Windows\n" - "and Mac users are advised to set this option to NO.Default value: system\n" - "dependent." + "and Mac users are advised to set this option to NO.\n" + "The default value is: system dependent." ); doc->add( "HIDE_SCOPE_NAMES", "If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with\n" "their full class and namespace scopes in the documentation. If set to YES the\n" - "scope will be hidden.Default value: NO." + "scope will be hidden.\n" + "The default value is: NO." ); doc->add( "SHOW_INCLUDE_FILES", "If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of\n" - "the files that are included by a file in the documentation of that\n" - "file.Default value: YES." + "the files that are included by a file in the documentation of that file.\n" + "The default value is: YES." ); doc->add( "FORCE_LOCAL_INCLUDES", "If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include\n" - "files with double quotes in the documentation rather than with sharp\n" - "brackets.Default value: NO." + "files with double quotes in the documentation rather than with sharp brackets.\n" + "The default value is: NO." ); doc->add( "INLINE_INFO", "If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the\n" - "documentation for inline members.Default value: YES." + "documentation for inline members.\n" + "The default value is: YES." ); doc->add( "SORT_MEMBER_DOCS", "If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the\n" "(detailed) documentation of file and class members alphabetically by member\n" - "name. If set to NO the members will appear in declaration order.Default value:\n" - "YES." + "name. If set to NO the members will appear in declaration order.\n" + "The default value is: YES." ); doc->add( "SORT_BRIEF_DOCS", "If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief\n" "descriptions of file, namespace and class members alphabetically by member\n" - "name. If set to NO the members will appear in declaration order.Default value:\n" - "NO." + "name. If set to NO the members will appear in declaration order.\n" + "The default value is: NO." ); doc->add( "SORT_MEMBERS_CTORS_1ST", @@ -506,13 +535,15 @@ void addConfigDocs(DocIntf *doc) "Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief\n" "member documentation.\n" "Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting\n" - "detailed member documentation.Default value: NO." + "detailed member documentation.\n" + "The default value is: NO." ); doc->add( "SORT_GROUP_NAMES", "If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy\n" "of group names into alphabetical order. If set to NO the group names will\n" - "appear in their defined order.Default value: NO." + "appear in their defined order.\n" + "The default value is: NO." ); doc->add( "SORT_BY_SCOPE_NAME", @@ -521,7 +552,8 @@ void addConfigDocs(DocIntf *doc) "be sorted only by class name, not including the namespace part.\n" "Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.\n" "Note: This option applies only to the class list, not to the alphabetical\n" - "list.Default value: NO." + "list.\n" + "The default value is: NO." ); doc->add( "STRICT_PROTO_MATCHING", @@ -530,32 +562,35 @@ void addConfigDocs(DocIntf *doc) "the prototype and the implementation of a member function even if there is\n" "only one candidate or it is obvious which candidate to choose by doing a\n" "simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still\n" - "accept a match between prototype and implementation in such cases.Default\n" - "value: NO." + "accept a match between prototype and implementation in such cases.\n" + "The default value is: NO." ); doc->add( "GENERATE_TODOLIST", "The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the\n" "todo list. This list is created by putting \\todo commands in the\n" - "documentation.Default value: YES." + "documentation.\n" + "The default value is: YES." ); doc->add( "GENERATE_TESTLIST", "The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the\n" "test list. This list is created by putting \\test commands in the\n" - "documentation.Default value: YES." + "documentation.\n" + "The default value is: YES." ); doc->add( "GENERATE_BUGLIST", "The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug\n" - "list. This list is created by putting \\bug commands in the\n" - "documentation.Default value: YES." + "list. This list is created by putting \\bug commands in the documentation.\n" + "The default value is: YES." ); doc->add( "GENERATE_DEPRECATEDLIST", "The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)\n" "the deprecated list. This list is created by putting \\deprecated commands in\n" - "the documentation.Default value: YES." + "the documentation.\n" + "The default value is: YES." ); doc->add( "ENABLED_SECTIONS", @@ -571,27 +606,29 @@ void addConfigDocs(DocIntf *doc) "it will be hidden. Use a value of 0 to hide initializers completely. The\n" "appearance of the value of individual variables and macros / defines can be\n" "controlled using \\showinitializer or \\hideinitializer command in the\n" - "documentation regardless of this setting. Minimum value: 0, maximum value:\n" - "10000, default value: 30." + "documentation regardless of this setting.\n" + "Minimum value: 0, maximum value: 10000, default value: 30." ); doc->add( "SHOW_USED_FILES", "Set the SHOW_USED_FILES tag to NO to disable the list of files generated at\n" "the bottom of the documentation of classes and structs. If set to YES the list\n" - "will mention the files that were used to generate the documentation.Default\n" - "value: YES." + "will mention the files that were used to generate the documentation.\n" + "The default value is: YES." ); doc->add( "SHOW_FILES", "Set the SHOW_FILES tag to NO to disable the generation of the Files page. This\n" "will remove the Files entry from the Quick Index and from the Folder Tree View\n" - "(if specified). The default is YES.Default value: YES." + "(if specified).\n" + "The default value is: YES." ); doc->add( "SHOW_NAMESPACES", "Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces\n" "page. This will remove the Namespaces entry from the Quick Index and from the\n" - "Folder Tree View (if specified). The default is YES.Default value: YES." + "Folder Tree View (if specified).\n" + "The default value is: YES." ); doc->add( "FILE_VERSION_FILTER", @@ -630,36 +667,41 @@ void addConfigDocs(DocIntf *doc) doc->add( "QUIET", "The QUIET tag can be used to turn on/off the messages that are generated to\n" - "standard output by doxygen. Possible values are YES and NO, where YES implies\n" - "that the messages are off.Default value: NO." + "standard output by doxygen. If QUIET is set to YES this implies that the\n" + "messages are off.\n" + "The default value is: NO." ); doc->add( "WARNINGS", "The WARNINGS tag can be used to turn on/off the warning messages that are\n" - "generated to standard error ( stderr) by doxygen. Possible values are YES and\n" - "NO, where YES implies that the warnings are on.\n" + "generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES\n" + "this implies that the warnings are on.\n" "\n" - "Tip: Turn warnings on while writing the documentation.Default value: YES." + "Tip: Turn warnings on while writing the documentation.\n" + "The default value is: YES." ); doc->add( "WARN_IF_UNDOCUMENTED", "If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate\n" "warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag\n" - "will automatically be disabled.Default value: YES." + "will automatically be disabled.\n" + "The default value is: YES." ); doc->add( "WARN_IF_DOC_ERROR", "If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for\n" "potential errors in the documentation, such as not documenting some parameters\n" "in a documented function, or documenting parameters that don't exist or using\n" - "markup commands wrongly.Default value: YES." + "markup commands wrongly.\n" + "The default value is: YES." ); doc->add( "WARN_NO_PARAMDOC", "This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that\n" "are documented, but have no documentation for their parameters or return\n" "value. If set to NO doxygen will only warn about wrong or incomplete parameter\n" - "documentation, but not about the absence of documentation.Default value: NO." + "documentation, but not about the absence of documentation.\n" + "The default value is: NO." ); doc->add( "WARN_FORMAT", @@ -668,13 +710,14 @@ void addConfigDocs(DocIntf *doc) "will be replaced by the file and line number from which the warning originated\n" "and the warning text. Optionally the format may contain $version, which will\n" "be replaced by the version of the file (if it could be obtained via\n" - "FILE_VERSION_FILTER)The default value is: $file:$line: $text." + "FILE_VERSION_FILTER)\n" + "The default value is: $file:$line: $text." ); doc->add( "WARN_LOGFILE", "The WARN_LOGFILE tag can be used to specify a file to which warning and error\n" "messages should be written. If left blank the output is written to standard\n" - "error ( stderr)." + "error (stderr)." ); doc->add( "INPUT", @@ -690,7 +733,8 @@ void addConfigDocs(DocIntf *doc) "that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses\n" "libiconv (or the iconv built into libc) for the transcoding. See the libiconv\n" "documentation (see: http://www.gnu.org/software/libiconv) for the list of\n" - "possible encodings.The default value is: UTF-8." + "possible encodings.\n" + "The default value is: UTF-8." ); doc->add( "FILE_PATTERNS", @@ -706,8 +750,8 @@ void addConfigDocs(DocIntf *doc) doc->add( "RECURSIVE", "The RECURSIVE tag can be used to specify whether or not subdirectories should\n" - "be searched for input files as well. Possible values are YES and NO.Default\n" - "value: NO." + "be searched for input files as well.\n" + "The default value is: NO." ); doc->add( "EXCLUDE", @@ -722,7 +766,8 @@ void addConfigDocs(DocIntf *doc) "EXCLUDE_SYMLINKS", "The EXCLUDE_SYMLINKS tag can be used to select whether or not files or\n" "directories that are symbolic links (a Unix file system feature) are excluded\n" - "from the input.Default value: NO." + "from the input.\n" + "The default value is: NO." ); doc->add( "EXCLUDE_PATTERNS", @@ -755,13 +800,14 @@ void addConfigDocs(DocIntf *doc) "If the value of the EXAMPLE_PATH tag contains directories, you can use the\n" "EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and\n" "*.h) to filter out the source-files in the directories. If left blank all\n" - "files are included.*." + "files are included." ); doc->add( "EXAMPLE_RECURSIVE", "If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be\n" "searched for input files to be used with the \\include or \\dontinclude commands\n" - "irrespective of the value of the RECURSIVE tag.Default value: NO." + "irrespective of the value of the RECURSIVE tag.\n" + "The default value is: NO." ); doc->add( "IMAGE_PATH", @@ -799,8 +845,8 @@ void addConfigDocs(DocIntf *doc) "FILTER_SOURCE_FILES", "If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using\n" "INPUT_FILTER ) will also be used to filter the input files that are used for\n" - "producing the source files to browse (i.e. when SOURCE_BROWSER is set to\n" - "YES).Default value: NO." + "producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).\n" + "The default value is: NO." ); doc->add( "FILTER_SOURCE_PATTERNS", @@ -808,7 +854,6 @@ void addConfigDocs(DocIntf *doc) "pattern. A pattern will override the setting for FILTER_PATTERN (if any) and\n" "it is also possible to disable source filtering for a specific pattern using\n" "*.ext= (so without naming a filter).\n" - "\n" "This tag requires that the tag FILTER_SOURCE_FILES is set to YES." ); doc->add( @@ -824,37 +869,41 @@ void addConfigDocs(DocIntf *doc) "generated. Documented entities will be cross-referenced with these sources.\n" "\n" "Note: To get rid of all source code in the generated output, make sure that\n" - "also VERBATIM_HEADERS is set to NO.Default value: NO." + "also VERBATIM_HEADERS is set to NO.\n" + "The default value is: NO." ); doc->add( "INLINE_SOURCES", "Setting the INLINE_SOURCES tag to YES will include the body of functions,\n" - "classes and enums directly into the documentation.Default value: NO." + "classes and enums directly into the documentation.\n" + "The default value is: NO." ); doc->add( "STRIP_CODE_COMMENTS", "Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any\n" "special comment blocks from generated source code fragments. Normal C, C++ and\n" - "Fortran comments will always remain visible.Default value: YES." + "Fortran comments will always remain visible.\n" + "The default value is: YES." ); doc->add( "REFERENCED_BY_RELATION", "If the REFERENCED_BY_RELATION tag is set to YES then for each documented\n" - "function all documented functions referencing it will be listed.Default value:\n" - "NO." + "function all documented functions referencing it will be listed.\n" + "The default value is: NO." ); doc->add( "REFERENCES_RELATION", "If the REFERENCES_RELATION tag is set to YES then for each documented function\n" - "all documented entities called/used by that function will be listed.Default\n" - "value: NO." + "all documented entities called/used by that function will be listed.\n" + "The default value is: NO." ); doc->add( "REFERENCES_LINK_SOURCE", "If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set\n" "to YES, then the hyperlinks from functions in REFERENCES_RELATION and\n" "REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will\n" - "link to the documentation.Default value: YES." + "link to the documentation.\n" + "The default value is: YES." ); doc->add( "SOURCE_TOOLTIPS", @@ -862,8 +911,8 @@ void addConfigDocs(DocIntf *doc) "source code will show a tooltip with additional information such as prototype,\n" "brief description and links to the definition and documentation. Since this\n" "will make the HTML file larger and loading of large files a bit slower, you\n" - "can opt to disable this feature.Default value: YES.\n" - "\n" + "can opt to disable this feature.\n" + "The default value is: YES.\n" "This tag requires that the tag SOURCE_BROWSER is set to YES." ); doc->add( @@ -884,8 +933,8 @@ void addConfigDocs(DocIntf *doc) "tools must be available from the command line (i.e. in the search path).\n" "\n" "The result: instead of the source browser generated by doxygen, the links to\n" - "source code will now point to the output of htags.Default value: NO.\n" - "\n" + "source code will now point to the output of htags.\n" + "The default value is: NO.\n" "This tag requires that the tag SOURCE_BROWSER is set to YES." ); doc->add( @@ -893,7 +942,8 @@ void addConfigDocs(DocIntf *doc) "If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a\n" "verbatim copy of the header file for each class for which an include is\n" "specified. Set to NO to disable this.\n" - "See also: Section \\class.Default value: YES." + "See also: Section \\class.\n" + "The default value is: YES." ); doc->add( "CLANG_ASSISTED_PARSING", @@ -903,7 +953,8 @@ void addConfigDocs(DocIntf *doc) "rich C++ code for which doxygen's built-in parser lacks the necessary type\n" "information.\n" "Note: The availability of this option depends on whether or not doxygen was\n" - "compiled with the --with-libclang option.Default value: NO." + "compiled with the --with-libclang option.\n" + "The default value is: NO." ); doc->add( "CLANG_OPTIONS", @@ -911,21 +962,20 @@ void addConfigDocs(DocIntf *doc) "line options that you would normally use when invoking the compiler. Note that\n" "the include paths will already be set by doxygen for the files and directories\n" "specified with INPUT and INCLUDE_PATH.\n" - "\n" "This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES." ); doc->add( "ALPHABETICAL_INDEX", "If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all\n" "compounds will be generated. Enable this if the project contains a lot of\n" - "classes, structs, unions or interfaces.Default value: YES." + "classes, structs, unions or interfaces.\n" + "The default value is: YES." ); doc->add( "COLS_IN_ALPHA_INDEX", "The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in\n" - "which the alphabetical index list will be split. Minimum value: 1, maximum\n" - "value: 20, default value: 5.\n" - "\n" + "which the alphabetical index list will be split.\n" + "Minimum value: 1, maximum value: 20, default value: 5.\n" "This tag requires that the tag ALPHABETICAL_INDEX is set to YES." ); doc->add( @@ -934,28 +984,26 @@ void addConfigDocs(DocIntf *doc) "be put under the same header in the alphabetical index. The IGNORE_PREFIX tag\n" "can be used to specify a prefix (or a list of prefixes) that should be ignored\n" "while generating the index headers.\n" - "\n" "This tag requires that the tag ALPHABETICAL_INDEX is set to YES." ); doc->add( "GENERATE_HTML", - "If the GENERATE_HTML tag is set to YES doxygen will generate HTML\n" - "outputDefault value: YES." + "If the GENERATE_HTML tag is set to YES doxygen will generate HTML output\n" + "The default value is: YES." ); doc->add( "HTML_OUTPUT", "The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a\n" "relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\n" - "it.The default directory is: html.\n" - "\n" + "it.\n" + "The default directory is: html.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( "HTML_FILE_EXTENSION", "The HTML_FILE_EXTENSION tag can be used to specify the file extension for each\n" - "generated HTML page (for example: .htm, .php, .asp).The default value is:\n" - ".html.\n" - "\n" + "generated HTML page (for example: .htm, .php, .asp).\n" + "The default value is: .html.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -976,7 +1024,6 @@ void addConfigDocs(DocIntf *doc) "Note: The header is subject to change so you typically have to regenerate the\n" "default header when upgrading to a newer version of doxygen. For a description\n" "of the possible markers and block names see the documentation.\n" - "\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -987,7 +1034,6 @@ void addConfigDocs(DocIntf *doc) "footer and what special commands can be used inside the footer. See also\n" "section \"Doxygen usage\" for information on how to generate the default footer\n" "that doxygen normally uses.\n" - "\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1000,7 +1046,6 @@ void addConfigDocs(DocIntf *doc) "Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as\n" "it is more robust and this tag (HTML_STYLESHEET) will in the future become\n" "obsolete.\n" - "\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1012,7 +1057,6 @@ void addConfigDocs(DocIntf *doc) "standard style sheet and is therefor more robust against future updates.\n" "Doxygen will copy the style sheet file to the output directory. For an example\n" "see the documentation.\n" - "\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1023,7 +1067,6 @@ void addConfigDocs(DocIntf *doc) "$relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these\n" "files. In the HTML_STYLESHEET file, use the file name only. Also note that the\n" "files will be copied as-is; there are no commands or markers available.\n" - "\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1033,18 +1076,16 @@ void addConfigDocs(DocIntf *doc) "this color. Hue is specified as an angle on a colorwheel, see\n" "http://en.wikipedia.org/wiki/Hue for more information. For instance the value\n" "0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300\n" - "purple, and 360 is red again. The allowed range is 0 to 359. Minimum value: 0,\n" - "maximum value: 359, default value: 220.\n" - "\n" + "purple, and 360 is red again.\n" + "Minimum value: 0, maximum value: 359, default value: 220.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( "HTML_COLORSTYLE_SAT", "The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors\n" "in the HTML output. For a value of 0 the output will use grayscales only. A\n" - "value of 255 will produce the most vivid colors. Minimum value: 0, maximum\n" - "value: 255, default value: 100.\n" - "\n" + "value of 255 will produce the most vivid colors.\n" + "Minimum value: 0, maximum value: 255, default value: 100.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1054,24 +1095,24 @@ void addConfigDocs(DocIntf *doc) "gradually make the output lighter, whereas values above 100 make the output\n" "darker. The value divided by 100 is the actual gamma applied, so 80 represents\n" "a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not\n" - "change the gamma. Minimum value: 40, maximum value: 240, default value: 80.\n" - "\n" + "change the gamma.\n" + "Minimum value: 40, maximum value: 240, default value: 80.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( "HTML_TIMESTAMP", "If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML\n" "page will contain the date and time when the page was generated. Setting this\n" - "to NO can help when comparing the output of multiple runs.Default value: YES.\n" - "\n" + "to NO can help when comparing the output of multiple runs.\n" + "The default value is: YES.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( "HTML_DYNAMIC_SECTIONS", "If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML\n" "documentation will contain sections that can be hidden and shown after the\n" - "page has loaded.Default value: NO.\n" - "\n" + "page has loaded.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1083,8 +1124,8 @@ void addConfigDocs(DocIntf *doc) "a fully collapsed tree already exceeds this amount). So setting the number of\n" "entries 1 will produce a full collapsed tree by default. 0 is a special value\n" "representing an infinite number of entries and will result in a full expanded\n" - "tree by default. Minimum value: 0, maximum value: 9999, default value: 100.\n" - "\n" + "tree by default.\n" + "Minimum value: 0, maximum value: 9999, default value: 100.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1097,42 +1138,38 @@ void addConfigDocs(DocIntf *doc) "that directory and running make install will install the docset in\n" "~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at\n" "startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html\n" - "for more information.Default value: NO.\n" - "\n" + "for more information.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( "DOCSET_FEEDNAME", "This tag determines the name of the docset feed. A documentation feed provides\n" "an umbrella under which multiple documentation sets from a single provider\n" - "(such as a company or product suite) can be grouped.The default value is:\n" - "Doxygen generated docs.\n" - "\n" + "(such as a company or product suite) can be grouped.\n" + "The default value is: Doxygen generated docs.\n" "This tag requires that the tag GENERATE_DOCSET is set to YES." ); doc->add( "DOCSET_BUNDLE_ID", "This tag specifies a string that should uniquely identify the documentation\n" "set bundle. This should be a reverse domain-name style string, e.g.\n" - "com.mycompany.MyDocSet. Doxygen will append .docset to the name.The default\n" - "value is: org.doxygen.Project.\n" - "\n" + "com.mycompany.MyDocSet. Doxygen will append .docset to the name.\n" + "The default value is: org.doxygen.Project.\n" "This tag requires that the tag GENERATE_DOCSET is set to YES." ); doc->add( "DOCSET_PUBLISHER_ID", "The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify\n" "the documentation publisher. This should be a reverse domain-name style\n" - "string, e.g. com.mycompany.MyDocSet.documentation.The default value is:\n" - "org.doxygen.Publisher.\n" - "\n" + "string, e.g. com.mycompany.MyDocSet.documentation.\n" + "The default value is: org.doxygen.Publisher.\n" "This tag requires that the tag GENERATE_DOCSET is set to YES." ); doc->add( "DOCSET_PUBLISHER_NAME", - "The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.The\n" - "default value is: Publisher.\n" - "\n" + "The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.\n" + "The default value is: Publisher.\n" "This tag requires that the tag GENERATE_DOCSET is set to YES." ); doc->add( @@ -1149,8 +1186,8 @@ void addConfigDocs(DocIntf *doc) "Windows help format (.hlp) on all Windows platforms in the future. Compressed\n" "HTML files also contain an index, a table of contents, and you can search for\n" "words in the documentation. The HTML workshop also contains a viewer for\n" - "compressed HTML files.Default value: NO.\n" - "\n" + "compressed HTML files.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1158,46 +1195,41 @@ void addConfigDocs(DocIntf *doc) "The CHM_FILE tag can be used to specify the file name of the resulting .chm\n" "file. You can add a path in front of the file if the result should not be\n" "written to the html output directory.\n" - "\n" "This tag requires that the tag GENERATE_HTMLHELP is set to YES." ); doc->add( "HHC_LOCATION", "The HHC_LOCATION tag can be used to specify the location (absolute path\n" "including file name) of the HTML help compiler ( hhc.exe). If non-empty\n" - "doxygen will try to run the HTML help compiler on the generated index.hhp.The\n" - "file has to be specified with full path.\n" - "\n" + "doxygen will try to run the HTML help compiler on the generated index.hhp.\n" + "The file has to be specified with full path.\n" "This tag requires that the tag GENERATE_HTMLHELP is set to YES." ); doc->add( "GENERATE_CHI", "The GENERATE_CHI flag controls if a separate .chi index file is generated (\n" - "YES) or that it should be included in the master .chm file ( NO).Default\n" - "value: NO.\n" - "\n" + "YES) or that it should be included in the master .chm file ( NO).\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_HTMLHELP is set to YES." ); doc->add( "CHM_INDEX_ENCODING", "The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)\n" "and project file content.\n" - "\n" "This tag requires that the tag GENERATE_HTMLHELP is set to YES." ); doc->add( "BINARY_TOC", "The BINARY_TOC flag controls whether a binary table of contents is generated (\n" - "YES) or a normal table of contents ( NO) in the .chm file.Default value: NO.\n" - "\n" + "YES) or a normal table of contents ( NO) in the .chm file.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_HTMLHELP is set to YES." ); doc->add( "TOC_EXPAND", "The TOC_EXPAND flag can be set to YES to add extra items for group members to\n" - "the table of contents of the HTML help documentation and to the tree\n" - "view.Default value: NO.\n" - "\n" + "the table of contents of the HTML help documentation and to the tree view.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_HTMLHELP is set to YES." ); doc->add( @@ -1205,8 +1237,8 @@ void addConfigDocs(DocIntf *doc) "If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and\n" "QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that\n" "can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help\n" - "(.qch) of the generated HTML documentation.Default value: NO.\n" - "\n" + "(.qch) of the generated HTML documentation.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1214,16 +1246,14 @@ void addConfigDocs(DocIntf *doc) "If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify\n" "the file name of the resulting .qch file. The path specified is relative to\n" "the HTML output folder.\n" - "\n" "This tag requires that the tag GENERATE_QHP is set to YES." ); doc->add( "QHP_NAMESPACE", "The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help\n" "Project output. For more information please see Qt Help Project / Namespace\n" - "(see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).The\n" - "default value is: org.doxygen.Project.\n" - "\n" + "(see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).\n" + "The default value is: org.doxygen.Project.\n" "This tag requires that the tag GENERATE_QHP is set to YES." ); doc->add( @@ -1231,8 +1261,8 @@ void addConfigDocs(DocIntf *doc) "The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt\n" "Help Project output. For more information please see Qt Help Project / Virtual\n" "Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-\n" - "folders).The default value is: doc.\n" - "\n" + "folders).\n" + "The default value is: doc.\n" "This tag requires that the tag GENERATE_QHP is set to YES." ); doc->add( @@ -1241,7 +1271,6 @@ void addConfigDocs(DocIntf *doc) "filter to add. For more information please see Qt Help Project / Custom\n" "Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-\n" "filters).\n" - "\n" "This tag requires that the tag GENERATE_QHP is set to YES." ); doc->add( @@ -1250,7 +1279,6 @@ void addConfigDocs(DocIntf *doc) "custom filter to add. For more information please see Qt Help Project / Custom\n" "Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-\n" "filters).\n" - "\n" "This tag requires that the tag GENERATE_QHP is set to YES." ); doc->add( @@ -1258,7 +1286,6 @@ void addConfigDocs(DocIntf *doc) "The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this\n" "project's filter section matches. Qt Help Project / Filter Attributes (see:\n" "http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).\n" - "\n" "This tag requires that the tag GENERATE_QHP is set to YES." ); doc->add( @@ -1266,7 +1293,6 @@ void addConfigDocs(DocIntf *doc) "The QHG_LOCATION tag can be used to specify the location of Qt's\n" "qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the\n" "generated .qhp file.\n" - "\n" "This tag requires that the tag GENERATE_QHP is set to YES." ); doc->add( @@ -1277,18 +1303,16 @@ void addConfigDocs(DocIntf *doc) "Eclipse, the contents of the directory containing the HTML and XML files needs\n" "to be copied into the plugins directory of eclipse. The name of the directory\n" "within the plugins directory should be the same as the ECLIPSE_DOC_ID value.\n" - "After copying Eclipse needs to be restarted before the help appears.Default\n" - "value: NO.\n" - "\n" + "After copying Eclipse needs to be restarted before the help appears.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( "ECLIPSE_DOC_ID", "A unique identifier for the Eclipse help plugin. When installing the plugin\n" "the directory name containing the HTML and XML files should also have this\n" - "name. Each documentation set should have its own identifier.The default value\n" - "is: org.doxygen.Project.\n" - "\n" + "name. Each documentation set should have its own identifier.\n" + "The default value is: org.doxygen.Project.\n" "This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES." ); doc->add( @@ -1298,9 +1322,8 @@ void addConfigDocs(DocIntf *doc) "DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top\n" "of each HTML page. A value of NO enables the index and the value YES disables\n" "it. Since the tabs in the index contain the same information as the navigation\n" - "tree, you can set this option to YES if you also set GENERATE_TREEVIEW to\n" - "YES.Default value: NO.\n" - "\n" + "tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1316,8 +1339,8 @@ void addConfigDocs(DocIntf *doc) "sheet generated by doxygen has an example that shows how to put an image at\n" "the root of the tree instead of the PROJECT_NAME. Since the tree basically has\n" "the same information as the tab index, you could consider setting\n" - "DISABLE_INDEX to YES when enabling this option.Default value: NO.\n" - "\n" + "DISABLE_INDEX to YES when enabling this option.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1326,9 +1349,8 @@ void addConfigDocs(DocIntf *doc) "doxygen will group on one line in the generated HTML documentation.\n" "\n" "Note that a value of 0 will completely suppress the enum values from appearing\n" - "in the overview section. Minimum value: 0, maximum value: 20, default value:\n" - "4.\n" - "\n" + "in the overview section.\n" + "Minimum value: 0, maximum value: 20, default value: 4.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1336,15 +1358,13 @@ void addConfigDocs(DocIntf *doc) "If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used\n" "to set the initial width (in pixels) of the frame in which the tree is shown.\n" "Minimum value: 0, maximum value: 1500, default value: 250.\n" - "\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( "EXT_LINKS_IN_WINDOW", "When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to\n" - "external symbols imported via tag files in a separate window.Default value:\n" - "NO.\n" - "\n" + "external symbols imported via tag files in a separate window.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1352,9 +1372,8 @@ void addConfigDocs(DocIntf *doc) "Use this tag to change the font size of LaTeX formulas included as images in\n" "the HTML documentation. When you change the font size after a successful\n" "doxygen run you need to manually remove any form_*.png images from the HTML\n" - "output directory to force them to be regenerated. Minimum value: 8, maximum\n" - "value: 50, default value: 10.\n" - "\n" + "output directory to force them to be regenerated.\n" + "Minimum value: 8, maximum value: 50, default value: 10.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1364,8 +1383,8 @@ void addConfigDocs(DocIntf *doc) "supported properly for IE 6.0, but are supported on all modern browsers.\n" "\n" "Note that when changing this option you need to delete any form_*.png files in\n" - "the HTML output directory before the changes have effect.Default value: YES.\n" - "\n" + "the HTML output directory before the changes have effect.\n" + "The default value is: YES.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1375,20 +1394,18 @@ void addConfigDocs(DocIntf *doc) "instead of using prerendered bitmaps. Use this if you do not have LaTeX\n" "installed or if you want to formulas look prettier in the HTML output. When\n" "enabled you may also need to install MathJax separately and configure the path\n" - "to it using the MATHJAX_RELPATH option.Default value: NO.\n" - "\n" + "to it using the MATHJAX_RELPATH option.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( "MATHJAX_FORMAT", "When MathJax is enabled you can set the default output format to be used for\n" "the MathJax output. See the MathJax site (see:\n" - "http://docs.mathjax.org/en/latest/output.html) for more details.Possible\n" - "values are: HTML-CSS (which is slower, but has the best compatibility),\n" - "NativeMML (i.e. MathML) and SVG.\n" - "\n" + "http://docs.mathjax.org/en/latest/output.html) for more details.\n" + "Possible values are: HTML-CSS (which is slower, but has the best\n" + "compatibility), NativeMML (i.e. MathML) and SVG.\n" "The default value is: HTML-CSS.\n" - "\n" "This tag requires that the tag USE_MATHJAX is set to YES." ); doc->add( @@ -1400,9 +1417,8 @@ void addConfigDocs(DocIntf *doc) "MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax\n" "Content Delivery Network so you can quickly see the result without installing\n" "MathJax. However, it is strongly recommended to install a local copy of\n" - "MathJax from http://www.mathjax.org before deployment.The default value is:\n" - "http://cdn.mathjax.org/mathjax/latest.\n" - "\n" + "MathJax from http://www.mathjax.org before deployment.\n" + "The default value is: http://cdn.mathjax.org/mathjax/latest.\n" "This tag requires that the tag USE_MATHJAX is set to YES." ); doc->add( @@ -1410,7 +1426,6 @@ void addConfigDocs(DocIntf *doc) "The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax\n" "extension names that should be enabled during MathJax rendering. For example\n" "MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols\n" - "\n" "This tag requires that the tag USE_MATHJAX is set to YES." ); doc->add( @@ -1419,7 +1434,6 @@ void addConfigDocs(DocIntf *doc) "of code that will be used on startup of the MathJax code. See the MathJax site\n" "(see: http://docs.mathjax.org/en/latest/output.html) for more details. For an\n" "example see the documentation.\n" - "\n" "This tag requires that the tag USE_MATHJAX is set to YES." ); doc->add( @@ -1439,8 +1453,8 @@ void addConfigDocs(DocIntf *doc) "the search. The filter options can be selected when the cursor is inside the\n" "search box by pressing +. Also here use the \n" "to select a filter and or to activate or cancel the filter\n" - "option.Default value: YES.\n" - "\n" + "option.\n" + "The default value is: YES.\n" "This tag requires that the tag GENERATE_HTML is set to YES." ); doc->add( @@ -1451,8 +1465,8 @@ void addConfigDocs(DocIntf *doc) "EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for\n" "searching and an index file used by the script. When EXTERNAL_SEARCH is\n" "enabled the indexing and searching needs to be provided by external tools. See\n" - "the section \"External Indexing and Searching\" for details.Default value: NO.\n" - "\n" + "the section \"External Indexing and Searching\" for details.\n" + "The default value is: NO.\n" "This tag requires that the tag SEARCHENGINE is set to YES." ); doc->add( @@ -1467,9 +1481,8 @@ void addConfigDocs(DocIntf *doc) "(doxysearch.cgi) which are based on the open source search engine library\n" "Xapian (see: http://xapian.org/).\n" "\n" - "See the section \"External Indexing and Searching\" for details.Default value:\n" - "NO.\n" - "\n" + "See the section \"External Indexing and Searching\" for details.\n" + "The default value is: NO.\n" "This tag requires that the tag SEARCHENGINE is set to YES." ); doc->add( @@ -1481,16 +1494,14 @@ void addConfigDocs(DocIntf *doc) "(doxysearch.cgi) which are based on the open source search engine library\n" "Xapian (see: http://xapian.org/). See the section \"External Indexing and\n" "Searching\" for details.\n" - "\n" "This tag requires that the tag SEARCHENGINE is set to YES." ); doc->add( "SEARCHDATA_FILE", "When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed\n" "search data is written to a file for indexing by an external tool. With the\n" - "SEARCHDATA_FILE tag the name of this file can be specified.The default file\n" - "is: searchdata.xml.\n" - "\n" + "SEARCHDATA_FILE tag the name of this file can be specified.\n" + "The default file is: searchdata.xml.\n" "This tag requires that the tag SEARCHENGINE is set to YES." ); doc->add( @@ -1499,7 +1510,6 @@ void addConfigDocs(DocIntf *doc) "EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is\n" "useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple\n" "projects and redirect the results back to the right project.\n" - "\n" "This tag requires that the tag SEARCHENGINE is set to YES." ); doc->add( @@ -1510,20 +1520,19 @@ void addConfigDocs(DocIntf *doc) "unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of\n" "to a relative location where the documentation can be found. The format is:\n" "EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...\n" - "\n" "This tag requires that the tag SEARCHENGINE is set to YES." ); doc->add( "GENERATE_LATEX", - "If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX\n" - "output.Default value: YES." + "If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.\n" + "The default value is: YES." ); doc->add( "LATEX_OUTPUT", "The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a\n" "relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\n" - "it.The default directory is: latex.\n" - "\n" + "it.\n" + "The default directory is: latex.\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( @@ -1533,33 +1542,32 @@ void addConfigDocs(DocIntf *doc) "\n" "Note that when enabling USE_PDFLATEX this option is only used for generating\n" "bitmaps for formulas in the HTML output, but not in the Makefile that is\n" - "written to the output directory.The default file is: latex.\n" - "\n" + "written to the output directory.\n" + "The default file is: latex.\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( "MAKEINDEX_CMD_NAME", "The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate\n" - "index for LaTeX.The default file is: makeindex.\n" - "\n" + "index for LaTeX.\n" + "The default file is: makeindex.\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( "COMPACT_LATEX", "If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX\n" "documents. This may be useful for small projects and may help to save some\n" - "trees in general.Default value: NO.\n" - "\n" + "trees in general.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( "PAPER_TYPE", "The PAPER_TYPE tag can be used to set the paper type that is used by the\n" - "printer.Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches),\n" - "legal (8.5 x 14 inches) and executive (7.25 x 10.5 inches).\n" - "\n" + "printer.\n" + "Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x\n" + "14 inches) and executive (7.25 x 10.5 inches).\n" "The default value is: a4.\n" - "\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( @@ -1569,7 +1577,6 @@ void addConfigDocs(DocIntf *doc) "instance you can specify\n" "EXTRA_PACKAGES=times\n" "If left blank no extra packages will be included.\n" - "\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( @@ -1586,7 +1593,6 @@ void addConfigDocs(DocIntf *doc) "replace them by respectively the title of the page, the current date and time,\n" "only the current date, the version number of doxygen, the project name (see\n" "PROJECT_NAME), or the project number (see PROJECT_NUMBER).\n" - "\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( @@ -1596,7 +1602,6 @@ void addConfigDocs(DocIntf *doc) "chapter. If it is left blank doxygen will generate a standard footer.\n" "\n" "Note: Only use a user-defined footer if you know what you are doing!\n" - "\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( @@ -1605,7 +1610,6 @@ void addConfigDocs(DocIntf *doc) "other source files which should be copied to the LATEX_OUTPUT output\n" "directory. Note that the files will be copied as-is; there are no commands or\n" "markers available.\n" - "\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( @@ -1613,17 +1617,16 @@ void addConfigDocs(DocIntf *doc) "If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is\n" "prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will\n" "contain links (just like the HTML output) instead of page references. This\n" - "makes the output suitable for online browsing using a PDF viewer.Default\n" - "value: YES.\n" - "\n" + "makes the output suitable for online browsing using a PDF viewer.\n" + "The default value is: YES.\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( "USE_PDFLATEX", "If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate\n" "the PDF file directly from the LaTeX files. Set this option to YES to get a\n" - "higher quality PDF documentation.Default value: YES.\n" - "\n" + "higher quality PDF documentation.\n" + "The default value is: YES.\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( @@ -1631,16 +1634,15 @@ void addConfigDocs(DocIntf *doc) "If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode\n" "command to the generated LaTeX files. This will instruct LaTeX to keep running\n" "if errors occur, instead of asking the user for help. This option is also used\n" - "when generating formulas in HTML.Default value: NO.\n" - "\n" + "when generating formulas in HTML.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( "LATEX_HIDE_INDICES", "If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the\n" - "index chapters (such as File Index, Compound Index, etc.) in the\n" - "output.Default value: NO.\n" - "\n" + "index chapters (such as File Index, Compound Index, etc.) in the output.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( @@ -1649,39 +1651,39 @@ void addConfigDocs(DocIntf *doc) "code with syntax highlighting in the LaTeX output.\n" "\n" "Note that which sources are shown also depends on other settings such as\n" - "SOURCE_BROWSER.Default value: NO.\n" - "\n" + "SOURCE_BROWSER.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( "LATEX_BIB_STYLE", "The LATEX_BIB_STYLE tag can be used to specify the style to use for the\n" "bibliography, e.g. plainnat, or ieeetr. See\n" - "http://en.wikipedia.org/wiki/BibTeX and \\cite for more info.The default value\n" - "is: plain.\n" - "\n" + "http://en.wikipedia.org/wiki/BibTeX and \\cite for more info.\n" + "The default value is: plain.\n" "This tag requires that the tag GENERATE_LATEX is set to YES." ); doc->add( "GENERATE_RTF", "If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The\n" "RTF output is optimized for Word 97 and may not look too pretty with other RTF\n" - "readers/editors.Default value: NO." + "readers/editors.\n" + "The default value is: NO." ); doc->add( "RTF_OUTPUT", "The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a\n" "relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\n" - "it.The default directory is: rtf.\n" - "\n" + "it.\n" + "The default directory is: rtf.\n" "This tag requires that the tag GENERATE_RTF is set to YES." ); doc->add( "COMPACT_RTF", "If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF\n" "documents. This may be useful for small projects and may help to save some\n" - "trees in general.Default value: NO.\n" - "\n" + "trees in general.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_RTF is set to YES." ); doc->add( @@ -1692,8 +1694,8 @@ void addConfigDocs(DocIntf *doc) "browsing using Word or some other Word compatible readers that support those\n" "fields.\n" "\n" - "Note: WordPad (write) and others do not support links.Default value: NO.\n" - "\n" + "Note: WordPad (write) and others do not support links.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_RTF is set to YES." ); doc->add( @@ -1704,7 +1706,6 @@ void addConfigDocs(DocIntf *doc) "\n" "See also section \"Doxygen usage\" for information on how to generate the\n" "default style sheet that doxygen normally uses.\n" - "\n" "This tag requires that the tag GENERATE_RTF is set to YES." ); doc->add( @@ -1712,21 +1713,21 @@ void addConfigDocs(DocIntf *doc) "Set optional variables used in the generation of an RTF document. Syntax is\n" "similar to doxygen's config file. A template extensions file can be generated\n" "using doxygen -e rtf extensionFile.\n" - "\n" "This tag requires that the tag GENERATE_RTF is set to YES." ); doc->add( "GENERATE_MAN", "If the GENERATE_MAN tag is set to YES doxygen will generate man pages for\n" - "classes and files.Default value: NO." + "classes and files.\n" + "The default value is: NO." ); doc->add( "MAN_OUTPUT", "The MAN_OUTPUT tag is used to specify where the man pages will be put. If a\n" "relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\n" "it. A directory man3 will be created inside the directory specified by\n" - "MAN_OUTPUT.The default directory is: man.\n" - "\n" + "MAN_OUTPUT.\n" + "The default directory is: man.\n" "This tag requires that the tag GENERATE_MAN is set to YES." ); doc->add( @@ -1734,8 +1735,8 @@ void addConfigDocs(DocIntf *doc) "The MAN_EXTENSION tag determines the extension that is added to the generated\n" "man pages. In case the manual section does not start with a number, the number\n" "3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is\n" - "optional.The default value is: .3.\n" - "\n" + "optional.\n" + "The default value is: .3.\n" "This tag requires that the tag GENERATE_MAN is set to YES." ); doc->add( @@ -1743,37 +1744,34 @@ void addConfigDocs(DocIntf *doc) "If the MAN_LINKS tag is set to YES and doxygen generates man output, then it\n" "will generate one additional man file for each entity documented in the real\n" "man page(s). These additional files only source the real man page, but without\n" - "them the man command would be unable to find the correct page.Default value:\n" - "NO.\n" - "\n" + "them the man command would be unable to find the correct page.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_MAN is set to YES." ); doc->add( "GENERATE_XML", "If the GENERATE_XML tag is set to YES doxygen will generate an XML file that\n" - "captures the structure of the code including all documentation.Default value:\n" - "NO." + "captures the structure of the code including all documentation.\n" + "The default value is: NO." ); doc->add( "XML_OUTPUT", "The XML_OUTPUT tag is used to specify where the XML pages will be put. If a\n" "relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\n" - "it.The default directory is: xml.\n" - "\n" + "it.\n" + "The default directory is: xml.\n" "This tag requires that the tag GENERATE_XML is set to YES." ); doc->add( "XML_SCHEMA", "The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a\n" "validating XML parser to check the syntax of the XML files.\n" - "\n" "This tag requires that the tag GENERATE_XML is set to YES." ); doc->add( "XML_DTD", "The XML_DTD tag can be used to specify a XML DTD, which can be used by a\n" "validating XML parser to check the syntax of the XML files.\n" - "\n" "This tag requires that the tag GENERATE_XML is set to YES." ); doc->add( @@ -1781,21 +1779,22 @@ void addConfigDocs(DocIntf *doc) "If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program\n" "listings (including syntax highlighting and cross-referencing information) to\n" "the XML output. Note that enabling this will significantly increase the size\n" - "of the XML output.Default value: YES.\n" - "\n" + "of the XML output.\n" + "The default value is: YES.\n" "This tag requires that the tag GENERATE_XML is set to YES." ); doc->add( "GENERATE_DOCBOOK", "If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files\n" - "that can be used to generate PDF.Default value: NO." + "that can be used to generate PDF.\n" + "The default value is: NO." ); doc->add( "DOCBOOK_OUTPUT", "The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.\n" "If a relative path is entered the value of OUTPUT_DIRECTORY will be put in\n" - "front of it.The default directory is: docbook.\n" - "\n" + "front of it.\n" + "The default directory is: docbook.\n" "This tag requires that the tag GENERATE_DOCBOOK is set to YES." ); doc->add( @@ -1803,22 +1802,23 @@ void addConfigDocs(DocIntf *doc) "If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen\n" "Definitions (see http://autogen.sf.net) file that captures the structure of\n" "the code including all documentation. Note that this feature is still\n" - "experimental and incomplete at the moment.Default value: NO." + "experimental and incomplete at the moment.\n" + "The default value is: NO." ); doc->add( "GENERATE_PERLMOD", "If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module\n" "file that captures the structure of the code including all documentation.\n" "\n" - "Note that this feature is still experimental and incomplete at the\n" - "moment.Default value: NO." + "Note that this feature is still experimental and incomplete at the moment.\n" + "The default value is: NO." ); doc->add( "PERLMOD_LATEX", "If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary\n" "Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI\n" - "output from the Perl module output.Default value: NO.\n" - "\n" + "output from the Perl module output.\n" + "The default value is: NO.\n" "This tag requires that the tag GENERATE_PERLMOD is set to YES." ); doc->add( @@ -1827,8 +1827,8 @@ void addConfigDocs(DocIntf *doc) "formatted so it can be parsed by a human reader. This is useful if you want to\n" "understand what is going on. On the other hand, if this tag is set to NO the\n" "size of the Perl module output will be much smaller and Perl will parse it\n" - "just the same.Default value: YES.\n" - "\n" + "just the same.\n" + "The default value is: YES.\n" "This tag requires that the tag GENERATE_PERLMOD is set to YES." ); doc->add( @@ -1837,37 +1837,36 @@ void addConfigDocs(DocIntf *doc) "prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful\n" "so different doxyrules.make files included by the same Makefile don't\n" "overwrite each other's variables.\n" - "\n" "This tag requires that the tag GENERATE_PERLMOD is set to YES." ); doc->add( "ENABLE_PREPROCESSING", "If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all\n" - "C-preprocessor directives found in the sources and include files.Default\n" - "value: YES." + "C-preprocessor directives found in the sources and include files.\n" + "The default value is: YES." ); doc->add( "MACRO_EXPANSION", "If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names\n" "in the source code. If set to NO only conditional compilation will be\n" "performed. Macro expansion can be done in a controlled way by setting\n" - "EXPAND_ONLY_PREDEF to YES.Default value: NO.\n" - "\n" + "EXPAND_ONLY_PREDEF to YES.\n" + "The default value is: NO.\n" "This tag requires that the tag ENABLE_PREPROCESSING is set to YES." ); doc->add( "EXPAND_ONLY_PREDEF", "If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then\n" "the macro expansion is limited to the macros specified with the PREDEFINED and\n" - "EXPAND_AS_DEFINED tags.Default value: NO.\n" - "\n" + "EXPAND_AS_DEFINED tags.\n" + "The default value is: NO.\n" "This tag requires that the tag ENABLE_PREPROCESSING is set to YES." ); doc->add( "SEARCH_INCLUDES", "If the SEARCH_INCLUDES tag is set to YES the includes files in the\n" - "INCLUDE_PATH will be searched if a #include is found.Default value: YES.\n" - "\n" + "INCLUDE_PATH will be searched if a #include is found.\n" + "The default value is: YES.\n" "This tag requires that the tag ENABLE_PREPROCESSING is set to YES." ); doc->add( @@ -1875,7 +1874,6 @@ void addConfigDocs(DocIntf *doc) "The INCLUDE_PATH tag can be used to specify one or more directories that\n" "contain include files that are not input files but should be processed by the\n" "preprocessor.\n" - "\n" "This tag requires that the tag SEARCH_INCLUDES is set to YES." ); doc->add( @@ -1884,7 +1882,6 @@ void addConfigDocs(DocIntf *doc) "patterns (like *.h and *.hpp) to filter out the header-files in the\n" "directories. If left blank, the patterns specified with FILE_PATTERNS will be\n" "used.\n" - "\n" "This tag requires that the tag ENABLE_PREPROCESSING is set to YES." ); doc->add( @@ -1895,7 +1892,6 @@ void addConfigDocs(DocIntf *doc) "name=definition (no spaces). If the definition and the \"=\" are omitted, \"=1\"\n" "is assumed. To prevent a macro definition from being undefined via #undef or\n" "recursively expanded use the := operator instead of the = operator.\n" - "\n" "This tag requires that the tag ENABLE_PREPROCESSING is set to YES." ); doc->add( @@ -1905,7 +1901,6 @@ void addConfigDocs(DocIntf *doc) "macro definition that is found in the sources will be used. Use the PREDEFINED\n" "tag if you want to use a different macro definition that overrules the\n" "definition found in the source code.\n" - "\n" "This tag requires that the tag ENABLE_PREPROCESSING is set to YES." ); doc->add( @@ -1914,8 +1909,8 @@ void addConfigDocs(DocIntf *doc) "remove all refrences to function-like macros that are alone on a line, have an\n" "all uppercase name, and do not end with a semicolon. Such function macros are\n" "typically used for boiler-plate code, and will confuse the parser if not\n" - "removed.Default value: YES.\n" - "\n" + "removed.\n" + "The default value is: YES.\n" "This tag requires that the tag ENABLE_PREPROCESSING is set to YES." ); doc->add( @@ -1942,26 +1937,28 @@ void addConfigDocs(DocIntf *doc) doc->add( "ALLEXTERNALS", "If the ALLEXTERNALS tag is set to YES all external class will be listed in the\n" - "class index. If set to NO only the inherited external classes will be\n" - "listed.Default value: NO." + "class index. If set to NO only the inherited external classes will be listed.\n" + "The default value is: NO." ); doc->add( "EXTERNAL_GROUPS", "If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in\n" "the modules index. If set to NO, only the current project's groups will be\n" - "listed.Default value: YES." + "listed.\n" + "The default value is: YES." ); doc->add( "EXTERNAL_PAGES", "If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in\n" "the related pages index. If set to NO, only the current project's pages will\n" - "be listed.Default value: YES." + "be listed.\n" + "The default value is: YES." ); doc->add( "PERL_PATH", "The PERL_PATH should be the absolute path and name of the perl script\n" - "interpreter (i.e. the result of 'which perl').The default file (with absolute\n" - "path) is: /usr/bin/perl." + "interpreter (i.e. the result of 'which perl').\n" + "The default file (with absolute path) is: /usr/bin/perl." ); doc->add( "CLASS_DIAGRAMS", @@ -1969,7 +1966,8 @@ void addConfigDocs(DocIntf *doc) "(in HTML and LaTeX) for classes with base or super classes. Setting the tag to\n" "NO turns the diagrams off. Note that this option also works with HAVE_DOT\n" "disabled, but it is recommended to install and use dot, since it yields more\n" - "powerful graphs.Default value: YES." + "powerful graphs.\n" + "The default value is: YES." ); doc->add( "MSCGEN_PATH", @@ -1983,8 +1981,8 @@ void addConfigDocs(DocIntf *doc) doc->add( "HIDE_UNDOC_RELATIONS", "If set to YES, the inheritance and collaboration graphs will hide inheritance\n" - "and usage relations if the target is undocumented or is not a class.Default\n" - "value: YES." + "and usage relations if the target is undocumented or is not a class.\n" + "The default value is: YES." ); doc->add( "HAVE_DOT", @@ -1992,7 +1990,8 @@ void addConfigDocs(DocIntf *doc) "available from the path. This tool is part of Graphviz (see:\n" "http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent\n" "Bell Labs. The other options in this section have no effect if this option is\n" - "set to NODefault value: NO." + "set to NO\n" + "The default value is: NO." ); doc->add( "DOT_NUM_THREADS", @@ -2000,8 +1999,8 @@ void addConfigDocs(DocIntf *doc) "to run in parallel. When set to 0 doxygen will base this on the number of\n" "processors available in the system. You can set it explicitly to a value\n" "larger than 0 to get control over the balance between CPU load and processing\n" - "speed. Minimum value: 0, maximum value: 32, default value: 0.\n" - "\n" + "speed.\n" + "Minimum value: 0, maximum value: 32, default value: 0.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2010,16 +2009,15 @@ void addConfigDocs(DocIntf *doc) "generates you can specify the font name using DOT_FONTNAME. You need to make\n" "sure dot is able to find the font, which can be done by putting it in a\n" "standard location or by setting the DOTFONTPATH environment variable or by\n" - "setting DOT_FONTPATH to the directory containing the font.The default value\n" - "is: Helvetica.\n" - "\n" + "setting DOT_FONTPATH to the directory containing the font.\n" + "The default value is: Helvetica.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( "DOT_FONTSIZE", "The DOT_FONTSIZE tag can be used to set the size (in points) of the font of\n" - "dot graphs. Minimum value: 4, maximum value: 24, default value: 10.\n" - "\n" + "dot graphs.\n" + "Minimum value: 4, maximum value: 24, default value: 10.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2027,16 +2025,14 @@ void addConfigDocs(DocIntf *doc) "By default doxygen will tell dot to use the default font as specified with\n" "DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set\n" "the path where dot can find it using this tag.\n" - "\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( "CLASS_GRAPH", "If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for\n" "each documented class showing the direct and indirect inheritance relations.\n" - "Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.Default value:\n" - "YES.\n" - "\n" + "Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.\n" + "The default value is: YES.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2044,23 +2040,23 @@ void addConfigDocs(DocIntf *doc) "If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a\n" "graph for each documented class showing the direct and indirect implementation\n" "dependencies (inheritance, containment, and class references variables) of the\n" - "class with other documented classes.Default value: YES.\n" - "\n" + "class with other documented classes.\n" + "The default value is: YES.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( "GROUP_GRAPHS", "If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for\n" - "groups, showing the direct groups dependencies.Default value: YES.\n" - "\n" + "groups, showing the direct groups dependencies.\n" + "The default value is: YES.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( "UML_LOOK", "If the UML_LOOK tag is set to YES doxygen will generate inheritance and\n" "collaboration diagrams in a style similar to the OMG's Unified Modeling\n" - "Language.Default value: NO.\n" - "\n" + "Language.\n" + "The default value is: NO.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2072,16 +2068,16 @@ void addConfigDocs(DocIntf *doc) "for no limit. Note that the threshold may be exceeded by 50% before the limit\n" "is enforced. So when you set the threshold to 10, up to 15 fields may appear,\n" "but if the number exceeds 15, the total amount of fields shown is limited to\n" - "10. Minimum value: 0, maximum value: 100, default value: 10.\n" - "\n" + "10.\n" + "Minimum value: 0, maximum value: 100, default value: 10.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( "TEMPLATE_RELATIONS", "If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and\n" "collaboration graphs will show the relations between templates and their\n" - "instances.Default value: NO.\n" - "\n" + "instances.\n" + "The default value is: NO.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2089,8 +2085,8 @@ void addConfigDocs(DocIntf *doc) "If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to\n" "YES then doxygen will generate a graph for each documented file showing the\n" "direct and indirect include dependencies of the file with other documented\n" - "files.Default value: YES.\n" - "\n" + "files.\n" + "The default value is: YES.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2098,8 +2094,8 @@ void addConfigDocs(DocIntf *doc) "If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are\n" "set to YES then doxygen will generate a graph for each documented file showing\n" "the direct and indirect include dependencies of the file with other documented\n" - "files.Default value: YES.\n" - "\n" + "files.\n" + "The default value is: YES.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2109,8 +2105,8 @@ void addConfigDocs(DocIntf *doc) "\n" "Note that enabling this option will significantly increase the time of a run.\n" "So in most cases it will be better to enable call graphs for selected\n" - "functions only using the \\callgraph command.Default value: NO.\n" - "\n" + "functions only using the \\callgraph command.\n" + "The default value is: NO.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2120,15 +2116,15 @@ void addConfigDocs(DocIntf *doc) "\n" "Note that enabling this option will significantly increase the time of a run.\n" "So in most cases it will be better to enable caller graphs for selected\n" - "functions only using the \\callergraph command.Default value: NO.\n" - "\n" + "functions only using the \\callergraph command.\n" + "The default value is: NO.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( "GRAPHICAL_HIERARCHY", "If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical\n" - "hierarchy of all classes instead of a textual one.Default value: YES.\n" - "\n" + "hierarchy of all classes instead of a textual one.\n" + "The default value is: YES.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2136,8 +2132,8 @@ void addConfigDocs(DocIntf *doc) "If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the\n" "dependencies a directory has on other directories in a graphical way. The\n" "dependency relations are determined by the #include relations between the\n" - "files in the directories.Default value: YES.\n" - "\n" + "files in the directories.\n" + "The default value is: YES.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2146,10 +2142,9 @@ void addConfigDocs(DocIntf *doc) "generated by dot.\n" "Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order\n" "to make the SVG files visible in IE 9+ (other browsers do not have this\n" - "requirement).Possible values are: png, jpg, gif and svg.\n" - "\n" + "requirement).\n" + "Possible values are: png, jpg, gif and svg.\n" "The default value is: png.\n" - "\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2160,16 +2155,14 @@ void addConfigDocs(DocIntf *doc) "Note that this requires a modern browser other than Internet Explorer. Tested\n" "and working are Firefox, Chrome, Safari, and Opera.\n" "Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make\n" - "the SVG files visible. Older versions of IE do not have SVG support.Default\n" - "value: NO.\n" - "\n" + "the SVG files visible. Older versions of IE do not have SVG support.\n" + "The default value is: NO.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( "DOT_PATH", "The DOT_PATH tag can be used to specify the path where the dot tool can be\n" "found. If left blank, it is assumed the dot tool can be found in the path.\n" - "\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2177,7 +2170,6 @@ void addConfigDocs(DocIntf *doc) "The DOTFILE_DIRS tag can be used to specify one or more directories that\n" "contain dot files that are included in the documentation (see the \\dotfile\n" "command).\n" - "\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2194,9 +2186,8 @@ void addConfigDocs(DocIntf *doc) "by representing a node as a red box. Note that doxygen if the number of direct\n" "children of the root node in a graph is already larger than\n" "DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that\n" - "the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. Minimum\n" - "value: 0, maximum value: 10000, default value: 50.\n" - "\n" + "the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.\n" + "Minimum value: 0, maximum value: 10000, default value: 50.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2207,9 +2198,8 @@ void addConfigDocs(DocIntf *doc) "further from the root node will be omitted. Note that setting this option to 1\n" "or 2 may greatly reduce the computation time needed for large code bases. Also\n" "note that the size of a graph can be further restricted by\n" - "DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. Minimum\n" - "value: 0, maximum value: 1000, default value: 0.\n" - "\n" + "DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.\n" + "Minimum value: 0, maximum value: 1000, default value: 0.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2220,8 +2210,8 @@ void addConfigDocs(DocIntf *doc) "\n" "Warning: Depending on the platform used, enabling this option may lead to\n" "badly anti-aliased labels on the edges of a graph (i.e. they become hard to\n" - "read).Default value: NO.\n" - "\n" + "read).\n" + "The default value is: NO.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( @@ -2229,23 +2219,23 @@ void addConfigDocs(DocIntf *doc) "Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output\n" "files in one run (i.e. multiple -o and -T options on the command line). This\n" "makes dot run faster, but since only newer versions of dot (>1.8.10) support\n" - "this, this feature is disabled by default.Default value: NO.\n" - "\n" + "this, this feature is disabled by default.\n" + "The default value is: NO.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( "GENERATE_LEGEND", "If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page\n" "explaining the meaning of the various boxes and arrows in the dot generated\n" - "graphs.Default value: YES.\n" - "\n" + "graphs.\n" + "The default value is: YES.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); doc->add( "DOT_CLEANUP", "If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot\n" - "files that are used to generate the various graphs.Default value: YES.\n" - "\n" + "files that are used to generate the various graphs.\n" + "The default value is: YES.\n" "This tag requires that the tag HAVE_DOT is set to YES." ); } diff --git a/addon/doxywizard/expert.cpp b/addon/doxywizard/expert.cpp index 8278641..efc5b00 100644 --- a/addon/doxywizard/expert.cpp +++ b/addon/doxywizard/expert.cpp @@ -112,7 +112,8 @@ void Expert::createTopics(const QDomElement &rootElem) { if (childElem.tagName()==SA("group")) { - QString name = childElem.attribute(SA("name")); + // Remove _ from a group name like: Source_Browser + QString name = childElem.attribute(SA("name")).replace(SA("_"),SA(" ")); items.append(new QTreeWidgetItem((QTreeWidget*)0,QStringList(name))); QWidget *widget = createTopicWidget(childElem); m_topics[name] = widget; @@ -144,7 +145,7 @@ static QString getDocsForNode(const QDomElement &child) QDomText t = n.toText(); if (!t.isNull()) docs+=t.data(); } - docs+=SA("
"); + docs += SA("
"); } docsVal = docsVal.nextSiblingElement(); } @@ -152,6 +153,7 @@ static QString getDocsForNode(const QDomElement &child) // for an enum we list the values if (type==SA("enum")) { + docs += SA("
"); docs += SA("Possible values are: "); int numValues=0; docsVal = child.firstChildElement(); @@ -192,29 +194,35 @@ static QString getDocsForNode(const QDomElement &child) docsVal = docsVal.nextSiblingElement(); } docs+=SA("
"); - docs+=SA("The default value is: ")+ + docs+=SA("
"); + docs+=SA(" The default value is: ")+ child.attribute(SA("defval"))+ SA("."); + docs+= SA("
"); } else if (type==SA("int")) { + docs+=SA("
"); docs+=SA("Minimum value: ")+child.attribute(SA("minval"))+SA(", "); docs+=SA("maximum value: ")+child.attribute(SA("maxval"))+SA(", "); docs+=SA("default value: ")+child.attribute(SA("defval"))+SA("."); + docs+= SA("
"); } else if (type==SA("bool")) { + docs+=SA("
"); if (child.hasAttribute(SA("altdefval"))) { - docs+=SA("The default value is: system dependent."); + docs+=SA(" The default value is: system dependent."); } else { QString defval = child.attribute(SA("defval")); - docs+=SA("The default value is: ")+ + docs+=SA(" The default value is: ")+ (defval==SA("1")?SA("YES"):SA("NO"))+ SA("."); } + docs+= SA("
"); } else if (type==SA("list")) { @@ -226,7 +234,12 @@ static QString getDocsForNode(const QDomElement &child) { if (docsVal.tagName()==SA("value")) { - if (docsVal.attribute(SA("name"))!=SA("")) numValues++; + QString showDocu = SA(""); + if (docsVal.hasAttribute(SA("show_docu"))) + { + showDocu = docsVal.attribute(SA("show_docu")).toLower(); + } + if ((showDocu != SA("no")) && (docsVal.attribute(SA("name"))!=SA(""))) numValues++; } docsVal = docsVal.nextSiblingElement(); } @@ -238,29 +251,38 @@ static QString getDocsForNode(const QDomElement &child) { if (docsVal.tagName()==SA("value")) { - i++; - docs += SA("") + docsVal.attribute(SA("name")) + SA(""); - QString desc = docsVal.attribute(SA("desc")); - if (desc != SA("")) - { - docs += SA(" ") + desc; - } - if (i==numValues-1) + QString showDocu = SA(""); + if (docsVal.hasAttribute(SA("show_docu"))) { - docs += SA(" and "); + showDocu = docsVal.attribute(SA("show_docu")).toLower(); } - else if (i==numValues) + if ((showDocu != SA("no")) && (docsVal.attribute(SA("name"))!=SA(""))) { - docs += SA("."); - } - else - { - docs += SA(", "); + i++; + docs += SA("") + docsVal.attribute(SA("name")) + SA(""); + QString desc = docsVal.attribute(SA("desc")); + if (desc != SA("")) + { + docs += SA(" ") + desc; + } + if (i==numValues-1) + { + docs += SA(" and "); + } + else if (i==numValues) + { + docs += SA("."); + } + else + { + docs += SA(", "); + } } } docsVal = docsVal.nextSiblingElement(); } } + // docs+= SA("
"); } } else if (type==SA("string")) @@ -270,7 +292,9 @@ static QString getDocsForNode(const QDomElement &child) { if (defval != SA("")) { - docs += SA("The default directory is: ") + defval + SA("."); + docs+=SA("
"); + docs += SA(" The default directory is: ") + defval + SA("."); + docs += SA("
"); } } else if (child.attribute(SA("format")) == SA("file")) @@ -278,20 +302,24 @@ static QString getDocsForNode(const QDomElement &child) QString abspath = child.attribute(SA("abspath")); if (defval != SA("")) { + docs+=SA("
"); if (abspath != SA("1")) { - docs += SA("The default file is: ") + defval + SA("."); + docs += SA(" The default file is: ") + defval + SA("."); } else { - docs += SA("The default file (with absolute path) is: ") + defval + SA("."); + docs += SA(" The default file (with absolute path) is: ") + defval + SA("."); } + docs += SA("
"); } else { if (abspath == SA("1")) { - docs += SA("The file has to be specified with full path."); + docs+=SA("
"); + docs += SA(" The file has to be specified with full path."); + docs += SA("
"); } } } @@ -299,7 +327,9 @@ static QString getDocsForNode(const QDomElement &child) { if (defval != SA("")) { - docs += SA("The default value is: ") + defval + SA("."); + docs+=SA("
"); + docs += SA(" The default value is: ") + defval + SA("."); + docs += SA("
"); } } } @@ -307,8 +337,8 @@ static QString getDocsForNode(const QDomElement &child) if (child.hasAttribute(SA("depends"))) { QString dependsOn = child.attribute(SA("depends")); - docs += SA("
"); - docs+= SA("This tag requires that the tag \\ref cfg_"); + docs+=SA("
"); + docs+= SA(" This tag requires that the tag \\ref cfg_"); docs+= dependsOn.toLower(); docs+= SA(" \""); docs+= dependsOn.toUpper(); @@ -324,13 +354,22 @@ static QString getDocsForNode(const QDomElement &child) // remove
at end regexp.setPattern(SA("
*$")); docs.replace(regexp,SA(" ")); - // \c word -> word + // \c word -> word; word ends with ')', ',', '.' or ' ' + regexp.setPattern(SA("\\\\c[ ]+([^ \\)]+)\\)")); + docs.replace(regexp,SA("\\1)")); + + regexp.setPattern(SA("\\\\c[ ]+([^ ,]+),")); + docs.replace(regexp,SA("\\1,")); + + regexp.setPattern(SA("\\\\c[ ]+([^ \\.]+)\\.")); + docs.replace(regexp,SA("\\1.")); + regexp.setPattern(SA("\\\\c[ ]+([^ ]+) ")); docs.replace(regexp,SA("\\1 ")); // `word` -> word docs.replace(SA("``"),SA("")); regexp.setPattern(SA("`([^`]+)`")); - docs.replace(regexp,SA("\\1 ")); + docs.replace(regexp,SA("\\1")); // \ref key "desc" -> desc regexp.setPattern(SA("\\\\ref[ ]+[^ ]+[ ]+\"([^ ]+)\"")); docs.replace(regexp,SA("\\1 ")); @@ -683,7 +722,7 @@ void Expert::saveTopic(QTextStream &t,QDomElement &elem,QTextCodec *codec, t << convertToComment(option->templateDocs()); t << endl; } - t << name.leftJustified(23) << "= "; + t << name.leftJustified(MAX_OPTION_LENGTH) << "= "; if (option) { option->writeValue(t,codec); @@ -744,9 +783,10 @@ void Expert::showHelp(Input *option) m_helper->setText( QString::fromAscii("")+option->id()+ QString::fromAscii("
")+ + QString::fromAscii("
")+ option->docs(). replace(QChar::fromAscii('\n'),QChar::fromAscii(' '))+ - QString::fromAscii("") + QString::fromAscii("") ); m_inShowHelp = FALSE; } diff --git a/doc/config.doc b/doc/config.doc index 14627a7..5bd9e8e 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -329,6 +329,7 @@ followed by the descriptions of the tags grouped by category. 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. + The default value is: UTF-8. \anchor cfg_project_name @@ -338,6 +339,7 @@ The default value is: UTF-8. surrounded by double-quotes, unless you are using Doxywizard) that should identify the project for which the documentation is generated. This name is used in the title of most generated pages and in a few other places. + The default value is: My Project. \anchor cfg_project_number @@ -380,6 +382,7 @@ The default value is: My Project. files, where putting all generated files in the same directory would otherwise causes performance problems for the file system. + The default value is: NO. \anchor cfg_output_language @@ -430,6 +433,7 @@ Possible values are: Ukrainian and Vietnamese. + The default value is: English. \anchor cfg_brief_member_desc @@ -440,6 +444,7 @@ The default value is: English. the file and class documentation (similar to \c Javadoc). Set to \c NO to disable this. + The default value is: YES. \anchor cfg_repeat_brief @@ -453,6 +458,7 @@ The default value is: YES. \ref cfg_brief_member_desc "BRIEF_MEMBER_DESC" are set to \c NO, the brief descriptions will be completely suppressed. + The default value is: YES. \anchor cfg_abbreviate_brief @@ -485,6 +491,7 @@ The default value is: YES. doxygen will generate a detailed section even if there is only a brief description. + The default value is: NO. \anchor cfg_inline_inherited_memb @@ -495,6 +502,7 @@ The default value is: NO. ordinary class members. Constructors, destructors and assignment operators of the base classes will not be shown. + The default value is: NO. \anchor cfg_full_path_names @@ -504,6 +512,7 @@ The default value is: NO. path before files name in the file list and in the header files. If set to \c NO the shortest path that makes the file name unique will be used + The default value is: YES. \anchor cfg_strip_from_path @@ -519,6 +528,7 @@ The default value is: YES. relative paths, which will be relative from the directory where doxygen is started. + This tag requires that the tag \ref cfg_full_path_names "FULL_PATH_NAMES" is set to \c YES. \anchor cfg_strip_from_inc_path
\c STRIP_FROM_INC_PATH
@@ -537,6 +547,7 @@ This tag requires that the tag \ref cfg_full_path_names "FULL_PATH_NAMES" is set (but less readable) file names. This can be useful is your file systems doesn't support long names like on DOS, Mac, or CD-ROM. + The default value is: NO. \anchor cfg_javadoc_autobrief @@ -548,6 +559,7 @@ The default value is: NO. Javadoc-style will behave just like regular Qt-style comments (thus requiring an explicit \ref cmdbrief "\@brief" command for a brief description.) + The default value is: NO. \anchor cfg_qt_autobrief @@ -559,6 +571,7 @@ The default value is: NO. Qt-style will behave just like regular Qt-style comments (thus requiring an explicit \ref cmdbrief "\\brief" command for a brief description.) + The default value is: NO. \anchor cfg_multiline_cpp_is_brief @@ -572,6 +585,7 @@ The default value is: NO.
Note that setting this tag to \c YES also means that rational rose comments are not recognized any more. + The default value is: NO. \anchor cfg_inherit_docs @@ -581,6 +595,7 @@ The default value is: NO. member inherits the documentation from any documented member that it re-implements. + The default value is: YES. \anchor cfg_separate_member_pages @@ -590,6 +605,7 @@ The default value is: YES. a new page for each member. If set to \c NO, the documentation of a member will be part of the file/class/namespace that contains it. + The default value is: NO. \anchor cfg_tab_size @@ -598,6 +614,7 @@ The default value is: NO. The \c TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen uses this value to replace tabs by spaces in code fragments. + Minimum value: 1, maximum value: 16, default value: 4. \anchor cfg_aliases @@ -633,6 +650,7 @@ The default value is: NO. for C. For instance, some of the names that are used will be different. The list of all members will be omitted, etc. + The default value is: NO. \anchor cfg_optimize_output_java @@ -643,6 +661,7 @@ The default value is: NO. for that language. For instance, namespaces will be presented as packages, qualified scopes will look different, etc. + The default value is: NO. \anchor cfg_optimize_for_fortran @@ -651,6 +670,7 @@ The default value is: NO. Set the \c OPTIMIZE_FOR_FORTRAN tag to \c YES if your project consists of Fortran sources. Doxygen will then generate output that is tailored for Fortran. + The default value is: NO. \anchor cfg_optimize_output_vhdl @@ -659,6 +679,7 @@ The default value is: NO. Set the \c OPTIMIZE_OUTPUT_VHDL tag to \c YES if your project consists of VHDL sources. Doxygen will then generate output that is tailored for VHDL. + The default value is: NO. \anchor cfg_extension_mapping @@ -689,6 +710,7 @@ The default value is: NO. can mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in case of backward compatibilities issues. + The default value is: YES. \anchor cfg_autolink_support @@ -699,6 +721,7 @@ The default value is: YES. 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. + The default value is: YES. \anchor cfg_builtin_stl_support @@ -711,6 +734,7 @@ The default value is: YES. `func(std::string) {}`). This also make the inheritance and collaboration diagrams that involve STL classes more complete and accurate. + The default value is: NO. \anchor cfg_cpp_cli_support @@ -719,6 +743,7 @@ The default value is: NO. If you use Microsoft's C++/CLI language, you should set this option to \c YES to enable parsing support. + The default value is: NO. \anchor cfg_sip_support @@ -729,6 +754,7 @@ The default value is: NO. Doxygen will parse them like normal C++ but will assume all classes use public instead of private inheritance when no explicit protection keyword is present. + The default value is: NO. \anchor cfg_idl_property_support @@ -741,6 +767,7 @@ The default value is: NO. setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to \c NO. + The default value is: YES. \anchor cfg_distribute_group_doc @@ -751,6 +778,7 @@ The default value is: YES. member in the group (if any) for the other members of the group. By default all members of a group must be documented explicitly. + The default value is: NO. \anchor cfg_subgrouping @@ -762,6 +790,7 @@ The default value is: NO. \c NO to prevent subgrouping. Alternatively, this can be done per class using the \ref cmdnosubgrouping "\\nosubgrouping" command. + The default value is: YES. \anchor cfg_inline_grouped_classes @@ -774,6 +803,7 @@ The default value is: YES.
Note that this feature does not work in combination with \ref cfg_separate_member_pages "SEPARATE_MEMBER_PAGES". + The default value is: NO. \anchor cfg_inline_simple_structs @@ -786,6 +816,7 @@ The default value is: NO. to \c NO, structs, classes, and unions are shown on a separate page (for HTML and Man pages) or section (for \f$\mbox{\LaTeX}\f$ and RTF). + The default value is: NO. \anchor cfg_typedef_hides_struct @@ -799,6 +830,7 @@ The default value is: NO. be useful for C code in case the coding convention dictates that all compound types are typedef'ed and only the typedef is referenced, never the tag name. + The default value is: NO. \anchor cfg_lookup_cache_size @@ -815,6 +847,7 @@ The default value is: NO. At the end of a run doxygen will report the cache usage and suggest the optimal cache size from a speed point of view. + Minimum value: 0, maximum value: 9, default value: 0. @@ -828,11 +861,12 @@ The default value is: NO. entities in documentation are documented, even if no documentation was available. Private class members and static file members will be hidden unless the \ref cfg_extract_private "EXTRACT_PRIVATE" respectively - \ref cfg_extract_static "EXTRACT_STATIC" tags are set to \c YES + \ref cfg_extract_static "EXTRACT_STATIC" tags are 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 + set to \c YES. + The default value is: NO. @@ -842,6 +876,7 @@ The default value is: NO. If the \c EXTRACT_PRIVATE tag is set to \c YES all private members of a class will be included in the documentation. + The default value is: NO. \anchor cfg_extract_package @@ -850,6 +885,7 @@ The default value is: NO. If the \c EXTRACT_PACKAGE tag is set to \c YES all members with package or internal scope will be included in the documentation. + The default value is: NO. \anchor cfg_extract_static @@ -858,6 +894,7 @@ The default value is: NO. If the \c EXTRACT_STATIC tag is set to \c YES all static members of a file will be included in the documentation. + The default value is: NO. \anchor cfg_extract_local_classes @@ -868,6 +905,7 @@ The default value is: NO. If set to \c NO only classes defined in header files are included. Does not have any effect for Java sources. + The default value is: YES. \anchor cfg_extract_local_methods @@ -878,6 +916,7 @@ The default value is: YES. the interface are included in the documentation. If set to \c NO only methods in the interface are included. + The default value is: NO. \anchor cfg_extract_anon_nspaces @@ -888,6 +927,7 @@ The default value is: NO. where file will be replaced with the base name of the file that contains the anonymous namespace. By default anonymous namespace are hidden. + The default value is: NO. \anchor cfg_hide_undoc_members @@ -899,6 +939,7 @@ The default value is: NO. various overviews, but no documentation section is generated. This option has no effect if \ref cfg_extract_all "EXTRACT_ALL" is enabled. + The default value is: NO. \anchor cfg_hide_undoc_classes @@ -910,6 +951,7 @@ The default value is: NO. various overviews. This option has no effect if \ref cfg_extract_all "EXTRACT_ALL" is enabled. + The default value is: NO. \anchor cfg_hide_friend_compounds @@ -920,6 +962,7 @@ The default value is: NO. If set to \c NO these declarations will be included in the documentation. + The default value is: NO. \anchor cfg_hide_in_body_docs @@ -930,6 +973,7 @@ The default value is: NO. If set to \c NO these blocks will be appended to the function's detailed documentation block. + The default value is: NO. \anchor cfg_internal_docs @@ -940,6 +984,7 @@ The default value is: NO. to \c NO then the documentation will be excluded. Set it to \c YES to include the internal documentation. + The default value is: NO. \anchor cfg_case_sense_names @@ -952,7 +997,8 @@ The default value is: NO. supports case sensitive file names. Windows and Mac users are advised to set this option to \c NO. -Default value is system dependent. + +The default value is system dependent. \anchor cfg_hide_scope_names
\c HIDE_SCOPE_NAMES
@@ -961,6 +1007,7 @@ Default value is system dependent. will show members with their full class and namespace scopes in the documentation. If set to \c YES the scope will be hidden. + The default value is: NO. \anchor cfg_show_include_files @@ -970,6 +1017,7 @@ The default value is: NO. will put a list of the files that are included by a file in the documentation of that file. + The default value is: YES. \anchor cfg_force_local_includes @@ -979,6 +1027,7 @@ The default value is: YES. will list include files with double quotes in the documentation rather than with sharp brackets. + The default value is: NO. \anchor cfg_inline_info @@ -987,6 +1036,7 @@ The default value is: NO. If the \c INLINE_INFO tag is set to \c YES then a tag [inline] is inserted in the documentation for inline members. + The default value is: YES. \anchor cfg_sort_member_docs @@ -997,6 +1047,7 @@ The default value is: YES. alphabetically by member name. If set to \c NO the members will appear in declaration order. + The default value is: YES. \anchor cfg_sort_brief_docs @@ -1007,6 +1058,7 @@ The default value is: YES. by member name. If set to \c NO the members will appear in declaration order. + The default value is: NO. \anchor cfg_sort_members_ctors_1st @@ -1022,6 +1074,7 @@ The default value is: NO. \note If \ref cfg_sort_member_docs "SORT_MEMBER_DOCS" is set to \c NO this option is ignored for sorting detailed member documentation. + The default value is: NO. \anchor cfg_sort_group_names @@ -1031,6 +1084,7 @@ The default value is: NO. hierarchy of group names into alphabetical order. If set to \c NO the group names will appear in their defined order. + The default value is: NO. \anchor cfg_sort_by_scope_name @@ -1044,6 +1098,7 @@ The default value is: NO. \note This option applies only to the class list, not to the alphabetical list. + The default value is: NO. \anchor cfg_strict_proto_matching @@ -1056,6 +1111,7 @@ The default value is: NO. 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. + The default value is: NO. \anchor cfg_generate_todolist @@ -1065,6 +1121,7 @@ The default value is: NO. disable (\c NO) the todo list. This list is created by putting \ref cmdtodo "\\todo" commands in the documentation. + The default value is: YES. \anchor cfg_generate_testlist @@ -1074,6 +1131,7 @@ The default value is: YES. disable (\c NO) the test list. This list is created by putting \ref cmdtest "\\test" commands in the documentation. + The default value is: YES. \anchor cfg_generate_buglist @@ -1083,6 +1141,7 @@ The default value is: YES. disable (\c NO) the bug list. This list is created by putting \ref cmdbug "\\bug" commands in the documentation. + The default value is: YES. \anchor cfg_generate_deprecatedlist @@ -1093,6 +1152,7 @@ The default value is: YES. putting \ref cmddeprecated "\\deprecated" commands in the documentation. + The default value is: YES. \anchor cfg_enabled_sections @@ -1114,6 +1174,7 @@ The default value is: YES. individual variables and macros / defines can be controlled using \ref cmdshowinitializer "\\showinitializer" or \ref cmdhideinitializer "\\hideinitializer" command in the documentation regardless of this setting. + Minimum value: 0, maximum value: 10000, default value: 30. \anchor cfg_show_used_files @@ -1123,6 +1184,7 @@ The default value is: YES. at the bottom of the documentation of classes and structs. If set to \c YES the list will mention the files that were used to generate the documentation. + The default value is: YES. \anchor cfg_show_files @@ -1130,7 +1192,8 @@ The default value is: YES. \addindex SHOW_FILES Set the \c SHOW_FILES tag to \c NO to disable the generation of the Files page. This will remove the Files entry from the Quick Index and from the - Folder Tree View (if specified). The default is \c YES. + Folder Tree View (if specified). + The default value is: YES. @@ -1139,7 +1202,8 @@ The default value is: YES. \addindex SHOW_NAMESPACES Set the \c SHOW_NAMESPACES tag to \c NO to disable the generation of the Namespaces page. This will remove the Namespaces entry from the Quick Index - and from the Folder Tree View (if specified). The default is \c YES. + and from the Folder Tree View (if specified). + The default value is: YES. @@ -1209,8 +1273,8 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
\c QUIET
\addindex QUIET The \c QUIET tag can be used to turn on/off the messages that are generated - to standard output by doxygen. Possible values are \c YES and \c NO, - where \c YES implies that the messages are off. + to standard output by doxygen. If \c QUIET is set to \c YES this implies that the messages are off. + The default value is: NO. @@ -1218,11 +1282,12 @@ The default value is: NO.
\c WARNINGS
\addindex WARNINGS The \c WARNINGS tag can be used to turn on/off the warning messages that are - generated to standard error (\c stderr) by doxygen. Possible values are \c YES and \c NO, - where \c YES implies that the warnings are on. + generated to standard error (\c stderr) by doxygen. If \c WARNINGS is set to + \c YES this implies that the warnings are on.
\b Tip: Turn warnings on while writing the documentation. + The default value is: YES. \anchor cfg_warn_if_undocumented @@ -1232,6 +1297,7 @@ The default value is: YES. for undocumented members. If \ref cfg_extract_all "EXTRACT_ALL" is set to \c YES then this flag will automatically be disabled. + The default value is: YES. \anchor cfg_warn_if_doc_error @@ -1242,6 +1308,7 @@ The default value is: YES. parameters in a documented function, or documenting parameters that don't exist or using markup commands wrongly. + The default value is: YES. \anchor cfg_warn_no_paramdoc @@ -1253,6 +1320,7 @@ The default value is: YES. wrong or incomplete parameter documentation, but not about the absence of documentation. + The default value is: NO. \anchor cfg_warn_format @@ -1266,6 +1334,7 @@ The default value is: NO. Optionally the format may contain $version, which will be replaced by the version of the file (if it could be obtained via \ref cfg_file_version_filter "FILE_VERSION_FILTER") + The default value is: $file:$line: $text. \anchor cfg_warn_logfile @@ -1273,7 +1342,7 @@ The default value is: $file:$line: $text. \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 standard error (\c stderr). + to standard error (`stderr`). \section config_input Configuration options related to the input files @@ -1297,6 +1366,7 @@ The default value is: $file:$line: $text. Doxygen uses `libiconv` (or the `iconv` built into `libc`) for the transcoding. See the libiconv documentation for the list of possible encodings. + The default value is: UTF-8. \anchor cfg_file_patterns @@ -1353,8 +1423,8 @@ The default value is: UTF-8.
\c RECURSIVE
\addindex RECURSIVE The \c RECURSIVE tag can be used to specify whether or not subdirectories - should be searched for input files as well. Possible values are \c YES - and \c NO. + should be searched for input files as well. + The default value is: NO. @@ -1372,6 +1442,7 @@ The default value is: NO. The \c EXCLUDE_SYMLINKS tag can be used to select whether or not files or directories that are symbolic links (a Unix file system feature) are excluded from the input. + The default value is: NO. \anchor cfg_exclude_patterns @@ -1411,7 +1482,6 @@ The default value is: NO. \c EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like `*.cpp` and `*.h`) to filter out the source-files in the directories. If left blank all files are included. -*. \anchor cfg_example_recursive
\c EXAMPLE_RECURSIVE
@@ -1421,6 +1491,7 @@ The default value is: NO. \ref cmddontinclude "\\dontinclude" commands irrespective of the value of the \ref cfg_recursive "RECURSIVE" tag. + The default value is: NO. \anchor cfg_image_path @@ -1466,6 +1537,7 @@ The default value is: NO. files that are used for producing the source files to browse (i.e. when \ref cfg_source_browser "SOURCE_BROWSER" is set to \c YES). + The default value is: NO. \anchor cfg_filter_source_patterns @@ -1477,6 +1549,7 @@ The default value is: NO. and it is also possible to disable source filtering for a specific pattern using `*.ext=` (so without naming a filter). + This tag requires that the tag \ref cfg_filter_source_files "FILTER_SOURCE_FILES" is set to \c YES. \anchor cfg_use_mdfile_as_mainpage
\c USE_MDFILE_AS_MAINPAGE
@@ -1498,6 +1571,7 @@ This tag requires that the tag \ref cfg_filter_source_files "FILTER_SOURCE_FILES
Note: To get rid of all source code in the generated output, make sure that also \ref cfg_verbatim_headers "VERBATIM_HEADERS" is set to \c NO. + The default value is: NO. \anchor cfg_inline_sources @@ -1506,6 +1580,7 @@ The default value is: NO. Setting the \c INLINE_SOURCES tag to \c YES will include the body of functions, classes and enums directly into the documentation. + The default value is: NO. \anchor cfg_strip_code_comments @@ -1515,6 +1590,7 @@ The default value is: NO. doxygen to hide any special comment blocks from generated source code fragments. Normal C, C++ and Fortran comments will always remain visible. + The default value is: YES. \anchor cfg_referenced_by_relation @@ -1524,6 +1600,7 @@ The default value is: YES. then for each documented function all documented functions referencing it will be listed. + The default value is: NO. \anchor cfg_references_relation @@ -1533,6 +1610,7 @@ The default value is: NO. then for each documented function all documented entities called/used by that function will be listed. + The default value is: NO. \anchor cfg_references_link_source @@ -1544,6 +1622,7 @@ The default value is: NO. \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION" lists will link to the source code. Otherwise they will link to the documentation. + The default value is: YES. \anchor cfg_source_tooltips @@ -1555,8 +1634,10 @@ 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 to disable this feature. + The default value is: YES. + This tag requires that the tag \ref cfg_source_browser "SOURCE_BROWSER" is set to \c YES. \anchor cfg_use_htags
\c USE_HTAGS
@@ -1579,8 +1660,10 @@ This tag requires that the tag \ref cfg_source_browser "SOURCE_BROWSER" is set t The result: instead of the source browser generated by doxygen, the links to source code will now point to the output of \c htags. + The default value is: NO. + This tag requires that the tag \ref cfg_source_browser "SOURCE_BROWSER" is set to \c YES. \anchor cfg_verbatim_headers
\c VERBATIM_HEADERS
@@ -1590,6 +1673,7 @@ This tag requires that the tag \ref cfg_source_browser "SOURCE_BROWSER" is set t which an include is specified. Set to \c NO to disable this. \sa Section \ref cmdclass "\\class". + The default value is: YES. \anchor cfg_clang_assisted_parsing @@ -1604,6 +1688,7 @@ The default value is: YES. @note The availability of this option depends on whether or not doxygen was compiled with the `--with-libclang` option. + The default value is: NO. \anchor cfg_clang_options @@ -1614,6 +1699,7 @@ The default value is: NO. the include paths will already be set by doxygen for the files and directories specified with \ref cfg_input "INPUT" and \ref cfg_include_path "INCLUDE_PATH". + This tag requires that the tag \ref cfg_clang_assisted_parsing "CLANG_ASSISTED_PARSING" is set to \c YES. \section config_index Configuration options related to the alphabetical class index @@ -1626,6 +1712,7 @@ This tag requires that the tag \ref cfg_clang_assisted_parsing "CLANG_ASSISTED_P of all compounds will be generated. Enable this if the project contains a lot of classes, structs, unions or interfaces. + The default value is: YES. \anchor cfg_cols_in_alpha_index @@ -1634,8 +1721,10 @@ The default value is: YES. 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. + Minimum value: 1, maximum value: 20, default value: 5. + This tag requires that the tag \ref cfg_alphabetical_index "ALPHABETICAL_INDEX" is set to \c YES. \anchor cfg_ignore_prefix
\c IGNORE_PREFIX
@@ -1645,6 +1734,7 @@ This tag requires that the tag \ref cfg_alphabetical_index "ALPHABETICAL_INDEX" 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. + This tag requires that the tag \ref cfg_alphabetical_index "ALPHABETICAL_INDEX" is set to \c YES. \section config_html Configuration options related to the HTML output @@ -1656,6 +1746,7 @@ This tag requires that the tag \ref cfg_alphabetical_index "ALPHABETICAL_INDEX" If the \c GENERATE_HTML tag is set to \c YES doxygen will generate HTML output + The default value is: YES. \anchor cfg_html_output @@ -1664,16 +1755,20 @@ The default value is: YES. 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 \ref cfg_output_directory "OUTPUT_DIRECTORY" will be put in front of it. + The default directory is: html. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_html_file_extension
\c HTML_FILE_EXTENSION
\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). + The default value is: .html. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_html_header
\c HTML_HEADER
@@ -1766,6 +1861,7 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil \ref cfg_searchengine "SEARCHENGINE" are enabled. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_html_footer
\c HTML_FOOTER
@@ -1781,6 +1877,7 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to See also section \ref doxygen_usage for information on how to generate the default footer that doxygen normally uses. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_html_stylesheet
\c HTML_STYLESHEET
@@ -1798,6 +1895,7 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to as it is more robust and this tag (HTML_STYLESHEET) will in the future become obsolete. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_html_extra_stylesheet
\c HTML_EXTRA_STYLESHEET
@@ -1839,6 +1937,7 @@ hr.footer { } \endverbatim + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_html_extra_files
\c HTML_EXTRA_FILES
@@ -1851,6 +1950,7 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to 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. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_html_colorstyle_hue
\c HTML_COLORSTYLE_HUE
@@ -1860,11 +1960,12 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to according to this color. Hue is specified as an angle on a colorwheel, see http://en.wikipedia.org/wiki/Hue for more information. For instance the value 0 represents red, 60 is yellow, 120 is green, - 180 is cyan, 240 is blue, 300 purple, and 360 is red again. - The allowed range is 0 to 359. + 180 is cyan, 240 is blue, 300 purple, and 360 is red again. + Minimum value: 0, maximum value: 359, default value: 220. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_html_colorstyle_sat
\c HTML_COLORSTYLE_SAT
@@ -1873,8 +1974,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to the colors in the HTML output. For a value of 0 the output will use grayscales only. A value of 255 will produce the most vivid colors. + Minimum value: 0, maximum value: 255, default value: 100. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_html_colorstyle_gamma
\c HTML_COLORSTYLE_GAMMA
@@ -1886,8 +1989,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not change the gamma. + Minimum value: 40, maximum value: 240, default value: 80. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_html_timestamp
\c HTML_TIMESTAMP
@@ -1897,8 +2002,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to was generated. Setting this to \c NO can help when comparing the output of multiple runs. + The default value is: YES. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_html_dynamic_sections
\c HTML_DYNAMIC_SECTIONS
@@ -1907,8 +2014,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to documentation will contain sections that can be hidden and shown after the page has loaded. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_html_index_num_entries
\c HTML_INDEX_NUM_ENTRIES
@@ -1922,8 +2031,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to default. 0 is a special value representing an infinite number of entries and will result in a full expanded tree by default. + Minimum value: 0, maximum value: 9999, default value: 100. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_generate_docset
\c GENERATE_DOCSET
@@ -1940,8 +2051,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_docset_feedname
\c DOCSET_FEEDNAME
@@ -1950,8 +2063,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to 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. + The default value is: Doxygen generated docs. + This tag requires that the tag \ref cfg_generate_docset "GENERATE_DOCSET" is set to \c YES. \anchor cfg_docset_bundle_id
\c DOCSET_BUNDLE_ID
@@ -1960,8 +2075,10 @@ This tag requires that the tag \ref cfg_generate_docset "GENERATE_DOCSET" is set should uniquely identify the documentation set bundle. This should be a reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen will append .docset to the name. + The default value is: org.doxygen.Project. + This tag requires that the tag \ref cfg_generate_docset "GENERATE_DOCSET" is set to \c YES. \anchor cfg_docset_publisher_id
\c DOCSET_PUBLISHER_ID
@@ -1970,15 +2087,19 @@ The \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. + The default value is: org.doxygen.Publisher. + This tag requires that the tag \ref cfg_generate_docset "GENERATE_DOCSET" is set to \c YES. \anchor cfg_docset_publisher_name
\c DOCSET_PUBLISHER_NAME
\addindex DOCSET_PUBLISHER_NAME The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. + The default value is: Publisher. + This tag requires that the tag \ref cfg_generate_docset "GENERATE_DOCSET" is set to \c YES. \anchor cfg_generate_htmlhelp
\c GENERATE_HTMLHELP
@@ -1999,8 +2120,10 @@ This tag requires that the tag \ref cfg_generate_docset "GENERATE_DOCSET" is set and you can search for words in the documentation. The HTML workshop also contains a viewer for compressed HTML files. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_chm_file
\c CHM_FILE
@@ -2010,6 +2133,7 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to can add a path in front of the file if the result should not be written to the html output directory. + This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES. \anchor cfg_hhc_location
\c HHC_LOCATION
@@ -2018,8 +2142,10 @@ This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is be used to specify the location (absolute path including file name) of 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. + The file has to be specified with full path. + This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES. \anchor cfg_generate_chi
\c GENERATE_CHI
@@ -2028,8 +2154,10 @@ This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is controls if a separate `.chi` index file is generated (\c YES) or that it should be included in the master `.chm` file (\c NO). + The default value is: NO. + This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES. \anchor cfg_chm_index_encoding
\c CHM_INDEX_ENCODING
@@ -2038,6 +2166,7 @@ This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is is used to encode HtmlHelp index (\c hhk), content (\c hhc) and project file content. + This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES. \anchor cfg_binary_toc
\c BINARY_TOC
@@ -2046,8 +2175,10 @@ This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is controls whether a binary table of contents is generated (\c YES) or a normal table of contents (\c NO) in the `.chm` file. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES. \anchor cfg_toc_expand
\c TOC_EXPAND
@@ -2056,8 +2187,10 @@ This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is group members to the table of contents of the HTML help documentation and to the tree view. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES. \anchor cfg_generate_qhp
\c GENERATE_QHP
@@ -2068,8 +2201,10 @@ This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is to generate a Qt Compressed Help (`.qch`) of the generated HTML documentation. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_qch_file
\c QCH_FILE
@@ -2078,6 +2213,7 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to be used to specify the file name of the resulting `.qch` file. The path specified is relative to the HTML output folder. + This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES. \anchor cfg_qhp_namespace
\c QHP_NAMESPACE
@@ -2085,8 +2221,10 @@ This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c The \c QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help Project output. For more information please see Qt Help Project / Namespace. + The default value is: org.doxygen.Project. + This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES. \anchor cfg_qhp_virtual_folder
\c QHP_VIRTUAL_FOLDER
@@ -2094,8 +2232,10 @@ This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c The \c QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt Help Project output. For more information please see Qt Help Project / Virtual Folders. + The default value is: doc. + This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES. \anchor cfg_qhp_cust_filter_name
\c QHP_CUST_FILTER_NAME
@@ -2103,6 +2243,7 @@ This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c If the \c QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom filter to add. For more information please see Qt Help Project / Custom Filters. + This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES. \anchor cfg_qhp_cust_filter_attrs
\c QHP_CUST_FILTER_ATTRS
@@ -2111,6 +2252,7 @@ This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c For more information please see Qt Help Project / Custom Filters. + This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES. \anchor cfg_qhp_sect_filter_attrs
\c QHP_SECT_FILTER_ATTRS
@@ -2118,6 +2260,7 @@ This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c The \c QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's filter section matches. Qt Help Project / Filter Attributes. + This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES. \anchor cfg_qhg_location
\c QHG_LOCATION
@@ -2125,6 +2268,7 @@ This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c 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. + This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES. \anchor cfg_generate_eclipsehelp
\c GENERATE_ECLIPSEHELP
@@ -2141,8 +2285,10 @@ This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c After copying `Eclipse` needs to be restarted before the help appears. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_eclipse_doc_id
\c ECLIPSE_DOC_ID
@@ -2150,8 +2296,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to 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. + The default value is: org.doxygen.Project. + This tag requires that the tag \ref cfg_generate_eclipsehelp "GENERATE_ECLIPSEHELP" is set to \c YES. \anchor cfg_disable_index
\c DISABLE_INDEX
@@ -2164,8 +2312,10 @@ This tag requires that the tag \ref cfg_generate_eclipsehelp "GENERATE_ECLIPSEHE information as the navigation tree, you can set this option to \c YES if you also set \ref cfg_generate_treeview "GENERATE_TREEVIEW" to \c YES. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_generate_treeview
\c GENERATE_TREEVIEW
@@ -2188,8 +2338,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to consider setting \ref cfg_disable_index "DISABLE_INDEX" to \c YES when enabling this option. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_enum_values_per_line
\c ENUM_VALUES_PER_LINE
@@ -2199,8 +2351,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
Note that a value of 0 will completely suppress the enum values from appearing in the overview section. + Minimum value: 0, maximum value: 20, default value: 4. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_treeview_width
\c TREEVIEW_WIDTH
@@ -2209,8 +2363,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to used to set the initial width (in pixels) of the frame in which the tree is shown. + Minimum value: 0, maximum value: 1500, default value: 250. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_ext_links_in_window
\c EXT_LINKS_IN_WINDOW
@@ -2218,8 +2374,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to When the \c EXT_LINKS_IN_WINDOW option is set to \c YES doxygen will open links to external symbols imported via tag files in a separate window. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_formula_fontsize
\c FORMULA_FONTSIZE
@@ -2230,8 +2388,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to to manually remove any `form_*.png` images from the HTML output directory to force them to be regenerated. + Minimum value: 8, maximum value: 50, default value: 10. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_formula_transparent
\c FORMULA_TRANSPARENT
@@ -2242,8 +2402,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
Note that when changing this option you need to delete any `form_*.png` files in the HTML output directory before the changes have effect. + The default value is: YES. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_use_mathjax
\c USE_MATHJAX
@@ -2256,8 +2418,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to configure the path to it using the \ref cfg_mathjax_relpath "MATHJAX_RELPATH" option. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_mathjax_format
\c MATHJAX_FORMAT
@@ -2272,8 +2436,10 @@ Possible values are: NativeMML (i.e. MathML) and SVG. + The default value is: HTML-CSS. + This tag requires that the tag \ref cfg_use_mathjax "USE_MATHJAX" is set to \c YES. \anchor cfg_mathjax_relpath
\c MATHJAX_RELPATH
@@ -2286,8 +2452,10 @@ This tag requires that the tag \ref cfg_use_mathjax "USE_MATHJAX" is set to \c Y the MathJax Content Delivery Network so you can quickly see the result without installing MathJax. However, it is strongly recommended to install a local copy of MathJax from http://www.mathjax.org before deployment. + The default value is: http://cdn.mathjax.org/mathjax/latest. + This tag requires that the tag \ref cfg_use_mathjax "USE_MATHJAX" is set to \c YES. \anchor cfg_mathjax_extensions
\c MATHJAX_EXTENSIONS
@@ -2298,6 +2466,7 @@ This tag requires that the tag \ref cfg_use_mathjax "USE_MATHJAX" is set to \c Y MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols \endverbatim + This tag requires that the tag \ref cfg_use_mathjax "USE_MATHJAX" is set to \c YES. \anchor cfg_mathjax_codefile
\c MATHJAX_CODEFILE
@@ -2320,6 +2489,7 @@ MATHJAX_CODEFILE = disableRenderer.js }); \endverbatim + This tag requires that the tag \ref cfg_use_mathjax "USE_MATHJAX" is set to \c YES. \anchor cfg_searchengine
\c SEARCHENGINE
@@ -2345,8 +2515,10 @@ This tag requires that the tag \ref cfg_use_mathjax "USE_MATHJAX" is set to \c Y by pressing \+\. Also here use the \ to select a filter and \ or \ to activate or cancel the filter option. + The default value is: YES. + This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES. \anchor cfg_server_based_search
\c SERVER_BASED_SEARCH
@@ -2361,8 +2533,10 @@ by the script. When \ref cfg_external_search "EXTERNAL_SEARCH" is enabled the indexing and searching needs to be provided by external tools. See the section \ref extsearch for details. + The default value is: NO. + This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c YES. \anchor cfg_external_search
\c EXTERNAL_SEARCH
@@ -2378,8 +2552,10 @@ This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c engine library Xapian.
See the section \ref extsearch for details. + The default value is: NO. + This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c YES. \anchor cfg_searchengine_url
\c SEARCHENGINE_URL
@@ -2392,6 +2568,7 @@ This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c engine library Xapian. See the section \ref extsearch for details. + This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c YES. \anchor cfg_searchdata_file
\c SEARCHDATA_FILE
@@ -2400,8 +2577,10 @@ 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 file is: searchdata.xml. + This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c YES. \anchor cfg_external_search_id
\c EXTERNAL_SEARCH_ID
@@ -2412,6 +2591,7 @@ When \ref cfg_server_based_search "SERVER_BASED_SEARCH" and 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. + This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c YES. \anchor cfg_extra_search_mappings
\c EXTRA_SEARCH_MAPPINGS
@@ -2428,6 +2608,7 @@ This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... \endverbatim + This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c YES. \section config_latex Configuration options related to the LaTeX output @@ -2439,6 +2620,7 @@ This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c If the \c GENERATE_LATEX tag is set to \c YES doxygen will generate \f$\mbox{\LaTeX}\f$ output. + The default value is: YES. \anchor cfg_latex_output @@ -2448,8 +2630,10 @@ The default value is: YES. docs 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. + The default directory is: latex. + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \anchor cfg_latex_cmd_name
\c LATEX_CMD_NAME
@@ -2458,16 +2642,20 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
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 \c Makefile that is written to the output directory. + The default file is: latex. + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \anchor cfg_makeindex_cmd_name
\c MAKEINDEX_CMD_NAME
\addindex MAKEINDEX_CMD_NAME The \c MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate index for \f$\mbox{\LaTeX}\f$. + The default file is: makeindex. + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \anchor cfg_compact_latex
\c COMPACT_LATEX
@@ -2476,8 +2664,10 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t \f$\mbox{\LaTeX}\f$ documents. This may be useful for small projects and may help to save some trees in general. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \anchor cfg_paper_type
\c PAPER_TYPE
@@ -2491,8 +2681,10 @@ Possible values are: legal (8.5 x 14 inches) and executive (7.25 x 10.5 inches). + The default value is: a4. + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \anchor cfg_extra_packages
\c EXTRA_PACKAGES
@@ -2505,6 +2697,7 @@ EXTRA_PACKAGES=times \endverbatim If left blank no extra packages will be included. + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \anchor cfg_latex_header
\c LATEX_HEADER
@@ -2528,6 +2721,7 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t 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"). + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \anchor cfg_latex_footer
\c LATEX_FOOTER
@@ -2539,6 +2733,7 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
Note: Only use a user-defined footer if you know what you are doing! + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \anchor cfg_latex_extra_files
\c LATEX_EXTRA_FILES
@@ -2549,6 +2744,7 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t Note that the files will be copied as-is; there are no commands or markers available. + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \anchor cfg_pdf_hyperlinks
\c PDF_HYPERLINKS
@@ -2559,8 +2755,10 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t contain links (just like the HTML output) instead of page references. This makes the output suitable for online browsing using a PDF viewer. + The default value is: YES. + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \anchor cfg_use_pdflatex
\c USE_PDFLATEX
@@ -2569,8 +2767,10 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t \c pdflatex 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. + The default value is: YES. + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \anchor cfg_latex_batchmode
\c LATEX_BATCHMODE
@@ -2581,8 +2781,10 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t asking the user for help. This option is also used when generating formulas in HTML. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \anchor cfg_latex_hide_indices
\c LATEX_HIDE_INDICES
@@ -2591,8 +2793,10 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t include the index chapters (such as File Index, Compound Index, etc.) in the output. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \anchor cfg_latex_source_code
\c LATEX_SOURCE_CODE
@@ -2602,8 +2806,10 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
Note that which sources are shown also depends on other settings such as \ref cfg_source_browser "SOURCE_BROWSER". + The default value is: NO. + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \anchor cfg_latex_bib_style
\c LATEX_BIB_STYLE
@@ -2612,8 +2818,10 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t bibliography, e.g. \c plainnat, or \c ieeetr. See http://en.wikipedia.org/wiki/BibTeX and \ref cmdcite "\\cite" for more info. + The default value is: plain. + This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES. \section config_rtf Configuration options related to the RTF output @@ -2626,6 +2834,7 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t The RTF output is optimized for Word 97 and may not look too pretty with other RTF readers/editors. + The default value is: NO. \anchor cfg_rtf_output @@ -2634,8 +2843,10 @@ The default value is: NO. 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 \ref cfg_output_directory "OUTPUT_DIRECTORY" will be put in front of it. + The default directory is: rtf. + This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c YES. \anchor cfg_compact_rtf
\c COMPACT_RTF
@@ -2644,8 +2855,10 @@ This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c RTF documents. This may be useful for small projects and may help to save some trees in general. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c YES. \anchor cfg_rtf_hyperlinks
\c RTF_HYPERLINKS
@@ -2658,8 +2871,10 @@ This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c
Note: WordPad (write) and others do not support links. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c YES. \anchor cfg_rtf_stylesheet_file
\c RTF_STYLESHEET_FILE
@@ -2671,6 +2886,7 @@ This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c See also section \ref doxygen_usage for information on how to generate the default style sheet that doxygen normally uses. + This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c YES. \anchor cfg_rtf_extensions_file
\c RTF_EXTENSIONS_FILE
@@ -2680,6 +2896,7 @@ This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c A template extensions file can be generated using doxygen -e rtf extensionFile. + This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c YES. \section config_man Configuration options related to the man page output @@ -2691,6 +2908,7 @@ This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c If the \c GENERATE_MAN tag is set to \c YES doxygen will generate man pages for classes and files. + The default value is: NO. \anchor cfg_man_output @@ -2701,8 +2919,10 @@ The default value is: NO. put in front of it. A directory \c man3 will be created inside the directory specified by \c MAN_OUTPUT. + The default directory is: man. + This tag requires that the tag \ref cfg_generate_man "GENERATE_MAN" is set to \c YES. \anchor cfg_man_extension
\c MAN_EXTENSION
@@ -2711,8 +2931,10 @@ This tag requires that the tag \ref cfg_generate_man "GENERATE_MAN" is set to \c the generated man pages. In case the manual section does not start with a number, the number 3 is prepended. The dot (.) at the beginning of the \c MAN_EXTENSION tag is optional. + The default value is: .3. + This tag requires that the tag \ref cfg_generate_man "GENERATE_MAN" is set to \c YES. \anchor cfg_man_links
\c MAN_LINKS
@@ -2722,8 +2944,10 @@ This tag requires that the tag \ref cfg_generate_man "GENERATE_MAN" is set to \c the real man page(s). These additional files only source the real man page, but without them the \c man command would be unable to find the correct page. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_man "GENERATE_MAN" is set to \c YES. \section config_xml Configuration options related to the XML output @@ -2736,6 +2960,7 @@ This tag requires that the tag \ref cfg_generate_man "GENERATE_MAN" is set to \c generate an XML file that captures the structure of the code including all documentation. + The default value is: NO. \anchor cfg_xml_output @@ -2744,8 +2969,10 @@ The default value is: NO. 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 \ref cfg_output_directory "OUTPUT_DIRECTORY" will be put in front of it. + The default directory is: xml. + This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c YES. \anchor cfg_xml_schema
\c XML_SCHEMA
@@ -2754,6 +2981,7 @@ This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c which can be used by a validating XML parser to check the syntax of the XML files. + This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c YES. \anchor cfg_xml_dtd
\c XML_DTD
@@ -2762,6 +2990,7 @@ This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c which can be used by a validating XML parser to check the syntax of the XML files. + This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c YES. \anchor cfg_xml_programlisting
\c XML_PROGRAMLISTING
@@ -2771,8 +3000,10 @@ This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c and cross-referencing information) to the XML output. Note that enabling this will significantly increase the size of the XML output. + The default value is: YES. + This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c YES. \section config_docbook Configuration options related to the DOCBOOK output @@ -2784,6 +3015,7 @@ This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c If the \c GENERATE_DOCBOOK tag is set to \c YES doxygen will generate Docbook files that can be used to generate PDF. + The default value is: NO. \anchor cfg_docbook_output @@ -2792,11 +3024,13 @@ The default value is: NO. 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. + The default directory is: docbook. + This tag requires that the tag \ref cfg_generate_docbook "GENERATE_DOCBOOK" is set to \c YES. -\section config_def Configuration options for the AutoGen Definitions output +\section config_autogen Configuration options for the AutoGen Definitions output \anchor cfg_generate_autogen_def
@@ -2808,6 +3042,7 @@ This tag requires that the tag \ref cfg_generate_docbook "GENERATE_DOCBOOK" is s documentation. Note that this feature is still experimental and incomplete at the moment. + The default value is: NO.
@@ -2824,6 +3059,7 @@ The default value is: NO. feature is still experimental and incomplete at the moment. + The default value is: NO. \anchor cfg_perlmod_latex @@ -2833,8 +3069,10 @@ The default value is: NO. the necessary \c Makefile rules, \c Perl scripts and \f$\mbox{\LaTeX}\f$ code to be able to generate PDF and DVI output from the Perl module output. + The default value is: NO. + This tag requires that the tag \ref cfg_generate_perlmod "GENERATE_PERLMOD" is set to \c YES. \anchor cfg_perlmod_pretty
\c PERLMOD_PRETTY
@@ -2845,8 +3083,10 @@ This tag requires that the tag \ref cfg_generate_perlmod "GENERATE_PERLMOD" is s tag is set to \c NO the size of the Perl module output will be much smaller and Perl will parse it just the same. + The default value is: YES. + This tag requires that the tag \ref cfg_generate_perlmod "GENERATE_PERLMOD" is set to \c YES. \anchor cfg_perlmod_makevar_prefix
\c PERLMOD_MAKEVAR_PREFIX
@@ -2856,6 +3096,7 @@ This tag requires that the tag \ref cfg_generate_perlmod "GENERATE_PERLMOD" is s This is useful so different `doxyrules.make` files included by the same `Makefile` don't overwrite each other's variables. + This tag requires that the tag \ref cfg_generate_perlmod "GENERATE_PERLMOD" is set to \c YES. \section config_preprocessor Configuration options related to the preprocessor @@ -2868,6 +3109,7 @@ This tag requires that the tag \ref cfg_generate_perlmod "GENERATE_PERLMOD" is s evaluate all C-preprocessor directives found in the sources and include files. + The default value is: YES. \anchor cfg_macro_expansion @@ -2878,8 +3120,10 @@ The default value is: YES. compilation will be performed. Macro expansion can be done in a controlled way by setting \ref cfg_expand_only_predef "EXPAND_ONLY_PREDEF" to \c YES. + The default value is: NO. + This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to \c YES. \anchor cfg_expand_only_predef
\c EXPAND_ONLY_PREDEF
@@ -2888,8 +3132,10 @@ This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSI then the macro expansion is limited to the macros specified with the \ref cfg_predefined "PREDEFINED" and \ref cfg_expand_as_defined "EXPAND_AS_DEFINED" tags. + The default value is: NO. + This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to \c YES. \anchor cfg_search_includes
\c SEARCH_INCLUDES
@@ -2897,8 +3143,10 @@ This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSI If the \c SEARCH_INCLUDES tag is set to \c YES the includes files in the \ref cfg_include_path "INCLUDE_PATH" will be searched if a \c \#include is found. + The default value is: YES. + This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to \c YES. \anchor cfg_include_path
\c INCLUDE_PATH
@@ -2907,6 +3155,7 @@ This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSI contain include files that are not input files but should be processed by the preprocessor. + This tag requires that the tag \ref cfg_search_includes "SEARCH_INCLUDES" is set to \c YES. \anchor cfg_include_file_patterns
\c INCLUDE_FILE_PATTERNS
@@ -2916,6 +3165,7 @@ This tag requires that the tag \ref cfg_search_includes "SEARCH_INCLUDES" is set directories. If left blank, the patterns specified with \ref cfg_file_patterns "FILE_PATTERNS" will be used. + This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to \c YES. \anchor cfg_predefined
\c PREDEFINED
@@ -2928,6 +3178,7 @@ This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSI a macro definition from being undefined via \c \#undef or recursively expanded use the := operator instead of the \c = operator. + This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to \c YES. \anchor cfg_expand_as_defined
\c EXPAND_AS_DEFINED
@@ -2939,6 +3190,7 @@ This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSI Use the \ref cfg_predefined "PREDEFINED" tag if you want to use a different macro definition that overrules the definition found in the source code. + This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to \c YES. \anchor cfg_skip_function_macros
\c SKIP_FUNCTION_MACROS
@@ -2949,8 +3201,10 @@ This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSI Such function macros are typically used for boiler-plate code, and will confuse the parser if not removed. + The default value is: YES. + This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to \c YES. \section config_external Configuration options related to external references @@ -2995,6 +3249,7 @@ where `loc1` and `loc2` can be relative or absolute paths or URLs. in the class index. If set to \c NO only the inherited external classes will be listed. + The default value is: NO. \anchor cfg_external_groups @@ -3004,6 +3259,7 @@ The default value is: NO. in the modules index. If set to \c NO, only the current project's groups will be listed. + The default value is: YES. \anchor cfg_external_pages @@ -3013,6 +3269,7 @@ The default value is: YES. in the related pages index. If set to \c NO, only the current project's pages will be listed. + The default value is: YES. \anchor cfg_perl_path @@ -3020,6 +3277,7 @@ The default value is: YES. \addindex PERL_PATH The \c PERL_PATH should be the absolute path and name of the perl script interpreter (i.e. the result of `'which perl'`). + The default file (with absolute path) is: /usr/bin/perl. @@ -3035,6 +3293,7 @@ The default file (with absolute path) is: /usr/bin/perl. 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. + The default value is: YES. \anchor cfg_mscgen_path @@ -3053,6 +3312,7 @@ The default value is: YES. inheritance and usage relations if the target is undocumented or is not a class. + The default value is: YES. \anchor cfg_have_dot @@ -3064,6 +3324,7 @@ The default value is: YES. 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 value is: NO. \anchor cfg_dot_num_threads @@ -3075,8 +3336,10 @@ The default value is: NO. explicitly to a value larger than 0 to get control over the balance between CPU load and processing speed. + Minimum value: 0, maximum value: 32, default value: 0. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_dot_fontname
\c DOT_FONTNAME
@@ -3087,16 +3350,20 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. which can be done by putting it in a standard location or by setting the \c DOTFONTPATH environment variable or by setting \ref cfg_dot_fontpath "DOT_FONTPATH" to the directory containing the font. + The default value is: Helvetica. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_dot_fontsize
\c DOT_FONTSIZE
\addindex DOT_FONTSIZE The \c DOT_FONTSIZE tag can be used to set the size (in points) of the font of dot graphs. + Minimum value: 4, maximum value: 24, default value: 10. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_dot_fontpath
\c DOT_FONTPATH
@@ -3106,6 +3373,7 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. different font using \ref cfg_dot_fontname "DOT_FONTNAME" you can set the path where \c dot can find it using this tag. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_class_graph
\c CLASS_GRAPH
@@ -3115,8 +3383,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. indirect inheritance relations. Setting this tag to \c YES will force the \ref cfg_class_diagrams "CLASS_DIAGRAMS" tag to \c NO. + The default value is: YES. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_collaboration_graph
\c COLLABORATION_GRAPH
@@ -3126,8 +3396,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. indirect implementation dependencies (inheritance, containment, and class references variables) of the class with other documented classes. + The default value is: YES. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_group_graphs
\c GROUP_GRAPHS
@@ -3135,8 +3407,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. If the \c GROUP_GRAPHS tag is set to \c YES then doxygen will generate a graph for groups, showing the direct groups dependencies. + The default value is: YES. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_uml_look
\c UML_LOOK
@@ -3145,8 +3419,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. collaboration diagrams in a style similar to the OMG's Unified Modeling Language. + The default value is: NO. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_uml_limit_num_fields
\c UML_LIMIT_NUM_FIELDS
@@ -3160,8 +3436,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. to 10, up to 15 fields may appear, but if the number exceeds 15, the total amount of fields shown is limited to 10. + Minimum value: 0, maximum value: 100, default value: 10. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_template_relations
\c TEMPLATE_RELATIONS
@@ -3169,8 +3447,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. If the \c TEMPLATE_RELATIONS tag is set to \c YES then the inheritance and collaboration graphs will show the relations between templates and their instances. + The default value is: NO. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_include_graph
\c INCLUDE_GRAPH
@@ -3181,8 +3461,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. showing the direct and indirect include dependencies of the file with other documented files. + The default value is: YES. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_included_by_graph
\c INCLUDED_BY_GRAPH
@@ -3193,8 +3475,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. showing the direct and indirect include dependencies of the file with other documented files. + The default value is: YES. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_call_graph
\c CALL_GRAPH
@@ -3205,8 +3489,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. So in most cases it will be better to enable call graphs for selected functions only using the \ref cmdcallgraph "\\callgraph" command. + The default value is: NO. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_caller_graph
\c CALLER_GRAPH
@@ -3217,8 +3503,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. So in most cases it will be better to enable caller graphs for selected functions only using the \ref cmdcallergraph "\\callergraph" command. + The default value is: NO. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_graphical_hierarchy
\c GRAPHICAL_HIERARCHY
@@ -3226,8 +3514,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. If the \c GRAPHICAL_HIERARCHY tag is set to \c YES then doxygen will graphical hierarchy of all classes instead of a textual one. + The default value is: YES. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_directory_graph
\c DIRECTORY_GRAPH
@@ -3237,8 +3527,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. in a graphical way. The dependency relations are determined by the \c \#include relations between the files in the directories. + The default value is: YES. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_dot_image_format
\c DOT_IMAGE_FORMAT
@@ -3255,8 +3547,10 @@ Possible values are: gif and svg. + The default value is: png. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_interactive_svg
\c INTERACTIVE_SVG
@@ -3268,8 +3562,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \note For IE 9+ you need to set \ref cfg_html_file_extension "HTML_FILE_EXTENSION" to \c xhtml in order to make the SVG files visible. Older versions of IE do not have SVG support. + The default value is: NO. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_dot_path
\c DOT_PATH
@@ -3277,6 +3573,7 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. The \c DOT_PATH 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. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_dotfile_dirs
\c DOTFILE_DIRS
@@ -3285,6 +3582,7 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. contain dot files that are included in the documentation (see the \ref cmddotfile "\\dotfile" command). + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_mscfile_dirs
\c MSCFILE_DIRS
@@ -3304,8 +3602,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \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 \ref cfg_max_dot_graph_depth "MAX_DOT_GRAPH_DEPTH". + Minimum value: 0, maximum value: 10000, default value: 50. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_max_dot_graph_depth
\c MAX_DOT_GRAPH_DEPTH
@@ -3318,8 +3618,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. code bases. Also note that the size of a graph can be further restricted by \ref cfg_dot_graph_max_nodes "DOT_GRAPH_MAX_NODES". Using a depth of 0 means no depth restriction. + Minimum value: 0, maximum value: 1000, default value: 0. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_dot_transparent
\c DOT_TRANSPARENT
@@ -3332,8 +3634,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. enabling this option may lead to badly anti-aliased labels on the edges of a graph (i.e. they become hard to read). + The default value is: NO. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_dot_multi_targets
\c DOT_MULTI_TARGETS
@@ -3343,8 +3647,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. makes \c dot run faster, but since only newer versions of \c dot (>1.8.10) support this, this feature is disabled by default. + The default value is: NO. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_generate_legend
\c GENERATE_LEGEND
@@ -3353,8 +3659,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. generate a legend page explaining the meaning of the various boxes and arrows in the dot generated graphs. + The default value is: YES. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \anchor cfg_dot_cleanup
\c DOT_CLEANUP
@@ -3362,8 +3670,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. 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. + The default value is: YES. + This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES. \section config_examples Examples diff --git a/src/config.xml b/src/config.xml index 1630c6b..d7ace9f 100644 --- a/src/config.xml +++ b/src/config.xml @@ -734,11 +734,11 @@ Go to the next section or return to the entities in documentation are documented, even if no documentation was available. Private class members and static file members will be hidden unless the \ref cfg_extract_private "EXTRACT_PRIVATE" respectively - \ref cfg_extract_static "EXTRACT_STATIC" tags are set to \c YES + \ref cfg_extract_static "EXTRACT_STATIC" tags are 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 + set to \c YES. ]]> @@ -1038,7 +1038,7 @@ Go to the next section or return to the @@ -1047,7 +1047,7 @@ Go to the next section or return to the @@ -1131,8 +1131,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" @@ -1140,8 +1139,8 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" \b Tip: Turn warnings on while writing the documentation. ]]> @@ -1196,7 +1195,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" @@ -1282,8 +1281,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" @@ -1350,7 +1348,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" blank all files are included. ]]> - + @@ -2746,7 +2743,7 @@ front of it. - +