<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Doxygen manual: Configuration</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.4 -->
<h1><a class="anchor" name="config">Configuration</a></h1><h2><a class="anchor" name="config_format">
Format</a></h2>
A configuration file is a free-form ASCII text file with a structure that is similar to that of a Makefile, with the default name <code>Doxyfile</code>. It is parsed by <code>doxygen</code>. The file may contain tabs and newlines for formatting purposes. The statements in the file are case-sensitive. Comments may be placed anywhere within the file (except within quotes). Comments begin with the # character and end at the end of the line.<p>
The file essentially consists of a list of assignment statements. Each statement consists of a <code>TAG_NAME</code> written in capitals, followed by the <code>=</code> character and one or more values. If the same tag is assigned more than once, the last assignment overwrites any earlier assignment. For options that take a list as their argument, the <code>+=</code> operator can be used instead of <code>=</code> to append new values to the list. Values are sequences of non-blanks. If the value should contain one or more blanks it must be surrounded by quotes ("..."). Multiple lines can be concatenated by inserting a backslash (\) as the last character of a line. Environment variables can be expanded using the pattern <code>$(ENV_VARIABLE_NAME)</code>.<p>
You can also include part of a configuration file from another configuration file using a <code>@INCLUDE</code> tag as follows: <div class="fragment"><pre class="fragment">@INCLUDE = config_file_name
</pre></div> The include file is searched in the current working directory. You can also specify a list of directories that should be searched before looking in the current working directory. Do this by putting a <code>@INCLUDE_PATH</code> tag with these paths before the <code>@INCLUDE</code> tag, e.g: <div class="fragment"><pre class="fragment">@INCLUDE_PATH = my_config_dir
</pre></div><p>
The configuration options can be divided into several categories. Below is an alphabetical index of the tags that are recognized followed by the descriptions of the tags grouped by category.<p>
<multicol cols=3>
<ul>
<li><a href="config.html#cfg_abbreviate_brief">ABBREVIATE_BRIEF</a> <li><a href="config.html#cfg_aliases">ALIASES</a> <li><a href="config.html#cfg_allexternals">ALLEXTERNALS </a> <li><a href="config.html#cfg_alphabetical_index">ALPHABETICAL_INDEX </a> <li><a href="config.html#cfg_always_detailed_sec">ALWAYS_DETAILED_SEC</a> <li><a href="config.html#cfg_binary_toc">BINARY_TOC</a> <li><a href="config.html#cfg_brief_member_desc">BRIEF_MEMBER_DESC </a> <li><a href="config.html#cfg_call_graph">CALL_GRAPH</a> <li><a href="config.html#cfg_case_sense_names">CASE_SENSE_NAMES </a> <li><a href="config.html#cfg_chm_file">CHM_FILE</a> <li><a href="config.html#cfg_class_diagrams">CLASS_DIAGRAMS </a> <li><a href="config.html#cfg_class_graph">CLASS_GRAPH</a> <li><a href="config.html#cfg_collaboration_graph">COLLABORATION_GRAPH</a> <li><a href="config.html#cfg_cols_in_alpha_index">COLS_IN_ALPHA_INDEX</a> <li><a href="config.html#cfg_compact_latex">COMPACT_LATEX </a> <li><a href="config.html#cfg_compact_rtf">COMPACT_RTF</a> <li><a href="config.html#cfg_create_subdirs">CREATE_SUBDIRS</a> <li><a href="config.html#cfg_details_at_top">DETAILS_AT_TOP </a> <li><a href="config.html#cfg_directory_graph">DIRECTORY_GRAPH</a> <li><a href="config.html#cfg_disable_index">DISABLE_INDEX </a> <li><a href="config.html#cfg_distribute_group_doc">DISTRIBUTE_GROUP_DOC</a> <li><a href="config.html#cfg_dot_image_format">DOT_IMAGE_FORMAT</a> <li><a href="config.html#cfg_dot_multi_targets">DOT_MULTI_TARGETS</a> <li><a href="config.html#cfg_dot_path">DOT_PATH</a> <li><a href="config.html#cfg_dot_transparent">DOT_TRANSPARENT</a> <li><a href="config.html#cfg_dotfile_dirs">DOTFILE_DIRS</a> <li><a href="config.html#cfg_enable_preprocessing">ENABLE_PREPROCESSING</a> <li><a href="config.html#cfg_enum_values_per_line">ENUM_VALUES_PER_LINE</a> <li><a href="config.html#cfg_enabled_sections">ENABLED_SECTIONS</a> <li><a href="config.html#cfg_example_path">EXAMPLE_PATH</a> <li><a href="config.html#cfg_example_patterns">EXAMPLE_PATTERNS</a> <li><a href="config.html#cfg_example_recursive">EXAMPLE_RECURSIVE</a> <li><a href="config.html#cfg_exclude">EXCLUDE</a> <li><a href="config.html#cfg_exclude_patterns">EXCLUDE_PATTERNS</a> <li><a href="config.html#cfg_exclude_symlinks">EXCLUDE_SYMLINKS</a> <li><a href="config.html#cfg_expand_as_defined">EXPAND_AS_DEFINED</a> <li><a href="config.html#cfg_expand_only_predef">EXPAND_ONLY_PREDEF</a> <li><a href="config.html#cfg_external_groups">EXTERNAL_GROUPS</a> <li><a href="config.html#cfg_extra_packages">EXTRA_PACKAGES</a> <li><a href="config.html#cfg_extract_all">EXTRACT_ALL</a> <li><a href="config.html#cfg_extract_local_classes">EXTRACT_LOCAL_CLASSES</a> <li><a href="config.html#cfg_extract_local_methods">EXTRACT_LOCAL_METHODS</a> <li><a href="config.html#cfg_extract_private">EXTRACT_PRIVATE</a> <li><a href="config.html#cfg_extract_static">EXTRACT_STATIC</a> <li><a href="config.html#cfg_file_patterns">FILE_PATTERNS</a> <li><a href="config.html#cfg_file_version_filter">FILE_VERSION_FILTER</a> <li><a href="config.html#cfg_filter_patterns">FILTER_PATTERNS</a> <li><a href="config.html#cfg_filter_source_files">FILTER_SOURCE_FILES</a> <li><a href="config.html#cfg_full_path_names">FULL_PATH_NAMES</a> <li><a href="config.html#cfg_generate_autogen_def">GENERATE_AUTOGEN_DEF</a> <li><a href="config.html#cfg_generate_buglist">GENERATE_BUGLIST</a> <li><a href="config.html#cfg_generate_chi">GENERATE_CHI</a> <li><a href="config.html#cfg_generate_deprecatedlist">GENERATE_DEPRECIATEDLIST</a> <li><a href="config.html#cfg_generate_html">GENERATE_HTML</a> <li><a href="config.html#cfg_generate_htmlhelp">GENERATE_HTMLHELP</a> <li><a href="config.html#cfg_generate_latex">GENERATE_LATEX</a> <li><a href="config.html#cfg_generate_legend">GENERATE_LEGEND</a> <li><a href="config.html#cfg_generate_man">GENERATE_MAN</a> <li><a href="config.html#cfg_generate_perlmod">GENERATE_PERLMOD</a> <li><a href="config.html#cfg_generate_rtf">GENERATE_RTF</a> <li><a href="config.html#cfg_generate_tagfile">GENERATE_TAGFILE</a> <li><a href="config.html#cfg_generate_testlist">GENERATE_TESTLIST</a> <li><a href="config.html#cfg_generate_todolist">GENERATE_TODOLIST</a> <li><a href="config.html#cfg_generate_treeview">GENERATE_TREEVIEW</a> <li><a href="config.html#cfg_generate_xml">GENERATE_XML</a> <li><a href="config.html#cfg_graphical_hierarchy">GRAPHICAL_HIERARCHY</a> <li><a href="config.html#cfg_group_graphs">GROUP_GRAPHS</a> <li><a href="config.html#cfg_have_dot">HAVE_DOT</a> <li><a href="config.html#cfg_hhc_location">HHC_LOCATION</a> <li><a href="config.html#cfg_hide_friend_compounds">HIDE_FRIEND_COMPOUNDS</a> <li><a href="config.html#cfg_hide_in_body_docs">HIDE_IN_BODY_DOCS</a> <li><a href="config.html#cfg_hide_scope_names">HIDE_SCOPE_NAMES</a> <li><a href="config.html#cfg_hide_undoc_classes">HIDE_UNDOC_CLASSES</a> <li><a href="config.html#cfg_hide_undoc_members">HIDE_UNDOC_MEMBERS</a> <li><a href="config.html#cfg_hide_undoc_relations">HIDE_UNDOC_RELATIONS</a> <li><a href="config.html#cfg_html_align_members">HTML_ALIGN_MEMBERS</a> <li><a href="config.html#cfg_html_footer">HTML_FOOTER</a> <li><a href="config.html#cfg_html_header">HTML_HEADER</a> <li><a href="config.html#cfg_html_output">HTML_OUTPUT</a> <li><a href="config.html#cfg_html_stylesheet">HTML_STYLESHEET</a> <li><a href="config.html#cfg_ignore_prefix">IGNORE_PREFIX</a> <li><a href="config.html#cfg_image_path">IMAGE_PATH</a> <li><a href="config.html#cfg_include_graph">INCLUDE_GRAPH</a> <li><a href="config.html#cfg_include_path">INCLUDE_PATH</a> <li><a href="config.html#cfg_inherit_docs">INHERIT_DOCS</a> <li><a href="config.html#cfg_inline_info">INLINE_INFO</a> <li><a href="config.html#cfg_inline_inherited_memb">INLINE_INHERITED_MEMB</a> <li><a href="config.html#cfg_inline_sources">INLINE_SOURCES</a> <li><a href="config.html#cfg_input">INPUT</a> <li><a href="config.html#cfg_input_filter">INPUT_FILTER</a> <li><a href="config.html#cfg_internal_docs">INTERNAL_DOCS</a> <li><a href="config.html#cfg_javadoc_autobrief">JAVADOC_AUTOBRIEF</a> <li><a href="config.html#cfg_latex_batchmode">LATEX_BATCHMODE</a> <li><a href="config.html#cfg_latex_cmd_name">LATEX_CMD_NAME</a> <li><a href="config.html#cfg_latex_header">LATEX_HEADER</a> <li><a href="config.html#cfg_latex_hide_indices">LATEX_HIDE_INDICES</a> <li><a href="config.html#cfg_latex_output">LATEX_OUTPUT</a> <li><a href="config.html#cfg_macro_expansion">MACRO_EXPANSION</a> <li><a href="config.html#cfg_makeindex_cmd_name">MAKEINDEX_CMD_NAME</a> <li><a href="config.html#cfg_man_extension">MAN_EXTENSION</a> <li><a href="config.html#cfg_man_links">MAN_LINKS</a> <li><a href="config.html#cfg_man_output">MAN_OUTPUT</a> <li><a href="config.html#cfg_max_dot_graph_depth">MAX_DOT_GRAPH_DEPTH</a> <li><a href="config.html#cfg_max_dot_graph_height">MAX_DOT_GRAPH_HEIGHT</a> <li><a href="config.html#cfg_max_dot_graph_width">MAX_DOT_GRAPH_WIDTH</a> <li><a href="config.html#cfg_max_initializer_lines">MAX_INITIALIZER_LINES</a> <li><a href="config.html#cfg_multiline_cpp_is_brief">MULTILINE_CPP_IS_BRIEF</a> <li><a href="config.html#cfg_optimize_output_for_c">OPTIMIZE_OUTPUT_FOR_C</a> <li><a href="config.html#cfg_optimize_output_java">OPTIMIZE_OUTPUT_JAVA</a> <li><a href="config.html#cfg_output_directory">OUTPUT_DIRECTORY</a> <li><a href="config.html#cfg_output_language">OUTPUT_LANGUAGE</a> <li><a href="config.html#cfg_paper_type">PAPER_TYPE</a> <li><a href="config.html#cfg_pdf_hyperlinks">PDF_HYPERLINKS</a> <li><a href="config.html#cfg_perl_path">PERL_PATH</a> <li><a href="config.html#cfg_perlmod_latex">PERLMOD_LATEX</a> <li><a href="config.html#cfg_perlmod_pretty">PERLMOD_PRETTY</a> <li><a href="config.html#cfg_perlmod_makevar_prefix">PERLMOD_MAKEVAR_PREFIX</a> <li><a href="config.html#cfg_predefined">PREDEFINED</a> <li><a href="config.html#cfg_project_name">PROJECT_NAME</a> <li><a href="config.html#cfg_project_number">PROJECT_NUMBER</a> <li><a href="config.html#cfg_quiet">QUIET</a> <li><a href="config.html#cfg_recursive">RECURSIVE</a> <li><a href="config.html#cfg_referenced_by_relation">REFERENCED_BY_RELATION</a> <li><a href="config.html#cfg_references_relation">REFERENCES_RELATION</a> <li><a href="config.html#cfg_repeat_brief">REPEAT_BRIEF</a> <li><a href="config.html#cfg_rtf_extensions_file">RTF_EXTENSIONS_FILE</a> <li><a href="config.html#cfg_rtf_hyperlinks">RTF_HYPERLINKS</a> <li><a href="config.html#cfg_rtf_output">RTF_OUTPUT</a> <li><a href="config.html#cfg_rtf_stylesheet_file">RTF_STYLESHEET_FILE</a> <li><a href="config.html#cfg_search_includes">SEARCH_INCLUDES</a> <li><a href="config.html#cfg_searchengine">SEARCHENGINE</a> <li><a href="config.html#cfg_separate_member_pages">SEPARATE_MEMBER_PAGES</a> <li><a href="config.html#cfg_short_names">SHORT_NAMES</a> <li><a href="config.html#cfg_show_dirs">SHOW_DIRECTORIES</a> <li><a href="config.html#cfg_show_include_files">SHOW_INCLUDE_FILES</a> <li><a href="config.html#cfg_show_used_files">SHOW_USED_FILES</a> <li><a href="config.html#cfg_skip_function_macros">SKIP_FUNCTION_MACROS</a> <li><a href="config.html#cfg_sort_brief_docs">SORT_BRIEF_DOCS</a> <li><a href="config.html#cfg_sort_member_docs">SORT_MEMBER_DOCS</a> <li><a href="config.html#cfg_source_browser">SOURCE_BROWSER</a> <li><a href="config.html#cfg_strip_code_comments">STRIP_CODE_COMMENTS</a> <li><a href="config.html#cfg_strip_from_inc_path">STRIP_FROM_INC_PATH</a> <li><a href="config.html#cfg_strip_from_path">STRIP_FROM_PATH</a> <li><a href="config.html#cfg_subgrouping">SUBGROUPING</a> <li><a href="config.html#cfg_tab_size">TAB_SIZE</a> <li><a href="config.html#cfg_tagfiles">TAGFILES</a> <li><a href="config.html#cfg_template_relations">TEMPLATE_RELATIONS</a> <li><a href="config.html#cfg_toc_expand">TOC_EXPAND</a> <li><a href="config.html#cfg_treeview_width">TREEVIEW_WIDTH</a> <li><a href="config.html#cfg_uml_look">UML_LOOK</a> <li><a href="config.html#cfg_use_htags">USE_HTAGS</a> <li><a href="config.html#cfg_use_windows_encoding">USE_WINDOWS_ENCODING</a> <li><a href="config.html#cfg_verbatim_headers">VERBATIM_HEADERS</a> <li><a href="config.html#cfg_warn_format">WARN_FORMAT</a> <li><a href="config.html#cfg_warn_if_doc_error">WARN_IF_DOC_ERROR</a> <li><a href="config.html#cfg_warn_if_undocumented">WARN_IF_UNDOCUMENTED</a> <li><a href="config.html#cfg_warn_logfile">WARN_LOGFILE</a> <li><a href="config.html#cfg_warn_no_paramdoc">WARN_NO_PARAMDOC</a> <li><a href="config.html#cfg_warnings">WARNINGS</a> <li><a href="config.html#cfg_xml_dtd">XML_DTD</a> <li><a href="config.html#cfg_xml_output">XML_OUTPUT</a> <li><a href="config.html#cfg_xml_programlisting">XML_PROGRAMLISTING</a> <li><a href="config.html#cfg_xml_schema">XML_SCHEMA</a> </ul>
</multicol>
<h2><a class="anchor" name="config_project">
Project related options</a></h2>
<a class="anchor" name="cfg_project_name"></a> <dl>
<dt><code>PROJECT_NAME</code> </dt>
<dd> The <code>PROJECT_NAME</code> tag is a single word (or a sequence of words surrounded by double-quotes) 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.<p>
<a class="anchor" name="cfg_project_number"></a> </dd>
<dt><code>PROJECT_NUMBER</code> </dt>
<dd> The <code>PROJECT_NUMBER</code> tag can be used to enter a project or revision number. This could be handy for archiving the generated documentation or if some version control system is used.<p>
<a class="anchor" name="cfg_output_directory"></a> </dd>
<dt><code>OUTPUT_DIRECTORY</code> </dt>
<dd> The <code>OUTPUT_DIRECTORY</code> tag is used to specify the (relative or absolute) path into which the generated documentation will be written. If a relative path is entered, it will be relative to the location where doxygen was started. If left blank the current directory will be used.<p>
<a class="anchor" name="cfg_create_subdirs"></a> </dd>
<dt><code>CREATE_SUBDIRS</code> </dt>
<dd> If the <code>CREATE_SUBDIRS</code> tag is set to <code>YES</code>, then doxygen will create 4096 sub-directories (in 2 levels) under the output directory of each output format and will distribute the generated files over these directories. Enabling this option can be useful when feeding doxygen a huge amount of source files, where putting all generated files in the same directory would otherwise causes performance problems for the file system.<p>
<a class="anchor" name="cfg_output_language"></a> </dd>
<dt><code>OUTPUT_LANGUAGE</code> </dt>
<dd> The <code>OUTPUT_LANGUAGE</code> tag is used to specify the language in which all documentation generated by doxygen is written. Doxygen will use this information to generate all constant output in the proper language. The default language is English, other supported languages are: Brazilian, Catalan, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, Korean, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.<p>
<a class="anchor" name="cfg_use_windows_encoding"></a> </dd>
<dt><code>USE_WINDOWS_ENCODING</code> </dt>
<dd> This tag can be used to specify the encoding used in the generated output. The encoding is not always determined by the language that is chosen, but also whether or not the output is meant for Windows or non-Windows users. In case there is a difference, setting the <code>USE_WINDOWS_ENCODING</code> tag to <code>YES</code> forces the Windows encoding, (this is the default for the Windows binary), whereas setting the tag to <code>NO</code> uses a Unix-style encoding (the default for all platforms other than Windows).<p>
<a class="anchor" name="cfg_brief_member_desc"></a> </dd>
<dt><code>BRIEF_MEMBER_DESC</code> </dt>
<dd> If the <code>BRIEF_MEMBER_DESC</code> tag is set to <code>YES</code> (the default) doxygen will include brief member descriptions after the members that are listed in the file and class documentation (similar to JavaDoc). Set to NO to disable this.<p>
<a class="anchor" name="cfg_repeat_brief"></a> </dd>
<dt><code>REPEAT_BRIEF</code> </dt>
<dd> If the <code>REPEAT_BRIEF</code> tag is set to <code>YES</code> (the default) doxygen will prepend the brief description of a member or function before the detailed description<p>
<dl compact><dt><b>Note: </b></dt><dd>If both <code>HIDE_UNDOC_MEMBERS</code> and <code>BRIEF_MEMBER_DESC</code> are set to <code>NO</code>, the brief descriptions will be completely suppressed.</dd></dl>
<a class="anchor" name="cfg_abbreviate_brief"></a> </dd>
<dt><code>ABBREVIATE_BRIEF</code> </dt>
<dd> This tag implements a quasi-intelligent brief description abbreviator that is used to form the text in various listings. Each string in this list, if found as the leading text of the brief description, will be stripped from the text and the result after processing the whole list, is used as the annotated text. Otherwise, the brief description is used as-is. If left blank, the following values are used ("\$name" is automatically replaced with the name of the entity): "The $name class" "The $name widget" "The $name file" "is" "provides" "specifies" "contains" "represents" "a" "an" "the".<p>
<a class="anchor" name="cfg_always_detailed_sec"></a> </dd>
<dt><code>ALWAYS_DETAILED_SEC</code> </dt>
<dd> If the <code>ALWAYS_DETAILED_SEC</code> and <code>REPEAT_BRIEF</code> tags are both set to <code>YES</code> then doxygen will generate a detailed section even if there is only a brief description.<p>
<a class="anchor" name="cfg_inline_inherited_memb"></a> </dd>
<dt><code>INLINE_INHERITED_MEMB</code> </dt>
<dd> If the <code>INLINE_INHERITED_MEMB</code> tag is set to <code>YES</code>, doxygen will show all inherited members of a class in the documentation of that class as if those members were ordinary class members. Constructors, destructors and assignment operators of the base classes will not be shown.<p>
<a class="anchor" name="cfg_full_path_names"></a> </dd>
<dt><code>FULL_PATH_NAMES</code> </dt>
<dd> If the <code>FULL_PATH_NAMES</code> tag is set to <code>YES</code> doxygen will prepend the full path before files name in the file list and in the header files. If set to NO the shortest path that makes the file name unique will be used<p>
<a class="anchor" name="cfg_strip_from_path"></a> </dd>
<dt><code>STRIP_FROM_PATH</code> </dt>
<dd> If the <code>FULL_PATH_NAMES</code> tag is set to <code>YES</code> then the <code>STRIP_FROM_PATH</code> tag can be used to strip a user-defined part of the path. Stripping is only done if one of the specified strings matches the left-hand part of the path. The tag can be used to show relative paths in the file list. If left blank the directory from which doxygen is run is used as the path to strip.<p>
<a class="anchor" name="cfg_strip_from_inc_path"></a> </dd>
<dt><code>STRIP_FROM_INC_PATH</code> The <code>STRIP_FROM_INC_PATH</code> tag can be used to strip a user-defined part of the path mentioned in the documentation of a class, which tells the reader which header file to include in order to use a class. If left blank only the name of the header file containing the class definition is used. Otherwise one should specify the include paths that are normally passed to the compiler using the -I flag. <a class="anchor" name="cfg_case_sense_names"></a> </dt>
<dd></dd>
<dt><code>CASE_SENSE_NAMES</code> </dt>
<dd> If the <code>CASE_SENSE_NAMES</code> tag is set to <code>NO</code> then doxygen will only generate file names in lower-case letters. If set to <code>YES</code> upper-case letters are also allowed. This is useful if you have classes or files whose names only differ in case and if your file system supports case sensitive file names. Windows users are advised to set this option to NO.<p>
<a class="anchor" name="cfg_short_names"></a> </dd>
<dt><code>SHORT_NAMES</code> </dt>
<dd> If the <code>SHORT_NAMES</code> tag is set to <code>YES</code>, doxygen will generate much shorter (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.<p>
<a class="anchor" name="cfg_javadoc_autobrief"></a> </dd>
<dt><code>JAVADOC_AUTOBRIEF</code> </dt>
<dd> If the <code>JAVADOC_AUTOBRIEF</code> is set to <code>YES</code> then doxygen will interpret the first line (until the first dot) of a JavaDoc-style comment as the brief description. If set to NO (the default), the Javadoc-style will behave just like the Qt-style comments.<p>
<a class="anchor" name="cfg_multiline_cpp_is_brief"></a> </dd>
<dt><code>MULTILINE_CPP_IS_BRIEF</code> </dt>
<dd> The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a multi-line C++ special comment block (i.e. a block of //! or /// comments) as a brief description. This used to be the default behaviour. The new default is to treat a multi-line C++ comment block as a detailed description. Set this tag to YES if you prefer the old behaviour instead. Note that setting this tag to YES also means that rational rose comments are not recognized any more.<p>
<a class="anchor" name="cfg_details_at_top"></a> </dd>
<dt><code>DETAILS_AT_TOP</code> </dt>
<dd> If the DETAILS_AT_TOP tag is set to YES then Doxygen will output the detailed description near the top, like JavaDoc. If set to NO, the detailed description appears after the member documentation.<p>
<a class="anchor" name="cfg_inherit_docs"></a> </dd>
<dt><code>INHERIT_DOCS</code> </dt>
<dd> If the <code>INHERIT_DOCS</code> tag is set to <code>YES</code> (the default) then an undocumented member inherits the documentation from any documented member that it re-implements.<p>
<a class="anchor" name="cfg_distribute_group_doc"></a> </dd>
<dt><code>DISTRIBUTE_GROUP_DOC</code> </dt>
<dd> If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC tag is set to YES, then doxygen will reuse the documentation of the first member in the group (if any) for the other members of the group. By default all members of a group must be documented explicitly.<p>
<a class="anchor" name="cfg_separate_member_pages"></a> </dd>
<dt><code>SEPARATE_MEMBER_PAGES</code> </dt>
<dd> If the <code>SEPARATE_MEMBER_PAGES</code> tag is set to <code>YES</code>, then doxygen will produce a new page for each member. If set to <code>NO</code>, the documentation of a member will be part of the file/class/namespace that contains it.<p>
<a class="anchor" name="cfg_tab_size"></a> </dd>
<dt><code>TAB_SIZE</code> </dt>
<dd> the <code>TAB_SIZE</code> 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.<p>
<a class="anchor" name="cfg_aliases"></a> </dd>
<dt><code>ALIASES</code> </dt>
<dd> This tag can be used to specify a number of aliases that acts as commands in the documentation. An alias has the form <div class="fragment"><pre class="fragment"> name=value
</pre></div> For example adding <div class="fragment"><pre class="fragment"> "sideeffect=\par Side Effects:\n"
</pre></div> will allow you to put the command \sideeffect (or @sideeffect) in the documentation, which will result in a user-defined paragraph with heading "Side Effects:". You can put \n's in the value part of an alias to insert newlines.<p>
<a class="anchor" name="cfg_optimize_output_for_c"></a> </dd>
<dt><code>OPTIMIZE_OUTPUT_FOR_C</code> </dt>
<dd> Set the <code>OPTIMIZE_OUTPUT_FOR_C</code> tag to <code>YES</code> if your project consists of C sources only. Doxygen will then generate output that is more tailored for C. For instance, some of the names that are used will be different. The list of all members will be omitted, etc.<p>
<a class="anchor" name="cfg_optimize_output_java"></a> </dd>
<dt><code>OPTIMIZE_OUTPUT_JAVA</code> </dt>
<dd> Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources only. Doxygen will then generate output that is more tailored for Java. For instance, namespaces will be presented as packages, qualified scopes will look different, etc.<p>
<a class="anchor" name="cfg_subgrouping"></a> </dd>
<dt><code>SUBGROUPING</code> </dt>
<dd> Set the <code>SUBGROUPING</code> tag to <code>YES</code> (the default) to allow class member groups of the same type (for instance a group of public functions) to be put as a subgroup of that type (e.g. under the Public Functions section). Set it to <code>NO</code> to prevent subgrouping. Alternatively, this can be done per class using the <a class="el" href="commands.html#cmdnosubgrouping">\nosubgrouping</a> command.<p>
</dd>
</dl>
<h2><a class="anchor" name="config_build">
Build related options</a></h2>
<a class="anchor" name="cfg_extract_all"></a> <dl>
<dt><code>EXTRACT_ALL</code> </dt>
<dd> If the <code>EXTRACT_ALL</code> tag is set to <code>YES</code> doxygen will assume all entities in documentation are documented, even if no documentation was available. Private class members and static file members will be hidden unless the <code>EXTRACT_PRIVATE</code> and <code>EXTRACT_STATIC</code> tags are set to <code>YES</code> <p>
<dl compact><dt><b>Note: </b></dt><dd>This will also disable the warnings about undocumented members that are normally produced when <code>WARNINGS</code> is set to <code>YES</code> </dd></dl>
<a class="anchor" name="cfg_extract_private"></a> </dd>
<dt><code>EXTRACT_PRIVATE</code> </dt>
<dd> If the <code>EXTRACT_PRIVATE</code> tag is set to <code>YES</code> all private members of a class will be included in the documentation.<p>
<a class="anchor" name="cfg_extract_static"></a> </dd>
<dt><code>EXTRACT_STATIC</code> </dt>
<dd> If the <code>EXTRACT_STATIC</code> tag is set to <code>YES</code> all static members of a file will be included in the documentation.<p>
<a class="anchor" name="cfg_extract_local_classes"></a> </dd>
<dt><code>EXTRACT_LOCAL_CLASSES</code> </dt>
<dd> If the <code>EXTRACT_LOCAL_CLASSES</code> tag is set to <code>YES</code> classes (and structs) defined locally in source files will be included in the documentation. If set to NO only classes defined in header files are included. Does not have any effect for Java sources.<p>
<a class="anchor" name="cfg_extract_local_methods"></a> </dd>
<dt><code>EXTRACT_LOCAL_METHODS</code> </dt>
<dd> This flag is only useful for Objective-C code. When set to <code>YES</code> local methods, which are defined in the implementation section but not in the interface are included in the documentation. If set to <code>NO</code> (the default) only methods in the interface are included.<p>
<a class="anchor" name="cfg_hide_undoc_members"></a> </dd>
<dt><code>HIDE_UNDOC_MEMBERS</code> </dt>
<dd> If the <code>HIDE_UNDOC_MEMBERS</code> tag is set to <code>YES</code>, doxygen will hide all undocumented members inside documented classes or files. If set to <code>NO</code> (the default) these members will be included in the various overviews, but no documentation section is generated. This option has no effect if <code>EXTRACT_ALL</code> is enabled.<p>
<a class="anchor" name="cfg_hide_undoc_classes"></a> </dd>
<dt><code>HIDE_UNDOC_CLASSES</code> </dt>
<dd> If the <code>HIDE_UNDOC_CLASSESS</code> tag is set to <code>YES</code>, doxygen will hide all undocumented classes. If set to <code>NO</code> (the default) these classes will be included in the various overviews. This option has no effect if <code>EXTRACT_ALL</code> is enabled.<p>
<a class="anchor" name="cfg_hide_friend_compounds"></a> </dd>
<dt><code>HIDE_FRIEND_COMPOUNDS</code> </dt>
<dd> If the <code>HIDE_FRIEND_COMPOUNDS</code> tag is set to <code>YES</code>, Doxygen will hide all friend (class|struct|union) declarations. If set to <code>NO</code> (the default) these declarations will be included in the documentation.<p>
<a class="anchor" name="cfg_hide_in_body_docs"></a> </dd>
<dt><code>HIDE_IN_BODY_DOCS</code> </dt>
<dd> If the <code>HIDE_IN_BODY_DOCS</code> tag is set to <code>YES</code>, Doxygen will hide any documentation blocks found inside the body of a function. If set to <code>NO</code> (the default) these blocks will be appended to the function's detailed documentation block.<p>
<a class="anchor" name="cfg_internal_docs"></a> </dd>
<dt><code>INTERNAL_DOCS</code> </dt>
<dd> The <code>INTERNAL_DOCS</code> tag determines if documentation that is typed after a <a class="el" href="commands.html#cmdinternal">\internal</a> command is included. If the tag is set to <code>NO</code> (the default) then the documentation will be excluded. Set it to <code>YES</code> to include the internal documentation.<p>
<a class="anchor" name="cfg_hide_scope_names"></a> </dd>
<dt><code>HIDE_SCOPE_NAMES</code> </dt>
<dd> If the <code>HIDE_SCOPE_NAMES</code> tag is set to <code>NO</code> (the default) then doxygen will show members with their full class and namespace scopes in the documentation. If set to <code>YES</code> the scope will be hidden.<p>
<a class="anchor" name="cfg_show_include_files"></a> </dd>
<dt><code>SHOW_INCLUDE_FILES</code> </dt>
<dd> If the SHOW_INCLUDE_FILES tag is set to YES (the default) then doxygen will put a list of the files that are included by a file in the documentation of that file.<p>
<a class="anchor" name="cfg_inline_info"></a> </dd>
<dt><code>INLINE_INFO</code> </dt>
<dd> If the <code>INLINE_INFO</code> tag is set to <code>YES</code> (the default) then a tag [inline] is inserted in the documentation for inline members.<p>
<a class="anchor" name="cfg_sort_member_docs"></a> </dd>
<dt><code>SORT_MEMBER_DOCS</code> </dt>
<dd> If the <code>SORT_MEMBER_DOCS</code> tag is set to <code>YES</code> (the default) then doxygen will sort the (detailed) documentation of file and class members alphabetically by member name. If set to <code>NO</code> the members will appear in declaration order.<p>
<a class="anchor" name="cfg_sort_brief_docs"></a> </dd>
<dt><code>SORT_BRIEF_DOCS</code> </dt>
<dd> If the <code>SORT_BRIEF_DOCS</code> tag is set to <code>YES</code> then doxygen will sort the brief descriptions of file, namespace and class members alphabetically by member name. If set to <code>NO</code> (the default) the members will appear in declaration order.<p>
<a class="anchor" name="cfg_generate_deprecatedlist"></a> </dd>
<dt><code>GENERATE_DEPRECATEDLIST</code> </dt>
<dd> The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) the deprecated list. This list is created by putting <a class="el" href="commands.html#cmddeprecated">\deprecated</a> commands in the documentation.<p>
<a class="anchor" name="cfg_generate_todolist"></a> </dd>
<dt><code>GENERATE_TODOLIST</code> </dt>
<dd> The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo list. This list is created by putting <a class="el" href="commands.html#cmdtodo">\todo</a> commands in the documentation.<p>
<a class="anchor" name="cfg_generate_testlist"></a> </dd>
<dt><code>GENERATE_TESTLIST</code> </dt>
<dd> The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test list. This list is created by putting <a class="el" href="commands.html#cmdtest">\test</a> commands in the documentation.<p>
<a class="anchor" name="cfg_generate_buglist"></a> </dd>
<dt><code>GENERATE_BUGLIST</code> </dt>
<dd> The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug list. This list is created by putting <a class="el" href="commands.html#cmdbug">\bug</a> commands in the documentation.<p>
<a class="anchor" name="cfg_enabled_sections"></a> </dd>
<dt><code>ENABLED_SECTIONS</code> </dt>
<dd> The <code>ENABLED_SECTIONS</code> tag can be used to enable conditional documentation sections, marked by <a class="el" href="commands.html#cmdif">\if</a> <section-label> ... <a class="el" href="commands.html#cmdendif">\endif</a> and <a class="el" href="commands.html#cmdcond">\cond</a> <section-label> ... <a class="el" href="commands.html#cmdendcond">\endcond</a> blocks.<p>
<a class="anchor" name="cfg_max_initializer_lines"></a> </dd>
<dt><code>MAX_INITIALIZER_LINES</code> </dt>
<dd> The <code>MAX_INITIALIZER_LINES</code> tag determines the maximum number of lines that the initial value of a variable or define can be. If the initializer consists of more lines than specified here it will be hidden. Use a value of 0 to hide initializers completely. The appearance of the value of individual variables and defines can be controlled using <a class="el" href="commands.html#cmdshowinitializer">\showinitializer</a> or <a class="el" href="commands.html#cmdhideinitializer">\hideinitializer</a> command in the documentation.<p>
<a class="anchor" name="cfg_show_used_files"></a> </dd>
<dt><code>SHOW_USED_FILES</code> </dt>
<dd> Set the <code>SHOW_USED_FILES</code> tag to <code>NO</code> to disable the list of files generated at the bottom of the documentation of classes and structs. If set to <code>YES</code> the list will mention the files that were used to generate the documentation.<p>
<a class="anchor" name="cfg_show_dirs"></a> </dd>
<dt><code>SHOW_DIRECTORIES</code> </dt>
<dd> If the sources in your project are distributed over multiple directories then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy in the documentation.<p>
</dd>
</dl>
<h2><a class="anchor" name="messages_input">
Options related to warning and progress messages</a></h2>
<a class="anchor" name="cfg_quiet"></a> <dl>
<dt><code>QUIET</code> </dt>
<dd> The <code>QUIET</code> tag can be used to turn on/off the messages that are generated to standard output by doxygen. Possible values are <code>YES</code> and <code>NO</code>, where <code>YES</code> implies that the messages are off. If left blank <code>NO</code> is used.<p>
<a class="anchor" name="cfg_warnings"></a> </dd>
<dt><code>WARNINGS</code> </dt>
<dd> The <code>WARNINGS</code> tag can be used to turn on/off the warning messages that are generated to standard error by doxygen. Possible values are <code>YES</code> and <code>NO</code>, where <code>YES</code> implies that the warnings are on. If left blank <code>NO</code> is used.<p>
<b>Tip:</b> Turn warnings on while writing the documentation.<p>
<a class="anchor" name="cfg_warn_if_undocumented"></a> </dd>
<dt><code>WARN_IF_UNDOCUMENTED</code> </dt>
<dd> If <code>WARN_IF_UNDOCUMENTED</code> is set to <code>YES</code>, then doxygen will generate warnings for undocumented members. If <code>EXTRACT_ALL</code> is set to <code>YES</code> then this flag will automatically be disabled.<p>
<a class="anchor" name="cfg_warn_if_doc_error"></a> </dd>
<dt><code>WARN_IF_DOC_ERROR</code> </dt>
<dd>If <code>WARN_IF_DOC_ERROR</code> is set to <code>YES</code>, doxygen will generate warnings for potential errors in the documentation, such as not documenting some parameters in a documented function, or documenting parameters that don't exist or using markup commands wrongly.<p>
<a class="anchor" name="cfg_warn_no_paramdoc"></a> </dd>
<dt><code>WARN_NO_PARAMDOC</code> This <code>WARN_NO_PARAMDOC</code> option can be abled to get warnings for functions that are documented, but have no documentation for their parameters or return value. If set to <code>NO</code> (the default) doxygen will only warn about wrong or incomplete parameter documentation, but not about the absence of documentation. <a class="anchor" name="cfg_warn_format"></a> </dt>
<dd></dd>
<dt><code>WARN_FORMAT</code> </dt>
<dd> The <code>WARN_FORMAT</code> tag determines the format of the warning messages that doxygen can produce. The string should contain the <code>$file</code>, <code>$line</code>, and <code>$text</code> tags, which will be replaced by the file and line number from which the warning originated and the warning text.<p>
<a class="anchor" name="cfg_warn_logfile"></a> </dd>
<dt><code>WARN_LOGFILE</code> </dt>
<dd> The <code>WARN_LOGFILE</code> 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 stderr.<p>
</dd>
</dl>
<h2><a class="anchor" name="config_input">
Input related options</a></h2>
<a class="anchor" name="cfg_input"></a> <dl>
<dt><code>INPUT</code> </dt>
<dd> The <code>INPUT</code> tag is used to specify the files and/or directories that contain documented source files. You may enter file names like <code>myfile.cpp</code> or directories like <code>/usr/src/myproject</code>. Separate the files or directories with spaces.<br>
<p>
<b>Note:</b> If this tag is empty the current directory is searched.<p>
<a class="anchor" name="cfg_file_patterns"></a> </dd>
<dt><code>FILE_PATTERNS</code> </dt>
<dd> If the value of the <code>INPUT</code> tag contains directories, you can use the <code>FILE_PATTERNS</code> tag to specify one or more wildcard patterns (like <code>*</code>.cpp and <code>*</code>.h ) to filter out the source-files in the directories. If left blank the following patterns are tested: <code> .c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp .h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm </code><p>
<a class="anchor" name="cfg_file_version_filter"></a> </dd>
<dt><code>FILE_VERSION_FILTER</code> </dt>
<dd> The <code>FILE_VERSION_FILTER</code> tag can be used to specify a program or script that doxygen should invoke to get the current version for each file (typically from the version control system). Doxygen will invoke the program by executing (via popen()) the command <code>command input-file</code>, where <code>command</code> is the value of the <code>FILE_VERSION_FILTER</code> tag, and <code>input-file</code> is the name of an input file provided by doxygen. Whatever the progam writes to standard output is used as the file version.<p>
Example of using a shell script as a filter for Unix: <div class="fragment"><pre class="fragment"> FILE_VERSION_FILTER = "/bin/sh versionfilter.sh"
</pre></div><p>
Example shell script for CVS: <div class="fragment"><pre class="fragment">#!/bin/sh
cvs status $1 | sed -n 's/^[ \]*Working revision:[ \t]*\([0-9][0-9\.]*\).\1/p'
</pre></div><p>
Example shell script for Subversion: <div class="fragment"><pre class="fragment">#!/bin/sh
svn stat -v $1 | sed -n 's/^[ A-Z?\*|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ ./p'
</pre></div><p>
Example filter for ClearCase: <div class="fragment"><pre class="fragment">FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
</pre></div><p>
<a class="anchor" name="cfg_recursive"></a> </dd>
<dt><code>RECURSIVE</code> </dt>
<dd> The <code>RECURSIVE</code> tag can be used to specify whether or not subdirectories should be searched for input files as well. Possible values are <code>YES</code> and <code>NO</code>. If left blank <code>NO</code> is used.<p>
<a class="anchor" name="cfg_exclude"></a> </dd>
<dt><code>EXCLUDE</code> </dt>
<dd> The <code>EXCLUDE</code> tag can be used to specify files and/or directories that should excluded from the <code>INPUT</code> source files. This way you can easily exclude a subdirectory from a directory tree whose root is specified with the <code>INPUT</code> tag.<p>
<a class="anchor" name="cfg_exclude_symlinks"></a> </dd>
<dt><code>EXCLUDE_SYMLINKS</code> </dt>
<dd> The <code>EXCLUDE_SYMLINKS</code> tag can be used select whether or not files or directories that are symbolic links (a Unix filesystem feature) are excluded from the input.<p>
<a class="anchor" name="cfg_exclude_patterns"></a> </dd>
<dt><code>EXCLUDE_PATTERNS</code> </dt>
<dd> If the value of the <code>INPUT</code> tag contains directories, you can use the <code>EXCLUDE_PATTERNS</code> tag to specify one or more wildcard patterns to exclude certain files from those directories.<p>
Note that the wildcards are matched against the file with absolute path, so to exclude all test directories use the pattern <code>*</code><code>/test/</code><code>*</code><p>
<a class="anchor" name="cfg_example_path"></a> </dd>
<dt><code>EXAMPLE_PATH</code> </dt>
<dd> The <code>EXAMPLE_PATH</code> tag can be used to specify one or more files or directories that contain example code fragments that are included (see the \include command in section <a class="el" href="commands.html#cmdinclude">\include</a>).<p>
<a class="anchor" name="cfg_example_recursive"></a> </dd>
<dt><code>EXAMPLE_RECURSIVE</code> </dt>
<dd> If the <code>EXAMPLE_RECURSIVE</code> tag is set to <code>YES</code> then subdirectories will be searched for input files to be used with the \include or \dontinclude commands irrespective of the value of the <code>RECURSIVE</code> tag. Possible values are <code>YES</code> and <code>NO</code>. If left blank <code>NO</code> is used.<p>
<a class="anchor" name="cfg_example_patterns"></a> </dd>
<dt><code>EXAMPLE_PATTERNS</code> </dt>
<dd> If the value of the <code>EXAMPLE_PATH</code> tag contains directories, you can use the <code>EXAMPLE_PATTERNS</code> 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.<p>
<a class="anchor" name="cfg_image_path"></a> </dd>
<dt><code>IMAGE_PATH</code> </dt>
<dd> The <code>IMAGE_PATH</code> tag can be used to specify one or more files or directories that contain images that are to be included in the documentation (see the <a class="el" href="commands.html#cmdimage">\image</a> command).<p>
<a class="anchor" name="cfg_input_filter"></a> </dd>
<dt><code>INPUT_FILTER</code> </dt>
<dd> The <code>INPUT_FILTER</code> tag can be used to specify a program that doxygen should invoke to filter for each input file. Doxygen will invoke the filter program by executing (via popen()) the command: <div class="fragment"><pre class="fragment"><filter> <input-file>
</pre></div><p>
where <filter> is the value of the <code>INPUT_FILTER</code> tag, and <input-file> is the name of an input file. Doxygen will then use the output that the filter program writes to standard output.<p>
<a class="anchor" name="cfg_filter_patterns"></a> </dd>
<dt><code>FILTER_PATTERNS</code> </dt>
<dd> The <code>FILTER_PATTERNS</code> tag can be used to specify filters on a per file pattern basis. Doxygen will compare the file name with each pattern and apply the filter if there is a match. The filters are a list of the form: pattern=filter (like <code>*.cpp=my_cpp_filter</code>). See <code>INPUT_FILTER</code> for further info on how filters are used. If <code>FILTER_PATTERNS</code> is empty, <code>INPUT_FILTER</code> is applied to all files.<p>
<a class="anchor" name="cfg_filter_source_files"></a> </dd>
<dt><code>FILTER_SOURCE_FILES</code> </dt>
<dd> If the <code>FILTER_SOURCE_FILES</code> tag is set to <code>YES</code>, the input filter (if set using <a class="el" href="config.html#cfg_input_filter">INPUT_FILTER</a> ) will also be used to filter the input files that are used for producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).<p>
</dd>
</dl>
<h2><a class="anchor" name="sourcebrowser_index">
Source browsing related options</a></h2>
<a class="anchor" name="cfg_source_browser"></a> <dl>
<dt><code>SOURCE_BROWSER</code> </dt>
<dd> If the <code>SOURCE_BROWSER</code> tag is set to <code>YES</code> then a list of source files will be generated. Documented entities will be cross-referenced with these sources.<p>
<a class="anchor" name="cfg_inline_sources"></a> </dd>
<dt><code>INLINE_SOURCES</code> </dt>
<dd> Setting the <code>INLINE_SOURCES</code> tag to <code>YES</code> will include the body of functions, classes and enums directly into the documentation.<p>
<a class="anchor" name="cfg_strip_code_comments"></a> </dd>
<dt><code>STRIP_CODE_COMMENTS</code> </dt>
<dd> Setting the <code>STRIP_CODE_COMMENTS</code> tag to <code>YES</code> (the default) will instruct doxygen to hide any special comment blocks from generated source code fragments. Normal C and C++ comments will always remain visible.<p>
<a class="anchor" name="cfg_referenced_by_relation"></a> </dd>
<dt><code>REFERENCED_BY_RELATION</code> </dt>
<dd> If the <code>REFERENCED_BY_RELATION</code> tag is set to <code>YES</code> (the default) then for each documented function all documented functions referencing it will be listed.<p>
<a class="anchor" name="cfg_references_relation"></a> </dd>
<dt><code>REFERENCES_RELATION</code> </dt>
<dd> If the <code>REFERENCES_RELATION</code> tag is set to <code>YES</code> (the default) then for each documented function all documented entities called/used by that function will be listed.<p>
<a class="anchor" name="cfg_verbatim_headers"></a> </dd>
<dt><code>VERBATIM_HEADERS</code> </dt>
<dd> If the <code>VERBATIM_HEADERS</code> tag is set the <code>YES</code> (the default) then doxygen will generate a verbatim copy of the header file for each class for which an include is specified. Set to NO to disable this. <dl compact><dt><b>See also:</b></dt><dd>Section <a class="el" href="commands.html#cmdclass">\class</a>.</dd></dl>
<a class="anchor" name="cfg_use_htags"></a> </dd>
<dt><code>USE_HTAGS</code> </dt>
<dd> If the <code>USE_HTAGS</code> tag is set to <code>YES</code> then the references to source code will point to the HTML generated by the htags(1) tool instead of doxygen built-in source browser. The htags tool is part of GNU's global source tagging system (see <a href="http://www.gnu.org/software/global/global.html">http://www.gnu.org/software/global/global.html</a>). The use it do the following:<p>
<ol type=1>
<li>Install the latest version of global (i.e. 4.8.6 or better)</li><li>Enable SOURCE_BROWSER and USE_HTAGS in the config file</li><li>Make sure the INPUT points to the root of the source tree</li><li>Run doxygen as normal</li></ol>
<p>
Doxygen will invoke htags (and that will in turn invoke gtags), so these tools must be available from the command line (i.e. in the search path).<p>
The result: instead of the source browser generated by doxygen, the links to source code will now point to the output of htags.<p>
</dd>
</dl>
<h2><a class="anchor" name="alphabetical_index">
Alphabetical index options</a></h2>
<a class="anchor" name="cfg_alphabetical_index"></a> <dl>
<dt><code>ALPHABETICAL_INDEX</code> </dt>
<dd> If the <code>ALPHABETICAL_INDEX</code> tag is set to <code>YES</code>, an alphabetical index of all compounds will be generated. Enable this if the project contains a lot of classes, structs, unions or interfaces.<p>
<a class="anchor" name="cfg_cols_in_alpha_index"></a> </dd>
<dt><code>COLS_IN_ALPHA_INDEX</code> </dt>
<dd> If the alphabetical index is enabled (see <code>ALPHABETICAL_INDEX</code>) then the <code>COLS_IN_ALPHA_INDEX</code> tag can be used to specify the number of columns in which this list will be split (can be a number in the range [1..20])<p>
<a class="anchor" name="cfg_ignore_prefix"></a> </dd>
<dt><code>IGNORE_PREFIX</code> </dt>
<dd> In case all classes in a project start with a common prefix, all classes will be put under the same header in the alphabetical index. The <code>IGNORE_PREFIX</code> tag can be used to specify a prefix (or a list of prefixes) that should be ignored while generating the index headers.<p>
</dd>
</dl>
<h2><a class="anchor" name="html_output">
HTML related options</a></h2>
<a class="anchor" name="cfg_generate_html"></a> <dl>
<dt><code>GENERATE_HTML</code> </dt>
<dd> If the <code>GENERATE_HTML</code> tag is set to <code>YES</code> (the default) doxygen will generate HTML output<p>
<a class="anchor" name="cfg_html_output"></a> </dd>
<dt><code>HTML_OUTPUT</code> </dt>
<dd> The <code>HTML_OUTPUT</code> tag is used to specify where the HTML docs will be put. If a relative path is entered the value of <code>OUTPUT_DIRECTORY</code> will be put in front of it. If left blank `html' will be used as the default path.<p>
<a class="anchor" name="cfg_html_file_extension"></a> </dd>
<dt><code>HTML_FILE_EXTENSION</code> </dt>
<dd> The <code>HTML_FILE_EXTENSION</code> tag can be used to specify the file extension for each generated HTML page (for example: .htm, .php, .asp). If it is left blank doxygen will generate files with .html extension.<p>
<a class="anchor" name="cfg_html_header"></a> </dd>
<dt><code>HTML_HEADER</code> </dt>
<dd> The <code>HTML_HEADER</code> tag can be used to specify a user-defined HTML header file for each generated HTML page. To get valid HTML the header file should contain at least a <code><HTML></code> and a <code><BODY></code> tag, but it is good idea to include the style sheet that is generated by doxygen as well. Minimal example: <div class="fragment"><pre class="fragment"> <HTML>
<HEAD>
<TITLE>My title</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
</pre></div> If the tag is left blank doxygen will generate a standard header.<p>
The following commands have a special meaning inside the header: <code>$title</code>, <code>$datetime</code>, <code>$date</code>, <code>$doxygenversion</code>, <code>$projectname</code>, and <code>$projectnumber</code>. Doxygen will replace them by respectively the title of the page, the current date and time, only the current date, the version number of doxygen, the project name (see <code>PROJECT_NAME</code>), or the project number (see <code>PROJECT_NUMBER</code>).<p>
If <code>CREATE_SUBDIRS</code> is enabled, the command <code>$relpath$</code> can be used to produce a relative path to the root of the HTML output directory, e.g. use $relpath$doxygen.css, to refer to the standard style sheet.<p>
See also section <a class="el" href="doxygen_usage.html">Doxygen usage</a> for information on how to generate the default header that doxygen normally uses.<p>
<a class="anchor" name="cfg_html_footer"></a> </dd>
<dt><code>HTML_FOOTER</code> </dt>
<dd> The <code>HTML_FOOTER</code> tag can be used to specify a user-defined HTML footer for each generated HTML page. To get valid HTML the footer file should contain at least a <code></BODY></code> and a <code></HTML></code> tag. A minimal example: <div class="fragment"><pre class="fragment"> </BODY>
</HTML>
</pre></div> If the tag is left blank doxygen will generate a standard footer.<p>
The following commands have a special meaning inside the footer: <code>$title</code>, <code>$datetime</code>, <code>$date</code>, <code>$doxygenversion</code>, <code>$projectname</code>, <code>$projectnumber</code>. Doxygen will replace them by respectively the title of the page, the current date and time, only the current date, the version number of doxygen, the project name (see <code>PROJECT_NAME</code>), or the project number (see <code>PROJECT_NUMBER</code>).<p>
See also section <a class="el" href="doxygen_usage.html">Doxygen usage</a> for information on how to generate the default footer that doxygen normally uses.<p>
<a class="anchor" name="cfg_html_stylesheet"></a> </dd>
<dt><code>HTML_STYLESHEET</code> </dt>
<dd> The <code>HTML_STYLESHEET</code> tag can be used to specify a user-defined cascading style sheet that is used by each HTML page. It can be used to fine-tune the look of the HTML output. If the tag is left blank doxygen will generate a default style sheet.<p>
See also section <a class="el" href="doxygen_usage.html">Doxygen usage</a> for information on how to generate the style sheet that doxygen normally uses.<p>
<a class="anchor" name="cfg_html_align_members"></a> </dd>
<dt><code>HTML_ALIGN_MEMBERS</code> </dt>
<dd> If the <code>HTML_ALIGN_MEMBERS</code> tag is set to <code>YES</code>, the members of classes, files or namespaces will be aligned in HTML using tables. If set to <code>NO</code> a bullet list will be used.<p>
<b>Note:</b> Setting this tag to <code>NO</code> will become obsolete in the future, since I only intent to support and test the aligned representation.<p>
<a class="anchor" name="cfg_generate_htmlhelp"></a> </dd>
<dt><code>GENERATE_HTMLHELP</code> </dt>
<dd> If the <code>GENERATE_HTMLHELP</code> tag is set to <code>YES</code> then doxygen generates three additional HTML index files: <code>index.hhp</code>, <code>index.hhc</code>, and <code>index.hhk</code>. The <code>index.hhp</code> is a project file that can be read by <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/vsconHH1Start.asp">Microsoft's HTML Help Workshop</a> on Windows.<p>
The HTML Help Workshop contains a compiler that can convert all HTML output generated by doxygen into a single compressed HTML file (.chm). Compressed HTML files are now used as the Windows 98 help format, and will replace the old Windows help format (.hlp) on all Windows platforms in the future. Compressed HTML files also contain an index, a table of contents, and you can search for words in the documentation. The HTML workshop also contains a viewer for compressed HTML files.<p>
<a class="anchor" name="cfg_chm_file"></a> </dd>
<dt><code>CHM_FILE</code> </dt>
<dd> If the <code>GENERATE_HTMLHELP</code> tag is set to <code>YES</code>, the <code>CHM_FILE</code> tag can be used to specify the file name of the resulting .chm file. You can add a path in front of the file if the result should not be written to the html output directory.<p>
<a class="anchor" name="cfg_hhc_location"></a> </dd>
<dt><code>HHC_LOCATION</code> </dt>
<dd> If the <code>GENERATE_HTMLHELP</code> tag is set to <code>YES</code>, the <code>HHC_LOCATION</code> tag can be used to specify the location (absolute path including file name) of the HTML help compiler (hhc.exe). If non empty doxygen will try to run the HTML help compiler on the generated index.hhp.<p>
<a class="anchor" name="cfg_generate_chi"></a> </dd>
<dt><code>GENERATE_CHI</code> </dt>
<dd> If the <code>GENERATE_HTMLHELP</code> tag is set to <code>YES</code>, the <code>GENERATE_CHI</code> flag controls if a separate .chi index file is generated (<code>YES</code>) or that it should be included in the master .chm file (<code>NO</code>).<p>
<a class="anchor" name="cfg_binary_toc"></a> </dd>
<dt><code>BINARY_TOC</code> </dt>
<dd> If the <code>GENERATE_HTMLHELP</code> tag is set to <code>YES</code>, the <code>BINARY_TOC</code> flag controls whether a binary table of contents is generated (<code>YES</code>) or a normal table of contents (<code>NO</code>) in the .chm file.<p>
<a class="anchor" name="cfg_toc_expand"></a> </dd>
<dt><code>TOC_EXPAND</code> </dt>
<dd> The <code>TOC_EXPAND</code> flag can be set to YES to add extra items for group members to the table of contents of the HTML help documentation and to the tree view.<p>
<a class="anchor" name="cfg_disable_index"></a> </dd>
<dt><code>DISABLE_INDEX</code> </dt>
<dd> If you want full control over the layout of the generated HTML pages it might be necessary to disable the index and replace it with your own. The <code>DISABLE_INDEX</code> tag can be used to turn on/off the condensed index at top of each page. A value of NO (the default) enables the index and the value YES disables it.<p>
<a class="anchor" name="cfg_enum_values_per_line"></a> </dd>
<dt><code>ENUM_VALUES_PER_LINE</code> </dt>
<dd> This tag can be used to set the number of enum values (range [1..20]) that doxygen will group on one line in the generated HTML documentation.<p>
<a class="anchor" name="cfg_generate_treeview"></a> </dd>
<dt><code>GENERATE_TREEVIEW</code> </dt>
<dd> If the <code>GENERATE_TREEVIEW</code> tag is set to YES, a side panel will be generated containing a tree-like index structure (just like the one that is generated for HTML Help). For this to work a browser that supports JavaScript and frames is required (for instance Mozilla 1.0+, Netscape 6.0+ or Internet explorer 5.0+ or Konqueror).<p>
<a class="anchor" name="cfg_treeview_width"></a> </dd>
<dt><code>TREEVIEW_WIDTH</code> </dt>
<dd> If the treeview is enabled (see <code>GENERATE_TREEVIEW</code>) then this tag can be used to set the initial width (in pixels) of the frame in which the tree is shown.<p>
</dd>
</dl>
<h2><a class="anchor" name="latex_output">
LaTeX related options</a></h2>
<a class="anchor" name="cfg_generate_latex"></a> <dl>
<dt><code>GENERATE_LATEX</code> </dt>
<dd> If the <code>GENERATE_LATEX</code> tag is set to <code>YES</code> (the default) doxygen will generate <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"> output.<p>
<a class="anchor" name="cfg_latex_output"></a> </dd>
<dt><code>LATEX_OUTPUT</code> </dt>
<dd> The <code>LATEX_OUTPUT</code> tag is used to specify where the <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"> docs will be put. If a relative path is entered the value of <code>OUTPUT_DIRECTORY</code> will be put in front of it. If left blank `latex' will be used as the default path.<p>
<a class="anchor" name="cfg_latex_cmd_name"></a> </dd>
<dt><code>LATEX_CMD_NAME</code> </dt>
<dd> The <code>LATEX_CMD_NAME</code> tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.<p>
<a class="anchor" name="cfg_makeindex_cmd_name"></a> </dd>
<dt><code>MAKEINDEX_CMD_NAME</code> </dt>
<dd> The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate index for LaTeX. If left blank `makeindex' will be used as the default command name.<p>
<a class="anchor" name="cfg_compact_latex"></a> </dd>
<dt><code>COMPACT_LATEX</code> </dt>
<dd> If the <code>COMPACT_LATEX</code> tag is set to <code>YES</code> doxygen generates more compact <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"> documents. This may be useful for small projects and may help to save some trees in general.<p>
<a class="anchor" name="cfg_paper_type"></a> </dd>
<dt><code>PAPER_TYPE</code> </dt>
<dd> The <code>PAPER_TYPE</code> tag can be used to set the paper type that is used by the printer. Possible values are: <ul>
<li>
<code>a4</code> (210 x 297 mm). </li>
<li>
<code>a4wide</code> (same as a4, but including the a4wide package). </li>
<li>
<code>letter</code> (8.5 x 11 inches). </li>
<li>
<code>legal</code> (8.5 x 14 inches). </li>
<li>
<code>executive</code> (7.25 x 10.5 inches) </li>
</ul>
If left blank a4wide will be used.<p>
<a class="anchor" name="cfg_extra_packages"></a> </dd>
<dt><code>EXTRA_PACKAGES</code> </dt>
<dd> The <code>EXTRA_PACKAGES</code> tag can be used to specify one or more <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"> package names that should be included in the <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"> output. To get the times font for instance you can specify <div class="fragment"><pre class="fragment">EXTRA_PACKAGES = times
</pre></div> If left blank no extra packages will be included.<p>
<a class="anchor" name="cfg_latex_header"></a> </dd>
<dt><code>LATEX_HEADER</code> </dt>
<dd> The <code>LATEX_HEADER</code> tag can be used to specify a personal <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"> header for the generated <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"> document. The header should contain everything until the first chapter.<p>
If it is left blank doxygen will generate a standard header. See section <a class="el" href="doxygen_usage.html">Doxygen usage</a> for information on how to let doxygen write the default header to a separate file.<p>
<dl compact><dt><b>Note: </b></dt><dd>Only use a user-defined header if you know what you are doing!</dd></dl>
The following commands have a special meaning inside the header: <code>$title</code>, <code>$datetime</code>, <code>$date</code>, <code>$doxygenversion</code>, <code>$projectname</code>, <code>$projectnumber</code>. Doxygen will replace them by respectively the title of the page, the current date and time, only the current date, the version number of doxygen, the project name (see <code>PROJECT_NAME</code>), or the project number (see <code>PROJECT_NUMBER</code>).<p>
<a class="anchor" name="cfg_pdf_hyperlinks"></a> </dd>
<dt><code>PDF_HYPERLINKS</code> </dt>
<dd><p>
If the <code>PDF_HYPERLINKS</code> tag is set to <code>YES</code>, the <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"> that is generated is prepared for conversion to PDF (using ps2pdf). The PDF file will contain links (just like the HTML output) instead of page references. This makes the output suitable for online browsing using a PDF viewer.<p>
<a class="anchor" name="cfg_latex_pdflatex"></a> </dd>
<dt><code>USE_PDFLATEX</code> </dt>
<dd><p>
If the <code>LATEX_PDFLATEX</code> tag is set to <code>YES</code>, doxygen will use pdflatex to generate the PDF file directly from the <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"> files.<p>
<a class="anchor" name="cfg_latex_batchmode"></a> </dd>
<dt><code>LATEX_BATCHMODE</code> </dt>
<dd><p>
If the <code>LATEX_BATCHMODE</code> tag is set to <code>YES</code>, doxygen will add the \batchmode. command to the generated <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"> files. This will instruct <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"> to keep running if errors occur, instead of asking the user for help. This option is also used when generating formulas in HTML.<p>
<a class="anchor" name="cfg_latex_hide_indices"></a> </dd>
<dt><code>LATEX_HIDE_INDICES</code> </dt>
<dd><p>
If <code>LATEX_HIDE_INDICES</code> is set to <code>YES</code> then doxygen will not include the index chapters (such as File Index, Compound Index, etc.) in the output.<p>
</dd>
</dl>
<h2><a class="anchor" name="rtf_output">
RTF related options</a></h2>
<a class="anchor" name="cfg_generate_rtf"></a> <dl>
<dt><code>GENERATE_RTF</code> </dt>
<dd> If the <code>GENERATE_RTF</code> tag is set to <code>YES</code> doxygen will generate RTF output. The RTF output is optimized for Word 97 and may not look too pretty with other readers/editors.<p>
<a class="anchor" name="cfg_rtf_output"></a> </dd>
<dt><code>RTF_OUTPUT</code> </dt>
<dd> The <code>RTF_OUTPUT</code> tag is used to specify where the RTF docs will be put. If a relative path is entered the value of <code>OUTPUT_DIRECTORY</code> will be put in front of it. If left blank <code>rtf</code> will be used as the default path.<p>
<a class="anchor" name="cfg_compact_rtf"></a> </dd>
<dt><code>COMPACT_RTF</code> </dt>
<dd> If the <code>COMPACT_RTF</code> tag is set to <code>YES</code> doxygen generates more compact RTF documents. This may be useful for small projects and may help to save some trees in general.<p>
<a class="anchor" name="cfg_rtf_hyperlinks"></a> </dd>
<dt><code>RTF_HYPERLINKS</code> </dt>
<dd> If the <code>RTF_HYPERLINKS</code> tag is set to <code>YES</code>, the RTF that is generated will contain hyperlink fields. The RTF file will contain links (just like the HTML output) instead of page references. This makes the output suitable for online browsing using Word or some other Word compatible reader that support those fields.<p>
<dl compact><dt><b>note:</b></dt><dd>WordPad (write) and others do not support links.</dd></dl>
<a class="anchor" name="cfg_rtf_stylesheet_file"></a> </dd>
<dt><code>RTF_STYLESHEET_FILE</code> </dt>
<dd> Load stylesheet definitions from file. Syntax is similar to doxygen's config file, i.e. a series of assignments. You only have to provide replacements, missing definitions are set to their default value.<p>
See also section <a class="el" href="doxygen_usage.html">Doxygen usage</a> for information on how to generate the default style sheet that doxygen normally uses.<p>
<a class="anchor" name="cfg_rtf_extensions_file"></a> </dd>
<dt><code>RTF_EXTENSIONS_FILE</code> </dt>
<dd>Set optional variables used in the generation of an RTF document. Syntax is similar to doxygen's config file. A template extensions file can be generated using <code>doxygen -e rtf extensionFile</code>.<p>
</dd>
</dl>
<h2><a class="anchor" name="man_output">
Man page related options</a></h2>
<a class="anchor" name="cfg_generate_man"></a> <dl>
<dt><code>GENERATE_MAN</code> </dt>
<dd> If the <code>GENERATE_MAN</code> tag is set to <code>YES</code> (the default) doxygen will generate man pages for classes and files.<p>
<a class="anchor" name="cfg_man_output"></a> </dd>
<dt><code>MAN_OUTPUT</code> </dt>
<dd> The <code>MAN_OUTPUT</code> tag is used to specify where the man pages will be put. If a relative path is entered the value of <code>OUTPUT_DIRECTORY</code> will be put in front of it. If left blank `man' will be used as the default path. A directory man3 will be created inside the directory specified by <code>MAN_OUTPUT</code>.<p>
<a class="anchor" name="cfg_man_extension"></a> </dd>
<dt><code>MAN_EXTENSION</code> </dt>
<dd> The <code>MAN_EXTENSION</code> tag determines the extension that is added to the generated man pages (default is the subroutine's section .3)<p>
<a class="anchor" name="cfg_man_links"></a> </dd>
<dt><code>MAN_LINKS</code> </dt>
<dd> If the <code>MAN_LINKS</code> tag is set to <code>YES</code> and doxygen generates man output, then it will generate one additional man file for each entity documented in the real man page(s). These additional files only source the real man page, but without them the man command would be unable to find the correct page. The default is <code>NO</code>.<p>
</dd>
</dl>
<h2><a class="anchor" name="xml_output">
XML related options</a></h2>
<a class="anchor" name="cfg_generate_xml"></a> <dl>
<dt><code>GENERATE_XML</code> </dt>
<dd> If the <code>GENERATE_XML</code> tag is set to <code>YES</code> Doxygen will generate an XML file that captures the structure of the code including all documentation.<p>
<a class="anchor" name="cfg_xml_output"></a> </dd>
<dt><code>XML_OUTPUT</code> </dt>
<dd> The <code>XML_OUTPUT</code> tag is used to specify where the XML pages will be put. If a relative path is entered the value of <code>OUTPUT_DIRECTORY</code> will be put in front of it. If left blank <code>xml</code> will be used as the default path.<p>
<a class="anchor" name="cfg_xml_schema"></a> </dd>
<dt><code>XML_SCHEMA</code> </dt>
<dd> The <code>XML_SCHEMA</code> tag can be used to specify an XML schema, which can be used by a validating XML parser to check the syntax of the XML files.<p>
<a class="anchor" name="cfg_xml_dtd"></a> </dd>
<dt><code>XML_DTD</code> </dt>
<dd> The <code>XML_DTD</code> tag can be used to specify an XML DTD, which can be used by a validating XML parser to check the syntax of the XML files.<p>
<a class="anchor" name="cfg_xml_programlisting"></a> </dd>
<dt><code>XML_PROGRAMLISTING</code> </dt>
<dd> If the <code>XML_PROGRAMLISTING</code> tag is set to <code>YES</code> Doxygen will dump the program listings (including syntax highlighting and cross-referencing information) to the XML output. Note that enabling this will significantly increase the size of the XML output.<p>
</dd>
</dl>
<h2><a class="anchor" name="autogen_output">
AUTOGEN_DEF related options</a></h2>
<a class="anchor" name="cfg_generate_autogen_def"></a> <dl>
<dt><code>GENERATE_AUTOGEN_DEF</code> </dt>
<dd> If the <code>GENERATE_AUTOGEN_DEF</code> tag is set to <code>YES</code> Doxygen will generate an AutoGen Definitions (see <a href="http://autogen.sf.net">http://autogen.sf.net</a>) file that captures the structure of the code including all documentation. Note that this feature is still experimental and incomplete at the moment.<p>
</dd>
</dl>
<h2><a class="anchor" name="perlmod_output">
PERLMOD related options</a></h2>
<a class="anchor" name="cfg_generate_perlmod"></a> <dl>
<dt><code>GENERATE_PERLMOD</code> </dt>
<dd> If the <code>GENERATE_PERLMOD</code> tag is set to <code>YES</code> Doxygen will generate a Perl module file that captures the structure of the code including all documentation. Note that this feature is still experimental and incomplete at the moment.<p>
<a class="anchor" name="cfg_perlmod_latex"></a> </dd>
<dt><code>PERLMOD_LATEX</code> </dt>
<dd> If the <code>PERLMOD_LATEX</code> tag is set to <code>YES</code> Doxygen will generate the necessary Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI output from the Perl module output.<p>
<a class="anchor" name="cfg_perlmod_pretty"></a> </dd>
<dt><code>PERLMOD_PRETTY</code> </dt>
<dd> If the <code>PERLMOD_PRETTY</code> tag is set to <code>YES</code> the Perl module output will be nicely formatted so it can be parsed by a human reader. This is useful if you want to understand what is going on. On the other hand, if this tag is set to <code>NO</code> the size of the Perl module output will be much smaller and Perl will parse it just the same.<p>
<a class="anchor" name="cfg_perlmod_makevar_prefix"></a> </dd>
<dt><code>PERLMOD_MAKEVAR_PREFIX</code> </dt>
<dd> The names of the make variables in the generated doxyrules.make file are prefixed with the string contained in <code>PERLMOD_MAKEVAR_PREFIX</code>. This is useful so different doxyrules.make files included by the same Makefile don't overwrite each other's variables.<p>
</dd>
</dl>
<h2><a class="anchor" name="config_prepro">
Preprocessor related options</a></h2>
<a class="anchor" name="cfg_enable_preprocessing"></a> <dl>
<dt><code>ENABLE_PREPROCESSING</code> </dt>
<dd> If the <code>ENABLE_PREPROCESSING</code> tag is set to <code>YES</code> (the default) doxygen will evaluate all C-preprocessor directives found in the sources and include files.<p>
<a class="anchor" name="cfg_macro_expansion"></a> </dd>
<dt><code>MACRO_EXPANSION</code> </dt>
<dd> If the <code>MACRO_EXPANSION</code> tag is set to <code>YES</code> doxygen will expand all macro names in the source code. If set to <code>NO</code> (the default) only conditional compilation will be performed. Macro expansion can be done in a controlled way by setting <code>EXPAND_ONLY_PREDEF</code> to <code>YES</code>.<p>
<a class="anchor" name="cfg_expand_only_predef"></a> </dd>
<dt><code>EXPAND_ONLY_PREDEF</code> </dt>
<dd> If the <code>EXPAND_ONLY_PREDEF</code> and <code>MACRO_EXPANSION</code> tags are both set to YES then the macro expansion is limited to the macros specified with the <code>PREDEFINED</code> and <code>EXPAND_AS_DEFINED</code> tags.<p>
<a class="anchor" name="cfg_search_includes"></a> </dd>
<dt><code>SEARCH_INCLUDES</code> </dt>
<dd> If the <code>SEARCH_INCLUDES</code> tag is set to <code>YES</code> (the default) the includes files in the <code>INCLUDE_PATH</code> (see below) will be searched if a #include is found.<p>
<a class="anchor" name="cfg_include_path"></a> </dd>
<dt><code>INCLUDE_PATH</code> </dt>
<dd> The <code>INCLUDE_PATH</code> tag can be used to specify one or more directories that contain include files that are not input files but should be processed by the preprocessor.<p>
<a class="anchor" name="cfg_predefined"></a> </dd>
<dt><code>PREDEFINED</code> </dt>
<dd> The <code>PREDEFINED</code> tag can be used to specify one or more macro names that are defined before the preprocessor is started (similar to the -D option of gcc). The argument of the tag is a list of macros of the form: <code>name</code> or <code>name=definition</code> (no spaces). If the definition and the "=" are omitted, "=1" is assumed. To prevent a macro definition from being undefined via #undef or recursively expanded use the := operator instead of the = operator.<p>
<a class="anchor" name="cfg_expand_as_defined"></a> </dd>
<dt><code>EXPAND_AS_DEFINED</code> </dt>
<dd> If the <code>MACRO_EXPANSION</code> and <code>EXPAND_ONLY_PREDEF</code> tags are set to <code>YES</code> then this tag can be used to specify a list of macro names that should be expanded. The macro definition that is found in the sources will be used. Use the <code>PREDEFINED</code> tag if you want to use a different macro definition.<p>
<a class="anchor" name="cfg_skip_function_macros"></a> </dd>
<dt><code>SKIP_FUNCTION_MACROS</code> </dt>
<dd> If the <code>SKIP_FUNCTION_MACROS</code> tag is set to <code>YES</code> (the default) then doxygen's preprocessor will remove all function-like macros that are alone on a line, have an all uppercase name, and do not end with a semicolon. Such function macros are typically used for boiler-plate code, and will confuse the parser if not removed.<p>
</dd>
</dl>
<h2><a class="anchor" name="config_extref">
External reference options</a></h2>
<a class="anchor" name="cfg_tagfiles"></a> <dl>
<dt><code>TAGFILES</code> </dt>
<dd> The <code>TAGFILES</code> tag can be used to specify one or more tagfiles.<p>
See section <a class="el" href="doxytag_usage.html">Doxytag usage</a> for more information about the usage of tag files.<p>
Optionally an initial location of the external documentation can be added for each tagfile. The format of a tag file without this location is as follows: <pre>
TAGFILES = file1 file2 ... </pre> Adding location for the tag files is done as follows: <pre>
TAGFILES = file1=loc1 "file2 = loc2" ... </pre> where <code>loc1</code> and <code>loc2</code> can be relative or absolute paths or URLs, If a location is present for each tag, the installdox tool (see section <a class="el" href="installdox_usage.html">Installdox usage</a> for more information) does not have to be run to correct the links.<p>
<dl compact><dt><b>Note:</b></dt><dd>Each tag file must have a unique name (where the name does <em>not</em> include the path) If a tag file is not located in the directory in which doxygen is run, you must also specify the path to the tagfile here.</dd></dl>
<a class="anchor" name="cfg_generate_tagfile"></a> </dd>
<dt><code>GENERATE_TAGFILE</code> </dt>
<dd> When a file name is specified after <code>GENERATE_TAGFILE</code>, doxygen will create a tag file that is based on the input files it reads. See section <a class="el" href="doxytag_usage.html">Doxytag usage</a> for more information about the usage of tag files.<p>
<a class="anchor" name="cfg_allexternals"></a> </dd>
<dt><code>ALLEXTERNALS</code> </dt>
<dd> If the <code>ALLEXTERNALS</code> tag is set to <code>YES</code> all external class will be listed in the class index. If set to <code>NO</code> only the inherited external classes will be listed.<p>
<a class="anchor" name="cfg_external_groups"></a> </dd>
<dt><code>EXTERNAL_GROUPS</code> </dt>
<dd> If the <code>EXTERNAL_GROUPS</code> tag is set to <code>YES</code> all external groups will be listed in the modules index. If set to <code>NO</code>, only the current project's groups will be listed.<p>
<a class="anchor" name="cfg_perl_path"></a> </dd>
<dt><code>PERL_PATH</code> </dt>
<dd> The <code>PERL_PATH</code> should be the absolute path and name of the perl script interpreter (i.e. the result of `<code>which perl</code>').<p>
</dd>
</dl>
<h2><a class="anchor" name="config_dot">
Dot options</a></h2>
<a class="anchor" name="cfg_class_diagrams"></a> <dl>
<dt><code>CLASS_DIAGRAMS</code> </dt>
<dd> If the <code>CLASS_DIAGRAMS</code> tag is set to <code>YES</code> (the default) doxygen will generate a class diagram (in HTML and <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"> ) for classes with base or super classes. Setting the tag to <code>NO</code> turns the diagrams off. Note that this option is superseded by the HAVE_DOT option below. This is only a fallback. It is recommended to install and use dot, since it yields more powerful graphs.<p>
<a class="anchor" name="cfg_have_dot"></a> </dd>
<dt><code>HAVE_DOT</code> </dt>
<dd> If you set the <code>HAVE_DOT</code> tag to <code>YES</code> then doxygen will assume the dot tool is available from the path. This tool is part of <a href="http://www.research.att.com/sw/tools/graphviz/">Graphviz</a>, a graph visualization toolkit from AT&T and Lucent Bell Labs. The other options in this section have no effect if this option is set to <code>NO</code> (the default)<p>
<a class="anchor" name="cfg_class_graph"></a> </dd>
<dt><code>CLASS_GRAPH</code> </dt>
<dd> If the <code>CLASS_GRAPH</code> and <code>HAVE_DOT</code> tags are set to <code>YES</code> then doxygen will generate a graph for each documented class showing the direct and indirect inheritance relations. Setting this tag to <code>YES</code> will force the the <code>CLASS_DIAGRAMS</code> tag to NO.<p>
<a class="anchor" name="cfg_collaboration_graph"></a> </dd>
<dt><code>COLLABORATION_GRAPH</code> </dt>
<dd> If the <code>COLLABORATION_GRAPH</code> and <code>HAVE_DOT</code> tags are set to <code>YES</code> then doxygen will generate a graph for each documented class showing the direct and indirect implementation dependencies (inheritance, containment, and class references variables) of the class with other documented classes.<p>
<a class="anchor" name="cfg_group_graphs"></a> </dd>
<dt><code>GROUP_GRAPHS</code> </dt>
<dd> If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen will generate a graph for groups, showing the direct groups dependencies.<p>
<a class="anchor" name="cfg_uml_look"></a> </dd>
<dt><code>UML_LOOK</code> </dt>
<dd> If the UML_LOOK tag is set to YES doxygen will generate inheritance and collaboration diagrams in a style similar to the OMG's Unified Modeling Language.<p>
<a class="anchor" name="cfg_template_relations"></a> </dd>
<dt><code>TEMPLATE_RELATIONS</code> </dt>
<dd> If the <code>TEMPLATE_RELATIONS</code> and <code>HAVE_DOT</code> tags are set to <code>YES</code> then doxygen will show the relations between templates and their instances.<p>
<a class="anchor" name="cfg_hide_undoc_relations"></a> </dd>
<dt><code>HIDE_UNDOC_RELATIONS</code> </dt>
<dd> If set to YES, the inheritance and collaboration graphs will hide inheritance and usage relations if the target is undocumented or is not a class.<p>
<a class="anchor" name="cfg_include_graph"></a> </dd>
<dt><code>INCLUDE_GRAPH</code> </dt>
<dd> If the <code>ENABLE_PREPROCESSING</code>, <code>SEARCH_INCLUDES</code>, <code>INCLUDE_GRAPH</code>, and <code>HAVE_DOT</code> tags are set to <code>YES</code> then doxygen will generate a graph for each documented file showing the direct and indirect include dependencies of the file with other documented files.<p>
<a class="anchor" name="cfg_included_by_graph"></a> </dd>
<dt><code>INCLUDED_BY_GRAPH</code> </dt>
<dd> If the <code>ENABLE_PREPROCESSING</code>, <code>SEARCH_INCLUDES</code>, <code>INCLUDED_BY_GRAPH</code>, and <code>HAVE_DOT</code> tags are set to <code>YES</code> then doxygen will generate a graph for each documented header file showing the documented files that directly or indirectly include this file.<p>
<a class="anchor" name="cfg_call_graph"></a> </dd>
<dt><code>CALL_GRAPH</code> </dt>
<dd> If the <code>CALL_GRAPH</code> and <code>HAVE_DOT</code> tags are set to <code>YES</code> then doxygen will generate a call dependency graph for every global function or class method. Note that enabling this option will significantly increase the time of a run. So in most cases it will be better to enable call graphs for selected functions only using the \callgraph command.<p>
<a class="anchor" name="cfg_graphical_hierarchy"></a> </dd>
<dt><code>GRAPHICAL_HIERARCHY</code> </dt>
<dd> If the <code>GRAPHICAL_HIERARCHY</code> and <code>HAVE_DOT</code> tags are set to <code>YES</code> then doxygen will graphical hierarchy of all classes instead of a textual one.<p>
<a class="anchor" name="cfg_directory_graph"></a> </dd>
<dt><code>DIRECTORY_GRAPH</code> </dt>
<dd> If the <code>DIRECTORY_GRAPH</code>, <code>SHOW_DIRECTORIES</code> and <code>HAVE_DOT</code> options are set to <code>YES</code> then doxygen will show the dependencies a directory has on other directories in a graphical way. The dependency relations are determined by the #include relations between the files in the directories.<p>
<a class="anchor" name="cfg_dot_image_format"></a> </dd>
<dt><code>DOT_IMAGE_FORMAT</code> </dt>
<dd> The <code>DOT_IMAGE_FORMAT</code> tag can be used to set the image format of the images generated by dot. Possible values are gif, jpg, and png. If left blank png will be used.<p>
<a class="anchor" name="cfg_dot_path"></a> </dd>
<dt><code>DOT_PATH</code> </dt>
<dd> This tag can be used to specify the path where the dot tool can be found. If left blank, it is assumed the dot tool can be found on the path.<p>
<a class="anchor" name="cfg_dotfile_dirs"></a> </dd>
<dt><code>DOTFILE_DIRS</code> </dt>
<dd> This tag can be used to specify one or more directories that contain dot files that are included in the documentation (see the \dotfile command).<p>
<a class="anchor" name="cfg_max_dot_graph_height"></a> </dd>
<dt><code>MAX_DOT_GRAPH_HEIGHT</code> </dt>
<dd> The <code>MAX_DOT_GRAPH_HEIGHT</code> tag can be used to set the maximum allows height (in pixels) of the graphs generated by dot. If a graph becomes larger than this value, doxygen will try to truncate the graph, so that it fits within the specified constraint. Beware that most browsers cannot cope with very large images.<p>
<a class="anchor" name="cfg_max_dot_graph_depth"></a> </dd>
<dt><code>MAX_DOT_GRAPH_DEPTH</code> </dt>
<dd> The <code>MAX_DOT_GRAPH_DEPTH</code> tag can be used to set the maximum depth of the graphs generated by dot. A depth value of 3 means that only nodes reachable from the root by following a path via at most 3 edges will be shown. Nodes that lay further from the root node will be omitted. Note that setting this option to 1 or 2 may greatly reduce the computation time needed for large code bases. Also note that a graph may be further truncated if the graph's image dimensions are not sufficient to fit the graph (see <a class="el" href="config.html#cfg_max_dot_graph_width">MAX_DOT_GRAPH_WIDTH</a> and <a class="el" href="config.html#cfg_max_dot_graph_height">MAX_DOT_GRAPH_HEIGHT</a>). If 0 is used for the depth value (the default), the graph is not depth-constraint.<p>
<a class="anchor" name="cfg_max_dot_graph_width"></a> </dd>
<dt><code>MAX_DOT_GRAPH_WIDTH</code> </dt>
<dd> The <code>MAX_DOT_GRAPH_WIDTH</code> tag can be used to set the maximum allowed width (in pixels) of the graphs generated by dot. If a graph becomes larger than this value, doxygen will try to truncate the graph, so that it fits within the specified constraint. Beware that most browsers cannot cope with very large images.<p>
<a class="anchor" name="cfg_dot_transparent"></a> </dd>
<dt><code>DOT_TRANSPARENT</code> </dt>
<dd> Set the <code>DOT_TRANSPARENT</code> tag to <code>YES</code> to generate images with a transparent background. This is disabled by default, which results in a white background. Warning: Depending on the platform used, enabling this option may lead to badly anti-aliased labels on the edges of a graph (i.e. they become hard to read).<p>
<a class="anchor" name="cfg_dot_multi_targets"></a> </dd>
<dt><code>DOT_MULTI_TARGETS</code> </dt>
<dd> Set the <code>DOT_MULTI_TARGETS</code> tag to <code>YES</code> allow dot to generate multiple output files in one run (i.e. multiple -o and -T options on the command line). This makes dot run faster, but since only newer versions of dot (>1.8.10) support this, this feature is disabled by default.<p>
<a class="anchor" name="cfg_generate_legend"></a> </dd>
<dt><code>GENERATE_LEGEND</code> </dt>
<dd> If the <code>GENERATE_LEGEND</code> tag is set to <code>YES</code> (the default) doxygen will generate a legend page explaining the meaning of the various boxes and arrows in the dot generated graphs.<p>
<a class="anchor" name="cfg_dot_cleanup"></a> </dd>
<dt><code>DOT_CLEANUP</code> </dt>
<dd> If the <code>DOT_CLEANUP</code> tag is set to <code>YES</code> (the default) doxygen will remove the intermediate dot files that are used to generate the various graphs.<p>
</dd>
</dl>
<h2><a class="anchor" name="config_search">
Search engine options</a></h2>
<a class="anchor" name="cfg_searchengine"></a> <dl>
<dt><code>SEARCHENGINE</code> </dt>
<dd> The <code>SEARCHENGINE</code> tag specifies whether or not the HTML output should contain a search facility. Possible values are <code>YES</code> and <code>NO</code>. If set to YES, doxygen will produce a search index and a PHP script to search through the index. For this to work the documentation should be viewed via a web-server running PHP version 4.1.0 or higher. (See <a href="http://www.php.net/manual/en/installation.php">http://www.php.net/manual/en/installation.php</a> for installation instructions).<p>
</dd>
</dl>
<h2>Examples</h2>
<p>
Suppose you have a simple project consisting of two files: a source file <code>example.cc</code> and a header file <code>example.h</code>. Then a minimal configuration file is as simple as: <div class="fragment"><pre class="fragment">INPUT = example.cc example.h
</pre></div><p>
Assuming the example makes use of Qt classes and perl is located in <code>/usr/bin</code>, a more realistic configuration file would be: <div class="fragment"><pre class="fragment">PROJECT_NAME = Example
INPUT = example.cc example.h
WARNINGS = YES
TAGFILES = qt.tag
PERL_PATH = /usr/bin/perl
SEARCHENGINE = NO
</pre></div><p>
To generate the documentation for the <a href="http://www.stack.nl/~dimitri/qdbttabular/index.html">QdbtTabular</a> package I have used the following configuration file: <div class="fragment"><pre class="fragment">PROJECT_NAME = QdbtTabular
OUTPUT_DIRECTORY = html
WARNINGS = YES
INPUT = examples/examples.doc src
FILE_PATTERNS = *.cc *.h
INCLUDE_PATH = examples
TAGFILES = qt.tag
PERL_PATH = /usr/local/bin/perl
SEARCHENGINE = YES
</pre></div><p>
To regenerate the Qt-1.44 documentation from the sources, you could use the following config file: <div class="fragment"><pre class="fragment">PROJECT_NAME = Qt
OUTPUT_DIRECTORY = qt_docs
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
SEARCH_INCLUDES = YES
FULL_PATH_NAMES = YES
STRIP_FROM_PATH = $(QTDIR)/
PREDEFINED = USE_TEMPLATECLASS Q_EXPORT= \
QArrayT:=QArray \
QListT:=QList \
QDictT:=QDict \
QQueueT:=QQueue \
QVectorT:=QVector \
QPtrDictT:=QPtrDict \
QIntDictT:=QIntDict \
QStackT:=QStack \
QDictIteratorT:=QDictIterator \
QListIteratorT:=QListIterator \
QCacheT:=QCache \
QCacheIteratorT:=QCacheIterator \
QIntCacheT:=QIntCache \
QIntCacheIteratorT:=QIntCacheIterator \
QIntDictIteratorT:=QIntDictIterator \
QPtrDictIteratorT:=QPtrDictIterator
INPUT = $(QTDIR)/doc \
$(QTDIR)/src/widgets \
$(QTDIR)/src/kernel \
$(QTDIR)/src/dialogs \
$(QTDIR)/src/tools
FILE_PATTERNS = *.cpp *.h q*.doc
INCLUDE_PATH = $(QTDIR)/include
RECURSIVE = YES
</pre></div><p>
For the Qt-2.1 sources I recommend to use the following settings: <div class="fragment"><pre class="fragment">PROJECT_NAME = Qt
PROJECT_NUMBER = 2.1
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
SOURCE_BROWSER = YES
INPUT = $(QTDIR)/src
FILE_PATTERNS = *.cpp *.h q*.doc
RECURSIVE = YES
EXCLUDE_PATTERNS = *codec.cpp moc_* compat 3rdparty
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 3
IGNORE_PREFIX = Q
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
INCLUDE_PATH = $(QTDIR)/include
PREDEFINED = Q_PROPERTY(x)= \
Q_OVERRIDE(x)= \
Q_EXPORT= \
Q_ENUMS(x)= \
"QT_STATIC_CONST=static const " \
_WS_X11_ \
INCLUDE_MENUITEM_DEF
EXPAND_ONLY_PREDEF = YES
EXPAND_AS_DEFINED = Q_OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM \
Q_VARIANT_AS
</pre></div><p>
Here doxygen's preprocessor is used to substitute some macro names that are normally substituted by the C preprocessor, but without doing full macro expansion. <hr size="1"><address style="align: right;"><small>Generated on Wed Nov 15 11:05:48 2006 for Doxygen manual by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4 </small></address>
</body>
</html>
