summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2013-08-08 17:23:30 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2013-08-08 17:23:30 (GMT)
commit83fc120e5575446b1161e9ffb8168d55c423f7ac (patch)
treec7ee1c92a317eb218ca8f10b71c6ef9ac8188a3d /src
parente25977561907befe17844665942a4f7a6e96d321 (diff)
downloadDoxygen-83fc120e5575446b1161e9ffb8168d55c423f7ac.zip
Doxygen-83fc120e5575446b1161e9ffb8168d55c423f7ac.tar.gz
Doxygen-83fc120e5575446b1161e9ffb8168d55c423f7ac.tar.bz2
Minor changes to the way the code for config options is generated (thanks to Albert for the patch)
Diffstat (limited to 'src')
-rw-r--r--src/config.xml25
-rwxr-xr-xsrc/configgen.py52
-rw-r--r--src/configoptions.cpp776
-rw-r--r--src/doxygen.cpp2
-rw-r--r--src/doxygen.md4
5 files changed, 430 insertions, 429 deletions
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 <a href="commands.html">next</a> 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.
]]>
</docs>
</option>
@@ -1038,7 +1038,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<![CDATA[
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).
]]>
</docs>
</option>
@@ -1047,7 +1047,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<![CDATA[
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).
]]>
</docs>
</option>
@@ -1131,8 +1131,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
<docs>
<![CDATA[
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.
]]>
</docs>
</option>
@@ -1140,8 +1139,8 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
<docs>
<![CDATA[
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.
<br>
\b Tip: Turn warnings on while writing the documentation.
]]>
@@ -1196,7 +1195,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
<![CDATA[
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`).
]]>
</docs>
</option>
@@ -1282,8 +1281,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
<docs>
<![CDATA[
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.
]]>
</docs>
</option>
@@ -1350,7 +1348,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
blank all files are included.
]]>
</docs>
- <value name='*'/>
+ <value name='*' show_docu='NO'/>
</option>
<option type='bool' id='EXAMPLE_RECURSIVE' defval='0'>
<docs>
@@ -1829,7 +1827,6 @@ hr.footer {
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.
]]>
</docs>
</option>
@@ -2746,7 +2743,7 @@ front of it.
</docs>
</option>
</group>
- <group name='DEF' docs='Configuration options for the AutoGen Definitions output'>
+ <group name='AutoGen' docs='Configuration options for the AutoGen Definitions output'>
<option type='bool' id='GENERATE_AUTOGEN_DEF' defval='0'>
<docs>
<![CDATA[
diff --git a/src/configgen.py b/src/configgen.py
index fdbdaa7..4aed8bf 100755
--- a/src/configgen.py
+++ b/src/configgen.py
@@ -73,6 +73,10 @@ def transformDocs(doc):
# <br> will be removed later on again, we need it here otherwise splitlines
# will filter the extra line.
doc = doc.replace("<br>", "\n<br>\n")
+ # a dirty trick to go to the next line in Doxyfile documentation.
+ # <br/> will be removed later on again, we need it here otherwise splitlines
+ # will filter the line break.
+ doc = doc.replace("<br/>", "\n<br/>\n")
#
doc = doc.splitlines()
split_doc = []
@@ -82,7 +86,8 @@ def transformDocs(doc):
# and start string at next line
docC = []
for line in split_doc:
- docC.append(line.strip().replace('\\', '\\\\').
+ if (line.strip() != "<br/>"):
+ docC.append(line.strip().replace('\\', '\\\\').
replace('"', '\\"').replace("<br>", ""))
return docC
@@ -93,11 +98,12 @@ def collectValues(node):
if (n.nodeName == "value"):
if n.nodeType == Node.ELEMENT_NODE:
if n.getAttribute('name') != "":
- name = "<code>" + n.getAttribute('name') + "</code>"
- desc = n.getAttribute('desc')
- if (desc != ""):
- name += " " + desc
- values.append(name)
+ if n.getAttribute('show_docu') != "NO":
+ name = "<code>" + n.getAttribute('name') + "</code>"
+ desc = n.getAttribute('desc')
+ if (desc != ""):
+ name += " " + desc
+ values.append(name)
return values
@@ -142,7 +148,7 @@ def prepCDocs(node):
doc += parseDocs(n)
if (type == 'enum'):
values = collectValues(node)
- doc += "Possible values are: "
+ doc += "<br/>Possible values are: "
rng = len(values)
for i in range(rng):
val = values[i]
@@ -153,19 +159,18 @@ def prepCDocs(node):
else:
doc += "%s, " % (val)
if (defval != ""):
- doc += "<br>"
- doc += "The default value is: <code>%s</code>." % (defval)
+ doc += "<br/>The default value is: <code>%s</code>." % (defval)
elif (type == 'int'):
minval = node.getAttribute('minval')
maxval = node.getAttribute('maxval')
- doc += "%s: %s, %s: %s, %s: %s." % (" Minimum value", minval,
+ doc += "<br/>%s: %s, %s: %s, %s: %s." % (" Minimum value", minval,
"maximum value", maxval,
"default value", defval)
elif (type == 'bool'):
if (node.hasAttribute('altdefval')):
- doc += "%s: %s." % ("Default value", "system dependent")
+ doc += "<br/>%s: %s." % ("The default value is", "system dependent")
else:
- doc += "%s: %s." % ("Default value", "YES" if (defval == "1") else "NO")
+ doc += "<br/>%s: %s." % ("The default value is", "YES" if (defval == "1") else "NO")
elif (type == 'list'):
if format == 'string':
values = collectValues(node)
@@ -181,30 +186,29 @@ def prepCDocs(node):
elif (type == 'string'):
if format == 'dir':
if defval != '':
- doc += "The default directory is: <code>%s</code>." % (
+ doc += "<br/>The default directory is: <code>%s</code>." % (
defval)
elif format == 'file':
abspath = node.getAttribute('abspath')
if defval != '':
if abspath != '1':
- doc += "The default file is: <code>%s</code>." % (
+ doc += "<br/>The default file is: <code>%s</code>." % (
defval)
else:
- doc += "%s: %s%s%s." % (
+ doc += "<br/>%s: %s%s%s." % (
"The default file (with absolute path) is",
"<code>",defval,"</code>")
else:
if abspath == '1':
- doc += "The file has to be specified with full path."
+ doc += "<br/>The file has to be specified with full path."
else: # format == 'string':
if defval != '':
- doc += "The default value is: <code>%s</code>." % (
+ doc += "<br/>The default value is: <code>%s</code>." % (
defval)
# depends handling
if (node.hasAttribute('depends')):
depends = node.getAttribute('depends')
- doc += "<br>"
- doc += "%s \\ref cfg_%s \"%s\" is set to \\c YES." % (
+ doc += "<br/>%s \\ref cfg_%s \"%s\" is set to \\c YES." % (
"This tag requires that the tag", depends.lower(), depends.upper())
docC = transformDocs(doc)
@@ -393,12 +397,14 @@ def parseOptionDoc(node, first):
print "%s, " % (val)
if (defval != ""):
print ""
+ print ""
print "The default value is: <code>%s</code>." % (defval)
print ""
elif (type == 'int'):
minval = node.getAttribute('minval')
maxval = node.getAttribute('maxval')
print ""
+ print ""
print "%s: %s%s%s, %s: %s%s%s, %s: %s%s%s." % (
" Minimum value", "<code>", minval, "</code>",
"maximum value", "<code>", maxval, "</code>",
@@ -406,8 +412,9 @@ def parseOptionDoc(node, first):
print ""
elif (type == 'bool'):
print ""
+ print ""
if (node.hasAttribute('altdefval')):
- print "Default value is system dependent."
+ print "The default value is: system dependent."
else:
print "The default value is: <code>%s</code>." % (
"YES" if (defval == "1") else "NO")
@@ -428,11 +435,13 @@ def parseOptionDoc(node, first):
elif (type == 'string'):
if format == 'dir':
if defval != '':
+ print ""
print "The default directory is: <code>%s</code>." % (
defval)
elif format == 'file':
abspath = node.getAttribute('abspath')
if defval != '':
+ print ""
if abspath != '1':
print "The default file is: <code>%s</code>." % (
defval)
@@ -442,15 +451,18 @@ def parseOptionDoc(node, first):
"<code>",defval,"</code>")
else:
if abspath == '1':
+ print ""
print "The file has to be specified with full path."
else: # format == 'string':
if defval != '':
+ print ""
print "The default value is: <code>%s</code>." % (
defval)
print ""
# depends handling
if (node.hasAttribute('depends')):
depends = node.getAttribute('depends')
+ print ""
print "%s \\ref cfg_%s \"%s\" is set to \\c YES." % (
"This tag requires that the tag", depends.lower(), depends.upper())
return False
diff --git a/src/configoptions.cpp b/src/configoptions.cpp
index 26de2fd..7f7d454 100644
--- a/src/configoptions.cpp
+++ b/src/configoptions.cpp
@@ -41,7 +41,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("UTF-8");
//----
@@ -50,8 +51,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("My Project");
//----
@@ -94,7 +95,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -102,14 +104,13 @@ void addConfigOptions(Config *cfg)
"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.",
"English"
);
@@ -157,8 +158,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -168,7 +169,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -199,7 +201,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -208,7 +211,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -216,7 +220,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -230,7 +235,6 @@ void addConfigOptions(Config *cfg)
"\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."
);
cl->addValue("");
@@ -250,7 +254,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -260,7 +265,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -269,8 +275,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -283,15 +289,16 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
cb = cfg->addBool(
"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.",
TRUE
);
//----
@@ -299,15 +306,16 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
ci = cfg->addInt(
"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.",
1,16,4
);
//----
@@ -336,7 +344,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -345,23 +354,24 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
cb = cfg->addBool(
"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.",
FALSE
);
//----
cb = cfg->addBool(
"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.",
FALSE
);
//----
@@ -389,7 +399,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -398,7 +409,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -409,15 +421,16 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
cb = cfg->addBool(
"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.",
FALSE
);
//----
@@ -426,8 +439,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -438,7 +451,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -447,7 +461,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -457,7 +472,8 @@ void addConfigOptions(Config *cfg)
"(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.",
TRUE
);
//----
@@ -469,7 +485,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -480,7 +497,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -492,8 +510,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -507,8 +525,8 @@ void addConfigOptions(Config *cfg)
"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.",
0,9,0
);
//---------------------------------------------------------------------------
@@ -521,30 +539,34 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
cb = cfg->addBool(
"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.",
FALSE
);
//----
cb = cfg->addBool(
"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.",
FALSE
);
//----
cb = cfg->addBool(
"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.",
FALSE
);
//----
@@ -553,7 +575,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -562,7 +585,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -572,7 +596,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -581,8 +606,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -591,7 +616,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -599,7 +625,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -607,8 +634,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -616,8 +643,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -627,8 +654,8 @@ void addConfigOptions(Config *cfg)
"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.",
portable_fileSystemIsCaseSensitive()
);
//----
@@ -636,30 +663,32 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
cb = cfg->addBool(
"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.",
TRUE
);
//----
cb = cfg->addBool(
"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.",
FALSE
);
//----
cb = cfg->addBool(
"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.",
TRUE
);
//----
@@ -667,8 +696,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -676,8 +705,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -690,7 +719,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -698,7 +728,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -709,7 +740,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -720,8 +752,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -729,7 +761,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -737,15 +770,16 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
cb = cfg->addBool(
"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.",
TRUE
);
//----
@@ -753,7 +787,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -772,8 +807,8 @@ void addConfigOptions(Config *cfg)
"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.",
0,10000,30
);
//----
@@ -781,8 +816,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -790,7 +825,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -798,7 +834,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -849,18 +886,20 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
FALSE
);
//----
cb = cfg->addBool(
"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.",
TRUE
);
//----
@@ -868,7 +907,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -877,7 +917,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -886,7 +927,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -897,7 +939,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("$file:$line: $text");
//----
@@ -905,7 +948,7 @@ void addConfigOptions(Config *cfg)
"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)."
);
cs->setWidgetType(ConfigString::File);
//---------------------------------------------------------------------------
@@ -930,7 +973,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("UTF-8");
//----
@@ -991,8 +1035,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
FALSE
);
//----
@@ -1011,7 +1055,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -1050,7 +1095,7 @@ void addConfigOptions(Config *cfg)
"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."
);
cl->addValue("*");
//----
@@ -1058,7 +1103,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -1103,8 +1149,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -1114,7 +1160,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cl->addDependency("FILTER_SOURCE_FILES");
@@ -1137,14 +1182,16 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
cb = cfg->addBool(
"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.",
FALSE
);
//----
@@ -1152,23 +1199,24 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
cb = cfg->addBool(
"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.",
FALSE
);
//----
cb = cfg->addBool(
"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.",
FALSE
);
//----
@@ -1177,7 +1225,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -1187,8 +1236,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
@@ -1212,8 +1261,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -1224,7 +1273,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
#if USE_LIBCLANG
@@ -1237,7 +1287,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
#else
@@ -1251,7 +1302,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cl->addDependency("CLANG_ASSISTED_PARSING");
@@ -1267,16 +1317,16 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
ci = cfg->addInt(
"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.",
1,20,5
);
@@ -1288,7 +1338,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cl->addDependency("ALPHABETICAL_INDEX");
@@ -1299,8 +1348,8 @@ void addConfigOptions(Config *cfg)
//----
cb = cfg->addBool(
"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.",
TRUE
);
//----
@@ -1308,8 +1357,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("html");
@@ -1319,9 +1368,8 @@ void addConfigOptions(Config *cfg)
cs = cfg->addString(
"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."
);
cs->setDefaultValue(".html");
@@ -1345,7 +1393,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setWidgetType(ConfigString::File);
@@ -1359,7 +1406,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setWidgetType(ConfigString::File);
@@ -1375,7 +1421,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setWidgetType(ConfigString::File);
@@ -1390,7 +1435,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setWidgetType(ConfigString::File);
@@ -1404,7 +1448,6 @@ void addConfigOptions(Config *cfg)
"$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."
);
cl->addDependency("GENERATE_HTML");
@@ -1417,9 +1460,8 @@ void addConfigOptions(Config *cfg)
"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.",
0,359,220
);
@@ -1429,9 +1471,8 @@ void addConfigOptions(Config *cfg)
"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.",
0,255,100
);
@@ -1444,8 +1485,8 @@ void addConfigOptions(Config *cfg)
"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.",
40,240,80
);
@@ -1455,8 +1496,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
@@ -1466,8 +1507,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -1482,8 +1523,8 @@ void addConfigOptions(Config *cfg)
"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.",
0,9999,100
);
@@ -1499,8 +1540,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -1510,9 +1551,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("Doxygen generated docs");
@@ -1522,9 +1562,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("org.doxygen.Project");
@@ -1534,9 +1573,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("org.doxygen.Publisher");
@@ -1544,9 +1582,8 @@ void addConfigOptions(Config *cfg)
//----
cs = cfg->addString(
"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."
);
cs->setDefaultValue("Publisher");
@@ -1566,8 +1603,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -1578,7 +1615,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setWidgetType(ConfigString::File);
@@ -1588,9 +1624,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setWidgetType(ConfigString::File);
@@ -1599,9 +1634,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
FALSE
);
@@ -1611,7 +1645,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->addDependency("GENERATE_HTMLHELP");
@@ -1619,8 +1652,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
FALSE
);
@@ -1629,9 +1662,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
FALSE
);
@@ -1642,8 +1674,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -1654,7 +1686,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setWidgetType(ConfigString::File);
@@ -1664,9 +1695,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("org.doxygen.Project");
@@ -1677,8 +1707,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("doc");
@@ -1690,7 +1720,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->addDependency("GENERATE_QHP");
@@ -1701,7 +1730,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->addDependency("GENERATE_QHP");
@@ -1711,7 +1739,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->addDependency("GENERATE_QHP");
@@ -1721,7 +1748,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setWidgetType(ConfigString::File);
@@ -1735,9 +1761,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -1747,9 +1772,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("org.doxygen.Project");
@@ -1762,9 +1786,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -1783,8 +1806,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -1796,9 +1819,8 @@ void addConfigOptions(Config *cfg)
"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.",
0,20,4
);
@@ -1809,7 +1831,6 @@ void addConfigOptions(Config *cfg)
"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.",
0,1500,250
);
@@ -1818,9 +1839,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
FALSE
);
@@ -1831,9 +1851,8 @@ void addConfigOptions(Config *cfg)
"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.",
8,50,10
);
@@ -1846,8 +1865,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
@@ -1860,8 +1879,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -1871,12 +1890,10 @@ void addConfigOptions(Config *cfg)
"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.",
"HTML-CSS"
);
@@ -1894,9 +1911,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("http://cdn.mathjax.org/mathjax/latest");
@@ -1907,7 +1923,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cl->addDependency("USE_MATHJAX");
@@ -1918,7 +1933,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->addDependency("USE_MATHJAX");
@@ -1940,8 +1954,8 @@ void addConfigOptions(Config *cfg)
"the search. The filter options can be selected when the cursor is inside the\n"
"search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>\n"
"to select a filter and <Enter> or <escape> 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.",
TRUE
);
@@ -1955,8 +1969,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -1974,9 +1988,8 @@ void addConfigOptions(Config *cfg)
"(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.",
FALSE
);
@@ -1991,7 +2004,6 @@ void addConfigOptions(Config *cfg)
"(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."
);
cs->addDependency("SEARCHENGINE");
@@ -2000,9 +2012,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("searchdata.xml");
@@ -2015,7 +2026,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->addDependency("SEARCHENGINE");
@@ -2028,7 +2038,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cl->addDependency("SEARCHENGINE");
@@ -2039,8 +2048,8 @@ void addConfigOptions(Config *cfg)
//----
cb = cfg->addBool(
"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.",
TRUE
);
//----
@@ -2048,8 +2057,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("latex");
@@ -2063,8 +2072,8 @@ void addConfigOptions(Config *cfg)
"\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."
);
cs->setDefaultValue("latex");
@@ -2074,8 +2083,8 @@ void addConfigOptions(Config *cfg)
cs = cfg->addString(
"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."
);
cs->setDefaultValue("makeindex");
@@ -2086,8 +2095,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -2096,11 +2105,10 @@ void addConfigOptions(Config *cfg)
ce = cfg->addEnum(
"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.",
"a4"
);
@@ -2117,7 +2125,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cl->addDependency("GENERATE_LATEX");
@@ -2136,7 +2143,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setWidgetType(ConfigString::File);
@@ -2149,7 +2155,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setWidgetType(ConfigString::File);
@@ -2161,7 +2166,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cl->addDependency("GENERATE_LATEX");
@@ -2172,9 +2176,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
@@ -2184,8 +2187,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
@@ -2196,8 +2199,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -2206,9 +2209,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
FALSE
);
@@ -2220,8 +2222,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -2231,9 +2233,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("plain");
@@ -2247,7 +2248,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -2255,8 +2257,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("rtf");
@@ -2267,8 +2269,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -2282,8 +2284,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -2297,7 +2299,6 @@ void addConfigOptions(Config *cfg)
"\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."
);
cs->setWidgetType(ConfigString::File);
@@ -2308,7 +2309,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setWidgetType(ConfigString::File);
@@ -2321,7 +2321,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
FALSE
);
//----
@@ -2330,8 +2331,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("man");
@@ -2343,8 +2344,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue(".3");
@@ -2355,9 +2356,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -2370,8 +2370,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
FALSE
);
//----
@@ -2379,8 +2379,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("xml");
@@ -2391,7 +2391,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->addDependency("GENERATE_XML");
@@ -2400,7 +2399,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->addDependency("GENERATE_XML");
@@ -2410,8 +2408,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
@@ -2424,7 +2422,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
FALSE
);
//----
@@ -2432,15 +2431,15 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("docbook");
cs->setWidgetType(ConfigString::Dir);
cs->addDependency("GENERATE_DOCBOOK");
//---------------------------------------------------------------------------
- cfg->addInfo("DEF","Configuration options for the AutoGen Definitions output");
+ cfg->addInfo("AutoGen","Configuration options for the AutoGen Definitions output");
//---------------------------------------------------------------------------
//----
@@ -2449,7 +2448,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//---------------------------------------------------------------------------
@@ -2462,8 +2462,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -2471,8 +2471,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -2484,8 +2484,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
@@ -2497,7 +2497,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->addDependency("GENERATE_PERLMOD");
@@ -2509,8 +2508,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
TRUE
);
//----
@@ -2519,8 +2518,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -2530,8 +2529,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -2540,8 +2539,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
TRUE
);
@@ -2552,7 +2551,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cl->addDependency("SEARCH_INCLUDES");
@@ -2564,7 +2562,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cl->addDependency("ENABLE_PREPROCESSING");
@@ -2577,7 +2574,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cl->addDependency("ENABLE_PREPROCESSING");
@@ -2589,7 +2585,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cl->addDependency("ENABLE_PREPROCESSING");
@@ -2600,8 +2595,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
@@ -2639,8 +2634,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
FALSE
);
//----
@@ -2648,7 +2643,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
@@ -2656,15 +2652,16 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
//----
cs = cfg->addString(
"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."
);
cs->setDefaultValue("/usr/bin/perl");
cs->setWidgetType(ConfigString::File);
@@ -2679,7 +2676,8 @@ void addConfigOptions(Config *cfg)
"(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.",
TRUE
);
//----
@@ -2697,8 +2695,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
TRUE
);
//----
@@ -2708,7 +2706,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
//----
@@ -2718,8 +2717,8 @@ void addConfigOptions(Config *cfg)
"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.",
0,32,0
);
@@ -2731,9 +2730,8 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setDefaultValue("Helvetica");
@@ -2742,8 +2740,8 @@ void addConfigOptions(Config *cfg)
ci = cfg->addInt(
"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.",
4,24,10
);
@@ -2754,7 +2752,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setWidgetType(ConfigString::Dir);
@@ -2764,9 +2761,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
@@ -2777,8 +2773,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
@@ -2787,8 +2783,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
TRUE
);
@@ -2798,8 +2794,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -2814,8 +2810,8 @@ void addConfigOptions(Config *cfg)
"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.",
0,100,10
);
@@ -2825,8 +2821,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -2837,8 +2833,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
@@ -2849,8 +2845,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
@@ -2863,8 +2859,8 @@ void addConfigOptions(Config *cfg)
"\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.",
FALSE
);
@@ -2877,8 +2873,8 @@ void addConfigOptions(Config *cfg)
"\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.",
FALSE
);
@@ -2887,8 +2883,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
TRUE
);
@@ -2899,8 +2895,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
@@ -2912,10 +2908,9 @@ void addConfigOptions(Config *cfg)
"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.",
"png"
);
@@ -2933,9 +2928,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -2945,7 +2939,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cs->setWidgetType(ConfigString::Dir);
@@ -2956,7 +2949,6 @@ void addConfigOptions(Config *cfg)
"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."
);
cl->addDependency("HAVE_DOT");
@@ -2978,9 +2970,8 @@ void addConfigOptions(Config *cfg)
"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.",
0,10000,50
);
@@ -2994,9 +2985,8 @@ void addConfigOptions(Config *cfg)
"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.",
0,1000,0
);
@@ -3010,8 +3000,8 @@ void addConfigOptions(Config *cfg)
"\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.",
FALSE
);
@@ -3022,8 +3012,8 @@ void addConfigOptions(Config *cfg)
"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.",
FALSE
);
@@ -3033,8 +3023,8 @@ void addConfigOptions(Config *cfg)
"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.",
TRUE
);
@@ -3043,8 +3033,8 @@ void addConfigOptions(Config *cfg)
cb = cfg->addBool(
"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.",
TRUE
);
diff --git a/src/doxygen.cpp b/src/doxygen.cpp
index 39596bc..c78ce6b 100644
--- a/src/doxygen.cpp
+++ b/src/doxygen.cpp
@@ -9780,7 +9780,7 @@ static void usage(const char *name)
msg(" LaTeX: %s -w latex headerFile footerFile styleSheetFile [configFile]\n\n",name);
msg("6) Use doxygen to generate an rtf extensions file\n");
msg(" RTF: %s -e rtf extensionsFile\n\n",name);
- msg("If -s is specified the comments in the config file will be omitted.\n");
+ msg("If -s is specified the comments of the configuration items in the config file will be omitted.\n");
msg("If configName is omitted `Doxyfile' will be used as a default.\n\n");
exit(1);
}
diff --git a/src/doxygen.md b/src/doxygen.md
index 7941149..ee87e71 100644
--- a/src/doxygen.md
+++ b/src/doxygen.md
@@ -24,7 +24,9 @@ The format of the configuration file (options and types) is defined
by the file `config.xml`. As part of the build process,
the python script `configgen.py` will create a file configoptions.cpp
from this, which serves as the input for the configuration file parser
-that is invoked using Config::parse()
+that is invoked using Config::parse(). The script `configgen.py` will also
+create the documentation for the configuration items, creating the file
+`config.doc`.
Gathering Input files
---------------------
generated by cgit v0.12 at 2024-11-09 23:04:08 (GMT)