Sophie

Sophie

distrib > Fedora > 17 > i386 > media > updates > by-pkgid > 6f66f87ec44b6c623ed0b141648cc132 > files > 1285

doxygen-1.8.1.1-3.fc17.i686.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Configuration</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen_manual.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('config.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">Configuration </div>  </div>
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><li class="level1"><a href="#config_format">Format</a></li>
<li class="level1"><a href="#config_project">Project related options</a></li>
<li class="level1"><a href="#config_build">Build related options</a></li>
<li class="level1"><a href="#messages_input">Options related to warning and progress messages</a></li>
<li class="level1"><a href="#config_input">Input related options</a></li>
<li class="level1"><a href="#sourcebrowser_index">Source browsing related options</a></li>
<li class="level1"><a href="#alphabetical_index">Alphabetical index options</a></li>
<li class="level1"><a href="#html_output">HTML related options</a></li>
<li class="level1"><a href="#latex_output">LaTeX related options</a></li>
<li class="level1"><a href="#rtf_output">RTF related options</a></li>
<li class="level1"><a href="#man_output">Man page related options</a></li>
<li class="level1"><a href="#xml_output">XML related options</a></li>
<li class="level1"><a href="#autogen_output">AUTOGEN_DEF related options</a></li>
<li class="level1"><a href="#perlmod_output">PERLMOD related options</a></li>
<li class="level1"><a href="#config_prepro">Preprocessor related options</a></li>
<li class="level1"><a href="#config_extref">External reference options</a></li>
<li class="level1"><a href="#config_dot">Dot options</a></li>
</ul>
</div>
<div class="textblock"><h1><a class="anchor" id="config_format"></a>
Format</h1>
<p>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>
<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>
<p>You can also include part of a configuration file from another configuration file using a <code>@INCLUDE</code> tag as follows: </p>
<pre class="fragment">@INCLUDE = config_file_name
</pre><p> 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.: </p>
<pre class="fragment">@INCLUDE_PATH = my_config_dir
</pre><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>
<div class="multicol">
<ul>
<li><a href="config.html#cfg_abbreviate_brief">ABBREVIATE_BRIEF</a></li>
<li><a href="config.html#cfg_aliases">ALIASES</a></li>
<li><a href="config.html#cfg_allexternals">ALLEXTERNALS </a></li>
<li><a href="config.html#cfg_alphabetical_index">ALPHABETICAL_INDEX </a></li>
<li><a href="config.html#cfg_always_detailed_sec">ALWAYS_DETAILED_SEC</a></li>
<li><a href="config.html#cfg_binary_toc">BINARY_TOC</a></li>
<li><a href="config.html#cfg_brief_member_desc">BRIEF_MEMBER_DESC </a></li>
<li><a href="config.html#cfg_builtin_stl_support">BUILTIN_STL_SUPPORT</a></li>
<li><a href="config.html#cfg_call_graph">CALL_GRAPH</a></li>
<li><a href="config.html#cfg_caller_graph">CALLER_GRAPH</a></li>
<li><a href="config.html#cfg_case_sense_names">CASE_SENSE_NAMES </a></li>
<li><a href="config.html#cfg_chm_file">CHM_FILE</a></li>
<li><a href="config.html#cfg_chm_index_encoding">CHM_INDEX_ENCODING</a></li>
<li><a href="config.html#cfg_cite_bib_files">CITE_BIB_FILES</a></li>
<li><a href="config.html#cfg_class_diagrams">CLASS_DIAGRAMS </a></li>
<li><a href="config.html#cfg_class_graph">CLASS_GRAPH</a></li>
<li><a href="config.html#cfg_collaboration_graph">COLLABORATION_GRAPH</a></li>
<li><a href="config.html#cfg_cols_in_alpha_index">COLS_IN_ALPHA_INDEX</a></li>
<li><a href="config.html#cfg_compact_latex">COMPACT_LATEX </a></li>
<li><a href="config.html#cfg_compact_rtf">COMPACT_RTF</a></li>
<li><a href="config.html#cfg_cpp_cli_support">CPP_CLI_SUPPORT</a></li>
<li><a href="config.html#cfg_create_subdirs">CREATE_SUBDIRS</a></li>
<li><a href="config.html#cfg_directory_graph">DIRECTORY_GRAPH</a></li>
<li><a href="config.html#cfg_disable_index">DISABLE_INDEX </a></li>
<li><a href="config.html#cfg_distribute_group_doc">DISTRIBUTE_GROUP_DOC</a></li>
<li><a href="config.html#cfg_docset_bundle_id">DOCSET_BUNDLE_ID</a></li>
<li><a href="config.html#cfg_docset_feedname">DOCSET_FEEDNAME</a></li>
<li><a href="config.html#cfg_docset_publisher_id">DOCSET_PUBLISHER_ID</a></li>
<li><a href="config.html#cfg_docset_publisher_name">DOCSET_PUBLISHER_NAME</a></li>
<li><a href="config.html#cfg_dot_cleanup">DOT_CLEANUP</a></li>
<li><a href="config.html#cfg_dot_fontname">DOT_FONTNAME</a></li>
<li><a href="config.html#cfg_dot_fontpath">DOT_FONTPATH</a></li>
<li><a href="config.html#cfg_dot_fontsize">DOT_FONTSIZE</a></li>
<li><a href="config.html#cfg_dot_graph_max_nodes">DOT_GRAPH_MAX_NODES</a></li>
<li><a href="config.html#cfg_dot_image_format">DOT_IMAGE_FORMAT</a></li>
<li><a href="config.html#cfg_dot_multi_targets">DOT_MULTI_TARGETS</a></li>
<li><a href="config.html#cfg_dot_num_threads">DOT_NUM_THREADS</a></li>
<li><a href="config.html#cfg_dot_path">DOT_PATH</a></li>
<li><a href="config.html#cfg_dot_transparent">DOT_TRANSPARENT</a></li>
<li><a href="config.html#cfg_dotfile_dirs">DOTFILE_DIRS</a></li>
<li><a href="config.html#cfg_doxyfile_encoding">DOXYFILE_ENCODING</a></li>
<li><a href="config.html#cfg_eclipse_doc_id">ECLIPSE_DOC_ID</a></li>
<li><a href="config.html#cfg_enable_preprocessing">ENABLE_PREPROCESSING</a></li>
<li><a href="config.html#cfg_enabled_sections">ENABLED_SECTIONS</a></li>
<li><a href="config.html#cfg_enum_values_per_line">ENUM_VALUES_PER_LINE</a></li>
<li><a href="config.html#cfg_example_path">EXAMPLE_PATH</a></li>
<li><a href="config.html#cfg_example_patterns">EXAMPLE_PATTERNS</a></li>
<li><a href="config.html#cfg_example_recursive">EXAMPLE_RECURSIVE</a></li>
<li><a href="config.html#cfg_exclude">EXCLUDE</a></li>
<li><a href="config.html#cfg_exclude_patterns">EXCLUDE_PATTERNS</a></li>
<li><a href="config.html#cfg_exclude_symbols">EXCLUDE_SYMBOLS</a></li>
<li><a href="config.html#cfg_exclude_symlinks">EXCLUDE_SYMLINKS</a></li>
<li><a href="config.html#cfg_expand_as_defined">EXPAND_AS_DEFINED</a></li>
<li><a href="config.html#cfg_expand_only_predef">EXPAND_ONLY_PREDEF</a></li>
<li><a href="config.html#cfg_ext_links_in_window">EXT_LINKS_IN_WINDOW</a></li>
<li><a href="config.html#cfg_extension_mapping">EXTENSION_MAPPING</a></li>
<li><a href="config.html#cfg_external_groups">EXTERNAL_GROUPS</a></li>
<li><a href="config.html#cfg_extra_packages">EXTRA_PACKAGES</a></li>
<li><a href="config.html#cfg_extract_all">EXTRACT_ALL</a></li>
<li><a href="config.html#cfg_extract_anon_nspaces">EXTRACT_ANON_NSPACES</a></li>
<li><a href="config.html#cfg_extract_local_classes">EXTRACT_LOCAL_CLASSES</a></li>
<li><a href="config.html#cfg_extract_local_methods">EXTRACT_LOCAL_METHODS</a></li>
<li><a href="config.html#cfg_extract_private">EXTRACT_PRIVATE</a></li>
<li><a href="config.html#cfg_extract_static">EXTRACT_STATIC</a></li>
<li><a href="config.html#cfg_file_patterns">FILE_PATTERNS</a></li>
<li><a href="config.html#cfg_file_version_filter">FILE_VERSION_FILTER</a></li>
<li><a href="config.html#cfg_filter_patterns">FILTER_PATTERNS</a></li>
<li><a href="config.html#cfg_filter_source_files">FILTER_SOURCE_FILES</a></li>
<li><a href="config.html#cfg_filter_source_patterns">FILTER_SOURCE_PATTERNS</a></li>
<li><a href="config.html#cfg_force_local_includes">FORCE_LOCAL_INCLUDES</a></li>
<li><a href="config.html#cfg_formula_fontsize">FORMULA_FONTSIZE</a></li>
<li><a href="config.html#cfg_formula_transparent">FORMULA_TRANSPARENT</a></li>
<li><a href="config.html#cfg_full_path_names">FULL_PATH_NAMES</a></li>
<li><a href="config.html#cfg_generate_autogen_def">GENERATE_AUTOGEN_DEF</a></li>
<li><a href="config.html#cfg_generate_buglist">GENERATE_BUGLIST</a></li>
<li><a href="config.html#cfg_generate_chi">GENERATE_CHI</a></li>
<li><a href="config.html#cfg_generate_deprecatedlist">GENERATE_DEPRECIATEDLIST</a></li>
<li><a href="config.html#cfg_generate_docset">GENERATE_DOCSET</a></li>
<li><a href="config.html#cfg_generate_eclipsehelp">GENERATE_ECLIPSEHELP</a></li>
<li><a href="config.html#cfg_generate_html">GENERATE_HTML</a></li>
<li><a href="config.html#cfg_generate_htmlhelp">GENERATE_HTMLHELP</a></li>
<li><a href="config.html#cfg_generate_latex">GENERATE_LATEX</a></li>
<li><a href="config.html#cfg_generate_legend">GENERATE_LEGEND</a></li>
<li><a href="config.html#cfg_generate_man">GENERATE_MAN</a></li>
<li><a href="config.html#cfg_generate_perlmod">GENERATE_PERLMOD</a></li>
<li><a href="config.html#cfg_generate_qhp">GENERATE_QHP</a></li>
<li><a href="config.html#cfg_generate_rtf">GENERATE_RTF</a></li>
<li><a href="config.html#cfg_generate_tagfile">GENERATE_TAGFILE</a></li>
<li><a href="config.html#cfg_generate_testlist">GENERATE_TESTLIST</a></li>
<li><a href="config.html#cfg_generate_todolist">GENERATE_TODOLIST</a></li>
<li><a href="config.html#cfg_generate_treeview">GENERATE_TREEVIEW</a></li>
<li><a href="config.html#cfg_generate_xml">GENERATE_XML</a></li>
<li><a href="config.html#cfg_graphical_hierarchy">GRAPHICAL_HIERARCHY</a></li>
<li><a href="config.html#cfg_group_graphs">GROUP_GRAPHS</a></li>
<li><a href="config.html#cfg_have_dot">HAVE_DOT</a></li>
<li><a href="config.html#cfg_hhc_location">HHC_LOCATION</a></li>
<li><a href="config.html#cfg_hide_friend_compounds">HIDE_FRIEND_COMPOUNDS</a></li>
<li><a href="config.html#cfg_hide_in_body_docs">HIDE_IN_BODY_DOCS</a></li>
<li><a href="config.html#cfg_hide_scope_names">HIDE_SCOPE_NAMES</a></li>
<li><a href="config.html#cfg_hide_undoc_classes">HIDE_UNDOC_CLASSES</a></li>
<li><a href="config.html#cfg_hide_undoc_members">HIDE_UNDOC_MEMBERS</a></li>
<li><a href="config.html#cfg_hide_undoc_relations">HIDE_UNDOC_RELATIONS</a></li>
<li><a href="config.html#cfg_html_align_members">HTML_ALIGN_MEMBERS</a></li>
<li><a href="config.html#cfg_html_colorstyle_gamma">HTML_COLORSTYLE_GAMMA</a></li>
<li><a href="config.html#cfg_html_colorstyle_hue">HTML_COLORSTYLE_HUE</a></li>
<li><a href="config.html#cfg_html_colorstyle_sat">HTML_COLORSTYLE_SAT</a></li>
<li><a href="config.html#cfg_html_dynamic_sections">HTML_DYNAMIC_SECTIONS</a></li>
<li><a href="config.html#cfg_html_extra_files">HTML_EXTRA_FILES</a></li>
<li><a href="config.html#cfg_html_file_extension">HTML_FILE_EXTENSION</a></li>
<li><a href="config.html#cfg_html_footer">HTML_FOOTER</a></li>
<li><a href="config.html#cfg_html_header">HTML_HEADER</a></li>
<li><a href="config.html#cfg_html_index_num_entries">HTML_INDEX_NUM_ENTRIES</a></li>
<li><a href="config.html#cfg_html_output">HTML_OUTPUT</a></li>
<li><a href="config.html#cfg_html_stylesheet">HTML_STYLESHEET</a></li>
<li><a href="config.html#cfg_html_timestamp">HTML_TIMESTAMP</a></li>
<li><a href="config.html#cfg_idl_property_support">IDL_PROPERTY_SUPPORT</a></li>
<li><a href="config.html#cfg_ignore_prefix">IGNORE_PREFIX</a></li>
<li><a href="config.html#cfg_image_path">IMAGE_PATH</a></li>
<li><a href="config.html#cfg_include_file_patterns">INCLUDE_FILE_PATTERNS</a></li>
<li><a href="config.html#cfg_include_graph">INCLUDE_GRAPH</a></li>
<li><a href="config.html#cfg_include_path">INCLUDE_PATH</a></li>
<li><a href="config.html#cfg_included_by_graph">INCLUDED_BY_GRAPH</a></li>
<li><a href="config.html#cfg_inherit_docs">INHERIT_DOCS</a></li>
<li><a href="config.html#cfg_inline_grouped_classes">INLINE_GROUPED_CLASSES</a></li>
<li><a href="config.html#cfg_inline_info">INLINE_INFO</a></li>
<li><a href="config.html#cfg_inline_inherited_memb">INLINE_INHERITED_MEMB</a></li>
<li><a href="config.html#cfg_inline_sources">INLINE_SOURCES</a></li>
<li><a href="config.html#cfg_input">INPUT</a></li>
<li><a href="config.html#cfg_input_encoding">INPUT_ENCODING</a></li>
<li><a href="config.html#cfg_input_filter">INPUT_FILTER</a></li>
<li><a href="config.html#cfg_interactive_svg">INTERACTIVE_SVG</a></li>
<li><a href="config.html#cfg_internal_docs">INTERNAL_DOCS</a></li>
<li><a href="config.html#cfg_javadoc_autobrief">JAVADOC_AUTOBRIEF</a></li>
<li><a href="config.html#cfg_latex_batchmode">LATEX_BATCHMODE</a></li>
<li><a href="config.html#cfg_latex_bib_style">LATEX_BIB_STYLE</a></li>
<li><a href="config.html#cfg_latex_cmd_name">LATEX_CMD_NAME</a></li>
<li><a href="config.html#cfg_latex_footer">LATEX_FOOTER</a></li>
<li><a href="config.html#cfg_latex_header">LATEX_HEADER</a></li>
<li><a href="config.html#cfg_latex_hide_indices">LATEX_HIDE_INDICES</a></li>
<li><a href="config.html#cfg_latex_output">LATEX_OUTPUT</a></li>
<li><a href="config.html#cfg_latex_source_code">LATEX_SOURCE_CODE</a></li>
<li><a href="config.html#cfg_layout_file">LAYOUT_FILE</a></li>
<li><a href="config.html#cfg_lookup_cache_size">LOOKUP_CACHE_SIZE</a></li>
<li><a href="config.html#cfg_macro_expansion">MACRO_EXPANSION</a></li>
<li><a href="config.html#cfg_makeindex_cmd_name">MAKEINDEX_CMD_NAME</a></li>
<li><a href="config.html#cfg_man_extension">MAN_EXTENSION</a></li>
<li><a href="config.html#cfg_man_links">MAN_LINKS</a></li>
<li><a href="config.html#cfg_man_output">MAN_OUTPUT</a></li>
<li><a href="config.html#cfg_markdown_support">MARKDOWN_SUPPORT</a></li>
<li><a href="config.html#cfg_mathjax_extensions">MATHJAX_EXTENSIONS</a></li>
<li><a href="config.html#cfg_mathjax_relpath">MATHJAX_RELPATH</a></li>
<li><a href="config.html#cfg_max_dot_graph_depth">MAX_DOT_GRAPH_DEPTH</a></li>
<li><a href="config.html#cfg_max_initializer_lines">MAX_INITIALIZER_LINES</a></li>
<li><a href="config.html#cfg_mscfile_dirs">MSCFILE_DIRS</a></li>
<li><a href="config.html#cfg_mscgen_path">MSCGEN_PATH</a></li>
<li><a href="config.html#cfg_multiline_cpp_is_brief">MULTILINE_CPP_IS_BRIEF</a></li>
<li><a href="config.html#cfg_optimize_for_fortran">OPTIMIZE_FOR_FORTRAN</a></li>
<li><a href="config.html#cfg_optimize_output_for_c">OPTIMIZE_OUTPUT_FOR_C</a></li>
<li><a href="config.html#cfg_optimize_output_java">OPTIMIZE_OUTPUT_JAVA</a></li>
<li><a href="config.html#cfg_optimize_output_vhdl">OPTIMIZE_OUTPUT_VHDL</a></li>
<li><a href="config.html#cfg_output_directory">OUTPUT_DIRECTORY</a></li>
<li><a href="config.html#cfg_output_language">OUTPUT_LANGUAGE</a></li>
<li><a href="config.html#cfg_paper_type">PAPER_TYPE</a></li>
<li><a href="config.html#cfg_pdf_hyperlinks">PDF_HYPERLINKS</a></li>
<li><a href="config.html#cfg_perl_path">PERL_PATH</a></li>
<li><a href="config.html#cfg_perlmod_latex">PERLMOD_LATEX</a></li>
<li><a href="config.html#cfg_perlmod_makevar_prefix">PERLMOD_MAKEVAR_PREFIX</a></li>
<li><a href="config.html#cfg_perlmod_pretty">PERLMOD_PRETTY</a></li>
<li><a href="config.html#cfg_predefined">PREDEFINED</a></li>
<li><a href="config.html#cfg_project_brief">PROJECT_BRIEF</a></li>
<li><a href="config.html#cfg_project_logo">PROJECT_LOGO</a></li>
<li><a href="config.html#cfg_project_name">PROJECT_NAME</a></li>
<li><a href="config.html#cfg_project_number">PROJECT_NUMBER</a></li>
<li><a href="config.html#cfg_qch_file">QCH_FILE</a></li>
<li><a href="config.html#cfg_qhg_location">QHG_LOCATION</a></li>
<li><a href="config.html#cfg_qhp_cust_filter_attrs">QHP_CUST_FILTER_ATTRS</a></li>
<li><a href="config.html#cfg_qhp_cust_filter_name">QHP_CUST_FILTER_NAME</a></li>
<li><a href="config.html#cfg_qhp_namespace">QHP_NAMESPACE</a></li>
<li><a href="config.html#cfg_qhp_sect_filter_attrs">QHP_SECT_FILTER_ATTRS</a></li>
<li><a href="config.html#cfg_qhp_virtual_folder">QHP_VIRTUAL_FOLDER</a></li>
<li><a href="config.html#cfg_qt_autobrief">QT_AUTOBRIEF</a></li>
<li><a href="config.html#cfg_quiet">QUIET</a></li>
<li><a href="config.html#cfg_recursive">RECURSIVE</a></li>
<li><a href="config.html#cfg_referenced_by_relation">REFERENCED_BY_RELATION</a></li>
<li><a href="config.html#cfg_references_link_source">REFERENCES_LINK_SOURCE</a></li>
<li><a href="config.html#cfg_references_relation">REFERENCES_RELATION</a></li>
<li><a href="config.html#cfg_repeat_brief">REPEAT_BRIEF</a></li>
<li><a href="config.html#cfg_rtf_extensions_file">RTF_EXTENSIONS_FILE</a></li>
<li><a href="config.html#cfg_rtf_hyperlinks">RTF_HYPERLINKS</a></li>
<li><a href="config.html#cfg_rtf_output">RTF_OUTPUT</a></li>
<li><a href="config.html#cfg_rtf_stylesheet_file">RTF_STYLESHEET_FILE</a></li>
<li><a href="config.html#cfg_search_includes">SEARCH_INCLUDES</a></li>
<li><a href="config.html#cfg_searchengine">SEARCHENGINE</a></li>
<li><a href="config.html#cfg_separate_member_pages">SEPARATE_MEMBER_PAGES</a></li>
<li><a href="config.html#cfg_server_based_search">SERVER_BASED_SEARCH</a></li>
<li><a href="config.html#cfg_short_names">SHORT_NAMES</a></li>
<li><a href="config.html#cfg_show_files">SHOW_FILES</a></li>
<li><a href="config.html#cfg_show_include_files">SHOW_INCLUDE_FILES</a></li>
<li><a href="config.html#cfg_show_namespaces">SHOW_NAMESPACES</a></li>
<li><a href="config.html#cfg_show_used_files">SHOW_USED_FILES</a></li>
<li><a href="config.html#cfg_sip_support">SIP_SUPPORT</a></li>
<li><a href="config.html#cfg_skip_function_macros">SKIP_FUNCTION_MACROS</a></li>
<li><a href="config.html#cfg_sort_brief_docs">SORT_BRIEF_DOCS</a></li>
<li><a href="config.html#cfg_sort_by_scope_name">SORT_BY_SCOPE_NAME</a></li>
<li><a href="config.html#cfg_sort_group_names">SORT_GROUP_NAMES</a></li>
<li><a href="config.html#cfg_sort_member_docs">SORT_MEMBER_DOCS</a></li>
<li><a href="config.html#cfg_sort_members_constructors_first">SORT_MEMBERS_CTORS_1ST</a></li>
<li><a href="config.html#cfg_source_browser">SOURCE_BROWSER</a></li>
<li><a href="config.html#cfg_strip_code_comments">STRIP_CODE_COMMENTS</a></li>
<li><a href="config.html#cfg_strip_from_inc_path">STRIP_FROM_INC_PATH</a></li>
<li><a href="config.html#cfg_strip_from_path">STRIP_FROM_PATH</a></li>
<li><a href="config.html#cfg_subgrouping">SUBGROUPING</a></li>
<li><a href="config.html#cfg_symbol_cache_size">SYMBOL_CACHE_SIZE</a></li>
<li><a href="config.html#cfg_tab_size">TAB_SIZE</a></li>
<li><a href="config.html#cfg_tagfiles">TAGFILES</a></li>
<li><a href="config.html#cfg_template_relations">TEMPLATE_RELATIONS</a></li>
<li><a href="config.html#cfg_toc_expand">TOC_EXPAND</a></li>
<li><a href="config.html#cfg_treeview_width">TREEVIEW_WIDTH</a></li>
<li><a href="config.html#cfg_typedef_hides_struct">TYPEDEF_HIDES_STRUCT</a></li>
<li><a href="config.html#cfg_uml_limit_num_fields">UML_LIMIT_NUM_FIELDS</a></li>
<li><a href="config.html#cfg_uml_look">UML_LOOK</a></li>
<li><a href="config.html#cfg_use_htags">USE_HTAGS</a></li>
<li><a href="config.html#cfg_use_mathjax">USE_MATHJAX</a></li>
<li><a href="config.html#cfg_use_pdflatex">USE_PDFLATEX</a></li>
<li><a href="config.html#cfg_verbatim_headers">VERBATIM_HEADERS</a></li>
<li><a href="config.html#cfg_warn_format">WARN_FORMAT</a></li>
<li><a href="config.html#cfg_warn_if_doc_error">WARN_IF_DOC_ERROR</a></li>
<li><a href="config.html#cfg_warn_if_undocumented">WARN_IF_UNDOCUMENTED</a></li>
<li><a href="config.html#cfg_warn_logfile">WARN_LOGFILE</a></li>
<li><a href="config.html#cfg_warn_no_paramdoc">WARN_NO_PARAMDOC</a></li>
<li><a href="config.html#cfg_warnings">WARNINGS</a></li>
<li><a href="config.html#cfg_xml_dtd">XML_DTD</a></li>
<li><a href="config.html#cfg_xml_output">XML_OUTPUT</a></li>
<li><a href="config.html#cfg_xml_programlisting">XML_PROGRAMLISTING</a></li>
<li><a href="config.html#cfg_xml_schema">XML_SCHEMA</a></li>
</ul>
</div>
<h1><a class="anchor" id="config_project"></a>
Project related options</h1>
<p><a class="anchor" id="cfg_doxyfile_encoding"></a></p>
<dl>
<dt><code>DOXYFILE_ENCODING</code> </dt>
<dd><p class="startdd"><a name="DOXYFILE_ENCODING"></a> This tag specifies the encoding used for all characters in the config file that follow. The default is UTF-8 which is also the encoding used for all text before the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. See <a href="http://www.gnu.org/software/libiconv">http://www.gnu.org/software/libiconv</a> for the list of possible encodings.</p>
<p class="enddd"><a class="anchor" id="cfg_project_name"></a></p>
</dd>
<dt><code>PROJECT_NAME</code> </dt>
<dd><p class="startdd"><a name="PROJECT_NAME"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_project_number"></a></p>
</dd>
<dt><code>PROJECT_NUMBER</code> </dt>
<dd><p class="startdd"><a name="PROJECT_NUMBER"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_project_brief"></a></p>
</dd>
<dt><code>PROJECT_BRIEF</code> </dt>
<dd><p class="startdd">Using the <code>PROJECT_BRIEF</code> tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short.</p>
<p class="enddd"><a class="anchor" id="cfg_project_logo"></a></p>
</dd>
<dt><code>PROJECT_LOGO</code> </dt>
<dd><p class="startdd">With the <code>PROJECT_LOGO</code> tag one can specify an logo or icon that is included in the documentation. The maximum height of the logo should not exceed 55 pixels and the maximum width should not exceed 200 pixels. Doxygen will copy the logo to the output directory.</p>
<p class="enddd"><a class="anchor" id="cfg_output_directory"></a></p>
</dd>
<dt><code>OUTPUT_DIRECTORY</code> </dt>
<dd><p class="startdd"><a name="OUTPUT_DIRECTORY"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_create_subdirs"></a></p>
</dd>
<dt><code>CREATE_SUBDIRS</code> </dt>
<dd><p class="startdd"><a name="CREATE_SUBDIRS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_output_language"></a></p>
</dd>
<dt><code>OUTPUT_LANGUAGE</code> </dt>
<dd><p class="startdd"><a name="OUTPUT_LANGUAGE"></a> 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: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, Korean, Lithuanian, Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, and Ukrainian.</p>
<p class="enddd"><a class="anchor" id="cfg_brief_member_desc"></a></p>
</dd>
<dt><code>BRIEF_MEMBER_DESC</code> </dt>
<dd><p class="startdd"><a name="BRIEF_MEMBER_DESC"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_repeat_brief"></a></p>
</dd>
<dt><code>REPEAT_BRIEF</code> </dt>
<dd><p class="startdd"><a name="REPEAT_BRIEF"></a> 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 class="section user"><dt>Note: </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>
<p><a class="anchor" id="cfg_abbreviate_brief"></a></p>
</dd>
<dt><code>ABBREVIATE_BRIEF</code> </dt>
<dd><p class="startdd"><a name="ABBREVIATE_BRIEF"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_always_detailed_sec"></a></p>
</dd>
<dt><code>ALWAYS_DETAILED_SEC</code> </dt>
<dd><p class="startdd"><a name="ALWAYS_DETAILED_SEC"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_inline_inherited_memb"></a></p>
</dd>
<dt><code>INLINE_INHERITED_MEMB</code> </dt>
<dd><p class="startdd"><a name="INLINE_INHERITED_MEMB"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_full_path_names"></a></p>
</dd>
<dt><code>FULL_PATH_NAMES</code> </dt>
<dd><p class="startdd"><a name="FULL_PATH_NAMES"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_strip_from_path"></a></p>
</dd>
<dt><code>STRIP_FROM_PATH</code> </dt>
<dd><p class="startdd"><a name="STRIP_FROM_PATH"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_strip_from_inc_path"></a></p>
</dd>
<dt><code>STRIP_FROM_INC_PATH</code> </dt>
<dd><p class="startdd"><a name="STRIP_FROM_INC_PATH"></a> 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.</p>
<p class="enddd"><a class="anchor" id="cfg_short_names"></a></p>
</dd>
<dt><code>SHORT_NAMES</code> </dt>
<dd><p class="startdd"><a name="SHORT_NAMES"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_javadoc_autobrief"></a></p>
</dd>
<dt><code>JAVADOC_AUTOBRIEF</code> </dt>
<dd><p class="startdd"><a name="JAVADOC_AUTOBRIEF"></a> 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 regular Qt-style comments (thus requiring an explicit @brief command for a brief description.)</p>
<p class="enddd"><a class="anchor" id="cfg_qt_autobrief"></a></p>
</dd>
<dt><code>QT_AUTOBRIEF</code> </dt>
<dd><p class="startdd"><a name="QT_AUTOBRIEF"></a> If the <code>QT_AUTOBRIEF</code> is set to <code>YES</code> then doxygen will interpret the first line (until the first dot) of a Qt-style comment as the brief description. If set to NO (the default), the Qt-style will behave just like regular Qt-style comments (thus requiring an explicit \brief command for a brief description.)</p>
<p class="enddd"><a class="anchor" id="cfg_markdown_support"></a></p>
</dd>
<dt><code>MARKDOWN_SUPPORT</code> </dt>
<dd><p class="startdd"><a name="MARKDOWN_SUPPORT"></a> If <code>MARKDOWN_SUPPORT</code> is enabled (the default) then doxygen pre-processes all comments according to the Markdown format, which allows for more readable documentation. See <a href="http://daringfireball.net/projects/markdown/">http://daringfireball.net/projects/markdown/</a> for details. The output of markdown processing is further processed by doxygen, so you can mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in case of backward compatibilities issues.</p>
<p class="enddd"><a class="anchor" id="cfg_builtin_stl_support"></a></p>
</dd>
<dt><code>BUILTIN_STL_SUPPORT</code> </dt>
<dd><p class="startdd"><a name="BUILTIN_STL_SUPPORT"></a> If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to include (a tag file for) the STL sources as input, then you should set this tag to <code>YES</code> in order to let doxygen match functions declarations and definitions whose arguments contain STL classes (e.g. func(std::string); versus func(std::string) {}). This also make the inheritance and collaboration diagrams that involve STL classes more complete and accurate.</p>
<p class="enddd"><a class="anchor" id="cfg_cpp_cli_support"></a></p>
</dd>
<dt><code>CPP_CLI_SUPPORT</code> </dt>
<dd><p class="startdd"><a name="CPP_CLI_SUPPORT"></a> If you use Microsoft's C++/CLI language, you should set this option to YES to enable parsing support.</p>
<p class="enddd"><a class="anchor" id="cfg_sip_support"></a></p>
</dd>
<dt><code>SIP_SUPPORT</code> </dt>
<dd><p class="startdd"><a name="OPTIMIZE_OUTPUT_SIP"></a> Set the SIP_SUPPORT tag to YES if your project consists of <a href="http://www.riverbankcomputing.co.uk/sip/">sip</a> sources only. 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.</p>
<p class="enddd"><a class="anchor" id="cfg_idl_property_support"></a></p>
</dd>
<dt><code>IDL_PROPERTY_SUPPORT</code> </dt>
<dd><p class="startdd"><a name="IDL_PROPERTY_SUPPORT"></a> For Microsoft's IDL there are propget and propput attributes to indicate getter and setter methods for a property. Setting this option to <code>YES</code> (the default) will make doxygen to replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to <code>NO</code>.</p>
<p class="enddd"><a class="anchor" id="cfg_distribute_group_doc"></a></p>
</dd>
<dt><code>DISTRIBUTE_GROUP_DOC</code> </dt>
<dd><p class="startdd"><a name="DISTRIBUTE_GROUP_DOC"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_multiline_cpp_is_brief"></a></p>
</dd>
<dt><code>MULTILINE_CPP_IS_BRIEF</code> </dt>
<dd><p class="startdd"><a name="MULTILINE_CPP_IS_BRIEF"></a> 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 behavior. 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 behavior instead. Note that setting this tag to YES also means that rational rose comments are not recognized any more.</p>
<p class="enddd"><a class="anchor" id="cfg_inherit_docs"></a></p>
</dd>
<dt><code>INHERIT_DOCS</code> </dt>
<dd><p class="startdd"><a name="INHERIT_DOCS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_separate_member_pages"></a></p>
</dd>
<dt><code>SEPARATE_MEMBER_PAGES</code> </dt>
<dd><p class="startdd"><a name="SEPARATE_MEMBER_PAGES"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_tab_size"></a></p>
</dd>
<dt><code>TAB_SIZE</code> </dt>
<dd><p class="startdd"><a name="TAB_SIZE"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_aliases"></a></p>
</dd>
<dt><code>ALIASES</code> </dt>
<dd><p class="startdd"><a name="ALIASES"></a> This tag can be used to specify a number of aliases that acts as commands in the documentation. An alias has the form </p>
<pre class="fragment"> name=value
</pre><p> For example adding </p>
<pre class="fragment"> "sideeffect=\par Side Effects:\n" 
</pre><p> 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>
<p class="enddd"><a class="anchor" id="cfg_optimize_output_for_c"></a></p>
</dd>
<dt><code>OPTIMIZE_OUTPUT_FOR_C</code> </dt>
<dd><p class="startdd"><a name="OPTIMIZE_OUTPUT_FOR_C"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_optimize_output_java"></a></p>
</dd>
<dt><code>OPTIMIZE_OUTPUT_JAVA</code> </dt>
<dd><p class="startdd"><a name="OPTIMIZE_OUTPUT_JAVA"></a> Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or Python sources only. Doxygen will then generate output that is more tailored for that language. For instance, namespaces will be presented as packages, qualified scopes will look different, etc.</p>
<p class="enddd"><a class="anchor" id="cfg_optimize_for_fortran"></a></p>
</dd>
<dt><code>OPTIMIZE_FOR_FORTRAN</code> </dt>
<dd><p class="startdd"><a name="OPTIMIZE_FOR_FORTRAN"></a> Set the <code>OPTIMIZE_FOR_FORTRAN</code> tag to <code>YES</code> if your project consists of Fortran sources. Doxygen will then generate output that is tailored for Fortran.</p>
<p class="enddd"><a class="anchor" id="cfg_optimize_output_vhdl"></a></p>
</dd>
<dt><code>OPTIMIZE_OUTPUT_VHDL</code> </dt>
<dd><p class="startdd"><a name="OPTIMIZE_OUTPUT_VHDL"></a> Set the <code>OPTIMIZE_OUTPUT_VHDL</code> tag to <code>YES</code> if your project consists of VHDL sources. Doxygen will then generate output that is tailored for VHDL.</p>
<p class="enddd"><a class="anchor" id="cfg_extension_mapping"></a></p>
</dd>
<dt><code>EXTENSION_MAPPING</code> </dt>
<dd><p class="startdd"><a name="EXTENSION_MAPPING"></a> Doxygen selects the parser to use depending on the extension of the files it parses. With this tag you can assign which parser to use for a given extension. Doxygen has a built-in mapping, but you can override or extend it using this tag. The format is ext=language, where ext is a file extension, and language is one of the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make doxygen treat .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C</p>
<p class="enddd"><a class="anchor" id="cfg_subgrouping"></a></p>
</dd>
<dt><code>SUBGROUPING</code> </dt>
<dd><p class="startdd"><a name="SUBGROUPING"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_inline_grouped_classes"></a></p>
</dd>
<dt><code>INLINE_GROUPED_CLASSES</code> </dt>
<dd><p class="startdd"><a name="INLINE_GROUPED_CLASSES"></a> When the <code>INLINE_GROUPED_CLASSES</code> tag is set to <code>YES</code>, classes, structs and unions are shown inside the group in which they are included (e.g. using @ingroup) instead of on a separate page (for HTML and Man pages) or section (for LaTeX and RTF). Note that this feature does not work in combination with <a class="el" href="config.html#cfg_separate_member_pages">SEPARATE_MEMBER_PAGES</a>.</p>
<p class="enddd"><a class="anchor" id="cfg_typedef_hides_struct"></a> </p>
</dd>
<dt><code>TYPEDEF_HIDES_STRUCT</code> </dt>
<dd><p class="startdd"><a name="TYPEDEF_HIDES_STRUCT"></a> When <code>TYPEDEF_HIDES_STRUCT</code> is enabled, a typedef of a struct, union, or enum is documented as struct, union, or enum with the name of the typedef. So <code>typedef struct TypeS {} TypeT</code>, will appear in the documentation as a struct with name <code>TypeT</code>. When disabled the typedef will appear as a member of a file, namespace, or class. And the struct will be named <code>TypeS</code>. This can typically 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.</p>
<p class="enddd"><a class="anchor" id="cfg_symbol_cache_size"></a></p>
</dd>
<dt><code>SYMBOL_CACHE_SIZE</code> </dt>
<dd><p class="startdd"><a name="SYMBOL_CACHE_SIZE"></a> The <code>SYMBOL_CACHE_SIZE</code> determines the size of the internal cache use to determine which symbols to keep in memory and which to flush to disk. When the cache is full, less often used symbols will be written to disk. For small to medium size projects (&lt;1000 input files) the default value is probably good enough. For larger projects a too small cache size can cause doxygen to be busy swapping symbols to and from disk most of the time causing a significant performance penalty. If the system has enough physical memory increasing the cache will improve the performance by keeping more symbols in memory. Note that the value works on a logarithmic scale so increasing the size by one will roughly double the memory usage. The cache size is given by this formula: <img class="formulaInl" alt="$2^{(16+\mbox{SYMBOL\_CACHE\_SIZE})}$" src="form_6.png"/>. The valid range is 0..9, the default is 0, corresponding to a cache size of <img class="formulaInl" alt="$2^{16} = 65536$" src="form_7.png"/> symbols.</p>
<p class="enddd"><a class="anchor" id="cfg_lookup_cache_size"></a></p>
</dd>
<dt><code>LOOKUP_CACHE_SIZE</code> </dt>
<dd><p class="startdd"><a name="LOOKUP_CACHE_SIZE"></a> Similar to the <code>SYMBOL_CACHE_SIZE</code> the size of the symbol lookup cache can be set using <code>LOOKUP_CACHE_SIZE</code>. This cache is used to resolve symbols given their name and scope. Since this can be an expensive process and often the same symbol appear multiple times in the code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small doxygen will become slower. If the cache is too large, memory is wasted. The cache size is given by this formula: <img class="formulaInl" alt="$2^{(16+\mbox{LOOKUP\_CACHE\_SIZE})}$" src="form_8.png"/>. The valid range is 0..9, the default is 0, corresponding to a cache size of <img class="formulaInl" alt="$2^{16} = 65536$" src="form_7.png"/> symbols.</p>
<p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="config_build"></a>
Build related options</h1>
<p><a class="anchor" id="cfg_extract_all"></a></p>
<dl>
<dt><code>EXTRACT_ALL</code> </dt>
<dd><p class="startdd"><a name="EXTRACT_ALL"></a> 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 class="section user"><dt>Note: </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>
<p><a class="anchor" id="cfg_extract_private"></a></p>
</dd>
<dt><code>EXTRACT_PRIVATE</code> </dt>
<dd><p class="startdd"><a name="EXTRACT_PRIVATE"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_extract_static"></a></p>
</dd>
<dt><code>EXTRACT_STATIC</code> </dt>
<dd><p class="startdd"><a name="EXTRACT_STATIC"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_extract_local_classes"></a></p>
</dd>
<dt><code>EXTRACT_LOCAL_CLASSES</code> </dt>
<dd><p class="startdd"><a name="EXTRACT_LOCAL_CLASSES"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_extract_anon_nspaces"></a></p>
</dd>
<dt><code>EXTRACT_ANON_NSPACES</code> </dt>
<dd><p class="startdd"><a name="EXTRACT_ANON_NSPACES"></a> If this flag is set to YES, the members of anonymous namespaces will be extracted and appear in the documentation as a namespace called 'anonymous_namespace{file}', where file will be replaced with the base name of the file that contains the anonymous namespace. By default anonymous namespace are hidden.</p>
<p class="enddd"><a class="anchor" id="cfg_extract_local_methods"></a></p>
</dd>
<dt><code>EXTRACT_LOCAL_METHODS</code> </dt>
<dd><p class="startdd"><a name="EXTRACT_LOCAL_METHODS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_hide_undoc_members"></a></p>
</dd>
<dt><code>HIDE_UNDOC_MEMBERS</code> </dt>
<dd><p class="startdd"><a name="HIDE_UNDOC_MEMBERS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_hide_undoc_classes"></a></p>
</dd>
<dt><code>HIDE_UNDOC_CLASSES</code> </dt>
<dd><p class="startdd"><a name="HIDE_UNDOC_CLASSES"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_hide_friend_compounds"></a></p>
</dd>
<dt><code>HIDE_FRIEND_COMPOUNDS</code> </dt>
<dd><p class="startdd"><a name="HIDE_FRIEND_COMPOUNDS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_hide_in_body_docs"></a></p>
</dd>
<dt><code>HIDE_IN_BODY_DOCS</code> </dt>
<dd><p class="startdd"><a name="HIDE_IN_BODY_DOCS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_internal_docs"></a></p>
</dd>
<dt><code>INTERNAL_DOCS</code> </dt>
<dd><p class="startdd"><a name="INTERNAL_DOCS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_case_sense_names"></a></p>
</dd>
<dt><code>CASE_SENSE_NAMES</code> </dt>
<dd><p class="startdd"><a name="CASE_SENSE_NAMES"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_hide_scope_names"></a></p>
</dd>
<dt><code>HIDE_SCOPE_NAMES</code> </dt>
<dd><p class="startdd"><a name="HIDE_SCOPE_NAMES"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_show_include_files"></a></p>
</dd>
<dt><code>SHOW_INCLUDE_FILES</code> </dt>
<dd><p class="startdd"><a name="SHOW_INCLUDE_FILES"></a> If the SHOW_INCLUDE_FILES tag is set to <code>YES</code> (the default) then doxygen will put a list of the files that are included by a file in the documentation of that file.</p>
<p class="enddd"><a class="anchor" id="cfg_force_local_includes"></a></p>
</dd>
<dt><code>FORCE_LOCAL_INCLUDES</code> </dt>
<dd><p class="startdd"><a name="FORCE_LOCAL_INCLUDES"></a> If the <code>FORCE_LOCAL_INCLUDES</code> tag is set to <code>YES</code> then Doxygen will list include files with double quotes in the documentation rather than with sharp brackets.</p>
<p class="enddd"><a class="anchor" id="cfg_inline_info"></a></p>
</dd>
<dt><code>INLINE_INFO</code> </dt>
<dd><p class="startdd"><a name="INLINE_INFO"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_sort_member_docs"></a></p>
</dd>
<dt><code>SORT_MEMBER_DOCS</code> </dt>
<dd><p class="startdd"><a name="SORT_MEMBER_DOCS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_sort_brief_docs"></a></p>
</dd>
<dt><code>SORT_BRIEF_DOCS</code> </dt>
<dd><p class="startdd"><a name="SORT_BRIEF_DOCS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_sort_group_names"></a></p>
</dd>
<dt><code>SORT_GROUP_NAMES</code> </dt>
<dd><p class="startdd"><a name="SORT_GROUP_NAMES"></a> If the <code>SORT_GROUP_NAMES</code> tag is set to <code>YES</code> then doxygen will sort the hierarchy of group names into alphabetical order. If set to <code>NO</code> (the default) the group names will appear in their defined order.</p>
<p class="enddd"><a class="anchor" id="cfg_sort_by_scope_name"></a></p>
</dd>
<dt><code>SORT_BY_SCOPE_NAME</code> </dt>
<dd><a name="SORT_BY_SCOPE_NAME"></a> If the <code>SORT_BY_SCOPE_NAME</code> tag is set to <code>YES</code>, the class list will be sorted by fully-qualified names, including namespaces. If set to NO (the default), the class list will be sorted only by class name, not including the namespace part. <dl class="section note"><dt>Note:</dt><dd>This option is not very useful if <code>HIDE_SCOPE_NAMES</code> is set to <code>YES</code>. </dd>
<dd>
This option applies only to the class list, not to the alphabetical list.</dd></dl>
<a class="anchor" id="cfg_sort_members_constructors_first"></a></dd>
<dt><code>SORT_MEMBERS_CTORS_1ST</code> </dt>
<dd><a name="SORT_MEMBERS_CTORS_1ST"></a> If the <code>SORT_MEMBERS_CTORS_1ST</code> tag is set to <code>YES</code> then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by <code>SORT_MEMBER_DOCS</code> and <code>SORT_BRIEF_DOCS</code>. <dl class="section note"><dt>Note:</dt><dd>If <code>SORT_BRIEF_DOCS</code> is set to <code>NO</code> this option is ignored for sorting brief member documentation. </dd>
<dd>
If <code>SORT_MEMBER_DOCS</code> is set to <code>NO</code> this option is ignored for sorting detailed member documentation.</dd></dl>
<a class="anchor" id="cfg_generate_deprecatedlist"></a></dd>
<dt><code>GENERATE_DEPRECATEDLIST</code> </dt>
<dd><p class="startdd"><a name="GENERATE_DEPRECATEDLIST"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_strict_proto_matching"></a></p>
</dd>
<dt><code>STRICT_PROTO_MATCHING</code> </dt>
<dd><p class="startdd"><a name="STRICT_PROTO_MATCHING"></a> If the <code>STRICT_PROTO_MATCHING</code> option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling <code>STRICT_PROTO_MATCHING</code> doxygen will still accept a match between prototype and implementation in such cases.</p>
<p class="enddd"><a class="anchor" id="cfg_generate_todolist"></a></p>
</dd>
<dt><code>GENERATE_TODOLIST</code> </dt>
<dd><p class="startdd"><a name="GENERATE_TODOLIST"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_generate_testlist"></a></p>
</dd>
<dt><code>GENERATE_TESTLIST</code> </dt>
<dd><p class="startdd"><a name="GENERATE_TESTLIST"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_generate_buglist"></a></p>
</dd>
<dt><code>GENERATE_BUGLIST</code> </dt>
<dd><p class="startdd"><a name="GENERATE_BUGLIST"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_enabled_sections"></a></p>
</dd>
<dt><code>ENABLED_SECTIONS</code> </dt>
<dd><p class="startdd"><a name="ENABLED_SECTIONS"></a> 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> &lt;section-label&gt; ... <a class="el" href="commands.html#cmdendif">\endif</a> and <a class="el" href="commands.html#cmdcond">\cond</a> &lt;section-label&gt; ... <a class="el" href="commands.html#cmdendcond">\endcond</a> blocks.</p>
<p class="enddd"><a class="anchor" id="cfg_max_initializer_lines"></a></p>
</dd>
<dt><code>MAX_INITIALIZER_LINES</code> </dt>
<dd><p class="startdd"><a name="MAX_INITIALIZER_LINES"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_show_used_files"></a></p>
</dd>
<dt><code>SHOW_USED_FILES</code> </dt>
<dd><p class="startdd"><a name="SHOW_USED_FILES"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_show_files"></a></p>
</dd>
<dt><code>SHOW_FILES</code> </dt>
<dd><p class="startdd"><a name="SHOW_FILES"></a> Set the <code>SHOW_FILES</code> tag to <code>NO</code> 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 <code>YES</code>.</p>
<p class="enddd"><a class="anchor" id="cfg_show_namespaces"></a></p>
</dd>
<dt><code>SHOW_NAMESPACES</code> </dt>
<dd><p class="startdd"><a name="SHOW_NAMESPACES"></a> Set the <code>SHOW_NAMESPACES</code> tag to <code>NO</code> 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 <code>YES</code>.</p>
<p class="enddd"><a class="anchor" id="cfg_file_version_filter"></a></p>
</dd>
<dt><code>FILE_VERSION_FILTER</code> </dt>
<dd><p class="startdd"><a name="FILE_VERSION_FILTER"></a> 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 program writes to standard output is used as the file version.</p>
<p>Example of using a shell script as a filter for Unix: </p>
<pre class="fragment"> FILE_VERSION_FILTER = "/bin/sh versionfilter.sh"
</pre><p>Example shell script for CVS: </p>
<pre class="fragment">#!/bin/sh
cvs status $1 | sed -n 's/^[ \]*Working revision:[ \t]*\([0-9][0-9\.]*\).*/\1/p'
</pre><p>Example shell script for Subversion: </p>
<pre class="fragment">#!/bin/sh
svn stat -v $1 | sed -n 's/^[ A-Z?\*|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ .*//p'
</pre><p>Example filter for ClearCase: </p>
<pre class="fragment">FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
</pre><p class="enddd"><a class="anchor" id="cfg_layout_file"></a></p>
</dd>
<dt><code>LAYOUT_FILE</code> </dt>
<dd><p class="startdd">The <code>LAYOUT_FILE</code> tag can be used to specify a layout file which will be parsed by doxygen. The layout file controls the global structure of the generated output files in an output format independent way. To create the layout file that represents doxygen's defaults, run doxygen with the -l option. You can optionally specify a file name after the option, if omitted DoxygenLayout.xml will be used as the name of the layout file. Note that if you run doxygen from a directory containing a file called DoxygenLayout.xml, doxygen will parse it automatically even if the <code>LAYOUT_FILE</code> tag is left empty.</p>
<p class="enddd"><a class="anchor" id="cfg_cite_bib_files"></a></p>
</dd>
<dt><code>CITE_BIB_FILES</code> </dt>
<dd><p class="startdd"><a name="CITE_BIB_FILES"></a> The <code>CITE_BIB_FILES</code> tag can be used to specify one or more bib files containing the reference definitions. This must be a list of .bib files. The .bib extension is automatically appended if omitted. This requires the bibtex tool to be installed. See also <a href="http://en.wikipedia.org/wiki/BibTeX">http://en.wikipedia.org/wiki/BibTeX</a> for more info. For LaTeX the style of the bibliography can be controlled using <a class="el" href="config.html#cfg_latex_bib_style">LATEX_BIB_STYLE</a>. See also <a class="el" href="commands.html#cmdcite">\cite</a> for info how to create references.</p>
<p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="messages_input"></a>
Options related to warning and progress messages</h1>
<p><a class="anchor" id="cfg_quiet"></a></p>
<dl>
<dt><code>QUIET</code> </dt>
<dd><p class="startdd"><a name="QUIET"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_warnings"></a></p>
</dd>
<dt><code>WARNINGS</code> </dt>
<dd><p class="startdd"><a name="WARNINGS"></a> 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>
<p><b>Tip:</b> Turn warnings on while writing the documentation.</p>
<p class="enddd"><a class="anchor" id="cfg_warn_if_undocumented"></a></p>
</dd>
<dt><code>WARN_IF_UNDOCUMENTED</code> </dt>
<dd><p class="startdd"><a name="WARN_IF_UNDOCUMENTED"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_warn_if_doc_error"></a></p>
</dd>
<dt><code>WARN_IF_DOC_ERROR</code> </dt>
<dd><p class="startdd"><a name="WARN_IF_DOC_ERROR"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_warn_no_paramdoc"></a></p>
</dd>
<dt><code>WARN_NO_PARAMDOC</code> </dt>
<dd><p class="startdd"><a name="WARN_NO_PARAMDOC"></a> This <code>WARN_NO_PARAMDOC</code> option can be enabled 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.</p>
<p class="enddd"><a class="anchor" id="cfg_warn_format"></a></p>
</dd>
<dt><code>WARN_FORMAT</code> </dt>
<dd><p class="startdd"><a name="WARN_FORMAT"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_warn_logfile"></a></p>
</dd>
<dt><code>WARN_LOGFILE</code> </dt>
<dd><p class="startdd"><a name="WARN_LOGFILE"></a> 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>
<p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="config_input"></a>
Input related options</h1>
<p><a class="anchor" id="cfg_input"></a></p>
<dl>
<dt><code>INPUT</code> </dt>
<dd><p class="startdd"><a name="INPUT"></a> 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>
<p><b>Note:</b> If this tag is empty the current directory is searched.</p>
<p class="enddd"><a class="anchor" id="cfg_input_encoding"></a></p>
</dd>
<dt><code>INPUT_ENCODING</code> </dt>
<dd><p class="startdd"><a name="INPUT_ENCODING"></a> This tag can be used to specify the character encoding of the source files that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default input encoding. 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.</p>
<p class="enddd"><a class="anchor" id="cfg_file_patterns"></a></p>
</dd>
<dt><code>FILE_PATTERNS</code> </dt>
<dd><p class="startdd"><a name="FILE_PATTERNS"></a> 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++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh .hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.markdown *.md .mm *.dox *.py *.f90 *.f *.vhd *.vhdl </code></p>
<p class="enddd"><a class="anchor" id="cfg_recursive"></a></p>
</dd>
<dt><code>RECURSIVE</code> </dt>
<dd><p class="startdd"><a name="RECURSIVE"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_exclude"></a></p>
</dd>
<dt><code>EXCLUDE</code> </dt>
<dd><p class="startdd"><a name="EXCLUDE"></a> The <code>EXCLUDE</code> tag can be used to specify files and/or directories that should be 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. Note that relative paths are relative to the directory from which doxygen is run.</p>
<p class="enddd"><a class="anchor" id="cfg_exclude_symlinks"></a></p>
</dd>
<dt><code>EXCLUDE_SYMLINKS</code> </dt>
<dd><p class="startdd"><a name="EXCLUDE_SYMLINKS"></a> The <code>EXCLUDE_SYMLINKS</code> 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.</p>
<p class="enddd"><a class="anchor" id="cfg_exclude_patterns"></a></p>
</dd>
<dt><code>EXCLUDE_PATTERNS</code> </dt>
<dd><p class="startdd"><a name="EXCLUDE_PATTERNS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_exclude_symbols"></a></p>
</dd>
<dt><code>EXCLUDE_SYMBOLS</code> </dt>
<dd><p class="startdd">The <code>EXCLUDE_SYMBOLS</code> tag can be used to specify one or more symbol names (namespaces, classes, functions, etc.) that should be excluded from the output. The symbol name can be a fully qualified name, a word, or if the wildcard * is used, a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test</p>
<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>
<p class="enddd"><a class="anchor" id="cfg_example_path"></a></p>
</dd>
<dt><code>EXAMPLE_PATH</code> </dt>
<dd><p class="startdd"><a name="EXAMPLE_PATH"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_example_recursive"></a></p>
</dd>
<dt><code>EXAMPLE_RECURSIVE</code> </dt>
<dd><p class="startdd"><a name="EXAMPLE_RECURSIVE"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_example_patterns"></a></p>
</dd>
<dt><code>EXAMPLE_PATTERNS</code> </dt>
<dd><p class="startdd"><a name="EXAMPLE_PATTERNS"></a> 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 <code>*.cpp</code> and <code>*.h</code>) to filter out the source-files in the directories. If left blank all files are included.</p>
<p class="enddd"><a class="anchor" id="cfg_image_path"></a></p>
</dd>
<dt><code>IMAGE_PATH</code> </dt>
<dd><p class="startdd"><a name="IMAGE_PATH"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_input_filter"></a></p>
</dd>
<dt><code>INPUT_FILTER</code> </dt>
<dd><p class="startdd"><a name="INPUT_FILTER"></a> 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: </p>
<pre class="fragment">&lt;filter&gt; &lt;input-file&gt;
</pre><p>where &lt;filter&gt; is the value of the <code>INPUT_FILTER</code> tag, and &lt;input-file&gt; is the name of an input file. Doxygen will then use the output that the filter program writes to standard output.</p>
<p class="enddd"><a class="anchor" id="cfg_filter_patterns"></a></p>
</dd>
<dt><code>FILTER_PATTERNS</code> </dt>
<dd><p class="startdd"><a name="FILTER_PATTERNS"></a> 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 or if none of the patterns match the file name, <code>INPUT_FILTER</code> is applied.</p>
<p class="enddd"><a class="anchor" id="cfg_filter_source_files"></a></p>
</dd>
<dt><code>FILTER_SOURCE_FILES</code> </dt>
<dd><p class="startdd"><a name="FILTER_SOURCE_FILES"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_filter_source_patterns"></a></p>
</dd>
<dt><code>FILTER_SOURCE_PATTERNS</code> </dt>
<dd><p class="startdd"><a name="FILTER_SOURCE_PATTERNS"></a> The <code>FILTER_SOURCE_PATTERNS</code> tag can be used to specify source filters per file pattern. A pattern will override the setting for <code>FILTER_PATTERN</code> (if any) and it is also possible to disable source filtering for a specific pattern using <code>*.ext=</code> (so without naming a filter). This option only has effect when <code>FILTER_SOURCE_FILES</code> is enabled.</p>
<p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="sourcebrowser_index"></a>
Source browsing related options</h1>
<p><a class="anchor" id="cfg_source_browser"></a></p>
<dl>
<dt><code>SOURCE_BROWSER</code> </dt>
<dd><p class="startdd"><a name="SOURCE_BROWSER"></a> 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. Note: To get rid of all source code in the generated output, make sure also <code>VERBATIM_HEADERS</code> is set to NO.</p>
<p class="enddd"><a class="anchor" id="cfg_inline_sources"></a></p>
</dd>
<dt><code>INLINE_SOURCES</code> </dt>
<dd><p class="startdd"><a name="INLINE_SOURCES"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_strip_code_comments"></a></p>
</dd>
<dt><code>STRIP_CODE_COMMENTS</code> </dt>
<dd><p class="startdd"><a name="STRIP_CODE_COMMENTS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_referenced_by_relation"></a></p>
</dd>
<dt><code>REFERENCED_BY_RELATION</code> </dt>
<dd><p class="startdd"><a name="REFERENCED_BY_RELATION"></a> If the <code>REFERENCED_BY_RELATION</code> tag is set to <code>YES</code> then for each documented function all documented functions referencing it will be listed.</p>
<p class="enddd"><a class="anchor" id="cfg_references_relation"></a></p>
</dd>
<dt><code>REFERENCES_RELATION</code> </dt>
<dd><p class="startdd"><a name="REFERENCES_RELATION"></a> If the <code>REFERENCES_RELATION</code> tag is set to <code>YES</code> then for each documented function all documented entities called/used by that function will be listed.</p>
<p class="enddd"><a class="anchor" id="cfg_references_link_source"></a></p>
</dd>
<dt><code>REFERENCES_LINK_SOURCE</code> </dt>
<dd><p class="startdd"><a name="REFERENCES_LINK_SOURCE"></a> If the <code>REFERENCES_LINK_SOURCE</code> tag is set to <code>YES</code> (the default) and SOURCE_BROWSER tag is set to <code>YES</code>, then the hyperlinks from functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will link to the documentation.</p>
<p class="enddd"><a class="anchor" id="cfg_verbatim_headers"></a></p>
</dd>
<dt><code>VERBATIM_HEADERS</code> </dt>
<dd><a name="VERBATIM_HEADERS"></a> 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 class="section see"><dt>See also:</dt><dd>Section <a class="el" href="commands.html#cmdclass">\class</a>.</dd></dl>
<a class="anchor" id="cfg_use_htags"></a></dd>
<dt><code>USE_HTAGS</code> </dt>
<dd><p class="startdd"><a name="USE_HTAGS"></a> 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>). To 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>
<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>
<p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="alphabetical_index"></a>
Alphabetical index options</h1>
<p><a class="anchor" id="cfg_alphabetical_index"></a></p>
<dl>
<dt><code>ALPHABETICAL_INDEX</code> </dt>
<dd><p class="startdd"><a name="ALPHABETICAL_INDEX"></a> 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>
<p class="enddd"></p>
</dd>
<dt><code>COLS_IN_ALPHA_INDEX</code> </dt>
<dd><p class="startdd"><a class="anchor" id="cfg_cols_in_alpha_index"></a> <a name="COLS_IN_ALPHA_INDEX"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_ignore_prefix"></a></p>
</dd>
<dt><code>IGNORE_PREFIX</code> </dt>
<dd><p class="startdd"><a name="IGNORE_PREFIX"></a> 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>
<p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="html_output"></a>
HTML related options</h1>
<p><a class="anchor" id="cfg_generate_html"></a></p>
<dl>
<dt><code>GENERATE_HTML</code> </dt>
<dd><p class="startdd"><a name="GENERATE_HTML"></a> If the <code>GENERATE_HTML</code> tag is set to <code>YES</code> (the default) doxygen will generate HTML output</p>
<p class="enddd"><a class="anchor" id="cfg_html_output"></a></p>
</dd>
<dt><code>HTML_OUTPUT</code> </dt>
<dd><p class="startdd"><a name="HTML_OUTPUT"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_html_file_extension"></a></p>
</dd>
<dt><code>HTML_FILE_EXTENSION</code> </dt>
<dd><p class="startdd"><a name="HTML_FILE_EXTENSION"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_html_header"></a></p>
</dd>
<dt><code>HTML_HEADER</code> </dt>
<dd><p class="startdd"><a name="HTML_HEADER"></a> The <code>HTML_HEADER</code> tag can be used to specify a user-defined HTML header file for each generated HTML page. If the tag is left blank doxygen will generate a standard header.</p>
<p>To get valid HTML the header file that includes any scripts and style sheets that doxygen needs, it is highly recommended to start with a default header using </p>
<pre class="fragment">doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFile
</pre><p> and then modify the file <code>new_header.html</code>.</p>
<p>The following markers have a special meaning inside the header and footer: </p>
<dl>
<dt><code>$title</code></dt>
<dd>will be replaced with the title of the page. </dd>
<dt><code>$datetime</code></dt>
<dd>will be replaced with current the date and time. </dd>
<dt><code>$date</code></dt>
<dd>will be replaced with the current date. </dd>
<dt><code>$year</code></dt>
<dd>will be replaces with the current year. </dd>
<dt><code>$doxygenversion</code></dt>
<dd>will be replaced with the version of doxygen </dd>
<dt><code>$projectname</code></dt>
<dd>will be replaced with the name of the project (see <a class="el" href="config.html#cfg_project_name">PROJECT_NAME</a>) </dd>
<dt><code>$projectnumber</code></dt>
<dd>will be replaced with the project number (see <a class="el" href="config.html#cfg_project_number">PROJECT_NUMBER</a>) </dd>
<dt><code>$projectbrief</code></dt>
<dd>will be replaced with the project brief description (see <a class="el" href="config.html#cfg_project_brief">PROJECT_BRIEF</a>) </dd>
<dt><code>$projectlogo</code></dt>
<dd>will be replaced with the project logo (see <a class="el" href="config.html#cfg_project_logo">PROJECT_LOGO</a>) </dd>
<dt><code>$treeview</code></dt>
<dd>will be replaced with links to the javascript and style sheets needed for the navigation tree (or an empty string when <a class="el" href="config.html#cfg_generate_treeview">GENERATE_TREEVIEW</a> is disabled). </dd>
<dt><code>$search</code></dt>
<dd>will be replaced with a links to the javascript and style sheets needed for the search engine (or an empty string when <a class="el" href="config.html#cfg_searchengine">SEARCHENGINE</a> is disabled). </dd>
<dt><code>$mathjax</code></dt>
<dd>will be replaced with a links to the javascript and style sheets needed for the MathJax feature (or an empty string when <a class="el" href="config.html#cfg_use_mathjax">USE_MATHJAX</a> is disabled). </dd>
<dt><code>$relpath$</code></dt>
<dd>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. </dd>
</dl>
<p>To cope with differences in the layout of the header and footer that depend on configuration settings, the header can also contain special blocks that will be copied to the output or skipped depending on the configuration. Such blocks have the following form: </p>
<pre class="fragment"> &lt;!--BEGIN BLOCKNAME--&gt;
 Some context copied when condition BLOCKNAME holds
 &lt;!--END BLOCKNAME--&gt;
 &lt;!--BEGIN !BLOCKNAME--&gt;
 Some context copied when condition BLOCKNAME does not hold
 &lt;!--END !BLOCKNAME--&gt;
</pre><p> The following block names are supported: </p>
<dl>
<dt><code>DISABLE_INDEX</code></dt>
<dd>Content within this block is copied to the output when the <a class="el" href="config.html#cfg_disable_index">DISABLE_INDEX</a> option is enabled (so when the index is disabled). </dd>
<dt><code>GENERATE_TREEVIEW</code></dt>
<dd>Content within this block is copied to the output when the <a class="el" href="config.html#cfg_generate_treeview">GENERATE_TREEVIEW</a> option is enabled. </dd>
<dt><code>SEARCHENGINE</code></dt>
<dd>Content within this block is copied to the output when the <a class="el" href="config.html#cfg_searchengine">SEARCHENGINE</a> option is enabled. </dd>
<dt><code>PROJECT_NAME</code></dt>
<dd>Content within the block is copied to the output when the <a class="el" href="config.html#cfg_project_name">PROJECT_NAME</a> option is not empty. </dd>
<dt><code>PROJECT_NUMBER</code></dt>
<dd>Content within the block is copied to the output when the <a class="el" href="config.html#cfg_project_number">PROJECT_NUMBER</a> option is not empty. </dd>
<dt><code>PROJECT_BRIEF</code></dt>
<dd>Content within the block is copied to the output when the <a class="el" href="config.html#cfg_project_brief">PROJECT_BRIEF</a> option is not empty. </dd>
<dt><code>PROJECT_LOGO</code></dt>
<dd>Content within the block is copied to the output when the <a class="el" href="config.html#cfg_project_logo">PROJECT_LOGO</a> option is not empty. </dd>
<dt><code>TITLEAREA</code></dt>
<dd>Content within this block is copied to the output when a title is visible at the top of each page. This is the case if either <a class="el" href="config.html#cfg_project_name">PROJECT_NAME</a>, <a class="el" href="config.html#cfg_project_brief">PROJECT_BRIEF</a>, <a class="el" href="config.html#cfg_project_logo">PROJECT_LOGO</a> is filled in or if both <a class="el" href="config.html#cfg_disable_index">DISABLE_INDEX</a> and <a class="el" href="config.html#cfg_searchengine">SEARCHENGINE</a> are enabled. </dd>
</dl>
<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>
<dl class="section note"><dt>Note:</dt><dd>The header is subject to change so you typically have to regenerate the default header when upgrading to a newer version of doxygen.</dd></dl>
<p><a class="anchor" id="cfg_html_footer"></a></p>
</dd>
<dt><code>HTML_FOOTER</code> </dt>
<dd><p class="startdd"><a name="HTML_FOOTER"></a> The <code>HTML_FOOTER</code> tag can be used to specify a user-defined HTML footer for each generated HTML page. If the tag is left blank doxygen will generate a standard footer.</p>
<p>See <a class="el" href="config.html#cfg_html_header">HTML_HEADER</a> for more information on how to generate a default footer and what special commands can be used inside the footer.</p>
<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>
<p class="enddd"><a class="anchor" id="cfg_html_stylesheet"></a></p>
</dd>
<dt><code>HTML_STYLESHEET</code> </dt>
<dd><p class="startdd"><a name="HTML_STYLESHEET"></a> 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>
<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>
<p class="enddd"><a class="anchor" id="cfg_html_extra_files"></a></p>
</dd>
<dt><code>HTML_EXTRA_FILES</code> </dt>
<dd><p class="startdd"><a name="HTML_EXTRA_FILES"></a> The <code>HTML_EXTRA_FILES</code> tag can be used to specify one or more extra images or other source files which should be copied to the HTML output directory. Note that these files will be copied to the base HTML output directory. Use the $relpath$ marker in the <code>HTML_HEADER</code> and/or <code>HTML_FOOTER</code> files to load these files. In the <code>HTML_STYLESHEET</code> file, use the file name only. Also note that the files will be copied as-is; there are no commands or markers available.</p>
<p class="enddd"><a class="anchor" id="cfg_html_colorstyle_hue"></a></p>
</dd>
<dt><code>HTML_COLORSTYLE_HUE</code> </dt>
<dd><p class="startdd"><a name="HTML_COLOR_STYLE_HUE"></a> The <code>HTML_COLORSTYLE_HUE</code> tag controls the color of the HTML output. Doxygen will adjust the colors in the stylesheet and background images according to this color. Hue is specified as an angle on a colorwheel, see <a href="http://en.wikipedia.org/wiki/Hue">http://en.wikipedia.org/wiki/Hue</a> 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.</p>
<p class="enddd"><a class="anchor" id="cfg_html_colorstyle_sat"></a></p>
</dd>
<dt><code>HTML_COLORSTYLE_SAT</code> </dt>
<dd><p class="startdd"><a name="HTML_COLORSTYLE_SAT"></a> The <code>HTML_COLORSTYLE_SAT</code> tag controls the purity (or saturation) of 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.</p>
<p class="enddd"><a class="anchor" id="cfg_html_colorstyle_gamma"></a></p>
</dd>
<dt><code>HTML_COLORSTYLE_GAMMA</code> </dt>
<dd><p class="startdd">The <code>HTML_COLORSTYLE_GAMMA</code> tag controls the gamma correction applied to the luminance component of the colors in the HTML output. Values below 100 gradually make the output lighter, whereas values above 100 make the output darker. The value divided by 100 is the actual gamma applied, so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not change the gamma.</p>
<p class="enddd"><a class="anchor" id="cfg_html_timestamp"></a></p>
</dd>
<dt><code>HTML_TIMESTAMP</code> </dt>
<dd><p class="startdd"><a name="HTML_TIMESTAMP"></a> If the <code>HTML_TIMESTAMP</code> tag is set to <code>YES</code> then the footer of each generated HTML page will contain the date and time when the page was generated. Setting this to NO can help when comparing the output of multiple runs.</p>
<p class="enddd"><a class="anchor" id="cfg_html_align_members"></a></p>
</dd>
<dt><code>HTML_ALIGN_MEMBERS</code> </dt>
<dd><p class="startdd"><a name="HTML_ALIGN_MEMBERS"></a> 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>
<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>
<p class="enddd"><a class="anchor" id="cfg_html_dynamic_sections"></a></p>
</dd>
<dt><code>HTML_DYNAMIC_SECTIONS</code> </dt>
<dd><p class="startdd"><a name="HTML_DYNAMIC_SECTIONS"></a> If the <code>HTML_DYNAMIC_SECTIONS</code> tag is set to <code>YES</code> then the generated HTML documentation will contain sections that can be hidden and shown after the page has loaded.</p>
<p class="enddd"><a class="anchor" id="cfg_html_index_num_entries"></a></p>
</dd>
<dt><code>HTML_NUM_INDEX_ENTRIES</code> </dt>
<dd><p class="startdd"><a name="HTML_NUM_INDEX_ENTRIES"></a> With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries shown in the various tree structured indices initially; the user can expand and collapse entries dynamically later on. Doxygen will expand the tree to such a level that at most the specified number of entries are visible (unless a fully collapsed tree already exceeds this amount). So setting the number of entries 1 will produce a full collapsed tree by default. 0 is a special value representing an infinite number of entries and will result in a full expanded tree by default.</p>
<p class="enddd"><a class="anchor" id="cfg_generate_docset"></a></p>
</dd>
<dt><code>GENERATE_DOCSET</code> </dt>
<dd><p class="startdd"><a name="GENERATE_DOCSET"></a> If the <code>GENERATE_DOCSET</code> tag is set to <code>YES</code>, additional index files will be generated that can be used as input for <a href="http://developer.apple.com/tools/xcode/">Apple's Xcode 3 integrated development environment</a>, introduced with OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a Makefile in the HTML output directory. Running <code>make</code> will produce the docset in that directory and running <code>make install</code> will install the docset in <code>~/Library/Developer/Shared/Documentation/DocSets</code> so that Xcode will find it at startup. See <a href="http://developer.apple.com/tools/creatingdocsetswithdoxygen.html">this article</a> for more information.</p>
<p class="enddd"><a class="anchor" id="cfg_docset_feedname"></a> </p>
</dd>
<dt><code>DOCSET_FEEDNAME</code> </dt>
<dd><p class="startdd"><a name="DOCSET_FEEDNAME"></a> When <code>GENERATE_DOCSET</code> tag is set to <code>YES</code>, this tag determines the name of the 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.</p>
<p class="enddd"><a class="anchor" id="cfg_docset_bundle_id"></a></p>
</dd>
<dt><code>DOCSET_BUNDLE_ID</code> </dt>
<dd><p class="startdd">When <code>GENERATE_DOCSET</code> tag is set to <code>YES</code>, this tag specifies a string that 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.</p>
<p class="enddd"><a class="anchor" id="cfg_docset_publisher_id"></a></p>
</dd>
<dt><code>DOCSET_PUBLISHER_ID</code> </dt>
<dd><p class="startdd">When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify the documentation publisher. This should be a reverse domain-name style string, e.g. com.mycompany.MyDocSet.documentation.</p>
<p class="enddd"><a class="anchor" id="cfg_docset_publisher_name"></a></p>
</dd>
<dt><code>DOCSET_PUBLISHER_NAME</code> </dt>
<dd><p class="startdd">The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.</p>
<p class="enddd"><a class="anchor" id="cfg_generate_htmlhelp"></a></p>
</dd>
<dt><code>GENERATE_HTMLHELP</code> </dt>
<dd><p class="startdd"><a name="GENERATE_HTMLHELP"></a> 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>
<p>The HTML Help Workshop contains a compiler that can convert all HTML output generated by doxygen into a single compiled HTML file (.chm). Compiled 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>
<p class="enddd"><a class="anchor" id="cfg_chm_file"></a> </p>
</dd>
<dt><code>CHM_FILE</code> </dt>
<dd><p class="startdd"><a name="CHM_FILE"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_hhc_location"></a> </p>
</dd>
<dt><code>HHC_LOCATION</code> </dt>
<dd><p class="startdd"><a name="HHC_LOCATION"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_generate_chi"></a></p>
</dd>
<dt><code>GENERATE_CHI</code> </dt>
<dd><p class="startdd"><a name="GENERATE_CHI"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_chm_index_encoding"></a></p>
</dd>
<dt><code>CHM_INDEX_ENCODING</code> </dt>
<dd><p class="startdd"><a name="CHM_INDEX_ENCODING"></a> If the <code>GENERATE_HTMLHELP</code> tag is set to <code>YES</code>, the <code>CHM_INDEX_ENCODING</code> is used to encode HtmlHelp index (hhk), content (hhc) and project file content.</p>
<p class="enddd"><a class="anchor" id="cfg_binary_toc"></a></p>
</dd>
<dt><code>BINARY_TOC</code> </dt>
<dd><p class="startdd"><a name="BINARY_TOC"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_toc_expand"></a></p>
</dd>
<dt><code>TOC_EXPAND</code> </dt>
<dd><p class="startdd"><a name="TOC_EXPAND"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_generate_qhp"></a></p>
</dd>
<dt><code>GENERATE_QHP</code> </dt>
<dd><p class="startdd"><a name="GENERATE_QHP"></a> If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated HTML documentation.</p>
<p class="enddd"><a class="anchor" id="cfg_qch_file"></a></p>
</dd>
<dt><code>QCH_FILE</code> </dt>
<dd><p class="startdd"><a name="QCH_FILE"></a> If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify the file name of the resulting .qch file. The path specified is relative to the HTML output folder.</p>
<p class="enddd"><a class="anchor" id="cfg_qhp_namespace"></a></p>
</dd>
<dt><code>QHP_NAMESPACE</code> </dt>
<dd><p class="startdd"><a name="QHP_NAMESPACE"></a> The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help Project output. For more information please see <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.</p>
<p class="enddd"><a class="anchor" id="cfg_qhp_virtual_folder"></a></p>
</dd>
<dt><code>QHP_VIRTUAL_FOLDER</code> </dt>
<dd><p class="startdd"><a name="QHP_VIRTUAL_FOLDER"></a> The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt Help Project output. For more information please see <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.</p>
<p class="enddd"><a class="anchor" id="cfg_qhp_cust_filter_name"></a></p>
</dd>
<dt><code>QHP_CUST_FILTER_NAME</code> </dt>
<dd><p class="startdd"><a name="QHP_CUST_FILTER_NAME"></a> If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. For more information please see <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.</p>
<p class="enddd"><a class="anchor" id="cfg_qhp_cust_filter_attrs"></a></p>
</dd>
<dt><code>QHP_CUST_FILTER_ATTRS</code> </dt>
<dd><p class="startdd"><a name="QHP_CUST_FILTER_ATTRS"></a> The QHP_CUST_FILTER_ATTRIBUTES tag specifies the list of the attributes of the custom filter to add. For more information please see <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.</p>
<p class="enddd"><a class="anchor" id="cfg_qhp_sect_filter_attrs"></a></p>
</dd>
<dt><code>QHP_SECT_FILTER_ATTRS</code> </dt>
<dd><p class="startdd"><a name="QHP_SECT_FILTER_ATTRS"></a> The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's filter section matches. <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.</p>
<p class="enddd"><a class="anchor" id="cfg_qhg_location"></a></p>
</dd>
<dt><code>QHG_LOCATION</code> </dt>
<dd><p class="startdd"><a name="QHG_LOCATION"></a> If the GENERATE_QHP tag is set to YES, the 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.</p>
<p class="enddd"><a class="anchor" id="cfg_generate_eclipsehelp"></a></p>
</dd>
<dt><code>GENERATE_ECLIPSEHELP</code> </dt>
<dd><p class="startdd"><a name="GENERATE_ECLIPSEHELP"></a> If the <code>GENERATE_ECLIPSEHELP</code> tag is set to <code>YES</code>, additional index files will be generated, which together with the HTML files, form an Eclipse help plugin.</p>
<p>To install this plugin and make it available under the help contents menu in Eclipse, the contents of the directory containing the HTML and XML files needs to be copied into the plugins directory of eclipse. The name of the directory within the plugins directory should be the same as the <a class="el" href="config.html#cfg_eclipse_doc_id">ECLIPSE_DOC_ID</a> value.</p>
<p>After copying Eclipse needs to be restarted before the help appears.</p>
<p class="enddd"><a class="anchor" id="cfg_eclipse_doc_id"></a></p>
</dd>
<dt><code>ECLIPSE_DOC_ID</code> </dt>
<dd><p class="startdd"><a name="ECLIPSE_DOC_ID"></a> 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.</p>
<p class="enddd"><a class="anchor" id="cfg_searchengine"></a></p>
</dd>
<dt><code>SEARCHENGINE</code> </dt>
<dd><p class="startdd"><a name="SEARCHENGINE"></a></p>
<p>When the <code>SEARCHENGINE</code> tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript and DHTML and should work on any modern browser. Note that when using HTML help (<a class="el" href="config.html#cfg_generate_htmlhelp">GENERATE_HTMLHELP</a>), Qt help (<a class="el" href="config.html#cfg_generate_qhp">GENERATE_QHP</a>), or docsets (<a class="el" href="config.html#cfg_generate_docset">GENERATE_DOCSET</a>) there is already a search function so this one should typically be disabled. For large projects the javascript based search engine can be slow, then enabling <a class="el" href="config.html#cfg_server_based_search">SERVER_BASED_SEARCH</a> may provide a better solution.</p>
<p>It is possible to search using the keyboard; to jump to the search box use access key + S (what the access key is depends on the OS and browser, but it is typically CTRL, ALT/option, or both). Inside the search box use the cursor down key to jump into the search results window, the results can be navigated using the cursor keys. Press Enter to select an item or escape to cancel the search. The filter options can be selected when the cursor is inside the search box by pressing Shift+cursor down. Also here use the cursor keys to select a filter and enter or escape to activate or cancel the filter option.</p>
<p class="enddd"><a class="anchor" id="cfg_server_based_search"></a></p>
</dd>
<dt><code>SERVER_BASED_SEARCH</code> </dt>
<dd><p class="startdd"><a name="SERVER_BASED_SEARCH"></a></p>
<p>When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index file to put on the web server. The advantage of the server based approach is that it scales better to large projects and also allows full text search. The disadvantages are that it is more difficult to setup and does not have live searching capabilities.</p>
<p class="enddd"><a class="anchor" id="cfg_disable_index"></a></p>
</dd>
<dt><code>DISABLE_INDEX</code> </dt>
<dd><p class="startdd"><a name="DISABLE_INDEX"></a> 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 <code>YES</code> disables it. Since the tabs have the same information as the navigation tree you can set this option to <code>NO</code> if you already set <a class="el" href="config.html#cfg_generate_treeview">GENERATE_TREEVIEW</a> to <code>YES</code>.</p>
<p class="enddd"><a class="anchor" id="cfg_enum_values_per_line"></a></p>
</dd>
<dt><code>ENUM_VALUES_PER_LINE</code> </dt>
<dd><p class="startdd"><a name="ENUM_VALUES_PER_LINE"></a> This tag can be used to set the number of enum values (range [0,1..20]) that doxygen will group on one line in the generated HTML documentation. Note that a value of 0 will completely suppress the enum values from appearing in the overview section.</p>
<p class="enddd"><a class="anchor" id="cfg_generate_treeview"></a></p>
</dd>
<dt><code>GENERATE_TREEVIEW</code> </dt>
<dd><p class="startdd"><a name="GENERATE_TREEVIEW"></a> The GENERATE_TREEVIEW tag is used to specify whether a tree-like index structure should be generated to display hierarchical information. If the tag value 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, DHTML, CSS and frames is required (i.e. any modern browser). Windows users are probably better off using the HTML help feature.</p>
<p>Via custom stylesheets (see <a class="el" href="config.html#cfg_html_stylesheet">HTML_STYLESHEET</a>) one can further <a class="el" href="doxygen_usage.html#doxygen_finetune">fine-tune</a> the look of the index. As an example, the default style sheet generated by doxygen has an example that shows how to put an image at the root of the tree instead of the <a class="el" href="config.html#cfg_project_name">project name</a>.</p>
<p class="enddd"><a class="anchor" id="cfg_treeview_width"></a></p>
</dd>
<dt><code>TREEVIEW_WIDTH</code> </dt>
<dd><p class="startdd"><a name="TREEVIEW_WIDTH"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_ext_links_in_window"></a></p>
</dd>
<dt><code>EXT_LINKS_IN_WINDOW</code> </dt>
<dd><p class="startdd"><a name="EXT_LINKS_IN_WINDOW"></a> When the <code>EXT_LINKS_IN_WINDOW</code> option is set to <code>YES</code> doxygen will open links to external symbols imported via tag files in a separate window.</p>
<p class="enddd"><a class="anchor" id="cfg_formula_fontsize"></a></p>
</dd>
<dt><code>FORMULA_FONTSIZE</code> </dt>
<dd><p class="startdd"><a name="FORMULA_FONTSIZE"></a> Use this tag to change the font size of Latex formulas included as images in the HTML documentation. The default is 10. when you change the font size after a successful doxygen run you need to manually remove any <code>form_*.png</code> images from the HTML output directory to force them to be regenerated.</p>
<p class="enddd"><a class="anchor" id="cfg_formula_transparent"></a></p>
</dd>
<dt><code>FORMULA_TRANSPARENT</code> </dt>
<dd><p class="startdd"><a name="FORMULA_TRANSPARENT"></a> Use the <code>FORMULA_TRANPARENT</code> tag to determine whether or not the images generated for formulas are transparent PNGs. Transparent PNGs are not supported properly for IE 6.0, but are supported on all modern browsers. Note that when changing this option you need to delete any <code>form_*.png</code> files in the HTML output before the changes have effect.</p>
<p class="enddd"><a class="anchor" id="cfg_use_mathjax"></a></p>
</dd>
<dt><code>USE_MATHJAX</code> </dt>
<dd><p class="startdd"><a name="USE_MATHJAX"></a> Enable the <code>USE_MATHJAX</code> option to render LaTeX formulas using MathJax (see <a href="http://www.mathjax.org">http://www.mathjax.org</a>) which uses client side Javascript for the rendering instead of using prerendered bitmaps. Use this if you do not have LaTeX installed or if you want to formulas look prettier in the HTML output. When enabled you may also need to install MathJax separately and configure the path to it using the <a class="el" href="config.html#cfg_mathjax_relpath">MATHJAX_RELPATH</a> option.</p>
<p class="enddd"><a class="anchor" id="cfg_mathjax_relpath"></a></p>
</dd>
<dt><code>MATHJAX_RELPATH</code> </dt>
<dd><p class="startdd"><a name="MATHJAX_RELPATH"></a> When MathJax is enabled you need to specify the location relative to the HTML output directory using the <code>MATHJAX_RELPATH</code> option. The destination directory should contain the MathJax.js script. For instance, if the mathjax directory is located at the same level as the HTML output directory, then <code>MATHJAX_RELPATH</code> should be <code>../mathjax</code>. The default value points to 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 <a href="http://www.mathjax.org">http://www.mathjax.org</a> before deployment.</p>
<p class="enddd"><a class="anchor" id="cfg_mathjax_extensions"></a></p>
</dd>
<dt><code>MATHJAX_EXTENSIONS</code> </dt>
<dd><p class="startdd"><a name="MATHJAX_EXTENSIONS"></a> The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension names that should be enabled during MathJax rendering. For example </p>
<pre class="fragment">MATHJAX_EXTENSIONS     = TeX/AMSmath TeX/AMSsymbols
</pre><p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="latex_output"></a>
LaTeX related options</h1>
<p><a class="anchor" id="cfg_generate_latex"></a></p>
<dl>
<dt><code>GENERATE_LATEX</code> </dt>
<dd><p class="startdd"><a name="GENERATE_LATEX"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_latex_output"></a></p>
</dd>
<dt><code>LATEX_OUTPUT</code> </dt>
<dd><p class="startdd"><a name="LATEX_OUTPUT"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_latex_cmd_name"></a></p>
</dd>
<dt><code>LATEX_CMD_NAME</code> </dt>
<dd><p class="startdd"><a name="LATEX_CMD_NAME"></a> 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. Note that when enabling USE_PDFLATEX this option is only used for generating bitmaps for formulas in the HTML output, but not in the Makefile that is written to the output directory.</p>
<p class="enddd"><a class="anchor" id="cfg_makeindex_cmd_name"></a></p>
</dd>
<dt><code>MAKEINDEX_CMD_NAME</code> </dt>
<dd><p class="startdd"><a name="MAKEINDEX_CMD_NAME"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_compact_latex"></a></p>
</dd>
<dt><code>COMPACT_LATEX</code> </dt>
<dd><p class="startdd"><a name="COMPACT_LATEX"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_paper_type"></a></p>
</dd>
<dt><code>PAPER_TYPE</code> </dt>
<dd><p class="startdd"><a name="PAPER_TYPE"></a> The <code>PAPER_TYPE</code> tag can be used to set the paper type that is used by the printer. Possible values are: </p>
<ul>
<li>
<code>a4</code> (210 x 297 mm). </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>
<p>If left blank a4 will be used.</p>
<p class="enddd"><a class="anchor" id="cfg_extra_packages"></a></p>
</dd>
<dt><code>EXTRA_PACKAGES</code> </dt>
<dd><p class="startdd"><a name="EXTRA_PACKAGES"></a> 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 </p>
<pre class="fragment">EXTRA_PACKAGES = times
</pre><p> If left blank no extra packages will be included.</p>
<p class="enddd"><a class="anchor" id="cfg_latex_header"></a></p>
</dd>
<dt><code>LATEX_HEADER</code> </dt>
<dd><p class="startdd"><a name="LATEX_HEADER"></a> 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>
<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 class="section user"><dt>Note: </dt><dd>Only use a user-defined header if you know what you are doing!</dd></dl>
<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>, <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>
<p class="enddd"><a class="anchor" id="cfg_latex_footer"></a></p>
</dd>
<dt><code>LATEX_FOOTER</code> </dt>
<dd><p class="startdd"><a name="LATEX_FOOTER"></a> The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the generated latex document. The footer should contain everything after the last chapter. If it is left blank doxygen will generate a standard footer. Notice: only use this tag if you know what you are doing!</p>
<p class="enddd"><a class="anchor" id="cfg_pdf_hyperlinks"></a></p>
</dd>
<dt><code>PDF_HYPERLINKS</code> </dt>
<dd><p class="startdd"><a name="PDF_HYPERLINKS"></a></p>
<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 or pdflatex). 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>
<p class="enddd"><a class="anchor" id="cfg_use_pdflatex"></a></p>
</dd>
<dt><code>USE_PDFLATEX</code> </dt>
<dd><p class="startdd"><a name="LATEX_PDFLATEX"></a></p>
<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>
<p class="enddd"><a class="anchor" id="cfg_latex_batchmode"></a></p>
</dd>
<dt><code>LATEX_BATCHMODE</code> </dt>
<dd><p class="startdd"><a name="LATEX_BATCHMODE"></a></p>
<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>
<p class="enddd"><a class="anchor" id="cfg_latex_bib_style"></a> </p>
</dd>
<dt><code>LATEX_BIB_STYLE</code> </dt>
<dd><p class="startdd"><a name="LATEX_BIB_STYLE"></a></p>
<p>The <code>LATEX_BIB_STYLE</code> tag can be used to specify the style to use for the bibliography, e.g. <code>plainnat</code>, or <code>ieeetr</code>. The default style is <code>plain</code>. See <a href="http://en.wikipedia.org/wiki/BibTeX">http://en.wikipedia.org/wiki/BibTeX</a> and <a class="el" href="commands.html#cmdcite">\cite</a> for more info.</p>
<p class="enddd"><a class="anchor" id="cfg_latex_hide_indices"></a></p>
</dd>
<dt><code>LATEX_HIDE_INDICES</code> </dt>
<dd><p class="startdd"><a name="LATEX_HIDE_INDICES"></a></p>
<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>
<p class="enddd"><a class="anchor" id="cfg_latex_source_code"></a> </p>
</dd>
<dt><code>LATEX_SOURCE_CODE</code> </dt>
<dd><p class="startdd">If <code>LATEX_SOURCE_CODE</code> is set to <code>YES</code> then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as <a class="el" href="config.html#cfg_source_browser">SOURCE_BROWSER</a>.</p>
<p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="rtf_output"></a>
RTF related options</h1>
<p><a class="anchor" id="cfg_generate_rtf"></a></p>
<dl>
<dt><code>GENERATE_RTF</code> </dt>
<dd><p class="startdd"><a name="GENERATE_RTF"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_rtf_output"></a></p>
</dd>
<dt><code>RTF_OUTPUT</code> </dt>
<dd><p class="startdd"><a name="RTF_OUTPUT"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_compact_rtf"></a></p>
</dd>
<dt><code>COMPACT_RTF</code> </dt>
<dd><p class="startdd"><a name="COMPACT_RTF"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_rtf_hyperlinks"></a></p>
</dd>
<dt><code>RTF_HYPERLINKS</code> </dt>
<dd><p class="startdd"><a name="RTF_HYPERLINKS"></a> 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 class="section user"><dt>note:</dt><dd>WordPad (write) and others do not support links.</dd></dl>
<p><a class="anchor" id="cfg_rtf_stylesheet_file"></a> </p>
</dd>
<dt><code>RTF_STYLESHEET_FILE</code> </dt>
<dd><p class="startdd"><a name="RTF_STYLESHEET_FILE"></a> 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>
<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>
<p class="enddd"><a class="anchor" id="cfg_rtf_extensions_file"></a></p>
</dd>
<dt><code>RTF_EXTENSIONS_FILE</code> </dt>
<dd><p class="startdd">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>
<p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="man_output"></a>
Man page related options</h1>
<p><a class="anchor" id="cfg_generate_man"></a></p>
<dl>
<dt><code>GENERATE_MAN</code> </dt>
<dd><p class="startdd"><a name="GENERATE_MAN"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_man_output"></a></p>
</dd>
<dt><code>MAN_OUTPUT</code> </dt>
<dd><p class="startdd"><a name="MAN_OUTPUT"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_man_extension"></a></p>
</dd>
<dt><code>MAN_EXTENSION</code> </dt>
<dd><p class="startdd"><a name="MAX_EXTENSION"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_man_links"></a></p>
</dd>
<dt><code>MAN_LINKS</code> </dt>
<dd><p class="startdd"><a name="MAN_LINKS"></a> 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>
<p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="xml_output"></a>
XML related options</h1>
<p><a class="anchor" id="cfg_generate_xml"></a></p>
<dl>
<dt><code>GENERATE_XML</code> </dt>
<dd><p class="startdd"><a name="GENERATE_XML"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_xml_output"></a></p>
</dd>
<dt><code>XML_OUTPUT</code> </dt>
<dd><p class="startdd"><a name="XML_OUTPUT"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_xml_schema"></a></p>
</dd>
<dt><code>XML_SCHEMA</code> </dt>
<dd><p class="startdd"><a name="XML_SCHEMA"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_xml_dtd"></a></p>
</dd>
<dt><code>XML_DTD</code> </dt>
<dd><p class="startdd"><a name="XML_DTD"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_xml_programlisting"></a></p>
</dd>
<dt><code>XML_PROGRAMLISTING</code> </dt>
<dd><p class="startdd"><a name="XML_PROGRAMLISTING"></a> 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>
<p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="autogen_output"></a>
AUTOGEN_DEF related options</h1>
<p><a class="anchor" id="cfg_generate_autogen_def"></a></p>
<dl>
<dt><code>GENERATE_AUTOGEN_DEF</code> </dt>
<dd><p class="startdd"><a name="GENERATE_AUTOGEN_DEF"></a> 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>
<p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="perlmod_output"></a>
PERLMOD related options</h1>
<p><a class="anchor" id="cfg_generate_perlmod"></a></p>
<dl>
<dt><code>GENERATE_PERLMOD</code> </dt>
<dd><p class="startdd"><a name="GENERATE_PERLMOD"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_perlmod_latex"></a></p>
</dd>
<dt><code>PERLMOD_LATEX</code> </dt>
<dd><p class="startdd"><a name="PERLMOD_LATEX"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_perlmod_pretty"></a></p>
</dd>
<dt><code>PERLMOD_PRETTY</code> </dt>
<dd><p class="startdd"><a name="PERLMOD_PRETTY"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_perlmod_makevar_prefix"></a></p>
</dd>
<dt><code>PERLMOD_MAKEVAR_PREFIX</code> </dt>
<dd><p class="startdd"><a name="PERLMOD_MAKEVAR_PREFIX"></a> 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>
<p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="config_prepro"></a>
Preprocessor related options</h1>
<p><a class="anchor" id="cfg_enable_preprocessing"></a></p>
<dl>
<dt><code>ENABLE_PREPROCESSING</code> </dt>
<dd><p class="startdd"><a name="ENABLE_PREPROCESSING"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_macro_expansion"></a></p>
</dd>
<dt><code>MACRO_EXPANSION</code> </dt>
<dd><p class="startdd"><a name="MACRO_EXPANSION"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_expand_only_predef"></a></p>
</dd>
<dt><code>EXPAND_ONLY_PREDEF</code> </dt>
<dd><p class="startdd"><a name="EXPAND_ONLY_PREDEF"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_search_includes"></a></p>
</dd>
<dt><code>SEARCH_INCLUDES</code> </dt>
<dd><p class="startdd"><a name="SEARCH_INCLUDES"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_include_path"></a></p>
</dd>
<dt><code>INCLUDE_PATH</code> </dt>
<dd><p class="startdd"><a name="INCLUDE_PATH"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_include_file_patterns"></a></p>
</dd>
<dt><code>INCLUDE_FILE_PATTERNS</code> </dt>
<dd><p class="startdd"><a name="INCLUDE_FILE_PATTERNS"></a> You can use the <code>INCLUDE_FILE_PATTERNS</code> tag to specify one or more wildcard patterns (like <code>*.h</code> and <code>*.hpp</code>) to filter out the header-files in the directories. If left blank, the patterns specified with <code>FILE_PATTERNS</code> will be used.</p>
<p class="enddd"><a class="anchor" id="cfg_predefined"></a></p>
</dd>
<dt><code>PREDEFINED</code> </dt>
<dd><p class="startdd"><a name="PREDEFINED"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_expand_as_defined"></a></p>
</dd>
<dt><code>EXPAND_AS_DEFINED</code> </dt>
<dd><p class="startdd"><a name="EXPAND_AS_DEFINED"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_skip_function_macros"></a></p>
</dd>
<dt><code>SKIP_FUNCTION_MACROS</code> </dt>
<dd><p class="startdd"><a name="SKIP_FUNCTION_MACROS"></a> 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>
<p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="config_extref"></a>
External reference options</h1>
<p><a class="anchor" id="cfg_tagfiles"></a></p>
<dl>
<dt><code>TAGFILES</code> </dt>
<dd><p class="startdd"><a name="TAGFILES"></a> The <code>TAGFILES</code> tag can be used to specify one or more tag files.</p>
<p>See <a class="el" href="external.html">Linking to external documentation</a> for more information about the use of tag files.</p>
<dl class="section note"><dt>Note:</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>
<p><a class="anchor" id="cfg_generate_tagfile"></a></p>
</dd>
<dt><code>GENERATE_TAGFILE</code> </dt>
<dd><p class="startdd"><a name="GENERATE_TAGFILE"></a> 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="external.html">Linking to external documentation</a> for more information about the usage of tag files.</p>
<p class="enddd"><a class="anchor" id="cfg_allexternals"></a></p>
</dd>
<dt><code>ALLEXTERNALS</code> </dt>
<dd><p class="startdd"><a name="ALLEXTERNALS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_external_groups"></a></p>
</dd>
<dt><code>EXTERNAL_GROUPS</code> </dt>
<dd><p class="startdd"><a name="EXTERNAL_GROUPS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_perl_path"></a></p>
</dd>
<dt><code>PERL_PATH</code> </dt>
<dd><p class="startdd"><a name="PERL_PATH"></a> 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>
<p class="enddd"></p>
</dd>
</dl>
<h1><a class="anchor" id="config_dot"></a>
Dot options</h1>
<p><a class="anchor" id="cfg_class_diagrams"></a></p>
<dl>
<dt><code>CLASS_DIAGRAMS</code> </dt>
<dd><p class="startdd"><a name="CLASS_DIAGRAMS"></a> 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 NO turns the diagrams off. Note that this option also works with HAVE_DOT disabled, but it is recommended to install and use dot, since it yields more powerful graphs.</p>
<p class="enddd"><a class="anchor" id="cfg_mscgen_path"></a></p>
</dd>
<dt><code>MSCGEN_PATH</code> </dt>
<dd><p class="startdd"><a name="MSCGEN_PATH"></a> You can define message sequence charts within doxygen comments using the <a class="el" href="commands.html#cmdmsc">\msc</a> command. Doxygen will then run the <a href="http://www.mcternan.me.uk/mscgen/">mscgen tool</a>) to produce the chart and insert it in the documentation. The <code>MSCGEN_PATH</code> tag allows you to specify the directory where the mscgen tool resides. If left empty the tool is assumed to be found in the default search path.</p>
<p class="enddd"><a class="anchor" id="cfg_have_dot"></a></p>
</dd>
<dt><code>HAVE_DOT</code> </dt>
<dd><p class="startdd"><a name="HAVE_DOT"></a> 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&amp;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>
<p class="enddd"><a class="anchor" id="cfg_dot_num_threads"></a></p>
</dd>
<dt><code>DOT_NUM_THREADS</code> </dt>
<dd><p class="startdd"><a name="DOT_NUM_THREADS"></a> The <code>DOT_NUM_THREADS</code> specifies the number of dot invocations doxygen is allowed to run in parallel. When set to 0 (the default) doxygen will base this on the number of processors available in the system. You can set it explicitly to a value larger than 0 to get control over the balance between CPU load and processing speed.</p>
<p class="enddd"><a class="anchor" id="cfg_dot_fontname"></a></p>
</dd>
<dt><code>DOT_FONTNAME</code> </dt>
<dd><p class="startdd"><a name="DOT_FONTNAME"></a> By default doxygen will use the Helvetica font for all dot files that doxygen generates. When you want a differently looking font you can specify the font name using <code>DOT_FONTNAME</code>. You need to make sure dot is able to find the font, which can be done by putting it in a standard location or by setting the <code>DOTFONTPATH</code> environment variable or by setting <code>DOT_FONTPATH</code> to the directory containing the font.</p>
<p class="enddd"><a class="anchor" id="cfg_dot_fontsize"></a></p>
</dd>
<dt><code>DOT_FONTSIZE</code> </dt>
<dd><p class="startdd">The <code>DOT_FONTSIZE</code> tag can be used to set the size of the font of dot graphs. The default size is 10pt.</p>
<p class="enddd"><a class="anchor" id="cfg_dot_fontpath"></a></p>
</dd>
<dt><code>DOT_FONTPATH</code> </dt>
<dd><p class="startdd"><a name="DOT_FONTPATH"></a> By default doxygen will tell dot to use the output directory to look for the <code>FreeSans.ttf</code> font (which doxygen will put there itself). If you specify a different font using <code>DOT_FONTNAME</code> you can set the path where dot can find it using this tag.</p>
<p class="enddd"><a class="anchor" id="cfg_class_graph"></a></p>
</dd>
<dt><code>CLASS_GRAPH</code> </dt>
<dd><p class="startdd"><a name="CLASS_GRAPH"></a> 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 <code>CLASS_DIAGRAMS</code> tag to NO.</p>
<p class="enddd"><a class="anchor" id="cfg_collaboration_graph"></a></p>
</dd>
<dt><code>COLLABORATION_GRAPH</code> </dt>
<dd><p class="startdd"><a name="COLLABORATION_GRAPH"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_group_graphs"></a></p>
</dd>
<dt><code>GROUP_GRAPHS</code> </dt>
<dd><p class="startdd"><a name="GROUP_GRAPHS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_uml_look"></a></p>
</dd>
<dt><code>UML_LOOK</code> </dt>
<dd><p class="startdd"><a name="UML_LOOK"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_uml_limit_num_fields"></a></p>
</dd>
<dt><code>UML_LIMIT_NUM_FIELDS</code> </dt>
<dd><p class="startdd"><a name="UML_LIMIT_NUM_FIELDS"></a> If the <code>UML_LOOK</code> tag is enabled, the fields and methods are shown inside the class node. If there are many fields or methods and many nodes the graph may become too big to be useful. The <code>UML_LIMIT_NUM_FIELDS</code> threshold limits the number of items for each type to make the size more managable. Set this to 0 for no limit. Note that the threshold may be exceeded by 50% before the limit is enforced. So when you set the threshold to 10, up to 15 fields may appear, but if the number exceeds 15, the total amount of fields shown is limited to 10.</p>
<p class="enddd"><a class="anchor" id="cfg_template_relations"></a></p>
</dd>
<dt><code>TEMPLATE_RELATIONS</code> </dt>
<dd><p class="startdd"><a name="TEMPLATE_RELATIONS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_hide_undoc_relations"></a></p>
</dd>
<dt><code>HIDE_UNDOC_RELATIONS</code> </dt>
<dd><p class="startdd"><a name="HIDE_UNDOC_RELATIONS"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_include_graph"></a></p>
</dd>
<dt><code>INCLUDE_GRAPH</code> </dt>
<dd><p class="startdd"><a name="INCLUDE_GRAPH"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_included_by_graph"></a></p>
</dd>
<dt><code>INCLUDED_BY_GRAPH</code> </dt>
<dd><p class="startdd"><a name="INCLUDED_BY_GRAPH"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_call_graph"></a></p>
</dd>
<dt><code>CALL_GRAPH</code> </dt>
<dd><p class="startdd"><a name="CALL_GRAPH"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_caller_graph"></a></p>
</dd>
<dt><code>CALLER_GRAPH</code> </dt>
<dd><p class="startdd"><a name="CALLER_GRAPH"></a> If the <code>CALLER_GRAPH</code> and <code>HAVE_DOT</code> tags are set to <code>YES</code> then doxygen will generate a caller 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 caller graphs for selected functions only using the \callergraph command.</p>
<p class="enddd"><a class="anchor" id="cfg_graphical_hierarchy"></a></p>
</dd>
<dt><code>GRAPHICAL_HIERARCHY</code> </dt>
<dd><p class="startdd"><a name="GRAPHICAL_HIERARCHY"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_directory_graph"></a></p>
</dd>
<dt><code>DIRECTORY_GRAPH</code> </dt>
<dd><p class="startdd"><a name="DIRECTORY_GRAPH"></a> If the <code>DIRECTORY_GRAPH</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>
<p class="enddd"><a class="anchor" id="cfg_dot_graph_max_nodes"></a> </p>
</dd>
<dt><code>DOT_GRAPH_MAX_NODES</code> </dt>
<dd><p class="startdd"><a name="DOT_GRAPH_MAX_NODES"></a> The <code>DOT_GRAPH_MAX_NODES</code> tag can be used to set the maximum number of nodes that will be shown in the graph. If the number of nodes in a graph becomes larger than this value, doxygen will truncate the graph, which is visualized by representing a node as a red box. Note that doxygen if the number of direct children of the root node in a graph is already larger than <code>DOT_GRAPH_MAX_NODES</code> then the graph will not be shown at all. Also note that the size of a graph can be further restricted by <code>MAX_DOT_GRAPH_DEPTH</code>.</p>
<p class="enddd"><a class="anchor" id="cfg_max_dot_graph_depth"></a></p>
</dd>
<dt><code>MAX_DOT_GRAPH_DEPTH</code> </dt>
<dd><p class="startdd"><a name="MAX_DOT_GRAPH_DEPTH"></a> 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 the size of a graph can be further restricted by <code>DOT_GRAPH_MAX_NODES</code>. Using a depth of 0 means no depth restriction (the default).</p>
<p class="enddd"><a class="anchor" id="cfg_dot_image_format"></a></p>
</dd>
<dt><code>DOT_IMAGE_FORMAT</code> </dt>
<dd><a name="DOT_IMAGE_FORMAT"></a> The <code>DOT_IMAGE_FORMAT</code> tag can be used to set the image format of the images generated by dot. Possible values are svg, png, jpg, or gif. If left blank png will be used. <dl class="section note"><dt>Note:</dt><dd>If you choose <code>svg</code> you need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files visible in IE 9+ (other browsers do not have this requirement).</dd></dl>
<a class="anchor" id="cfg_interactive_svg"></a></dd>
<dt><code>INTERACTIVE_SVG</code> </dt>
<dd>If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to enable generation of interactive SVG images that allow zooming and panning. Note that this requires a modern browser other than Internet Explorer. Tested and working are Firefox, Chrome, Safari, and Opera. <dl class="section note"><dt>Note:</dt><dd>For IE 9+ you need to set <code>HTML_FILE_EXTENSION</code> to xhtml in order to make the SVG files visible. Older versions of IE do not have SVG support.</dd></dl>
<a class="anchor" id="cfg_dot_path"></a></dd>
<dt><code>DOT_PATH</code> </dt>
<dd><p class="startdd"><a name="DOT_PATH"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_dotfile_dirs"></a></p>
</dd>
<dt><code>DOTFILE_DIRS</code> </dt>
<dd><p class="startdd"><a name="DOTFILE_DIRS"></a> This tag can be used to specify one or more directories that contain dot files that are included in the documentation (see the <a class="el" href="commands.html#cmddotfile">\dotfile</a> command).</p>
<p class="enddd"><a class="anchor" id="cfg_mscfile_dirs"></a></p>
</dd>
<dt><code>MSCFILE_DIRS</code> </dt>
<dd><p class="startdd"><a name="MSCFILE_DIRS"></a> This tag can be used to specify one or more directories that contain msc files that are included in the documentation (see the <a class="el" href="commands.html#cmdmscfile">\mscfile</a> command).</p>
<p class="enddd"><a class="anchor" id="cfg_dot_transparent"></a></p>
</dd>
<dt><code>DOT_TRANSPARENT</code> </dt>
<dd><p class="startdd"><a name="DOT_TRANSPARENT"></a> Set the <code>DOT_TRANSPARENT</code> tag to <code>YES</code> to generate images with a transparent background. This is disabled by default, because dot on Windows does not seem to support this out of the box. 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>
<p class="enddd"><a class="anchor" id="cfg_dot_multi_targets"></a></p>
</dd>
<dt><code>DOT_MULTI_TARGETS</code> </dt>
<dd><p class="startdd"><a name="DOT_MULTI_TARGET"></a> 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 (&gt;1.8.10) support this, this feature is disabled by default.</p>
<p class="enddd"><a class="anchor" id="cfg_generate_legend"></a> </p>
</dd>
<dt><code>GENERATE_LEGEND</code> </dt>
<dd><p class="startdd"><a name="GENERATE_LEGEND"></a> 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>
<p class="enddd"><a class="anchor" id="cfg_dot_cleanup"></a></p>
</dd>
<dt><code>DOT_CLEANUP</code> </dt>
<dd><p class="startdd"><a name="DOT_CLEANUP"></a> 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>
<p class="enddd"></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: </p>
<pre class="fragment">INPUT            = example.cc example.h
</pre><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: </p>
<pre class="fragment">PROJECT_NAME     = Example
INPUT            = example.cc example.h
WARNINGS         = YES
TAGFILES         = qt.tag
PERL_PATH        = /usr/local/bin/perl
SEARCHENGINE     = NO
</pre><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: </p>
<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/bin/perl
SEARCHENGINE     = YES
</pre><p>To regenerate the Qt-1.44 documentation from the sources, you could use the following config file: </p>
<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><p>For the Qt-2.1 sources I recommend to use the following settings: </p>
<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><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. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
  </ul>
</div>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional