Skip to content

D
doxverilog
Commit 83fc120e authored by Dimitri van Heesch's avatar Dimitri van Heesch
Browse files
Options

Minor changes to the way the code for config options is generated (thanks to Albert for the patch)

parent e2597756
Hide whitespace changes
Inline Side-by-side
Showing with 1219 additions and 869 deletions
addon/doxywizard/config.h
View file @ 83fc120e
......@@ -15,4 +15,13 @@ bool parseConfig(
void writeStringValue(QTextStream &t,QTextCodec *codec,const QString &s);
// directly copied from ../../src/config.h to be consistent
enum
{
/*! Maximum length of an option in the config file. Used for
* alignment purposes.
*/
MAX_OPTION_LENGTH = 23
};
#endif
addon/doxywizard/configdoc.cpp
View file @ 83fc120e
This source diff could not be displayed because it is too large. You can view the blob instead.
addon/doxywizard/expert.cpp
View file @ 83fc120e
......@@ -112,7 +112,8 @@ void Expert::createTopics(const QDomElement &rootElem)
{
if (childElem.tagName()==SA("group"))
{
QString name = childElem.attribute(SA("name"));
// Remove _ from a group name like: Source_Browser
QString name = childElem.attribute(SA("name")).replace(SA("_"),SA(" "));
items.append(new QTreeWidgetItem((QTreeWidget*)0,QStringList(name)));
QWidget *widget = createTopicWidget(childElem);
m_topics[name] = widget;
......@@ -144,7 +145,7 @@ static QString getDocsForNode(const QDomElement &child)
QDomText t = n.toText();
if (!t.isNull()) docs+=t.data();
}
docs+=SA("<br/>");
docs += SA("<br/>");
}
docsVal = docsVal.nextSiblingElement();
}
......@@ -152,6 +153,7 @@ static QString getDocsForNode(const QDomElement &child)
// for an enum we list the values
if (type==SA("enum"))
{
docs += SA("<br/>");
docs += SA("Possible values are: ");
int numValues=0;
docsVal = child.firstChildElement();
......@@ -192,29 +194,35 @@ static QString getDocsForNode(const QDomElement &child)
docsVal = docsVal.nextSiblingElement();
}
docs+=SA("<br/>");
docs+=SA("The default value is: <code>")+
docs+=SA("<br/>");
docs+=SA(" The default value is: <code>")+
child.attribute(SA("defval"))+
SA("</code>.");
docs+= SA("<br/>");
}
else if (type==SA("int"))
{
docs+=SA("<br/>");
docs+=SA("Minimum value: ")+child.attribute(SA("minval"))+SA(", ");
docs+=SA("maximum value: ")+child.attribute(SA("maxval"))+SA(", ");
docs+=SA("default value: ")+child.attribute(SA("defval"))+SA(".");
docs+= SA("<br/>");
}
else if (type==SA("bool"))
{
docs+=SA("<br/>");
if (child.hasAttribute(SA("altdefval")))
{
docs+=SA("The default value is: system dependent.");
docs+=SA(" The default value is: system dependent.");
}
else
{
QString defval = child.attribute(SA("defval"));
docs+=SA("The default value is: <code>")+
docs+=SA(" The default value is: <code>")+
(defval==SA("1")?SA("YES"):SA("NO"))+
SA("</code>.");
}
docs+= SA("<br/>");
}
else if (type==SA("list"))
{
......@@ -226,7 +234,12 @@ static QString getDocsForNode(const QDomElement &child)
{
if (docsVal.tagName()==SA("value"))
{
if (docsVal.attribute(SA("name"))!=SA("")) numValues++;
QString showDocu = SA("");
if (docsVal.hasAttribute(SA("show_docu")))
{
showDocu = docsVal.attribute(SA("show_docu")).toLower();
}
if ((showDocu != SA("no")) && (docsVal.attribute(SA("name"))!=SA(""))) numValues++;
}
docsVal = docsVal.nextSiblingElement();
}
......@@ -238,29 +251,38 @@ static QString getDocsForNode(const QDomElement &child)
{
if (docsVal.tagName()==SA("value"))
{
i++;
docs += SA("<code>") + docsVal.attribute(SA("name")) + SA("</code>");
QString desc = docsVal.attribute(SA("desc"));
if (desc != SA(""))
{
docs += SA(" ") + desc;
}
if (i==numValues-1)
QString showDocu = SA("");
if (docsVal.hasAttribute(SA("show_docu")))
{
docs += SA(" and ");
showDocu = docsVal.attribute(SA("show_docu")).toLower();
}
else if (i==numValues)
if ((showDocu != SA("no")) && (docsVal.attribute(SA("name"))!=SA("")))
{
docs += SA(".");
}
else
{
docs += SA(", ");
i++;
docs += SA("<code>") + docsVal.attribute(SA("name")) + SA("</code>");
QString desc = docsVal.attribute(SA("desc"));
if (desc != SA(""))
{
docs += SA(" ") + desc;
}
if (i==numValues-1)
{
docs += SA(" and ");
}
else if (i==numValues)
{
docs += SA(".");
}
else
{
docs += SA(", ");
}
}
}
docsVal = docsVal.nextSiblingElement();
}
}
// docs+= SA("<br/>");
}
}
else if (type==SA("string"))
......@@ -270,7 +292,9 @@ static QString getDocsForNode(const QDomElement &child)
{
if (defval != SA(""))
{
docs += SA("The default directory is: <code>") + defval + SA("</code>.");
docs+=SA("<br/>");
docs += SA(" The default directory is: <code>") + defval + SA("</code>.");
docs += SA("<br/>");
}
}
else if (child.attribute(SA("format")) == SA("file"))
......@@ -278,20 +302,24 @@ static QString getDocsForNode(const QDomElement &child)
QString abspath = child.attribute(SA("abspath"));
if (defval != SA(""))
{
docs+=SA("<br/>");
if (abspath != SA("1"))
{
docs += SA("The default file is: <code>") + defval + SA("</code>.");
docs += SA(" The default file is: <code>") + defval + SA("</code>.");
}
else
{
docs += SA("The default file (with absolute path) is: <code>") + defval + SA("</code>.");
docs += SA(" The default file (with absolute path) is: <code>") + defval + SA("</code>.");
}
docs += SA("<br/>");
}
else
{
if (abspath == SA("1"))
{
docs += SA("The file has to be specified with full path.");
docs+=SA("<br/>");
docs += SA(" The file has to be specified with full path.");
docs += SA("<br/>");
}
}
}
......@@ -299,7 +327,9 @@ static QString getDocsForNode(const QDomElement &child)
{
if (defval != SA(""))
{
docs += SA("The default value is: <code>") + defval + SA("</code>.");
docs+=SA("<br/>");
docs += SA(" The default value is: <code>") + defval + SA("</code>.");
docs += SA("<br/>");
}
}
}
......@@ -307,8 +337,8 @@ static QString getDocsForNode(const QDomElement &child)
if (child.hasAttribute(SA("depends")))
{
QString dependsOn = child.attribute(SA("depends"));
docs += SA("<br/>");
docs+= SA("This tag requires that the tag \\ref cfg_");
docs+=SA("<br/>");
docs+= SA(" This tag requires that the tag \\ref cfg_");
docs+= dependsOn.toLower();
docs+= SA(" \"");
docs+= dependsOn.toUpper();
......@@ -324,13 +354,22 @@ static QString getDocsForNode(const QDomElement &child)
// remove <br> at end
regexp.setPattern(SA("<br> *$"));
docs.replace(regexp,SA(" "));
// \c word -> <code>word</code>
// \c word -> <code>word</code>; word ends with ')', ',', '.' or ' '
regexp.setPattern(SA("\\\\c[ ]+([^ \\)]+)\\)"));
docs.replace(regexp,SA("<code>\\1</code>)"));
regexp.setPattern(SA("\\\\c[ ]+([^ ,]+),"));
docs.replace(regexp,SA("<code>\\1</code>,"));
regexp.setPattern(SA("\\\\c[ ]+([^ \\.]+)\\."));
docs.replace(regexp,SA("<code>\\1</code>."));
regexp.setPattern(SA("\\\\c[ ]+([^ ]+) "));
docs.replace(regexp,SA("<code>\\1</code> "));
// `word` -> <code>word</code>
docs.replace(SA("``"),SA(""));
regexp.setPattern(SA("`([^`]+)`"));
docs.replace(regexp,SA("<code>\\1</code> "));
docs.replace(regexp,SA("<code>\\1</code>"));
// \ref key "desc" -> <code>desc</code>
regexp.setPattern(SA("\\\\ref[ ]+[^ ]+[ ]+\"([^ ]+)\""));
docs.replace(regexp,SA("<code>\\1</code> "));
......@@ -683,7 +722,7 @@ void Expert::saveTopic(QTextStream &t,QDomElement &elem,QTextCodec *codec,
t << convertToComment(option->templateDocs());
t << endl;
}
t << name.leftJustified(23) << "= ";
t << name.leftJustified(MAX_OPTION_LENGTH) << "= ";
if (option)
{
option->writeValue(t,codec);
......@@ -744,9 +783,10 @@ void Expert::showHelp(Input *option)
m_helper->setText(
QString::fromAscii("<qt><b>")+option->id()+
QString::fromAscii("</b><br>")+
QString::fromAscii("<br/>")+
option->docs().
replace(QChar::fromAscii('\n'),QChar::fromAscii(' '))+
QString::fromAscii("<qt>")
QString::fromAscii("</qt>")
);
m_inShowHelp = FALSE;
}
......
doc/config.doc
View file @ 83fc120e
......@@ -329,6 +329,7 @@ followed by the descriptions of the tags grouped by category.
the first occurrence of this tag. Doxygen uses \c libiconv (or the iconv built into
\c libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
possible encodings.
The default value is: <code>UTF-8</code>.
\anchor cfg_project_name
......@@ -338,6 +339,7 @@ The default value is: <code>UTF-8</code>.
surrounded by double-quotes, unless you are using Doxywizard) that should identify the project for which the
documentation is generated. This name is used in the title of most
generated pages and in a few other places.
The default value is: <code>My Project</code>.
\anchor cfg_project_number
......@@ -380,6 +382,7 @@ The default value is: <code>My Project</code>.
files, where putting all generated files in the same directory would otherwise
causes performance problems for the file system.
The default value is: <code>NO</code>.
\anchor cfg_output_language
......@@ -430,6 +433,7 @@ Possible values are:
<code>Ukrainian</code> and
<code>Vietnamese</code>.
The default value is: <code>English</code>.
\anchor cfg_brief_member_desc
......@@ -440,6 +444,7 @@ The default value is: <code>English</code>.
the file and class documentation (similar to \c Javadoc).
Set to \c NO to disable this.
The default value is: <code>YES</code>.
\anchor cfg_repeat_brief
......@@ -453,6 +458,7 @@ The default value is: <code>YES</code>.
\ref cfg_brief_member_desc "BRIEF_MEMBER_DESC" are set to \c NO, the
brief descriptions will be completely suppressed.
The default value is: <code>YES</code>.
\anchor cfg_abbreviate_brief
......@@ -485,6 +491,7 @@ The default value is: <code>YES</code>.
doxygen will generate a detailed section even if there is only a brief
description.
The default value is: <code>NO</code>.
\anchor cfg_inline_inherited_memb
......@@ -495,6 +502,7 @@ The default value is: <code>NO</code>.
ordinary class members. Constructors, destructors and assignment operators of
the base classes will not be shown.
The default value is: <code>NO</code>.
\anchor cfg_full_path_names
......@@ -504,6 +512,7 @@ The default value is: <code>NO</code>.
path before files name in the file list and in the header files. If set
to \c NO the shortest path that makes the file name unique will be used
The default value is: <code>YES</code>.
\anchor cfg_strip_from_path
......@@ -519,6 +528,7 @@ The default value is: <code>YES</code>.
relative paths, which will be relative from the directory where doxygen is
started.
This tag requires that the tag \ref cfg_full_path_names "FULL_PATH_NAMES" is set to \c YES.
\anchor cfg_strip_from_inc_path
<dt>\c STRIP_FROM_INC_PATH <dd>
......@@ -537,6 +547,7 @@ This tag requires that the tag \ref cfg_full_path_names "FULL_PATH_NAMES" is set
(but less readable) file names. This can be useful is your file systems
doesn't support long names like on DOS, Mac, or CD-ROM.
The default value is: <code>NO</code>.
\anchor cfg_javadoc_autobrief
......@@ -548,6 +559,7 @@ The default value is: <code>NO</code>.
Javadoc-style will behave just like regular Qt-style comments
(thus requiring an explicit \ref cmdbrief "\@brief" command for a brief description.)
The default value is: <code>NO</code>.
\anchor cfg_qt_autobrief
......@@ -559,6 +571,7 @@ The default value is: <code>NO</code>.
Qt-style will behave just like regular Qt-style comments (thus
requiring an explicit \ref cmdbrief "\\brief" command for a brief description.)
The default value is: <code>NO</code>.
\anchor cfg_multiline_cpp_is_brief
......@@ -572,6 +585,7 @@ The default value is: <code>NO</code>.
<br>Note that setting this tag to \c YES also means that rational rose comments
are not recognized any more.
The default value is: <code>NO</code>.
\anchor cfg_inherit_docs
......@@ -581,6 +595,7 @@ The default value is: <code>NO</code>.
member inherits the documentation from any documented member that it
re-implements.
The default value is: <code>YES</code>.
\anchor cfg_separate_member_pages
......@@ -590,6 +605,7 @@ The default value is: <code>YES</code>.
a new page for each member. If set to \c NO, the documentation of a member will
be part of the file/class/namespace that contains it.
The default value is: <code>NO</code>.
\anchor cfg_tab_size
......@@ -598,6 +614,7 @@ The default value is: <code>NO</code>.
The \c TAB_SIZE tag can be used to set the number of spaces in a tab.
Doxygen uses this value to replace tabs by spaces in code fragments.
Minimum value: <code>1</code>, maximum value: <code>16</code>, default value: <code>4</code>.
\anchor cfg_aliases
......@@ -633,6 +650,7 @@ The default value is: <code>NO</code>.
for C. For instance, some of the names that are used will be different.
The list of all members will be omitted, etc.
The default value is: <code>NO</code>.
\anchor cfg_optimize_output_java
......@@ -643,6 +661,7 @@ The default value is: <code>NO</code>.
for that language. For instance, namespaces will be presented as packages,
qualified scopes will look different, etc.
The default value is: <code>NO</code>.
\anchor cfg_optimize_for_fortran
......@@ -651,6 +670,7 @@ The default value is: <code>NO</code>.
Set the \c OPTIMIZE_FOR_FORTRAN tag to \c YES if your project consists of Fortran
sources. Doxygen will then generate output that is tailored for Fortran.
The default value is: <code>NO</code>.
\anchor cfg_optimize_output_vhdl
......@@ -659,6 +679,7 @@ The default value is: <code>NO</code>.
Set the \c OPTIMIZE_OUTPUT_VHDL tag to \c YES if your project consists of VHDL
sources. Doxygen will then generate output that is tailored for VHDL.
The default value is: <code>NO</code>.
\anchor cfg_extension_mapping
......@@ -689,6 +710,7 @@ The default value is: <code>NO</code>.
can mix doxygen, HTML, and XML commands with Markdown formatting.
Disable only in case of backward compatibilities issues.
The default value is: <code>YES</code>.
\anchor cfg_autolink_support
......@@ -699,6 +721,7 @@ The default value is: <code>YES</code>.
prevented in individual cases by by putting a \c % sign in front of the word or
globally by setting \c AUTOLINK_SUPPORT to \c NO.
The default value is: <code>YES</code>.
\anchor cfg_builtin_stl_support
......@@ -711,6 +734,7 @@ The default value is: <code>YES</code>.
`func(std::string) {}`). This also make the inheritance and collaboration
diagrams that involve STL classes more complete and accurate.
The default value is: <code>NO</code>.
\anchor cfg_cpp_cli_support
......@@ -719,6 +743,7 @@ The default value is: <code>NO</code>.
If you use Microsoft's C++/CLI language, you should set this option to \c YES to
enable parsing support.
The default value is: <code>NO</code>.
\anchor cfg_sip_support
......@@ -729,6 +754,7 @@ The default value is: <code>NO</code>.
Doxygen will parse them like normal C++ but will assume all classes use public
instead of private inheritance when no explicit protection keyword is present.
The default value is: <code>NO</code>.
\anchor cfg_idl_property_support
......@@ -741,6 +767,7 @@ The default value is: <code>NO</code>.
setting a simple type. If this is not the case, or you want to show the
methods anyway, you should set this option to \c NO.
The default value is: <code>YES</code>.
\anchor cfg_distribute_group_doc
......@@ -751,6 +778,7 @@ The default value is: <code>YES</code>.
member in the group (if any) for the other members of the group. By default
all members of a group must be documented explicitly.
The default value is: <code>NO</code>.
\anchor cfg_subgrouping
......@@ -762,6 +790,7 @@ The default value is: <code>NO</code>.
\c NO to prevent subgrouping. Alternatively, this can be done per class using
the \ref cmdnosubgrouping "\\nosubgrouping" command.
The default value is: <code>YES</code>.
\anchor cfg_inline_grouped_classes
......@@ -774,6 +803,7 @@ The default value is: <code>YES</code>.
<br>Note that this feature does not work in
combination with \ref cfg_separate_member_pages "SEPARATE_MEMBER_PAGES".
The default value is: <code>NO</code>.
\anchor cfg_inline_simple_structs
......@@ -786,6 +816,7 @@ The default value is: <code>NO</code>.
to \c NO, structs, classes, and unions are shown on a separate
page (for HTML and Man pages) or section (for \f$\mbox{\LaTeX}\f$ and RTF).
The default value is: <code>NO</code>.
\anchor cfg_typedef_hides_struct
......@@ -799,6 +830,7 @@ The default value is: <code>NO</code>.
be useful for C code in case the coding convention dictates that all compound
types are typedef'ed and only the typedef is referenced, never the tag name.
The default value is: <code>NO</code>.
\anchor cfg_lookup_cache_size
......@@ -815,6 +847,7 @@ The default value is: <code>NO</code>.
At the end of a run doxygen will report the cache usage and suggest the
optimal cache size from a speed point of view.
Minimum value: <code>0</code>, maximum value: <code>9</code>, default value: <code>0</code>.
</dl>
......@@ -828,11 +861,12 @@ The default value is: <code>NO</code>.
entities in documentation are documented, even if no documentation was
available. Private class members and static file members will be hidden
unless the \ref cfg_extract_private "EXTRACT_PRIVATE" respectively
\ref cfg_extract_static "EXTRACT_STATIC" tags are set to \c YES
\ref cfg_extract_static "EXTRACT_STATIC" tags are set to \c YES.
\note This will also disable the warnings about undocumented members
that are normally produced when \ref cfg_warnings "WARNINGS" is
set to \c YES
set to \c YES.
The default value is: <code>NO</code>.
......@@ -842,6 +876,7 @@ The default value is: <code>NO</code>.
If the \c EXTRACT_PRIVATE tag is set to \c YES all private members of a
class will be included in the documentation.
The default value is: <code>NO</code>.
\anchor cfg_extract_package
......@@ -850,6 +885,7 @@ The default value is: <code>NO</code>.
If the \c EXTRACT_PACKAGE tag is set to \c YES all members with package
or internal scope will be included in the documentation.
The default value is: <code>NO</code>.
\anchor cfg_extract_static
......@@ -858,6 +894,7 @@ The default value is: <code>NO</code>.
If the \c EXTRACT_STATIC tag is set to \c YES all static members of a file
will be included in the documentation.
The default value is: <code>NO</code>.
\anchor cfg_extract_local_classes
......@@ -868,6 +905,7 @@ The default value is: <code>NO</code>.
If set to \c NO only classes defined in header files are included. Does not
have any effect for Java sources.
The default value is: <code>YES</code>.
\anchor cfg_extract_local_methods
......@@ -878,6 +916,7 @@ The default value is: <code>YES</code>.
the interface are included in the documentation.
If set to \c NO only methods in the interface are included.
The default value is: <code>NO</code>.
\anchor cfg_extract_anon_nspaces
......@@ -888,6 +927,7 @@ The default value is: <code>NO</code>.
where file will be replaced with the base name of the file that contains the anonymous
namespace. By default anonymous namespace are hidden.
The default value is: <code>NO</code>.
\anchor cfg_hide_undoc_members
......@@ -899,6 +939,7 @@ The default value is: <code>NO</code>.
various overviews, but no documentation section is generated.
This option has no effect if \ref cfg_extract_all "EXTRACT_ALL" is enabled.
The default value is: <code>NO</code>.
\anchor cfg_hide_undoc_classes
......@@ -910,6 +951,7 @@ The default value is: <code>NO</code>.
various overviews.
This option has no effect if \ref cfg_extract_all "EXTRACT_ALL" is enabled.
The default value is: <code>NO</code>.
\anchor cfg_hide_friend_compounds
......@@ -920,6 +962,7 @@ The default value is: <code>NO</code>.
If set to \c NO these declarations will be included in the
documentation.
The default value is: <code>NO</code>.
\anchor cfg_hide_in_body_docs
......@@ -930,6 +973,7 @@ The default value is: <code>NO</code>.
If set to \c NO these blocks will be appended to the
function's detailed documentation block.
The default value is: <code>NO</code>.
\anchor cfg_internal_docs
......@@ -940,6 +984,7 @@ The default value is: <code>NO</code>.
to \c NO then the documentation will be excluded.
Set it to \c YES to include the internal documentation.
The default value is: <code>NO</code>.
\anchor cfg_case_sense_names
......@@ -952,7 +997,8 @@ The default value is: <code>NO</code>.
supports case sensitive file names. Windows and Mac users are advised to set this
option to \c NO.
Default value is system dependent.
The default value is system dependent.
\anchor cfg_hide_scope_names
<dt>\c HIDE_SCOPE_NAMES <dd>
......@@ -961,6 +1007,7 @@ Default value is system dependent.
will show members with their full class and namespace scopes in the
documentation. If set to \c YES the scope will be hidden.
The default value is: <code>NO</code>.
\anchor cfg_show_include_files
......@@ -970,6 +1017,7 @@ The default value is: <code>NO</code>.
will put a list of the files that are included by a file in the documentation
of that file.
The default value is: <code>YES</code>.
\anchor cfg_force_local_includes
......@@ -979,6 +1027,7 @@ The default value is: <code>YES</code>.
will list include files with double quotes in the documentation
rather than with sharp brackets.
The default value is: <code>NO</code>.
\anchor cfg_inline_info
......@@ -987,6 +1036,7 @@ The default value is: <code>NO</code>.
If the \c INLINE_INFO tag is set to \c YES then a tag [inline]
is inserted in the documentation for inline members.
The default value is: <code>YES</code>.
\anchor cfg_sort_member_docs
......@@ -997,6 +1047,7 @@ The default value is: <code>YES</code>.
alphabetically by member name. If set to \c NO the members will appear in
declaration order.
The default value is: <code>YES</code>.
\anchor cfg_sort_brief_docs
......@@ -1007,6 +1058,7 @@ The default value is: <code>YES</code>.
by member name. If set to \c NO the members will appear in
declaration order.
The default value is: <code>NO</code>.
\anchor cfg_sort_members_ctors_1st
......@@ -1022,6 +1074,7 @@ The default value is: <code>NO</code>.
\note If \ref cfg_sort_member_docs "SORT_MEMBER_DOCS" is set to \c NO this option is ignored for
sorting detailed member documentation.
The default value is: <code>NO</code>.
\anchor cfg_sort_group_names
......@@ -1031,6 +1084,7 @@ The default value is: <code>NO</code>.
hierarchy of group names into alphabetical order. If set to \c NO
the group names will appear in their defined order.
The default value is: <code>NO</code>.
\anchor cfg_sort_by_scope_name
......@@ -1044,6 +1098,7 @@ The default value is: <code>NO</code>.
\note This option applies only to the class list, not to the
alphabetical list.
The default value is: <code>NO</code>.
\anchor cfg_strict_proto_matching
......@@ -1056,6 +1111,7 @@ The default value is: <code>NO</code>.
by doing a simple string match. By disabling \c STRICT_PROTO_MATCHING doxygen
will still accept a match between prototype and implementation in such cases.
The default value is: <code>NO</code>.
\anchor cfg_generate_todolist
......@@ -1065,6 +1121,7 @@ The default value is: <code>NO</code>.
disable (\c NO) the todo list. This list is created by
putting \ref cmdtodo "\\todo" commands in the documentation.
The default value is: <code>YES</code>.
\anchor cfg_generate_testlist
......@@ -1074,6 +1131,7 @@ The default value is: <code>YES</code>.
disable (\c NO) the test list. This list is created by
putting \ref cmdtest "\\test" commands in the documentation.
The default value is: <code>YES</code>.
\anchor cfg_generate_buglist
......@@ -1083,6 +1141,7 @@ The default value is: <code>YES</code>.
disable (\c NO) the bug list. This list is created by
putting \ref cmdbug "\\bug" commands in the documentation.
The default value is: <code>YES</code>.
\anchor cfg_generate_deprecatedlist
......@@ -1093,6 +1152,7 @@ The default value is: <code>YES</code>.
putting \ref cmddeprecated "\\deprecated"
commands in the documentation.
The default value is: <code>YES</code>.
\anchor cfg_enabled_sections
......@@ -1114,6 +1174,7 @@ The default value is: <code>YES</code>.
individual variables and macros / defines can be controlled using \ref cmdshowinitializer "\\showinitializer"
or \ref cmdhideinitializer "\\hideinitializer" command in the documentation regardless of this setting.
Minimum value: <code>0</code>, maximum value: <code>10000</code>, default value: <code>30</code>.
\anchor cfg_show_used_files
......@@ -1123,6 +1184,7 @@ The default value is: <code>YES</code>.
at the bottom of the documentation of classes and structs. If set to \c YES the
list will mention the files that were used to generate the documentation.
The default value is: <code>YES</code>.
\anchor cfg_show_files
......@@ -1130,7 +1192,8 @@ The default value is: <code>YES</code>.
\addindex SHOW_FILES
Set the \c SHOW_FILES tag to \c NO to disable the generation of the Files page.
This will remove the Files entry from the Quick Index and from the
Folder Tree View (if specified). The default is \c YES.
Folder Tree View (if specified).
The default value is: <code>YES</code>.
......@@ -1139,7 +1202,8 @@ The default value is: <code>YES</code>.
\addindex SHOW_NAMESPACES
Set the \c SHOW_NAMESPACES tag to \c NO to disable the generation of the
Namespaces page. This will remove the Namespaces entry from the Quick Index
and from the Folder Tree View (if specified). The default is \c YES.
and from the Folder Tree View (if specified).
The default value is: <code>YES</code>.
......@@ -1209,8 +1273,8 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
<dt>\c QUIET <dd>
\addindex QUIET
The \c QUIET tag can be used to turn on/off the messages that are generated
to standard output by doxygen. Possible values are \c YES and \c NO,
where \c YES implies that the messages are off.
to standard output by doxygen. If \c QUIET is set to \c YES this implies that the messages are off.
The default value is: <code>NO</code>.
......@@ -1218,11 +1282,12 @@ The default value is: <code>NO</code>.
<dt>\c WARNINGS <dd>
\addindex WARNINGS
The \c WARNINGS tag can be used to turn on/off the warning messages that are
generated to standard error (\c stderr) by doxygen. Possible values are \c YES and \c NO,
where \c YES implies that the warnings are on.
generated to standard error (\c stderr) by doxygen. If \c WARNINGS is set to
\c YES this implies that the warnings are on.
<br>
\b Tip: Turn warnings on while writing the documentation.
The default value is: <code>YES</code>.
\anchor cfg_warn_if_undocumented
......@@ -1232,6 +1297,7 @@ The default value is: <code>YES</code>.
for undocumented members. If \ref cfg_extract_all "EXTRACT_ALL" is set to \c YES then this flag will
automatically be disabled.
The default value is: <code>YES</code>.
\anchor cfg_warn_if_doc_error
......@@ -1242,6 +1308,7 @@ The default value is: <code>YES</code>.
parameters in a documented function, or documenting parameters that
don't exist or using markup commands wrongly.
The default value is: <code>YES</code>.
\anchor cfg_warn_no_paramdoc
......@@ -1253,6 +1320,7 @@ The default value is: <code>YES</code>.
wrong or incomplete parameter documentation, but not about the absence of
documentation.
The default value is: <code>NO</code>.
\anchor cfg_warn_format
......@@ -1266,6 +1334,7 @@ The default value is: <code>NO</code>.
Optionally the format may contain
<code>$version</code>, which will be replaced by the version of the file (if it could
be obtained via \ref cfg_file_version_filter "FILE_VERSION_FILTER")
The default value is: <code>$file:$line: $text</code>.
\anchor cfg_warn_logfile
......@@ -1273,7 +1342,7 @@ The default value is: <code>$file:$line: $text</code>.
\addindex WARN_LOGFILE
The \c WARN_LOGFILE tag can be used to specify a file to which warning
and error messages should be written. If left blank the output is written
to standard error (\c stderr).
to standard error (`stderr`).
</dl>
\section config_input Configuration options related to the input files
......@@ -1297,6 +1366,7 @@ The default value is: <code>$file:$line: $text</code>.
Doxygen uses `libiconv` (or the `iconv` built into `libc`) for the transcoding.
See <a href="http://www.gnu.org/software/libiconv">the libiconv documentation</a> for
the list of possible encodings.
The default value is: <code>UTF-8</code>.
\anchor cfg_file_patterns
......@@ -1353,8 +1423,8 @@ The default value is: <code>UTF-8</code>.
<dt>\c RECURSIVE <dd>
\addindex RECURSIVE
The \c RECURSIVE tag can be used to specify whether or not subdirectories
should be searched for input files as well. Possible values are \c YES
and \c NO.
should be searched for input files as well.
The default value is: <code>NO</code>.
......@@ -1372,6 +1442,7 @@ The default value is: <code>NO</code>.
The \c EXCLUDE_SYMLINKS tag can be used to select whether or not files or directories
that are symbolic links (a Unix file system feature) are excluded from the input.
The default value is: <code>NO</code>.
\anchor cfg_exclude_patterns
......@@ -1411,7 +1482,6 @@ The default value is: <code>NO</code>.
\c EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like `*.cpp`
and `*.h`) to filter out the source-files in the directories. If left
blank all files are included.
<code>*</code>.
\anchor cfg_example_recursive
<dt>\c EXAMPLE_RECURSIVE <dd>
......@@ -1421,6 +1491,7 @@ The default value is: <code>NO</code>.
\ref cmddontinclude "\\dontinclude"
commands irrespective of the value of the \ref cfg_recursive "RECURSIVE" tag.
The default value is: <code>NO</code>.
\anchor cfg_image_path
......@@ -1466,6 +1537,7 @@ The default value is: <code>NO</code>.
files that are used for producing the source files to browse
(i.e. when \ref cfg_source_browser "SOURCE_BROWSER" is set to \c YES).
The default value is: <code>NO</code>.
\anchor cfg_filter_source_patterns
......@@ -1477,6 +1549,7 @@ The default value is: <code>NO</code>.
and it is also possible to disable source filtering for a specific pattern
using `*.ext=` (so without naming a filter).
This tag requires that the tag \ref cfg_filter_source_files "FILTER_SOURCE_FILES" is set to \c YES.
\anchor cfg_use_mdfile_as_mainpage
<dt>\c USE_MDFILE_AS_MAINPAGE <dd>
......@@ -1498,6 +1571,7 @@ This tag requires that the tag \ref cfg_filter_source_files "FILTER_SOURCE_FILES
<br>Note: To get rid of all source code in the generated output, make sure that also
\ref cfg_verbatim_headers "VERBATIM_HEADERS" is set to \c NO.
The default value is: <code>NO</code>.
\anchor cfg_inline_sources
......@@ -1506,6 +1580,7 @@ The default value is: <code>NO</code>.
Setting the \c INLINE_SOURCES tag to \c YES will include the body
of functions, classes and enums directly into the documentation.
The default value is: <code>NO</code>.
\anchor cfg_strip_code_comments
......@@ -1515,6 +1590,7 @@ The default value is: <code>NO</code>.
doxygen to hide any special comment blocks from generated source code
fragments. Normal C, C++ and Fortran comments will always remain visible.
The default value is: <code>YES</code>.
\anchor cfg_referenced_by_relation
......@@ -1524,6 +1600,7 @@ The default value is: <code>YES</code>.
then for each documented function all documented
functions referencing it will be listed.
The default value is: <code>NO</code>.
\anchor cfg_references_relation
......@@ -1533,6 +1610,7 @@ The default value is: <code>NO</code>.
then for each documented function all documented entities
called/used by that function will be listed.
The default value is: <code>NO</code>.
\anchor cfg_references_link_source
......@@ -1544,6 +1622,7 @@ The default value is: <code>NO</code>.
\ref cfg_referenced_by_relation "REFERENCED_BY_RELATION" lists will
link to the source code. Otherwise they will link to the documentation.
The default value is: <code>YES</code>.
\anchor cfg_source_tooltips
......@@ -1555,8 +1634,10 @@ brief description and links to the definition and documentation. Since this will
make the HTML file larger and loading of large files a bit slower, you can opt
to disable this feature.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_source_browser "SOURCE_BROWSER" is set to \c YES.
\anchor cfg_use_htags
<dt>\c USE_HTAGS <dd>
......@@ -1579,8 +1660,10 @@ This tag requires that the tag \ref cfg_source_browser "SOURCE_BROWSER" is set t
The result: instead of the source browser generated by doxygen, the links to
source code will now point to the output of \c htags.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_source_browser "SOURCE_BROWSER" is set to \c YES.
\anchor cfg_verbatim_headers
<dt>\c VERBATIM_HEADERS <dd>
......@@ -1590,6 +1673,7 @@ This tag requires that the tag \ref cfg_source_browser "SOURCE_BROWSER" is set t
which an include is specified. Set to \c NO to disable this.
\sa Section \ref cmdclass "\\class".
The default value is: <code>YES</code>.
\anchor cfg_clang_assisted_parsing
......@@ -1604,6 +1688,7 @@ The default value is: <code>YES</code>.
@note The availability of this option depends on whether or not doxygen
was compiled with the `--with-libclang` option.
The default value is: <code>NO</code>.
\anchor cfg_clang_options
......@@ -1614,6 +1699,7 @@ The default value is: <code>NO</code>.
the include paths will already be set by doxygen for the files and directories
specified with \ref cfg_input "INPUT" and \ref cfg_include_path "INCLUDE_PATH".
This tag requires that the tag \ref cfg_clang_assisted_parsing "CLANG_ASSISTED_PARSING" is set to \c YES.
</dl>
\section config_index Configuration options related to the alphabetical class index
......@@ -1626,6 +1712,7 @@ This tag requires that the tag \ref cfg_clang_assisted_parsing "CLANG_ASSISTED_P
of all compounds will be generated. Enable this if the project contains
a lot of classes, structs, unions or interfaces.
The default value is: <code>YES</code>.
\anchor cfg_cols_in_alpha_index
......@@ -1634,8 +1721,10 @@ The default value is: <code>YES</code>.
The \c COLS_IN_ALPHA_INDEX tag can be
used to specify the number of columns in which the alphabetical index list will be split.
Minimum value: <code>1</code>, maximum value: <code>20</code>, default value: <code>5</code>.
This tag requires that the tag \ref cfg_alphabetical_index "ALPHABETICAL_INDEX" is set to \c YES.
\anchor cfg_ignore_prefix
<dt>\c IGNORE_PREFIX <dd>
......@@ -1645,6 +1734,7 @@ This tag requires that the tag \ref cfg_alphabetical_index "ALPHABETICAL_INDEX"
The \c IGNORE_PREFIX tag can be used to specify a prefix
(or a list of prefixes) that should be ignored while generating the index headers.
This tag requires that the tag \ref cfg_alphabetical_index "ALPHABETICAL_INDEX" is set to \c YES.
</dl>
\section config_html Configuration options related to the HTML output
......@@ -1656,6 +1746,7 @@ This tag requires that the tag \ref cfg_alphabetical_index "ALPHABETICAL_INDEX"
If the \c GENERATE_HTML tag is set to \c YES doxygen will
generate HTML output
The default value is: <code>YES</code>.
\anchor cfg_html_output
......@@ -1664,16 +1755,20 @@ The default value is: <code>YES</code>.
The \c HTML_OUTPUT tag is used to specify where the HTML docs will be put.
If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
put in front of it.
The default directory is: <code>html</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_html_file_extension
<dt>\c HTML_FILE_EXTENSION <dd>
\addindex HTML_FILE_EXTENSION
The \c HTML_FILE_EXTENSION tag can be used to specify the file extension for
each generated HTML page (for example: <code>.htm, .php, .asp</code>).
The default value is: <code>.html</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_html_header
<dt>\c HTML_HEADER <dd>
......@@ -1766,6 +1861,7 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil
\ref cfg_searchengine "SEARCHENGINE" are enabled.
</dl>
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_html_footer
<dt>\c HTML_FOOTER <dd>
......@@ -1781,6 +1877,7 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
See also section \ref doxygen_usage for information on how to generate
the default footer that doxygen normally uses.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_html_stylesheet
<dt>\c HTML_STYLESHEET <dd>
......@@ -1798,6 +1895,7 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
as it is more robust and
this tag (<code>HTML_STYLESHEET</code>) will in the future become obsolete.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_html_extra_stylesheet
<dt>\c HTML_EXTRA_STYLESHEET <dd>
......@@ -1839,6 +1937,7 @@ hr.footer {
}
\endverbatim
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_html_extra_files
<dt>\c HTML_EXTRA_FILES <dd>
......@@ -1851,6 +1950,7 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
files. In the \ref cfg_html_stylesheet "HTML_STYLESHEET" file, use the file name only. Also note that
the files will be copied as-is; there are no commands or markers available.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_html_colorstyle_hue
<dt>\c HTML_COLORSTYLE_HUE <dd>
......@@ -1860,11 +1960,12 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
according to this color. Hue is specified as an angle on a colorwheel,
see http://en.wikipedia.org/wiki/Hue for more information.
For instance the value 0 represents red, 60 is yellow, 120 is green,
180 is cyan, 240 is blue, 300 purple, and 360 is red again.
The allowed range is 0 to 359.
180 is cyan, 240 is blue, 300 purple, and 360 is red again.
Minimum value: <code>0</code>, maximum value: <code>359</code>, default value: <code>220</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_html_colorstyle_sat
<dt>\c HTML_COLORSTYLE_SAT <dd>
......@@ -1873,8 +1974,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
the colors in the HTML output. For a value of 0 the output will use
grayscales only. A value of 255 will produce the most vivid colors.
Minimum value: <code>0</code>, maximum value: <code>255</code>, default value: <code>100</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_html_colorstyle_gamma
<dt>\c HTML_COLORSTYLE_GAMMA <dd>
......@@ -1886,8 +1989,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
and 100 does not change the gamma.
Minimum value: <code>40</code>, maximum value: <code>240</code>, default value: <code>80</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_html_timestamp
<dt>\c HTML_TIMESTAMP <dd>
......@@ -1897,8 +2002,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
was generated. Setting this to \c NO can help when comparing the output of
multiple runs.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_html_dynamic_sections
<dt>\c HTML_DYNAMIC_SECTIONS <dd>
......@@ -1907,8 +2014,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
documentation will contain sections that can be hidden and shown after the
page has loaded.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_html_index_num_entries
<dt>\c HTML_INDEX_NUM_ENTRIES <dd>
......@@ -1922,8 +2031,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
default. 0 is a special value representing an infinite number of entries
and will result in a full expanded tree by default.
Minimum value: <code>0</code>, maximum value: <code>9999</code>, default value: <code>100</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_generate_docset
<dt>\c GENERATE_DOCSET <dd>
......@@ -1940,8 +2051,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for
more information.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_docset_feedname
<dt>\c DOCSET_FEEDNAME <dd>
......@@ -1950,8 +2063,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
feed. A documentation feed provides an umbrella under which multiple
documentation sets from a single provider (such as a company or product suite)
can be grouped.
The default value is: <code>Doxygen generated docs</code>.
This tag requires that the tag \ref cfg_generate_docset "GENERATE_DOCSET" is set to \c YES.
\anchor cfg_docset_bundle_id
<dt>\c DOCSET_BUNDLE_ID <dd>
......@@ -1960,8 +2075,10 @@ This tag requires that the tag \ref cfg_generate_docset "GENERATE_DOCSET" is set
should uniquely identify the documentation set bundle. This should be a
reverse domain-name style string, e.g. <code>com.mycompany.MyDocSet</code>.
Doxygen will append <code>.docset</code> to the name.
The default value is: <code>org.doxygen.Project</code>.
This tag requires that the tag \ref cfg_generate_docset "GENERATE_DOCSET" is set to \c YES.
\anchor cfg_docset_publisher_id
<dt>\c DOCSET_PUBLISHER_ID <dd>
......@@ -1970,15 +2087,19 @@ The \c DOCSET_PUBLISHER_ID
tag specifies a string that should uniquely identify
the documentation publisher. This should be a reverse domain-name style
string, e.g. <code>com.mycompany.MyDocSet.documentation</code>.
The default value is: <code>org.doxygen.Publisher</code>.
This tag requires that the tag \ref cfg_generate_docset "GENERATE_DOCSET" is set to \c YES.
\anchor cfg_docset_publisher_name
<dt>\c DOCSET_PUBLISHER_NAME <dd>
\addindex DOCSET_PUBLISHER_NAME
The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
The default value is: <code>Publisher</code>.
This tag requires that the tag \ref cfg_generate_docset "GENERATE_DOCSET" is set to \c YES.
\anchor cfg_generate_htmlhelp
<dt>\c GENERATE_HTMLHELP <dd>
......@@ -1999,8 +2120,10 @@ This tag requires that the tag \ref cfg_generate_docset "GENERATE_DOCSET" is set
and you can search for words in the documentation.
The HTML workshop also contains a viewer for compressed HTML files.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_chm_file
<dt>\c CHM_FILE <dd>
......@@ -2010,6 +2133,7 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
can add a path in front of the file if the result should not be
written to the html output directory.
This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES.
\anchor cfg_hhc_location
<dt>\c HHC_LOCATION <dd>
......@@ -2018,8 +2142,10 @@ This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is
be used to specify the location (absolute path including file name) of
the HTML help compiler (\c hhc.exe). If non-empty doxygen will try to run
the HTML help compiler on the generated \c index.hhp.
The file has to be specified with full path.
This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES.
\anchor cfg_generate_chi
<dt>\c GENERATE_CHI <dd>
......@@ -2028,8 +2154,10 @@ This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is
controls if a separate `.chi` index file is generated (\c YES) or that
it should be included in the master `.chm` file (\c NO).
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES.
\anchor cfg_chm_index_encoding
<dt>\c CHM_INDEX_ENCODING <dd>
......@@ -2038,6 +2166,7 @@ This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is
is used to encode HtmlHelp index (\c hhk), content (\c hhc) and project file
content.
This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES.
\anchor cfg_binary_toc
<dt>\c BINARY_TOC <dd>
......@@ -2046,8 +2175,10 @@ This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is
controls whether a binary table of contents is generated (\c YES) or a
normal table of contents (\c NO) in the `.chm` file.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES.
\anchor cfg_toc_expand
<dt>\c TOC_EXPAND <dd>
......@@ -2056,8 +2187,10 @@ This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is
group members to the table of contents of the HTML help documentation
and to the tree view.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is set to \c YES.
\anchor cfg_generate_qhp
<dt>\c GENERATE_QHP <dd>
......@@ -2068,8 +2201,10 @@ This tag requires that the tag \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" is
to generate a Qt Compressed Help (`.qch`) of the generated HTML
documentation.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_qch_file
<dt>\c QCH_FILE <dd>
......@@ -2078,6 +2213,7 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
be used to specify the file name of the resulting `.qch` file.
The path specified is relative to the HTML output folder.
This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES.
\anchor cfg_qhp_namespace
<dt>\c QHP_NAMESPACE <dd>
......@@ -2085,8 +2221,10 @@ This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c
The \c QHP_NAMESPACE tag specifies the namespace to use when generating
Qt Help Project output. For more information please see
<a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.
The default value is: <code>org.doxygen.Project</code>.
This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES.
\anchor cfg_qhp_virtual_folder
<dt>\c QHP_VIRTUAL_FOLDER <dd>
......@@ -2094,8 +2232,10 @@ This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c
The \c QHP_VIRTUAL_FOLDER tag specifies the namespace to use when
generating Qt Help Project output. For more information please see
<a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.
The default value is: <code>doc</code>.
This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES.
\anchor cfg_qhp_cust_filter_name
<dt>\c QHP_CUST_FILTER_NAME <dd>
......@@ -2103,6 +2243,7 @@ This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c
If the \c QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom filter to add. For more information please see
<a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES.
\anchor cfg_qhp_cust_filter_attrs
<dt>\c QHP_CUST_FILTER_ATTRS <dd>
......@@ -2111,6 +2252,7 @@ This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c
For more information please see
<a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES.
\anchor cfg_qhp_sect_filter_attrs
<dt>\c QHP_SECT_FILTER_ATTRS <dd>
......@@ -2118,6 +2260,7 @@ This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c
The \c QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's filter section matches.
<a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES.
\anchor cfg_qhg_location
<dt>\c QHG_LOCATION <dd>
......@@ -2125,6 +2268,7 @@ This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c
The \c QHG_LOCATION tag can be used to specify the location of Qt's qhelpgenerator.
If non-empty doxygen will try to run qhelpgenerator on the generated `.qhp` file.
This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c YES.
\anchor cfg_generate_eclipsehelp
<dt>\c GENERATE_ECLIPSEHELP <dd>
......@@ -2141,8 +2285,10 @@ This tag requires that the tag \ref cfg_generate_qhp "GENERATE_QHP" is set to \c
After copying `Eclipse` needs to be restarted before the help appears.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_eclipse_doc_id
<dt>\c ECLIPSE_DOC_ID <dd>
......@@ -2150,8 +2296,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
A unique identifier for the `Eclipse` help plugin. When installing the plugin
the directory name containing the HTML and XML files should also have
this name. Each documentation set should have its own identifier.
The default value is: <code>org.doxygen.Project</code>.
This tag requires that the tag \ref cfg_generate_eclipsehelp "GENERATE_ECLIPSEHELP" is set to \c YES.
\anchor cfg_disable_index
<dt>\c DISABLE_INDEX <dd>
......@@ -2164,8 +2312,10 @@ This tag requires that the tag \ref cfg_generate_eclipsehelp "GENERATE_ECLIPSEHE
information as the navigation tree, you can set this option to \c YES if
you also set \ref cfg_generate_treeview "GENERATE_TREEVIEW" to \c YES.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_generate_treeview
<dt>\c GENERATE_TREEVIEW <dd>
......@@ -2188,8 +2338,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
consider setting \ref cfg_disable_index "DISABLE_INDEX" to \c YES when
enabling this option.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_enum_values_per_line
<dt>\c ENUM_VALUES_PER_LINE <dd>
......@@ -2199,8 +2351,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
<br>Note that a value of 0 will completely suppress the enum values from
appearing in the overview section.
Minimum value: <code>0</code>, maximum value: <code>20</code>, default value: <code>4</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_treeview_width
<dt>\c TREEVIEW_WIDTH <dd>
......@@ -2209,8 +2363,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
used to set the initial width (in pixels) of the frame in which the tree
is shown.
Minimum value: <code>0</code>, maximum value: <code>1500</code>, default value: <code>250</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_ext_links_in_window
<dt>\c EXT_LINKS_IN_WINDOW <dd>
......@@ -2218,8 +2374,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
When the \c EXT_LINKS_IN_WINDOW option is set to \c YES doxygen will open
links to external symbols imported via tag files in a separate window.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_formula_fontsize
<dt>\c FORMULA_FONTSIZE <dd>
......@@ -2230,8 +2388,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
to manually remove any `form_*.png` images from the HTML
output directory to force them to be regenerated.
Minimum value: <code>8</code>, maximum value: <code>50</code>, default value: <code>10</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_formula_transparent
<dt>\c FORMULA_TRANSPARENT <dd>
......@@ -2242,8 +2402,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
<br>Note that when changing this option you need to delete any `form_*.png` files
in the HTML output directory before the changes have effect.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_use_mathjax
<dt>\c USE_MATHJAX <dd>
......@@ -2256,8 +2418,10 @@ This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to
configure the path to it using the \ref cfg_mathjax_relpath "MATHJAX_RELPATH"
option.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_mathjax_format
<dt>\c MATHJAX_FORMAT <dd>
......@@ -2272,8 +2436,10 @@ Possible values are:
<code>NativeMML</code> (i.e. MathML) and
<code>SVG</code>.
The default value is: <code>HTML-CSS</code>.
This tag requires that the tag \ref cfg_use_mathjax "USE_MATHJAX" is set to \c YES.
\anchor cfg_mathjax_relpath
<dt>\c MATHJAX_RELPATH <dd>
......@@ -2286,8 +2452,10 @@ This tag requires that the tag \ref cfg_use_mathjax "USE_MATHJAX" is set to \c Y
the MathJax Content Delivery Network so you can quickly see the result without
installing MathJax. However, it is strongly recommended to install a local
copy of MathJax from http://www.mathjax.org before deployment.
The default value is: <code>http://cdn.mathjax.org/mathjax/latest</code>.
This tag requires that the tag \ref cfg_use_mathjax "USE_MATHJAX" is set to \c YES.
\anchor cfg_mathjax_extensions
<dt>\c MATHJAX_EXTENSIONS <dd>
......@@ -2298,6 +2466,7 @@ This tag requires that the tag \ref cfg_use_mathjax "USE_MATHJAX" is set to \c Y
MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
\endverbatim
This tag requires that the tag \ref cfg_use_mathjax "USE_MATHJAX" is set to \c YES.
\anchor cfg_mathjax_codefile
<dt>\c MATHJAX_CODEFILE <dd>
......@@ -2320,6 +2489,7 @@ MATHJAX_CODEFILE = disableRenderer.js
});
\endverbatim
This tag requires that the tag \ref cfg_use_mathjax "USE_MATHJAX" is set to \c YES.
\anchor cfg_searchengine
<dt>\c SEARCHENGINE <dd>
......@@ -2345,8 +2515,10 @@ This tag requires that the tag \ref cfg_use_mathjax "USE_MATHJAX" is set to \c Y
by pressing <code>\<Shift\>+\<cursor down\></code>. Also here use the <code>\<cursor keys\></code> to
select a filter and <code>\<Enter\></code> or <code>\<escape\></code> to activate or cancel the filter option.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_generate_html "GENERATE_HTML" is set to \c YES.
\anchor cfg_server_based_search
<dt>\c SERVER_BASED_SEARCH <dd>
......@@ -2361,8 +2533,10 @@ by the script. When \ref cfg_external_search "EXTERNAL_SEARCH" is
enabled the indexing and searching needs to be provided by external tools.
See the section \ref extsearch for details.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c YES.
\anchor cfg_external_search
<dt>\c EXTERNAL_SEARCH <dd>
......@@ -2378,8 +2552,10 @@ This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c
engine library <a href="http://xapian.org/">Xapian</a>.
<br>See the section \ref extsearch for details.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c YES.
\anchor cfg_searchengine_url
<dt>\c SEARCHENGINE_URL <dd>
......@@ -2392,6 +2568,7 @@ This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c
engine library <a href="http://xapian.org/">Xapian</a>.
See the section \ref extsearch for details.
This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c YES.
\anchor cfg_searchdata_file
<dt>\c SEARCHDATA_FILE <dd>
......@@ -2400,8 +2577,10 @@ When \ref cfg_server_based_search "SERVER_BASED_SEARCH" and
\ref cfg_external_search "EXTERNAL_SEARCH" are both enabled the unindexed
search data is written to a file for indexing by an external tool. With the
\c SEARCHDATA_FILE tag the name of this file can be specified.
The default file is: <code>searchdata.xml</code>.
This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c YES.
\anchor cfg_external_search_id
<dt>\c EXTERNAL_SEARCH_ID <dd>
......@@ -2412,6 +2591,7 @@ When \ref cfg_server_based_search "SERVER_BASED_SEARCH" and
useful in combination with \ref cfg_extra_search_mappings "EXTRA_SEARCH_MAPPINGS"
to search through multiple projects and redirect the results back to the right project.
This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c YES.
\anchor cfg_extra_search_mappings
<dt>\c EXTRA_SEARCH_MAPPINGS <dd>
......@@ -2428,6 +2608,7 @@ This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c
EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
\endverbatim
This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c YES.
</dl>
\section config_latex Configuration options related to the LaTeX output
......@@ -2439,6 +2620,7 @@ This tag requires that the tag \ref cfg_searchengine "SEARCHENGINE" is set to \c
If the \c GENERATE_LATEX tag is set to \c YES doxygen will
generate \f$\mbox{\LaTeX}\f$ output.
The default value is: <code>YES</code>.
\anchor cfg_latex_output
......@@ -2448,8 +2630,10 @@ The default value is: <code>YES</code>.
docs will be put.
If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
put in front of it.
The default directory is: <code>latex</code>.
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
\anchor cfg_latex_cmd_name
<dt>\c LATEX_CMD_NAME <dd>
......@@ -2458,16 +2642,20 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
<br>Note that when enabling \ref cfg_use_pdflatex "USE_PDFLATEX" this option is only used for
generating bitmaps for formulas in the HTML output, but not in the
\c Makefile that is written to the output directory.
The default file is: <code>latex</code>.
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
\anchor cfg_makeindex_cmd_name
<dt>\c MAKEINDEX_CMD_NAME <dd>
\addindex MAKEINDEX_CMD_NAME
The \c MAKEINDEX_CMD_NAME tag can be used to specify the command name to
generate index for \f$\mbox{\LaTeX}\f$.
The default file is: <code>makeindex</code>.
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
\anchor cfg_compact_latex
<dt>\c COMPACT_LATEX <dd>
......@@ -2476,8 +2664,10 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
\f$\mbox{\LaTeX}\f$ documents. This may be useful for small projects and may help to
save some trees in general.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
\anchor cfg_paper_type
<dt>\c PAPER_TYPE <dd>
......@@ -2491,8 +2681,10 @@ Possible values are:
<code>legal</code> (8.5 x 14 inches) and
<code>executive</code> (7.25 x 10.5 inches).
The default value is: <code>a4</code>.
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
\anchor cfg_extra_packages
<dt>\c EXTRA_PACKAGES <dd>
......@@ -2505,6 +2697,7 @@ EXTRA_PACKAGES=times
\endverbatim
If left blank no extra packages will be included.
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
\anchor cfg_latex_header
<dt>\c LATEX_HEADER <dd>
......@@ -2528,6 +2721,7 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
the version number of doxygen, the project name (see \ref cfg_project_name "PROJECT_NAME"), or the
project number (see \ref cfg_project_number "PROJECT_NUMBER").
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
\anchor cfg_latex_footer
<dt>\c LATEX_FOOTER <dd>
......@@ -2539,6 +2733,7 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
<br>Note: Only use a user-defined footer if you know what you are doing!
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
\anchor cfg_latex_extra_files
<dt>\c LATEX_EXTRA_FILES <dd>
......@@ -2549,6 +2744,7 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
Note that the files will be copied as-is; there are no commands or markers
available.
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
\anchor cfg_pdf_hyperlinks
<dt>\c PDF_HYPERLINKS <dd>
......@@ -2559,8 +2755,10 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
contain links (just like the HTML output) instead of page references.
This makes the output suitable for online browsing using a PDF viewer.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
\anchor cfg_use_pdflatex
<dt>\c USE_PDFLATEX <dd>
......@@ -2569,8 +2767,10 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
\c pdflatex to generate the PDF file directly from the \f$\mbox{\LaTeX}\f$
files. Set this option to \c YES to get a higher quality PDF documentation.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
\anchor cfg_latex_batchmode
<dt>\c LATEX_BATCHMODE <dd>
......@@ -2581,8 +2781,10 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
asking the user for help. This option is also used when generating formulas
in HTML.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
\anchor cfg_latex_hide_indices
<dt>\c LATEX_HIDE_INDICES <dd>
......@@ -2591,8 +2793,10 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
include the index chapters (such as File Index, Compound Index, etc.)
in the output.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
\anchor cfg_latex_source_code
<dt>\c LATEX_SOURCE_CODE <dd>
......@@ -2602,8 +2806,10 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
<br>Note that which sources are shown also depends on other settings
such as \ref cfg_source_browser "SOURCE_BROWSER".
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
\anchor cfg_latex_bib_style
<dt>\c LATEX_BIB_STYLE <dd>
......@@ -2612,8 +2818,10 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
bibliography, e.g. \c plainnat, or \c ieeetr.
See http://en.wikipedia.org/wiki/BibTeX and \ref cmdcite "\\cite"
for more info.
The default value is: <code>plain</code>.
This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set to \c YES.
</dl>
\section config_rtf Configuration options related to the RTF output
......@@ -2626,6 +2834,7 @@ This tag requires that the tag \ref cfg_generate_latex "GENERATE_LATEX" is set t
The RTF output is optimized for Word 97 and may not look too pretty with
other RTF readers/editors.
The default value is: <code>NO</code>.
\anchor cfg_rtf_output
......@@ -2634,8 +2843,10 @@ The default value is: <code>NO</code>.
The \c RTF_OUTPUT tag is used to specify where the RTF docs will be put.
If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
put in front of it.
The default directory is: <code>rtf</code>.
This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c YES.
\anchor cfg_compact_rtf
<dt>\c COMPACT_RTF <dd>
......@@ -2644,8 +2855,10 @@ This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c
RTF documents. This may be useful for small projects and may help to
save some trees in general.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c YES.
\anchor cfg_rtf_hyperlinks
<dt>\c RTF_HYPERLINKS <dd>
......@@ -2658,8 +2871,10 @@ This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c
<br>Note: WordPad (write) and others do not support links.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c YES.
\anchor cfg_rtf_stylesheet_file
<dt>\c RTF_STYLESHEET_FILE <dd>
......@@ -2671,6 +2886,7 @@ This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c
See also section \ref doxygen_usage for information on how to generate
the default style sheet that doxygen normally uses.
This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c YES.
\anchor cfg_rtf_extensions_file
<dt>\c RTF_EXTENSIONS_FILE <dd>
......@@ -2680,6 +2896,7 @@ This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c
A template extensions file can be generated using
<code>doxygen -e rtf extensionFile</code>.
This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c YES.
</dl>
\section config_man Configuration options related to the man page output
......@@ -2691,6 +2908,7 @@ This tag requires that the tag \ref cfg_generate_rtf "GENERATE_RTF" is set to \c
If the \c GENERATE_MAN tag is set to \c YES doxygen will
generate man pages for classes and files.
The default value is: <code>NO</code>.
\anchor cfg_man_output
......@@ -2701,8 +2919,10 @@ The default value is: <code>NO</code>.
put in front of it.
A directory \c man3 will be created inside the directory specified by
\c MAN_OUTPUT.
The default directory is: <code>man</code>.
This tag requires that the tag \ref cfg_generate_man "GENERATE_MAN" is set to \c YES.
\anchor cfg_man_extension
<dt>\c MAN_EXTENSION <dd>
......@@ -2711,8 +2931,10 @@ This tag requires that the tag \ref cfg_generate_man "GENERATE_MAN" is set to \c
the generated man pages. In case
the manual section does not start with a number, the number 3 is prepended.
The dot (.) at the beginning of the \c MAN_EXTENSION tag is optional.
The default value is: <code>.3</code>.
This tag requires that the tag \ref cfg_generate_man "GENERATE_MAN" is set to \c YES.
\anchor cfg_man_links
<dt>\c MAN_LINKS <dd>
......@@ -2722,8 +2944,10 @@ This tag requires that the tag \ref cfg_generate_man "GENERATE_MAN" is set to \c
the real man page(s). These additional files only source the real man page,
but without them the \c man command would be unable to find the correct page.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_man "GENERATE_MAN" is set to \c YES.
</dl>
\section config_xml Configuration options related to the XML output
......@@ -2736,6 +2960,7 @@ This tag requires that the tag \ref cfg_generate_man "GENERATE_MAN" is set to \c
generate an XML file that captures the structure of
the code including all documentation.
The default value is: <code>NO</code>.
\anchor cfg_xml_output
......@@ -2744,8 +2969,10 @@ The default value is: <code>NO</code>.
The \c XML_OUTPUT tag is used to specify where the XML pages will be put.
If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
put in front of it.
The default directory is: <code>xml</code>.
This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c YES.
\anchor cfg_xml_schema
<dt>\c XML_SCHEMA <dd>
......@@ -2754,6 +2981,7 @@ This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c
which can be used by a validating XML parser to check the
syntax of the XML files.
This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c YES.
\anchor cfg_xml_dtd
<dt>\c XML_DTD <dd>
......@@ -2762,6 +2990,7 @@ This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c
which can be used by a validating XML parser to check the
syntax of the XML files.
This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c YES.
\anchor cfg_xml_programlisting
<dt>\c XML_PROGRAMLISTING <dd>
......@@ -2771,8 +3000,10 @@ This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c
and cross-referencing information) to the XML output. Note that
enabling this will significantly increase the size of the XML output.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c YES.
</dl>
\section config_docbook Configuration options related to the DOCBOOK output
......@@ -2784,6 +3015,7 @@ This tag requires that the tag \ref cfg_generate_xml "GENERATE_XML" is set to \c
If the \c GENERATE_DOCBOOK tag is set to \c YES doxygen will generate Docbook files
that can be used to generate PDF.
The default value is: <code>NO</code>.
\anchor cfg_docbook_output
......@@ -2792,11 +3024,13 @@ The default value is: <code>NO</code>.
The \c DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be put in
front of it.
The default directory is: <code>docbook</code>.
This tag requires that the tag \ref cfg_generate_docbook "GENERATE_DOCBOOK" is set to \c YES.
</dl>
\section config_def Configuration options for the AutoGen Definitions output
\section config_autogen Configuration options for the AutoGen Definitions output
\anchor cfg_generate_autogen_def
<dl>
......@@ -2808,6 +3042,7 @@ This tag requires that the tag \ref cfg_generate_docbook "GENERATE_DOCBOOK" is s
documentation. Note that this feature is still experimental
and incomplete at the moment.
The default value is: <code>NO</code>.
</dl>
......@@ -2824,6 +3059,7 @@ The default value is: <code>NO</code>.
feature is still experimental and incomplete at the
moment.
The default value is: <code>NO</code>.
\anchor cfg_perlmod_latex
......@@ -2833,8 +3069,10 @@ The default value is: <code>NO</code>.
the necessary \c Makefile rules, \c Perl scripts and \f$\mbox{\LaTeX}\f$ code to be able
to generate PDF and DVI output from the Perl module output.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_generate_perlmod "GENERATE_PERLMOD" is set to \c YES.
\anchor cfg_perlmod_pretty
<dt>\c PERLMOD_PRETTY <dd>
......@@ -2845,8 +3083,10 @@ This tag requires that the tag \ref cfg_generate_perlmod "GENERATE_PERLMOD" is s
tag is set to \c NO the size of the Perl module output will be much smaller
and Perl will parse it just the same.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_generate_perlmod "GENERATE_PERLMOD" is set to \c YES.
\anchor cfg_perlmod_makevar_prefix
<dt>\c PERLMOD_MAKEVAR_PREFIX <dd>
......@@ -2856,6 +3096,7 @@ This tag requires that the tag \ref cfg_generate_perlmod "GENERATE_PERLMOD" is s
This is useful so different `doxyrules.make` files included by the same
`Makefile` don't overwrite each other's variables.
This tag requires that the tag \ref cfg_generate_perlmod "GENERATE_PERLMOD" is set to \c YES.
</dl>
\section config_preprocessor Configuration options related to the preprocessor
......@@ -2868,6 +3109,7 @@ This tag requires that the tag \ref cfg_generate_perlmod "GENERATE_PERLMOD" is s
evaluate all C-preprocessor directives found in the sources and include
files.
The default value is: <code>YES</code>.
\anchor cfg_macro_expansion
......@@ -2878,8 +3120,10 @@ The default value is: <code>YES</code>.
compilation will be performed. Macro expansion can be done in a controlled
way by setting \ref cfg_expand_only_predef "EXPAND_ONLY_PREDEF" to \c YES.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to \c YES.
\anchor cfg_expand_only_predef
<dt>\c EXPAND_ONLY_PREDEF <dd>
......@@ -2888,8 +3132,10 @@ This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSI
then the macro expansion is limited to the macros specified with the
\ref cfg_predefined "PREDEFINED" and \ref cfg_expand_as_defined "EXPAND_AS_DEFINED" tags.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to \c YES.
\anchor cfg_search_includes
<dt>\c SEARCH_INCLUDES <dd>
......@@ -2897,8 +3143,10 @@ This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSI
If the \c SEARCH_INCLUDES tag is set to \c YES the includes files
in the \ref cfg_include_path "INCLUDE_PATH" will be searched if a \c \#include is found.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to \c YES.
\anchor cfg_include_path
<dt>\c INCLUDE_PATH <dd>
......@@ -2907,6 +3155,7 @@ This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSI
contain include files that are not input files but should be processed by
the preprocessor.
This tag requires that the tag \ref cfg_search_includes "SEARCH_INCLUDES" is set to \c YES.
\anchor cfg_include_file_patterns
<dt>\c INCLUDE_FILE_PATTERNS <dd>
......@@ -2916,6 +3165,7 @@ This tag requires that the tag \ref cfg_search_includes "SEARCH_INCLUDES" is set
directories. If left blank, the patterns specified with \ref cfg_file_patterns "FILE_PATTERNS" will
be used.
This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to \c YES.
\anchor cfg_predefined
<dt>\c PREDEFINED <dd>
......@@ -2928,6 +3178,7 @@ This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSI
a macro definition from being undefined via \c \#undef or recursively expanded
use the <code>:=</code> operator instead of the \c = operator.
This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to \c YES.
\anchor cfg_expand_as_defined
<dt>\c EXPAND_AS_DEFINED <dd>
......@@ -2939,6 +3190,7 @@ This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSI
Use the \ref cfg_predefined "PREDEFINED" tag if you want to use a different macro definition that
overrules the definition found in the source code.
This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to \c YES.
\anchor cfg_skip_function_macros
<dt>\c SKIP_FUNCTION_MACROS <dd>
......@@ -2949,8 +3201,10 @@ This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSI
Such function macros are typically
used for boiler-plate code, and will confuse the parser if not removed.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to \c YES.
</dl>
\section config_external Configuration options related to external references
......@@ -2995,6 +3249,7 @@ where `loc1` and `loc2` can be relative or absolute paths or URLs.
in the class index. If set to \c NO only the inherited external classes
will be listed.
The default value is: <code>NO</code>.
\anchor cfg_external_groups
......@@ -3004,6 +3259,7 @@ The default value is: <code>NO</code>.
in the modules index. If set to \c NO, only the current project's groups will
be listed.
The default value is: <code>YES</code>.
\anchor cfg_external_pages
......@@ -3013,6 +3269,7 @@ The default value is: <code>YES</code>.
in the related pages index. If set to \c NO, only the current project's
pages will be listed.
The default value is: <code>YES</code>.
\anchor cfg_perl_path
......@@ -3020,6 +3277,7 @@ The default value is: <code>YES</code>.
\addindex PERL_PATH
The \c PERL_PATH should be the absolute path and name of the perl script
interpreter (i.e. the result of `'which perl'`).
The default file (with absolute path) is: <code>/usr/bin/perl</code>.
</dl>
......@@ -3035,6 +3293,7 @@ The default file (with absolute path) is: <code>/usr/bin/perl</code>.
this option also works with \ref cfg_have_dot "HAVE_DOT" disabled, but it is recommended to
install and use \c dot, since it yields more powerful graphs.
The default value is: <code>YES</code>.
\anchor cfg_mscgen_path
......@@ -3053,6 +3312,7 @@ The default value is: <code>YES</code>.
inheritance and usage relations if the target is undocumented
or is not a class.
The default value is: <code>YES</code>.
\anchor cfg_have_dot
......@@ -3064,6 +3324,7 @@ The default value is: <code>YES</code>.
visualization toolkit from AT\&T and Lucent Bell Labs. The other options in
this section have no effect if this option is set to \c NO
The default value is: <code>NO</code>.
\anchor cfg_dot_num_threads
......@@ -3075,8 +3336,10 @@ The default value is: <code>NO</code>.
explicitly to a value larger than 0 to get control over the balance
between CPU load and processing speed.
Minimum value: <code>0</code>, maximum value: <code>32</code>, default value: <code>0</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_dot_fontname
<dt>\c DOT_FONTNAME <dd>
......@@ -3087,16 +3350,20 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
which can be done by putting it in a standard location or by setting the
\c DOTFONTPATH environment variable or by setting \ref cfg_dot_fontpath "DOT_FONTPATH" to the
directory containing the font.
The default value is: <code>Helvetica</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_dot_fontsize
<dt>\c DOT_FONTSIZE <dd>
\addindex DOT_FONTSIZE
The \c DOT_FONTSIZE tag can be used to set the size (in points) of the font of dot graphs.
Minimum value: <code>4</code>, maximum value: <code>24</code>, default value: <code>10</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_dot_fontpath
<dt>\c DOT_FONTPATH <dd>
......@@ -3106,6 +3373,7 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
different font using \ref cfg_dot_fontname "DOT_FONTNAME" you can set the path where \c dot
can find it using this tag.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_class_graph
<dt>\c CLASS_GRAPH <dd>
......@@ -3115,8 +3383,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
indirect inheritance relations. Setting this tag to \c YES will force
the \ref cfg_class_diagrams "CLASS_DIAGRAMS" tag to \c NO.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_collaboration_graph
<dt>\c COLLABORATION_GRAPH <dd>
......@@ -3126,8 +3396,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
indirect implementation dependencies (inheritance, containment, and
class references variables) of the class with other documented classes.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_group_graphs
<dt>\c GROUP_GRAPHS <dd>
......@@ -3135,8 +3407,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
If the \c GROUP_GRAPHS tag is set to \c YES then doxygen
will generate a graph for groups, showing the direct groups dependencies.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_uml_look
<dt>\c UML_LOOK <dd>
......@@ -3145,8 +3419,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
collaboration diagrams in a style similar to the OMG's Unified Modeling
Language.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_uml_limit_num_fields
<dt>\c UML_LIMIT_NUM_FIELDS <dd>
......@@ -3160,8 +3436,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
to 10, up to 15 fields may appear, but if the number exceeds 15, the
total amount of fields shown is limited to 10.
Minimum value: <code>0</code>, maximum value: <code>100</code>, default value: <code>10</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_template_relations
<dt>\c TEMPLATE_RELATIONS <dd>
......@@ -3169,8 +3447,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
If the \c TEMPLATE_RELATIONS tag is set to \c YES then
the inheritance and collaboration graphs will show the relations between templates and their instances.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_include_graph
<dt>\c INCLUDE_GRAPH <dd>
......@@ -3181,8 +3461,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
showing the direct and indirect include dependencies of the file with other
documented files.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_included_by_graph
<dt>\c INCLUDED_BY_GRAPH <dd>
......@@ -3193,8 +3475,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
showing the direct and indirect include dependencies of the file with other
documented files.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_call_graph
<dt>\c CALL_GRAPH <dd>
......@@ -3205,8 +3489,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
So in most cases it will be better to enable call graphs for selected
functions only using the \ref cmdcallgraph "\\callgraph" command.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_caller_graph
<dt>\c CALLER_GRAPH <dd>
......@@ -3217,8 +3503,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
So in most cases it will be better to enable caller graphs for selected
functions only using the \ref cmdcallergraph "\\callergraph" command.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_graphical_hierarchy
<dt>\c GRAPHICAL_HIERARCHY <dd>
......@@ -3226,8 +3514,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
If the \c GRAPHICAL_HIERARCHY tag is set to \c YES then
doxygen will graphical hierarchy of all classes instead of a textual one.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_directory_graph
<dt>\c DIRECTORY_GRAPH <dd>
......@@ -3237,8 +3527,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
in a graphical way. The dependency relations are determined by the \c \#include
relations between the files in the directories.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_dot_image_format
<dt>\c DOT_IMAGE_FORMAT <dd>
......@@ -3255,8 +3547,10 @@ Possible values are:
<code>gif</code> and
<code>svg</code>.
The default value is: <code>png</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_interactive_svg
<dt>\c INTERACTIVE_SVG <dd>
......@@ -3268,8 +3562,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\note For IE 9+ you need to set \ref cfg_html_file_extension "HTML_FILE_EXTENSION" to \c xhtml in order
to make the SVG files visible. Older versions of IE do not have SVG support.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_dot_path
<dt>\c DOT_PATH <dd>
......@@ -3277,6 +3573,7 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
The \c DOT_PATH tag can be used to specify the path where the \c dot tool can be found.
If left blank, it is assumed the \c dot tool can be found in the \c path.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_dotfile_dirs
<dt>\c DOTFILE_DIRS <dd>
......@@ -3285,6 +3582,7 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
contain dot files that are included in the documentation (see the
\ref cmddotfile "\\dotfile" command).
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_mscfile_dirs
<dt>\c MSCFILE_DIRS <dd>
......@@ -3304,8 +3602,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\c DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
that the size of a graph can be further restricted by \ref cfg_max_dot_graph_depth "MAX_DOT_GRAPH_DEPTH".
Minimum value: <code>0</code>, maximum value: <code>10000</code>, default value: <code>50</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_max_dot_graph_depth
<dt>\c MAX_DOT_GRAPH_DEPTH <dd>
......@@ -3318,8 +3618,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
code bases. Also note that the size of a graph can be further restricted by
\ref cfg_dot_graph_max_nodes "DOT_GRAPH_MAX_NODES". Using a depth of 0 means no depth restriction.
Minimum value: <code>0</code>, maximum value: <code>1000</code>, default value: <code>0</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_dot_transparent
<dt>\c DOT_TRANSPARENT <dd>
......@@ -3332,8 +3634,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
enabling this option may lead to badly anti-aliased labels on the edges of
a graph (i.e. they become hard to read).
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_dot_multi_targets
<dt>\c DOT_MULTI_TARGETS <dd>
......@@ -3343,8 +3647,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
makes \c dot run faster, but since only newer versions of \c dot (>1.8.10)
support this, this feature is disabled by default.
The default value is: <code>NO</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_generate_legend
<dt>\c GENERATE_LEGEND <dd>
......@@ -3353,8 +3659,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
generate a legend page explaining the meaning of the various boxes and
arrows in the dot generated graphs.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\anchor cfg_dot_cleanup
<dt>\c DOT_CLEANUP <dd>
......@@ -3362,8 +3670,10 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
If the \c DOT_CLEANUP tag is set to \c YES doxygen will
remove the intermediate dot files that are used to generate the various graphs.
The default value is: <code>YES</code>.
This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
</dl>
\section config_examples Examples
......
src/config.xml
View file @ 83fc120e
......@@ -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[
......
src/configgen.py
View file @ 83fc120e
......@@ -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)
......@@ -392,6 +396,7 @@ def parseOptionDoc(node, first):
else:
print "%s, " % (val)
if (defval != ""):
print ""
print ""
print "The default value is: <code>%s</code>." % (defval)
print ""
......@@ -399,15 +404,17 @@ def parseOptionDoc(node, first):
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>",
"default value", "<code>", defval, "</code>")
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
......
src/configoptions.cpp
View file @ 83fc120e
This source diff could not be displayed because it is too large. You can view the blob instead.
src/doxygen.cpp
View file @ 83fc120e
......@@ -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);
}
......
src/doxygen.md
View file @ 83fc120e
......@@ -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
---------------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment