diff options
Diffstat (limited to 'vnfs/VES5.0/doxygen-1.8.12/html/config.html')
| -rw-r--r-- | vnfs/VES5.0/doxygen-1.8.12/html/config.html | 1965 |
1 files changed, 1965 insertions, 0 deletions
diff --git a/vnfs/VES5.0/doxygen-1.8.12/html/config.html b/vnfs/VES5.0/doxygen-1.8.12/html/config.html new file mode 100644 index 00000000..38cc0763 --- /dev/null +++ b/vnfs/VES5.0/doxygen-1.8.12/html/config.html @@ -0,0 +1,1965 @@ +<!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"/> +<meta name="generator" content="Doxygen 1.8.12"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Doxygen: 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="navtreedata.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! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Doxygen + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.12 --> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </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 configuration options</a></li> +<li class="level1"><a href="#config_build">Build related configuration options</a></li> +<li class="level1"><a href="#config_messages">Configuration options related to warning and progress messages</a></li> +<li class="level1"><a href="#config_input">Configuration options related to the input files</a></li> +<li class="level1"><a href="#config_source_browser">Configuration options related to source browsing</a></li> +<li class="level1"><a href="#config_index">Configuration options related to the alphabetical class index</a></li> +<li class="level1"><a href="#config_html">Configuration options related to the HTML output</a></li> +<li class="level1"><a href="#config_latex">Configuration options related to the LaTeX output</a></li> +<li class="level1"><a href="#config_rtf">Configuration options related to the RTF output</a></li> +<li class="level1"><a href="#config_man">Configuration options related to the man page output</a></li> +<li class="level1"><a href="#config_xml">Configuration options related to the XML output</a></li> +<li class="level1"><a href="#config_docbook">Configuration options related to the DOCBOOK output</a></li> +<li class="level1"><a href="#config_autogen">Configuration options for the AutoGen Definitions output</a></li> +<li class="level1"><a href="#config_perlmod">Configuration options related to the Perl module output</a></li> +<li class="level1"><a href="#config_preprocessor">Configuration options related to the preprocessor</a></li> +<li class="level1"><a href="#config_external">Configuration options related to external references</a></li> +<li class="level1"><a href="#config_dot">Configuration options related to the dot tool</a></li> +<li class="level1"><a href="#config_examples">Examples</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 <code>Makefile</code>, 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 beginning with two hash characters (<code>##</code>) are kept when updating the configuration file and are placed in front of the TAG they are in front of. Comments beginning with two hash characters (<code>##</code>) at the beginning of the configuration file are also kept and placed at the beginning of the file. Comments beginning with two hash characters (<code>##</code>) at the end of the configuration file are also kept and placed at the end of the file. Comments begin with the hash character (<code>#</code>) and ends 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 equal sign (<code>=</code>) and one or more values. If the same tag is assigned more than once, the last assignment overwrites any earlier assignment. For tags 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 (<code>"..."</code>). Multiple lines can be concatenated by inserting a backslash (<code>\</code>) 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_allow_unicode_names">ALLOW_UNICODE_NAMES</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_autolink_support">AUTOLINK_SUPPORT</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_caller_graph">CALLER_GRAPH</a></li> +<li><a href="config.html#cfg_call_graph">CALL_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_clang_assisted_parsing">CLANG_ASSISTED_PARSING</a></li> +<li><a href="config.html#cfg_clang_options">CLANG_OPTIONS</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_diafile_dirs">DIAFILE_DIRS</a></li> +<li><a href="config.html#cfg_dia_path">DIA_PATH</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_docbook_output">DOCBOOK_OUTPUT</a></li> +<li><a href="config.html#cfg_docbook_programlisting">DOCBOOK_PROGRAMLISTING</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_dotfile_dirs">DOTFILE_DIRS</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_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_enabled_sections">ENABLED_SECTIONS</a></li> +<li><a href="config.html#cfg_enable_preprocessing">ENABLE_PREPROCESSING</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_extension_mapping">EXTENSION_MAPPING</a></li> +<li><a href="config.html#cfg_external_groups">EXTERNAL_GROUPS</a></li> +<li><a href="config.html#cfg_external_pages">EXTERNAL_PAGES</a></li> +<li><a href="config.html#cfg_external_search">EXTERNAL_SEARCH</a></li> +<li><a href="config.html#cfg_external_search_id">EXTERNAL_SEARCH_ID</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_package">EXTRACT_PACKAGE</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_extra_packages">EXTRA_PACKAGES</a></li> +<li><a href="config.html#cfg_extra_search_mappings">EXTRA_SEARCH_MAPPINGS</a></li> +<li><a href="config.html#cfg_ext_links_in_window">EXT_LINKS_IN_WINDOW</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_DEPRECATEDLIST</a></li> +<li><a href="config.html#cfg_generate_docbook">GENERATE_DOCBOOK</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_group_nested_compounds">GROUP_NESTED_COMPOUNDS</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_compound_reference">HIDE_COMPOUND_REFERENCE</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_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_extra_stylesheet">HTML_EXTRA_STYLESHEET</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_included_by_graph">INCLUDED_BY_GRAPH</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_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_simple_structs">INLINE_SIMPLE_STRUCTS</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_extra_files">LATEX_EXTRA_FILES</a></li> +<li><a href="config.html#cfg_latex_extra_stylesheet">LATEX_EXTRA_STYLESHEET</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_latex_timestamp">LATEX_TIMESTAMP</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_man_subdir">MAN_SUBDIR</a></li> +<li><a href="config.html#cfg_markdown_support">MARKDOWN_SUPPORT</a></li> +<li><a href="config.html#cfg_mathjax_codefile">MATHJAX_CODEFILE</a></li> +<li><a href="config.html#cfg_mathjax_extensions">MATHJAX_EXTENSIONS</a></li> +<li><a href="config.html#cfg_mathjax_format">MATHJAX_FORMAT</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_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_perl_path">PERL_PATH</a></li> +<li><a href="config.html#cfg_plantuml_include_path">PLANTUML_INCLUDE_PATH</a></li> +<li><a href="config.html#cfg_plantuml_jar_path">PLANTUML_JAR_PATH</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_source_code">RTF_SOURCE_CODE</a></li> +<li><a href="config.html#cfg_rtf_stylesheet_file">RTF_STYLESHEET_FILE</a></li> +<li><a href="config.html#cfg_searchdata_file">SEARCHDATA_FILE</a></li> +<li><a href="config.html#cfg_searchengine">SEARCHENGINE</a></li> +<li><a href="config.html#cfg_searchengine_url">SEARCHENGINE_URL</a></li> +<li><a href="config.html#cfg_search_includes">SEARCH_INCLUDES</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_grouped_memb_inc">SHOW_GROUPED_MEMB_INC</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_members_ctors_1st">SORT_MEMBERS_CTORS_1ST</a></li> +<li><a href="config.html#cfg_sort_member_docs">SORT_MEMBER_DOCS</a></li> +<li><a href="config.html#cfg_source_browser">SOURCE_BROWSER</a></li> +<li><a href="config.html#cfg_source_tooltips">SOURCE_TOOLTIPS</a></li> +<li><a href="config.html#cfg_strict_proto_matching">STRICT_PROTO_MATCHING</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_tab_size">TAB_SIZE</a></li> +<li><a href="config.html#cfg_tagfiles">TAGFILES</a></li> +<li><a href="config.html#cfg_tcl_subst">TCL_SUBST</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_toc_include_headings">TOC_INCLUDE_HEADINGS</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_mdfile_as_mainpage">USE_MDFILE_AS_MAINPAGE</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_warnings">WARNINGS</a></li> +<li><a href="config.html#cfg_warn_as_error">WARN_AS_ERROR</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_xml_output">XML_OUTPUT</a></li> +<li><a href="config.html#cfg_xml_programlisting">XML_PROGRAMLISTING</a></li> +</ul> +</div> + <h1><a class="anchor" id="config_project"></a> +Project related configuration 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="aDOXYFILE_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 <code>libiconv</code> (or the iconv built into <code>libc</code>) 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>The default value is: <code>UTF-8</code>.</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="aPROJECT_NAME"></a> The <code>PROJECT_NAME</code> tag is a single word (or a sequence of words surrounded by double-quotes, unless you are using Doxywizard) that should identify the project for which the documentation is generated. This name is used in the title of most generated pages and in a few other places.</p> +<p>The default value is: <code>My Project</code>.</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="aPROJECT_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"><a name="aPROJECT_BRIEF"></a> 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"><a name="aPROJECT_LOGO"></a> With the <code>PROJECT_LOGO</code> tag one can specify a logo or an 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="aOUTPUT_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="aCREATE_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>The default value is: <code>NO</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_allow_unicode_names"></a></p> +</dd> +<dt><code>ALLOW_UNICODE_NAMES</code> </dt> +<dd><p class="startdd"><a name="aALLOW_UNICODE_NAMES"></a> If the <code>ALLOW_UNICODE_NAMES</code> tag is set to <code>YES</code>, doxygen will allow non-ASCII characters to appear in the names of generated files. If set to <code>NO</code>, non-ASCII characters will be escaped, for example _xE3_x81_x84 will be used for Unicode U+3044.</p> +<p>The default value is: <code>NO</code>.</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="aOUTPUT_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.</p> +<p>Possible values are: <code>Afrikaans</code>, <code>Arabic</code>, <code>Armenian</code>, <code>Brazilian</code>, <code>Catalan</code>, <code>Chinese</code>, <code>Chinese-Traditional</code>, <code>Croatian</code>, <code>Czech</code>, <code>Danish</code>, <code>Dutch</code>, <code>English</code> (United States), <code>Esperanto</code>, <code>Farsi</code> (Persian), <code>Finnish</code>, <code>French</code>, <code>German</code>, <code>Greek</code>, <code>Hungarian</code>, <code>Indonesian</code>, <code>Italian</code>, <code>Japanese</code>, <code>Japanese-en</code> (Japanese with English messages), <code>Korean</code>, <code>Korean-en</code> (Korean with English messages), <code>Latvian</code>, <code>Lithuanian</code>, <code>Macedonian</code>, <code>Norwegian</code>, <code>Persian</code> (Farsi), <code>Polish</code>, <code>Portuguese</code>, <code>Romanian</code>, <code>Russian</code>, <code>Serbian</code>, <code>Serbian-Cyrillic</code>, <code>Slovak</code>, <code>Slovene</code>, <code>Spanish</code>, <code>Swedish</code>, <code>Turkish</code>, <code>Ukrainian</code> and <code>Vietnamese</code>.</p> +<p>The default value is: <code>English</code>.</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="aBRIEF_MEMBER_DESC"></a> If the <code>BRIEF_MEMBER_DESC</code> tag is set to <code>YES</code>, doxygen will include brief member descriptions after the members that are listed in the file and class documentation (similar to <code>Javadoc</code>). Set to <code>NO</code> to disable this.</p> +<p>The default value is: <code>YES</code>.</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="aREPEAT_BRIEF"></a> If the <code>REPEAT_BRIEF</code> tag is set to <code>YES</code>, doxygen will prepend the brief description of a member or function before the detailed description <br /> +Note: If both <a class="el" href="config.html#cfg_hide_undoc_members">HIDE_UNDOC_MEMBERS</a> and <a class="el" href="config.html#cfg_brief_member_desc">BRIEF_MEMBER_DESC</a> are set to <code>NO</code>, the brief descriptions will be completely suppressed.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_abbreviate_brief"></a></p> +</dd> +<dt><code>ABBREVIATE_BRIEF</code> </dt> +<dd><p class="startdd"><a name="aABBREVIATE_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 (<code>$name</code> is automatically replaced with the name of the entity): <code>The $name class</code>, <code>The $name widget</code>, <code>The $name file</code>, <code>is</code>, <code>provides</code>, <code>specifies</code>, <code>contains</code>, <code>represents</code>, <code>a</code>, <code>an</code> and <code>the</code>.</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="aALWAYS_DETAILED_SEC"></a> If the <code>ALWAYS_DETAILED_SEC</code> and <a class="el" href="config.html#cfg_repeat_brief">REPEAT_BRIEF</a> 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>The default value is: <code>NO</code>.</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="aINLINE_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>The default value is: <code>NO</code>.</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="aFULL_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 <code>NO</code> the shortest path that makes the file name unique will be used</p> +<p>The default value is: <code>YES</code>.</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="aSTRIP_FROM_PATH"></a> 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. <br /> +Note that you can specify absolute paths here, but also relative paths, which will be relative from the directory where doxygen is started.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_full_path_names">FULL_PATH_NAMES</a> is set to <code>YES</code>. <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="aSTRIP_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 list of include paths that are normally passed to the compiler using the <code>-I</code> 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="aSHORT_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>The default value is: <code>NO</code>.</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="aJAVADOC_AUTOBRIEF"></a> If the <code>JAVADOC_AUTOBRIEF</code> tag 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 <code>NO</code>, the Javadoc-style will behave just like regular Qt-style comments (thus requiring an explicit <a class="el" href="commands.html#cmdbrief">@brief</a> command for a brief description.)</p> +<p>The default value is: <code>NO</code>.</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="aQT_AUTOBRIEF"></a> If the <code>QT_AUTOBRIEF</code> tag 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 <code>NO</code>, the Qt-style will behave just like regular Qt-style comments (thus requiring an explicit <a class="el" href="commands.html#cmdbrief">\brief</a> command for a brief description.)</p> +<p>The default value is: <code>NO</code>.</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="aMULTILINE_CPP_IS_BRIEF"></a> The <code>MULTILINE_CPP_IS_BRIEF</code> tag can be set to <code>YES</code> to make doxygen treat a multi-line C++ special comment block (i.e. a block of <code>//!</code> or <code>///</code> 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 <code>YES</code> if you prefer the old behavior instead. <br /> +Note that setting this tag to <code>YES</code> also means that rational rose comments are not recognized any more.</p> +<p>The default value is: <code>NO</code>.</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="aINHERIT_DOCS"></a> If the <code>INHERIT_DOCS</code> tag is set to <code>YES</code> then an undocumented member inherits the documentation from any documented member that it re-implements.</p> +<p>The default value is: <code>YES</code>.</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="aSEPARATE_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>The default value is: <code>NO</code>.</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="aTAB_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>Minimum value: <code>1</code>, maximum value: <code>16</code>, default value: <code>4</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_aliases"></a></p> +</dd> +<dt><code>ALIASES</code> </dt> +<dd><p class="startdd"><a name="aALIASES"></a> This tag can be used to specify a number of aliases that act 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 <code>\sideeffect</code> (or <code>@sideeffect</code>) in the documentation, which will result in a user-defined paragraph with heading "Side Effects:". You can put <a class="el" href="commands.html#cmdn">\n</a>'s in the value part of an alias to insert newlines.</p> +<p class="enddd"><a class="anchor" id="cfg_tcl_subst"></a></p> +</dd> +<dt><code>TCL_SUBST</code> </dt> +<dd><p class="startdd"><a name="aTCL_SUBST"></a> This tag can be used to specify a number of word-keyword mappings (TCL only). A mapping has the form <code>"name=value"</code>. For example adding <code>"class=itcl::class"</code> will allow you to use the command class in the <code>itcl::class</code> meaning.</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="aOPTIMIZE_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>The default value is: <code>NO</code>.</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="aOPTIMIZE_OUTPUT_JAVA"></a> Set the <code>OPTIMIZE_OUTPUT_JAVA</code> tag to <code>YES</code> 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>The default value is: <code>NO</code>.</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="aOPTIMIZE_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>The default value is: <code>NO</code>.</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="aOPTIMIZE_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>The default value is: <code>NO</code>.</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="aEXTENSION_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 <code>ext=language</code>, where <code>ext</code> 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 (fixed format Fortran: FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: Fortran. In the later case the parser tries to guess whether the code is fixed or free formatted code, this is the default for Fortran type files), VHDL.</p> +<p>For instance to make doxygen treat <code>.inc</code> files as Fortran files (default is PHP), and <code>.f</code> files as C (default is Fortran), use: <code>inc=Fortran f=C</code>.</p> +<p><br /> +Note: For files without extension you can use <code>no_extension</code> as a placeholder. <br /> +Note that for custom extensions you also need to set <a class="el" href="config.html#cfg_file_patterns">FILE_PATTERNS</a> otherwise the files are not read by doxygen.</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="aMARKDOWN_SUPPORT"></a> If the <code>MARKDOWN_SUPPORT</code> tag is enabled 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>The default value is: <code>YES</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_toc_include_headings"></a></p> +</dd> +<dt><code>TOC_INCLUDE_HEADINGS</code> </dt> +<dd><p class="startdd"><a name="aTOC_INCLUDE_HEADINGS"></a> When the <code>TOC_INCLUDE_HEADINGS</code> tag is set to a non-zero value, all headings up to that level are automatically included in the table of contents, even if they do not have an id attribute. </p><dl class="section note"><dt>Note</dt><dd>This feature currently applies only to Markdown headings.</dd></dl> +<p>Minimum value: <code>0</code>, maximum value: <code>99</code>, default value: <code>0</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_markdown_support">MARKDOWN_SUPPORT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_autolink_support"></a></p> +</dd> +<dt><code>AUTOLINK_SUPPORT</code> </dt> +<dd><p class="startdd"><a name="aAUTOLINK_SUPPORT"></a> When enabled doxygen tries to link words that correspond to documented classes, or namespaces to their corresponding documentation. Such a link can be prevented in individual cases by putting a <code>%</code> sign in front of the word or globally by setting <code>AUTOLINK_SUPPORT</code> to <code>NO</code>.</p> +<p>The default value is: <code>YES</code>.</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="aBUILTIN_STL_SUPPORT"></a> If you use STL classes (i.e. <code>std::string</code>, <code>std::vector</code>, 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. <code>func(std::string</code>); versus <code>func(std::string) {}</code>). This also make the inheritance and collaboration diagrams that involve STL classes more complete and accurate.</p> +<p>The default value is: <code>NO</code>.</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="aCPP_CLI_SUPPORT"></a> If you use Microsoft's C++/CLI language, you should set this option to <code>YES</code> to enable parsing support.</p> +<p>The default value is: <code>NO</code>.</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="aSIP_SUPPORT"></a> Set the <code>SIP_SUPPORT</code> tag to <code>YES</code> if your project consists of <a href="http://www.riverbankcomputing.co.uk/software/sip/intro">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>The default value is: <code>NO</code>.</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="aIDL_PROPERTY_SUPPORT"></a> For Microsoft's IDL there are <code>propget</code> and <code>propput</code> attributes to indicate getter and setter methods for a property. Setting this option to <code>YES</code> 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>The default value is: <code>YES</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="aDISTRIBUTE_GROUP_DOC"></a> If member grouping is used in the documentation and the <code>DISTRIBUTE_GROUP_DOC</code> tag is set to <code>YES</code> 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>The default value is: <code>NO</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_group_nested_compounds"></a></p> +</dd> +<dt><code>GROUP_NESTED_COMPOUNDS</code> </dt> +<dd><p class="startdd"><a name="aGROUP_NESTED_COMPOUNDS"></a> If one adds a struct or class to a group and this option is enabled, then also any nested class or struct is added to the same group. By default this option is disabled and one has to add nested compounds explicitly via <a class="el" href="commands.html#cmdingroup">\ingroup</a>.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_subgrouping"></a></p> +</dd> +<dt><code>SUBGROUPING</code> </dt> +<dd><p class="startdd"><a name="aSUBGROUPING"></a> Set the <code>SUBGROUPING</code> tag to <code>YES</code> 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>The default value is: <code>YES</code>.</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="aINLINE_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 <a class="el" href="commands.html#cmdingroup">\ingroup</a>) instead of on a separate page (for HTML and Man pages) or section (for <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> and RTF). <br /> +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>The default value is: <code>NO</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_inline_simple_structs"></a></p> +</dd> +<dt><code>INLINE_SIMPLE_STRUCTS</code> </dt> +<dd><p class="startdd"><a name="aINLINE_SIMPLE_STRUCTS"></a> When the <code>INLINE_SIMPLE_STRUCTS</code> tag is set to <code>YES</code>, structs, classes, and unions with only public data fields or simple typedef fields will be shown inline in the documentation of the scope in which they are defined (i.e. file, namespace, or group documentation), provided this scope is documented. If set to <code>NO</code>, structs, classes, and unions are shown on a separate page (for HTML and Man pages) or section (for <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> and RTF).</p> +<p>The default value is: <code>NO</code>.</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="aTYPEDEF_HIDES_STRUCT"></a> When <code>TYPEDEF_HIDES_STRUCT</code> tag 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>The default value is: <code>NO</code>.</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="aLOOKUP_CACHE_SIZE"></a> 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 appears 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_10.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_11.png"/> symbols. At the end of a run doxygen will report the cache usage and suggest the optimal cache size from a speed point of view.</p> +<p>Minimum value: <code>0</code>, maximum value: <code>9</code>, default value: <code>0</code>.</p> +<p class="enddd"></p> +</dd> +</dl> +<h1><a class="anchor" id="config_build"></a> +Build related configuration 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="aEXTRACT_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 <a class="el" href="config.html#cfg_extract_private">EXTRACT_PRIVATE</a> respectively <a class="el" href="config.html#cfg_extract_static">EXTRACT_STATIC</a> tags are set to <code>YES</code>.</p> +<dl class="section note"><dt>Note</dt><dd>This will also disable the warnings about undocumented members that are normally produced when <a class="el" href="config.html#cfg_warnings">WARNINGS</a> is set to <code>YES</code>.</dd></dl> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_extract_private"></a></p> +</dd> +<dt><code>EXTRACT_PRIVATE</code> </dt> +<dd><p class="startdd"><a name="aEXTRACT_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>The default value is: <code>NO</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_extract_package"></a></p> +</dd> +<dt><code>EXTRACT_PACKAGE</code> </dt> +<dd><p class="startdd"><a name="aEXTRACT_PACKAGE"></a> If the <code>EXTRACT_PACKAGE</code> tag is set to <code>YES</code>, all members with package or internal scope will be included in the documentation.</p> +<p>The default value is: <code>NO</code>.</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="aEXTRACT_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>The default value is: <code>NO</code>.</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="aEXTRACT_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 <code>NO</code>, only classes defined in header files are included. Does not have any effect for Java sources.</p> +<p>The default value is: <code>YES</code>.</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="aEXTRACT_LOCAL_METHODS"></a> This flag is only useful for Objective-C code. If 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>, only methods in the interface are included.</p> +<p>The default value is: <code>NO</code>.</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="aEXTRACT_ANON_NSPACES"></a> If this flag is set to <code>YES</code>, 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>The default value is: <code>NO</code>.</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="aHIDE_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> these members will be included in the various overviews, but no documentation section is generated. This option has no effect if <a class="el" href="config.html#cfg_extract_all">EXTRACT_ALL</a> is enabled.</p> +<p>The default value is: <code>NO</code>.</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="aHIDE_UNDOC_CLASSES"></a> If the <code>HIDE_UNDOC_CLASSES</code> tag is set to <code>YES</code>, doxygen will hide all undocumented classes that are normally visible in the class hierarchy. If set to <code>NO</code>, these classes will be included in the various overviews. This option has no effect if <a class="el" href="config.html#cfg_extract_all">EXTRACT_ALL</a> is enabled.</p> +<p>The default value is: <code>NO</code>.</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="aHIDE_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>, these declarations will be included in the documentation.</p> +<p>The default value is: <code>NO</code>.</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="aHIDE_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>, these blocks will be appended to the function's detailed documentation block.</p> +<p>The default value is: <code>NO</code>.</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="aINTERNAL_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> then the documentation will be excluded. Set it to <code>YES</code> to include the internal documentation.</p> +<p>The default value is: <code>NO</code>.</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="aCASE_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 and Mac users are advised to set this option to <code>NO</code>.</p> +<p>The default value is: system dependent.</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="aHIDE_SCOPE_NAMES"></a> If the <code>HIDE_SCOPE_NAMES</code> tag is set to <code>NO</code> 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>The default value is: <code>NO</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_hide_compound_reference"></a></p> +</dd> +<dt><code>HIDE_COMPOUND_REFERENCE</code> </dt> +<dd><p class="startdd"><a name="aHIDE_COMPOUND_REFERENCE"></a> If the <code>HIDE_COMPOUND_REFERENCE</code> tag is set to <code>NO</code> (default) then doxygen will append additional text to a page's title, such as Class Reference. If set to <code>YES</code> the compound reference will be hidden.</p> +<p>The default value is: <code>NO</code>.</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="aSHOW_INCLUDE_FILES"></a> If the <code>SHOW_INCLUDE_FILES</code> tag is set to <code>YES</code> then doxygen will put a list of the files that are included by a file in the documentation of that file.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_show_grouped_memb_inc"></a></p> +</dd> +<dt><code>SHOW_GROUPED_MEMB_INC</code> </dt> +<dd><p class="startdd"><a name="aSHOW_GROUPED_MEMB_INC"></a> If the SHOW_GROUPED_MEMB_INC tag is set to <code>YES</code> then Doxygen will add for each grouped member an include statement to the documentation, telling the reader which file to include in order to use the member.</p> +<p>The default value is: <code>NO</code>.</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="aFORCE_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>The default value is: <code>NO</code>.</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="aINLINE_INFO"></a> If the <code>INLINE_INFO</code> tag is set to <code>YES</code> then a tag [inline] is inserted in the documentation for inline members.</p> +<p>The default value is: <code>YES</code>.</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="aSORT_MEMBER_DOCS"></a> If the <code>SORT_MEMBER_DOCS</code> tag is set to <code>YES</code> 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>The default value is: <code>YES</code>.</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="aSORT_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 members will appear in declaration order. Note that this will also influence the order of the classes in the class list.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_sort_members_ctors_1st"></a></p> +</dd> +<dt><code>SORT_MEMBERS_CTORS_1ST</code> </dt> +<dd><p class="startdd"><a name="aSORT_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 <code>NO</code> the constructors will appear in the respective orders defined by <a class="el" href="config.html#cfg_sort_brief_docs">SORT_BRIEF_DOCS</a> and <a class="el" href="config.html#cfg_sort_member_docs">SORT_MEMBER_DOCS</a>. </p><dl class="section note"><dt>Note</dt><dd>If <a class="el" href="config.html#cfg_sort_brief_docs">SORT_BRIEF_DOCS</a> is set to <code>NO</code> this option is ignored for sorting brief member documentation. </dd> +<dd> +If <a class="el" href="config.html#cfg_sort_member_docs">SORT_MEMBER_DOCS</a> is set to <code>NO</code> this option is ignored for sorting detailed member documentation.</dd></dl> +<p>The default value is: <code>NO</code>.</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="aSORT_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 group names will appear in their defined order.</p> +<p>The default value is: <code>NO</code>.</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><p class="startdd"><a name="aSORT_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 <code>NO</code>, the class list will be sorted only by class name, not including the namespace part. </p><dl class="section note"><dt>Note</dt><dd>This option is not very useful if <a class="el" href="config.html#cfg_hide_scope_names">HIDE_SCOPE_NAMES</a> is set to <code>YES</code>. </dd> +<dd> +This option applies only to the class list, not to the alphabetical list.</dd></dl> +<p>The default value is: <code>NO</code>.</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="aSTRICT_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>The default value is: <code>NO</code>.</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="aGENERATE_TODOLIST"></a> The <code>GENERATE_TODOLIST</code> tag can be used to enable (<code>YES</code>) or disable (<code>NO</code>) the todo list. This list is created by putting <a class="el" href="commands.html#cmdtodo">\todo</a> commands in the documentation.</p> +<p>The default value is: <code>YES</code>.</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="aGENERATE_TESTLIST"></a> The <code>GENERATE_TESTLIST</code> tag can be used to enable (<code>YES</code>) or disable (<code>NO</code>) the test list. This list is created by putting <a class="el" href="commands.html#cmdtest">\test</a> commands in the documentation.</p> +<p>The default value is: <code>YES</code>.</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="aGENERATE_BUGLIST"></a> The <code>GENERATE_BUGLIST</code> tag can be used to enable (<code>YES</code>) or disable (<code>NO</code>) the bug list. This list is created by putting <a class="el" href="commands.html#cmdbug">\bug</a> commands in the documentation.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_generate_deprecatedlist"></a></p> +</dd> +<dt><code>GENERATE_DEPRECATEDLIST</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_DEPRECATEDLIST"></a> The <code>GENERATE_DEPRECATEDLIST</code> tag can be used to enable (<code>YES</code>) or disable (<code>NO</code>) the deprecated list. This list is created by putting <a class="el" href="commands.html#cmddeprecated">\deprecated</a> commands in the documentation.</p> +<p>The default value is: <code>YES</code>.</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="aENABLED_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> <section_label> ... <a class="el" href="commands.html#cmdendif">\endif</a> and <a class="el" href="commands.html#cmdcond">\cond</a> <section_label> ... <a class="el" href="commands.html#cmdendcond">\endcond</a> blocks.</p> +<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="aMAX_INITIALIZER_LINES"></a> The <code>MAX_INITIALIZER_LINES</code> tag determines the maximum number of lines that the initial value of a variable or macro / define can have for it to appear in the documentation. 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 macros / 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 regardless of this setting.</p> +<p>Minimum value: <code>0</code>, maximum value: <code>10000</code>, default value: <code>30</code>.</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="aSHOW_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>The default value is: <code>YES</code>.</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="aSHOW_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).</p> +<p>The default value 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="aSHOW_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).</p> +<p>The default value 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="aFILE_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 <code>popen()</code>) 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.Example of using a shell script as a filter for Unix: </p><pre class="fragment"> FILE_VERSION_FILTER = "/bin/sh versionfilter.sh" +</pre><p> <br /> + 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> <br /> + 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> <br /> + 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"><a name="aLAYOUT_FILE"></a> 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 <code>-l</code> option. You can optionally specify a file name after the option, if omitted <code>DoxygenLayout.xml</code> will be used as the name of the layout file. <br /> +Note that if you run doxygen from a directory containing a file called <code>DoxygenLayout.xml</code>, 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="aCITE_BIB_FILES"></a> The <code>CITE_BIB_FILES</code> tag can be used to specify one or more <code>bib</code> files containing the reference definitions. This must be a list of <code>.bib</code> files. The <code>.bib</code> extension is automatically appended if omitted. This requires the <code>bibtex</code> 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 <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> the style of the bibliography can be controlled using <a class="el" href="config.html#cfg_latex_bib_style">LATEX_BIB_STYLE</a>. To use this feature you need <code>bibtex</code> and <code>perl</code> available in the search path. 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="config_messages"></a> +Configuration 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="aQUIET"></a> The <code>QUIET</code> tag can be used to turn on/off the messages that are generated to standard output by doxygen. If <code>QUIET</code> is set to <code>YES</code> this implies that the messages are off.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_warnings"></a></p> +</dd> +<dt><code>WARNINGS</code> </dt> +<dd><p class="startdd"><a name="aWARNINGS"></a> The <code>WARNINGS</code> tag can be used to turn on/off the warning messages that are generated to standard error (<code>stderr</code>) by doxygen. If <code>WARNINGS</code> is set to <code>YES</code> this implies that the warnings are on. <br /> + <b>Tip:</b> Turn warnings on while writing the documentation.</p> +<p>The default value is: <code>YES</code>.</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="aWARN_IF_UNDOCUMENTED"></a> If the <code>WARN_IF_UNDOCUMENTED</code> tag is set to <code>YES</code> then doxygen will generate warnings for undocumented members. If <a class="el" href="config.html#cfg_extract_all">EXTRACT_ALL</a> is set to <code>YES</code> then this flag will automatically be disabled.</p> +<p>The default value is: <code>YES</code>.</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="aWARN_IF_DOC_ERROR"></a> If the <code>WARN_IF_DOC_ERROR</code> tag 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>The default value is: <code>YES</code>.</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="aWARN_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>, doxygen will only warn about wrong or incomplete parameter documentation, but not about the absence of documentation.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_warn_as_error"></a></p> +</dd> +<dt><code>WARN_AS_ERROR</code> </dt> +<dd><p class="startdd"><a name="aWARN_AS_ERROR"></a> If the <code>WARN_AS_ERROR</code> tag is set to <code>YES</code> then doxygen will immediately stop when a warning is encountered.</p> +<p>The default value is: <code>NO</code>.</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="aWARN_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. Optionally the format may contain <code>$version</code>, which will be replaced by the version of the file (if it could be obtained via <a class="el" href="config.html#cfg_file_version_filter">FILE_VERSION_FILTER</a>)</p> +<p>The default value is: <code>$file:$line: $text</code>.</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="aWARN_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 standard error (<code>stderr</code>).</p> +<p class="enddd"></p> +</dd> +</dl> +<h1><a class="anchor" id="config_input"></a> +Configuration options related to the input files</h1> +<p><a class="anchor" id="cfg_input"></a></p><dl> +<dt><code>INPUT</code> </dt> +<dd><p class="startdd"><a name="aINPUT"></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. See also <a class="el" href="config.html#cfg_file_patterns">FILE_PATTERNS</a> and <a class="el" href="config.html#cfg_extension_mapping">EXTENSION_MAPPING</a></p> +<dl class="section note"><dt>Note</dt><dd>If this tag is empty the current directory is searched.</dd></dl> +<p><a class="anchor" id="cfg_input_encoding"></a></p> +</dd> +<dt><code>INPUT_ENCODING</code> </dt> +<dd><p class="startdd"><a name="aINPUT_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. Doxygen uses <code>libiconv</code> (or the <code>iconv</code> built into <code>libc</code>) for the transcoding. See <a href="http://www.gnu.org/software/libiconv">the libiconv documentation</a> for the list of possible encodings.</p> +<p>The default value is: <code>UTF-8</code>.</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="aFILE_PATTERNS"></a> If the value of the <a class="el" href="config.html#cfg_input">INPUT</a> tag contains directories, you can use the <code>FILE_PATTERNS</code> tag to specify one or more wildcard patterns (like <code>*.cpp</code> and <code>*.h</code>) to filter out the source-files in the directories.<br /> + Note that for custom extensions or not directly supported extensions you also need to set <a class="el" href="config.html#cfg_extension_mapping">EXTENSION_MAPPING</a> for the extension otherwise the files are not read by doxygen.<br /> + If left blank the following patterns are tested: <code>*.c</code>, <code>*.cc</code>, <code>*.cxx</code>, <code>*.cpp</code>, <code>*.c++</code>, <code>*.java</code>, <code>*.ii</code>, <code>*.ixx</code>, <code>*.ipp</code>, <code>*.i++</code>, <code>*.inl</code>, <code>*.idl</code>, <code>*.ddl</code>, <code>*.odl</code>, <code>*.h</code>, <code>*.hh</code>, <code>*.hxx</code>, <code>*.hpp</code>, <code>*.h++</code>, <code>*.cs</code>, <code>*.d</code>, <code>*.php</code>, <code>*.php4</code>, <code>*.php5</code>, <code>*.phtml</code>, <code>*.inc</code>, <code>*.m</code>, <code>*.markdown</code>, <code>*.md</code>, <code>*.mm</code>, <code>*.dox</code>, <code>*.py</code>, <code>*.pyw</code>, <code>*.f90</code>, <code>*.f95</code>, <code>*.f03</code>, <code>*.f08</code>, <code>*.f</code>, <code>*.for</code>, <code>*.tcl</code>, <code>*.vhd</code>, <code>*.vhdl</code>, <code>*.ucf</code> and <code>*.qsf</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="aRECURSIVE"></a> The <code>RECURSIVE</code> tag can be used to specify whether or not subdirectories should be searched for input files as well.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_exclude"></a></p> +</dd> +<dt><code>EXCLUDE</code> </dt> +<dd><p class="startdd"><a name="aEXCLUDE"></a> The <code>EXCLUDE</code> tag can be used to specify files and/or directories that should be excluded from the <a class="el" href="config.html#cfg_input">INPUT</a> source files. This way you can easily exclude a subdirectory from a directory tree whose root is specified with the <a class="el" href="config.html#cfg_input">INPUT</a> tag. <br /> +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="aEXCLUDE_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>The default value is: <code>NO</code>.</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="aEXCLUDE_PATTERNS"></a> If the value of the <a class="el" href="config.html#cfg_input">INPUT</a> 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. <br /> +Note that the wildcards are matched against the file with absolute path, so to exclude all test directories for example use the pattern <code>*</code><code>/test/</code><code>*</code></p> +<p class="enddd"><a class="anchor" id="cfg_exclude_symbols"></a></p> +</dd> +<dt><code>EXCLUDE_SYMBOLS</code> </dt> +<dd><p class="startdd"><a name="aEXCLUDE_SYMBOLS"></a> 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 <code>*</code> is used, a substring. Examples: <code>ANamespace</code>, <code>AClass</code>, <code>AClass::ANamespace</code>, <code>ANamespace::*Test</code> <br /> +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="aEXAMPLE_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 <a class="el" href="commands.html#cmdinclude">\include</a> command).</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="aEXAMPLE_PATTERNS"></a> If the value of the <a class="el" href="config.html#cfg_example_path">EXAMPLE_PATH</a> 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_example_recursive"></a></p> +</dd> +<dt><code>EXAMPLE_RECURSIVE</code> </dt> +<dd><p class="startdd"><a name="aEXAMPLE_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 <a class="el" href="commands.html#cmdinclude">\include</a> or <a class="el" href="commands.html#cmddontinclude">\dontinclude</a> commands irrespective of the value of the <a class="el" href="config.html#cfg_recursive">RECURSIVE</a> tag.</p> +<p>The default value is: <code>NO</code>.</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="aIMAGE_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="aINPUT_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 <code>popen()</code>) the command: <br /> + <code><filter> <input-file></code> <br /> + where <code><filter></code> is the value of the <code>INPUT_FILTER</code> tag, and <code><input-file></code> is the name of an input file. Doxygen will then use the output that the filter program writes to standard output. If <a class="el" href="config.html#cfg_filter_patterns">FILTER_PATTERNS</a> is specified, this tag will be ignored. <br /> +Note that the filter must not add or remove lines; it is applied before the code is scanned, but not when the output code is generated. If lines are added or removed, the anchors will not be placed correctly. <br /> +Note that for custom extensions or not directly supported extensions you also need to set <a class="el" href="config.html#cfg_extension_mapping">EXTENSION_MAPPING</a> for the extension otherwise the files are not properly processed by doxygen.<br /> +</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="aFILTER_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 <a class="el" href="config.html#cfg_input_filter">INPUT_FILTER</a> for further information on how filters are used. If the <code>FILTER_PATTERNS</code> tag is empty or if none of the patterns match the file name, <a class="el" href="config.html#cfg_input_filter">INPUT_FILTER</a> is applied. <br /> +Note that for custom extensions or not directly supported extensions you also need to set <a class="el" href="config.html#cfg_extension_mapping">EXTENSION_MAPPING</a> for the extension otherwise the files are not properly processed by doxygen.<br /> +</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="aFILTER_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 <a class="el" href="config.html#cfg_source_browser">SOURCE_BROWSER</a> is set to <code>YES</code>).</p> +<p>The default value is: <code>NO</code>.</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="aFILTER_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 <a class="el" href="config.html#cfg_filter_patterns">FILTER_PATTERN</a> (if any) and it is also possible to disable source filtering for a specific pattern using <code>*.ext=</code> (so without naming a filter).</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_filter_source_files">FILTER_SOURCE_FILES</a> is set to <code>YES</code>. <a class="anchor" id="cfg_use_mdfile_as_mainpage"></a></p> +</dd> +<dt><code>USE_MDFILE_AS_MAINPAGE</code> </dt> +<dd><p class="startdd"><a name="aUSE_MDFILE_AS_MAINPAGE"></a> If the <code>USE_MDFILE_AS_MAINPAGE</code> tag refers to the name of a markdown file that is part of the input, its contents will be placed on the main page (<code>index.html</code>). This can be useful if you have a project on for instance GitHub and want to reuse the introduction page also for the doxygen output.</p> +<p class="enddd"></p> +</dd> +</dl> +<h1><a class="anchor" id="config_source_browser"></a> +Configuration options related to source browsing</h1> +<p><a class="anchor" id="cfg_source_browser"></a></p><dl> +<dt><code>SOURCE_BROWSER</code> </dt> +<dd><p class="startdd"><a name="aSOURCE_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. <br /> +Note: To get rid of all source code in the generated output, make sure that also <a class="el" href="config.html#cfg_verbatim_headers">VERBATIM_HEADERS</a> is set to <code>NO</code>.</p> +<p>The default value is: <code>NO</code>.</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="aINLINE_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>The default value is: <code>NO</code>.</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="aSTRIP_CODE_COMMENTS"></a> Setting the <code>STRIP_CODE_COMMENTS</code> tag to <code>YES</code> will instruct doxygen to hide any special comment blocks from generated source code fragments. Normal C, C++ and Fortran comments will always remain visible.</p> +<p>The default value is: <code>YES</code>.</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="aREFERENCED_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>The default value is: <code>NO</code>.</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="aREFERENCES_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>The default value is: <code>NO</code>.</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="aREFERENCES_LINK_SOURCE"></a> If the <code>REFERENCES_LINK_SOURCE</code> tag is set to <code>YES</code> and <a class="el" href="config.html#cfg_source_browser">SOURCE_BROWSER</a> tag is set to <code>YES</code> then the hyperlinks from functions in <a class="el" href="config.html#cfg_references_relation">REFERENCES_RELATION</a> and <a class="el" href="config.html#cfg_referenced_by_relation">REFERENCED_BY_RELATION</a> lists will link to the source code. Otherwise they will link to the documentation.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_source_tooltips"></a></p> +</dd> +<dt><code>SOURCE_TOOLTIPS</code> </dt> +<dd><p class="startdd"><a name="aSOURCE_TOOLTIPS"></a> If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the source code will show a tooltip with additional information such as prototype, brief description and links to the definition and documentation. Since this will make the HTML file larger and loading of large files a bit slower, you can opt to disable this feature.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_source_browser">SOURCE_BROWSER</a> is set to <code>YES</code>. <a class="anchor" id="cfg_use_htags"></a></p> +</dd> +<dt><code>USE_HTAGS</code> </dt> +<dd><p class="startdd"><a name="aUSE_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 <code>htags(1)</code> tool instead of doxygen built-in source browser. The <code>htags</code> 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>). You will need version 4.8.6 or higher. <br /> + To use it do the following:</p><ol type="1"> +<li>Install the latest version of <code>global</code> </li> +<li>Enable <a class="el" href="config.html#cfg_source_browser">SOURCE_BROWSER</a> and <code>USE_HTAGS</code> in the config file</li> +<li>Make sure the <a class="el" href="config.html#cfg_input">INPUT</a> points to the root of the source tree</li> +<li>Run <code>doxygen</code> as normal <br /> + Doxygen will invoke <code>htags</code> (and that will in turn invoke <code>gtags</code>), so these tools must be available from the command line (i.e. in the search path). <br /> + The result: instead of the source browser generated by doxygen, the links to source code will now point to the output of <code>htags</code>.</li> +</ol> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_source_browser">SOURCE_BROWSER</a> is set to <code>YES</code>. <a class="anchor" id="cfg_verbatim_headers"></a></p> +</dd> +<dt><code>VERBATIM_HEADERS</code> </dt> +<dd><p class="startdd"><a name="aVERBATIM_HEADERS"></a> If the <code>VERBATIM_HEADERS</code> tag is set the <code>YES</code> then doxygen will generate a verbatim copy of the header file for each class for which an include is specified. Set to <code>NO</code> to disable this. </p><dl class="section see"><dt>See also</dt><dd>Section <a class="el" href="commands.html#cmdclass">\class</a>.</dd></dl> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_clang_assisted_parsing"></a></p> +</dd> +<dt><code>CLANG_ASSISTED_PARSING</code> </dt> +<dd><p class="startdd"><a name="aCLANG_ASSISTED_PARSING"></a> If the <code>CLANG_ASSISTED_PARSING</code> tag is set to <code>YES</code> then doxygen will use the <a href="http://clang.llvm.org/">clang parser</a> for more accurate parsing at the cost of reduced performance. This can be particularly helpful with template rich C++ code for which doxygen's built-in parser lacks the necessary type information.</p> +<dl class="section note"><dt>Note</dt><dd>The availability of this option depends on whether or not doxygen was generated with the <code>-Duse-libclang=ON</code> option for CMake.</dd></dl> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_clang_options"></a></p> +</dd> +<dt><code>CLANG_OPTIONS</code> </dt> +<dd><p class="startdd"><a name="aCLANG_OPTIONS"></a> If clang assisted parsing is enabled you can provide the compiler with command line options that you would normally use when invoking the compiler. Note that the include paths will already be set by doxygen for the files and directories specified with <a class="el" href="config.html#cfg_input">INPUT</a> and <a class="el" href="config.html#cfg_include_path">INCLUDE_PATH</a>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_clang_assisted_parsing">CLANG_ASSISTED_PARSING</a> is set to <code>YES</code>. </p> +</dd> +</dl> +<h1><a class="anchor" id="config_index"></a> +Configuration options related to the alphabetical class index</h1> +<p><a class="anchor" id="cfg_alphabetical_index"></a></p><dl> +<dt><code>ALPHABETICAL_INDEX</code> </dt> +<dd><p class="startdd"><a name="aALPHABETICAL_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>The default value is: <code>YES</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_cols_in_alpha_index"></a></p> +</dd> +<dt><code>COLS_IN_ALPHA_INDEX</code> </dt> +<dd><p class="startdd"><a name="aCOLS_IN_ALPHA_INDEX"></a> The <code>COLS_IN_ALPHA_INDEX</code> tag can be used to specify the number of columns in which the alphabetical index list will be split.</p> +<p>Minimum value: <code>1</code>, maximum value: <code>20</code>, default value: <code>5</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_alphabetical_index">ALPHABETICAL_INDEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_ignore_prefix"></a></p> +</dd> +<dt><code>IGNORE_PREFIX</code> </dt> +<dd><p class="startdd"><a name="aIGNORE_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">This tag requires that the tag <a class="el" href="config.html#cfg_alphabetical_index">ALPHABETICAL_INDEX</a> is set to <code>YES</code>. </p> +</dd> +</dl> +<h1><a class="anchor" id="config_html"></a> +Configuration options related to the HTML output</h1> +<p><a class="anchor" id="cfg_generate_html"></a></p><dl> +<dt><code>GENERATE_HTML</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_HTML"></a> If the <code>GENERATE_HTML</code> tag is set to <code>YES</code>, doxygen will generate HTML output</p> +<p>The default value is: <code>YES</code>.</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="aHTML_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 <a class="el" href="config.html#cfg_output_directory">OUTPUT_DIRECTORY</a> will be put in front of it.</p> +<p>The default directory is: <code>html</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_html_file_extension"></a></p> +</dd> +<dt><code>HTML_FILE_EXTENSION</code> </dt> +<dd><p class="startdd"><a name="aHTML_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: <code>.htm, .php, .asp</code>).</p> +<p>The default value is: <code>.html</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_html_header"></a></p> +</dd> +<dt><code>HTML_HEADER</code> </dt> +<dd><p class="startdd"><a name="aHTML_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. <br /> + To get valid HTML the header file that includes any scripts and style sheets that doxygen needs, which is dependent on the configuration options used (e.g. the setting <a class="el" href="config.html#cfg_generate_treeview">GENERATE_TREEVIEW</a>). 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>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. The following markers have a special meaning inside the header and footer: <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 <a class="el" href="config.html#cfg_create_subdirs">CREATE_SUBDIRS</a> 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 <code>$relpath^doxygen.css</code>, to refer to the standard style sheet. </dd> +</dl> +</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"> <!--BEGIN BLOCKNAME--> + Some context copied when condition BLOCKNAME holds + <!--END BLOCKNAME--> + <!--BEGIN !BLOCKNAME--> + Some context copied when condition BLOCKNAME does not hold + <!--END !BLOCKNAME--> +</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 class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_html_footer"></a></p> +</dd> +<dt><code>HTML_FOOTER</code> </dt> +<dd><p class="startdd"><a name="aHTML_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">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_html_stylesheet"></a></p> +</dd> +<dt><code>HTML_STYLESHEET</code> </dt> +<dd><p class="startdd"><a name="aHTML_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 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> +<dl class="section note"><dt>Note</dt><dd>It is recommended to use <a class="el" href="config.html#cfg_html_extra_stylesheet">HTML_EXTRA_STYLESHEET</a> instead of this tag, as it is more robust and this tag (<code>HTML_STYLESHEET</code>) will in the future become obsolete.</dd></dl> +<p>This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_html_extra_stylesheet"></a></p> +</dd> +<dt><code>HTML_EXTRA_STYLESHEET</code> </dt> +<dd><a name="aHTML_EXTRA_STYLESHEET"></a> The <code>HTML_EXTRA_STYLESHEET</code> tag can be used to specify additional user-defined cascading style sheets that are included after the standard style sheets created by doxygen. Using this option one can overrule certain style aspects. This is preferred over using <a class="el" href="config.html#cfg_html_stylesheet">HTML_STYLESHEET</a> since it does not replace the standard style sheet and is therefore more robust against future updates. Doxygen will copy the style sheet files to the output directory. <dl class="section note"><dt>Note</dt><dd>The order of the extra style sheet files is of importance (e.g. the last style sheet in the list overrules the setting of the previous ones in the list). Here is an example style sheet that gives the contents area a fixed width: <pre class="fragment">body { + background-color: #CCC; + color: black; + margin: 0; +} + +div.contents { + margin-bottom: 10px; + padding: 12px; + margin-left: auto; + margin-right: auto; + width: 960px; + background-color: white; + border-radius: 8px; +} + +#titlearea { + background-color: white; +} + +hr.footer { + display: none; +} + +.footer { + background-color: #AAA; +} +</pre></dd></dl> +This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_html_extra_files"></a></dd> +<dt><code>HTML_EXTRA_FILES</code> </dt> +<dd><p class="startdd"><a name="aHTML_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 <code>$relpath^</code> marker in the <a class="el" href="config.html#cfg_html_header">HTML_HEADER</a> and/or <a class="el" href="config.html#cfg_html_footer">HTML_FOOTER</a> files to load these files. In the <a class="el" href="config.html#cfg_html_stylesheet">HTML_STYLESHEET</a> 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">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_html_colorstyle_hue"></a></p> +</dd> +<dt><code>HTML_COLORSTYLE_HUE</code> </dt> +<dd><p class="startdd"><a name="aHTML_COLORSTYLE_HUE"></a> The <code>HTML_COLORSTYLE_HUE</code> tag controls the color of the HTML output. Doxygen will adjust the colors in the style sheet 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.</p> +<p>Minimum value: <code>0</code>, maximum value: <code>359</code>, default value: <code>220</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_html_colorstyle_sat"></a></p> +</dd> +<dt><code>HTML_COLORSTYLE_SAT</code> </dt> +<dd><p class="startdd"><a name="aHTML_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>Minimum value: <code>0</code>, maximum value: <code>255</code>, default value: <code>100</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_html_colorstyle_gamma"></a></p> +</dd> +<dt><code>HTML_COLORSTYLE_GAMMA</code> </dt> +<dd><p class="startdd"><a name="aHTML_COLORSTYLE_GAMMA"></a> 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>Minimum value: <code>40</code>, maximum value: <code>240</code>, default value: <code>80</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_html_timestamp"></a></p> +</dd> +<dt><code>HTML_TIMESTAMP</code> </dt> +<dd><p class="startdd"><a name="aHTML_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 <code>YES</code> can help to show when doxygen was last run and thus if the documentation is up to date.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_html_dynamic_sections"></a></p> +</dd> +<dt><code>HTML_DYNAMIC_SECTIONS</code> </dt> +<dd><p class="startdd"><a name="aHTML_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>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_html_index_num_entries"></a></p> +</dd> +<dt><code>HTML_INDEX_NUM_ENTRIES</code> </dt> +<dd><p class="startdd"><a name="aHTML_INDEX_NUM_ENTRIES"></a> With <code>HTML_INDEX_NUM_ENTRIES</code> 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>Minimum value: <code>0</code>, maximum value: <code>9999</code>, default value: <code>100</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_generate_docset"></a></p> +</dd> +<dt><code>GENERATE_DOCSET</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_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">http://developer.apple.com/tools/creatingdocsetswithdoxygen.html</a> for more information.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_docset_feedname"></a></p> +</dd> +<dt><code>DOCSET_FEEDNAME</code> </dt> +<dd><p class="startdd"><a name="aDOCSET_FEEDNAME"></a> This tag determines the name of the docset 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>The default value is: <code>Doxygen generated docs</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_docset">GENERATE_DOCSET</a> is set to <code>YES</code>. <a class="anchor" id="cfg_docset_bundle_id"></a></p> +</dd> +<dt><code>DOCSET_BUNDLE_ID</code> </dt> +<dd><p class="startdd"><a name="aDOCSET_BUNDLE_ID"></a> 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>The default value is: <code>org.doxygen.Project</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_docset">GENERATE_DOCSET</a> is set to <code>YES</code>. <a class="anchor" id="cfg_docset_publisher_id"></a></p> +</dd> +<dt><code>DOCSET_PUBLISHER_ID</code> </dt> +<dd><p class="startdd"><a name="aDOCSET_PUBLISHER_ID"></a> The <code>DOCSET_PUBLISHER_ID</code> tag specifies a string that should uniquely identify the documentation publisher. This should be a reverse domain-name style string, e.g. <code>com.mycompany.MyDocSet.documentation</code>.</p> +<p>The default value is: <code>org.doxygen.Publisher</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_docset">GENERATE_DOCSET</a> is set to <code>YES</code>. <a class="anchor" id="cfg_docset_publisher_name"></a></p> +</dd> +<dt><code>DOCSET_PUBLISHER_NAME</code> </dt> +<dd><p class="startdd"><a name="aDOCSET_PUBLISHER_NAME"></a> The <code>DOCSET_PUBLISHER_NAME</code> tag identifies the documentation publisher.</p> +<p>The default value is: <code>Publisher</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_docset">GENERATE_DOCSET</a> is set to <code>YES</code>. <a class="anchor" id="cfg_generate_htmlhelp"></a></p> +</dd> +<dt><code>GENERATE_HTMLHELP</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_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://www.microsoft.com/en-us/download/details.aspx?id=21138">Microsoft's HTML Help Workshop</a> on Windows. <br /> + The HTML Help Workshop contains a compiler that can convert all HTML output generated by doxygen into a single compiled HTML file (<code>.chm</code>). Compiled HTML files are now used as the Windows 98 help format, and will replace the old Windows help format (<code>.hlp</code>) 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>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_chm_file"></a></p> +</dd> +<dt><code>CHM_FILE</code> </dt> +<dd><p class="startdd"><a name="aCHM_FILE"></a> The <code>CHM_FILE</code> tag can be used to specify the file name of the resulting <code>.chm</code> 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">This tag requires that the tag <a class="el" href="config.html#cfg_generate_htmlhelp">GENERATE_HTMLHELP</a> is set to <code>YES</code>. <a class="anchor" id="cfg_hhc_location"></a></p> +</dd> +<dt><code>HHC_LOCATION</code> </dt> +<dd><p class="startdd"><a name="aHHC_LOCATION"></a> The <code>HHC_LOCATION</code> tag can be used to specify the location (absolute path including file name) of the HTML help compiler (<code>hhc.exe</code>). If non-empty, doxygen will try to run the HTML help compiler on the generated <code>index.hhp</code>.</p> +<p>The file has to be specified with full path.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_htmlhelp">GENERATE_HTMLHELP</a> is set to <code>YES</code>. <a class="anchor" id="cfg_generate_chi"></a></p> +</dd> +<dt><code>GENERATE_CHI</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_CHI"></a> The <code>GENERATE_CHI</code> flag controls if a separate <code>.chi</code> index file is generated (<code>YES</code>) or that it should be included in the master <code>.chm</code> file (<code>NO</code>).</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_htmlhelp">GENERATE_HTMLHELP</a> is set to <code>YES</code>. <a class="anchor" id="cfg_chm_index_encoding"></a></p> +</dd> +<dt><code>CHM_INDEX_ENCODING</code> </dt> +<dd><p class="startdd"><a name="aCHM_INDEX_ENCODING"></a> The <code>CHM_INDEX_ENCODING</code> is used to encode HtmlHelp index (<code>hhk</code>), content (<code>hhc</code>) and project file content.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_htmlhelp">GENERATE_HTMLHELP</a> is set to <code>YES</code>. <a class="anchor" id="cfg_binary_toc"></a></p> +</dd> +<dt><code>BINARY_TOC</code> </dt> +<dd><p class="startdd"><a name="aBINARY_TOC"></a> 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 <code>.chm</code> file. Furthermore it enables the <code>Previous</code> and <code>Next</code> buttons.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_htmlhelp">GENERATE_HTMLHELP</a> is set to <code>YES</code>. <a class="anchor" id="cfg_toc_expand"></a></p> +</dd> +<dt><code>TOC_EXPAND</code> </dt> +<dd><p class="startdd"><a name="aTOC_EXPAND"></a> The <code>TOC_EXPAND</code> flag can be set to <code>YES</code> to add extra items for group members to the table of contents of the HTML help documentation and to the tree view.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_htmlhelp">GENERATE_HTMLHELP</a> is set to <code>YES</code>. <a class="anchor" id="cfg_generate_qhp"></a></p> +</dd> +<dt><code>GENERATE_QHP</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_QHP"></a> If the <code>GENERATE_QHP</code> tag is set to <code>YES</code> and both <a class="el" href="config.html#cfg_qhp_namespace">QHP_NAMESPACE</a> and <a class="el" href="config.html#cfg_qhp_virtual_folder">QHP_VIRTUAL_FOLDER</a> 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 (<code>.qch</code>) of the generated HTML documentation.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_qch_file"></a></p> +</dd> +<dt><code>QCH_FILE</code> </dt> +<dd><p class="startdd"><a name="aQCH_FILE"></a> If the <a class="el" href="config.html#cfg_qhg_location">QHG_LOCATION</a> tag is specified, the <code>QCH_FILE</code> tag can be used to specify the file name of the resulting <code>.qch</code> file. The path specified is relative to the HTML output folder.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_qhp">GENERATE_QHP</a> is set to <code>YES</code>. <a class="anchor" id="cfg_qhp_namespace"></a></p> +</dd> +<dt><code>QHP_NAMESPACE</code> </dt> +<dd><p class="startdd"><a name="aQHP_NAMESPACE"></a> The <code>QHP_NAMESPACE</code> tag specifies the namespace to use when generating Qt Help Project output. For more information please see <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.</p> +<p>The default value is: <code>org.doxygen.Project</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_qhp">GENERATE_QHP</a> is set to <code>YES</code>. <a class="anchor" id="cfg_qhp_virtual_folder"></a></p> +</dd> +<dt><code>QHP_VIRTUAL_FOLDER</code> </dt> +<dd><p class="startdd"><a name="aQHP_VIRTUAL_FOLDER"></a> The <code>QHP_VIRTUAL_FOLDER</code> tag specifies the namespace to use when generating Qt Help Project output. For more information please see <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.</p> +<p>The default value is: <code>doc</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_qhp">GENERATE_QHP</a> is set to <code>YES</code>. <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="aQHP_CUST_FILTER_NAME"></a> If the <code>QHP_CUST_FILTER_NAME</code> tag is set, it specifies the name of a custom filter to add. For more information please see <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_qhp">GENERATE_QHP</a> is set to <code>YES</code>. <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="aQHP_CUST_FILTER_ATTRS"></a> The <code>QHP_CUST_FILTER_ATTRS</code> tag specifies the list of the attributes of the custom filter to add. For more information please see <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_qhp">GENERATE_QHP</a> is set to <code>YES</code>. <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="aQHP_SECT_FILTER_ATTRS"></a> The <code>QHP_SECT_FILTER_ATTRS</code> tag specifies the list of the attributes this project's filter section matches. <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_qhp">GENERATE_QHP</a> is set to <code>YES</code>. <a class="anchor" id="cfg_qhg_location"></a></p> +</dd> +<dt><code>QHG_LOCATION</code> </dt> +<dd><p class="startdd"><a name="aQHG_LOCATION"></a> The <code>QHG_LOCATION</code> tag can be used to specify the location of Qt's qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the generated <code>.qhp</code> file.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_qhp">GENERATE_QHP</a> is set to <code>YES</code>. <a class="anchor" id="cfg_generate_eclipsehelp"></a></p> +</dd> +<dt><code>GENERATE_ECLIPSEHELP</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_ECLIPSEHELP"></a> If the <code>GENERATE_ECLIPSEHELP</code> tag is set to <code>YES</code>, additional index files will be generated, together with the HTML files, they form an <code>Eclipse</code> help plugin.</p> +<p>To install this plugin and make it available under the help contents menu in <code>Eclipse</code>, 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 <code>Eclipse</code> needs to be restarted before the help appears.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_eclipse_doc_id"></a></p> +</dd> +<dt><code>ECLIPSE_DOC_ID</code> </dt> +<dd><p class="startdd"><a name="aECLIPSE_DOC_ID"></a> A unique identifier for the <code>Eclipse</code> 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>The default value is: <code>org.doxygen.Project</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_eclipsehelp">GENERATE_ECLIPSEHELP</a> is set to <code>YES</code>. <a class="anchor" id="cfg_disable_index"></a></p> +</dd> +<dt><code>DISABLE_INDEX</code> </dt> +<dd><p class="startdd"><a name="aDISABLE_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 (tabs) at top of each HTML page. A value of <code>NO</code> enables the index and the value <code>YES</code> disables it. Since the tabs in the index contain the same information as the navigation tree, you can set this option to <code>YES</code> if you also set <a class="el" href="config.html#cfg_generate_treeview">GENERATE_TREEVIEW</a> to <code>YES</code>.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_generate_treeview"></a></p> +</dd> +<dt><code>GENERATE_TREEVIEW</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_TREEVIEW"></a> The <code>GENERATE_TREEVIEW</code> 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 <code>YES</code>, 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 style sheets (see <a class="el" href="config.html#cfg_html_extra_stylesheet">HTML_EXTRA_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>Since the tree basically has the same information as the tab index, you could consider setting <a class="el" href="config.html#cfg_disable_index">DISABLE_INDEX</a> to <code>YES</code> when enabling this option.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <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="aENUM_VALUES_PER_LINE"></a> The <code>ENUM_VALUES_PER_LINE</code> tag can be used to set the number of enum values that doxygen will group on one line in the generated HTML documentation. <br /> +Note that a value of 0 will completely suppress the enum values from appearing in the overview section.</p> +<p>Minimum value: <code>0</code>, maximum value: <code>20</code>, default value: <code>4</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_treeview_width"></a></p> +</dd> +<dt><code>TREEVIEW_WIDTH</code> </dt> +<dd><p class="startdd"><a name="aTREEVIEW_WIDTH"></a> If the treeview is enabled (see <a class="el" href="config.html#cfg_generate_treeview">GENERATE_TREEVIEW</a>) then this tag can be used to set the initial width (in pixels) of the frame in which the tree is shown.</p> +<p>Minimum value: <code>0</code>, maximum value: <code>1500</code>, default value: <code>250</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <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="aEXT_LINKS_IN_WINDOW"></a> If 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>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_formula_fontsize"></a></p> +</dd> +<dt><code>FORMULA_FONTSIZE</code> </dt> +<dd><p class="startdd"><a name="aFORMULA_FONTSIZE"></a> Use this tag to change the font size of <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> formulas included as images in the HTML documentation. 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>Minimum value: <code>8</code>, maximum value: <code>50</code>, default value: <code>10</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_formula_transparent"></a></p> +</dd> +<dt><code>FORMULA_TRANSPARENT</code> </dt> +<dd><p class="startdd"><a name="aFORMULA_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. <br /> +Note that when changing this option you need to delete any <code>form_*.png</code> files in the HTML output directory before the changes have effect.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_use_mathjax"></a></p> +</dd> +<dt><code>USE_MATHJAX</code> </dt> +<dd><p class="startdd"><a name="aUSE_MATHJAX"></a> Enable the <code>USE_MATHJAX</code> option to render <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> 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 pre-rendered bitmaps. Use this if you do not have <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> 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>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_mathjax_format"></a></p> +</dd> +<dt><code>MATHJAX_FORMAT</code> </dt> +<dd><p class="startdd"><a name="aMATHJAX_FORMAT"></a> When MathJax is enabled you can set the default output format to be used for the MathJax output. See <a href="http://docs.mathjax.org/en/latest/output.html">the MathJax site</a> for more details.</p> +<p>Possible values are: <code>HTML-CSS</code> (which is slower, but has the best compatibility), <code>NativeMML</code> (i.e. MathML) and <code>SVG</code>.</p> +<p>The default value is: <code>HTML-CSS</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_use_mathjax">USE_MATHJAX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_mathjax_relpath"></a></p> +</dd> +<dt><code>MATHJAX_RELPATH</code> </dt> +<dd><p class="startdd"><a name="aMATHJAX_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 <code>MathJax.js</code> script. For instance, if the <code>mathjax</code> 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>The default value is: <code><a href="http://cdn.mathjax.org/mathjax/latest">http://cdn.mathjax.org/mathjax/latest</a></code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_use_mathjax">USE_MATHJAX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_mathjax_extensions"></a></p> +</dd> +<dt><code>MATHJAX_EXTENSIONS</code> </dt> +<dd><p class="startdd"><a name="aMATHJAX_EXTENSIONS"></a> The <code>MATHJAX_EXTENSIONS</code> tag can be used to specify one or more 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">This tag requires that the tag <a class="el" href="config.html#cfg_use_mathjax">USE_MATHJAX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_mathjax_codefile"></a></p> +</dd> +<dt><code>MATHJAX_CODEFILE</code> </dt> +<dd><p class="startdd"><a name="aMATHJAX_CODEFILE"></a> The <code>MATHJAX_CODEFILE</code> tag can be used to specify a file with javascript pieces of code that will be used on startup of the MathJax code. See <a href="http://docs.mathjax.org/en/latest/output.html">the MathJax site</a> for more details. As an example to disable the "Math Renderer" menu item in the "Math + Settings" menu of MathJax: </p><pre class="fragment">MATHJAX_CODEFILE = disableRenderer.js +</pre><p> with in the file <code>disableRenderer.js</code>: </p><pre class="fragment"> MathJax.Hub.Config({ + menuSettings: { + showRenderer: false, + } + }); +</pre><p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_use_mathjax">USE_MATHJAX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_searchengine"></a></p> +</dd> +<dt><code>SEARCHENGINE</code> </dt> +<dd><p class="startdd"><a name="aSEARCHENGINE"></a> 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 <code><access key> + S</code> (what the <code><access key></code> is depends on the OS and browser, but it is typically <code><CTRL></code>, <code><ALT></code>/<code><option></code>, or both). Inside the search box use the <code><cursor down key></code> to jump into the search results window, the results can be navigated using the <code><cursor keys></code>. Press <code><Enter></code> to select an item or <code><escape></code> to cancel the search. The filter options can be selected when the cursor is inside the search box by pressing <code><Shift>+<cursor down></code>. Also here use the <code><cursor keys></code> to select a filter and <code><Enter></code> or <code><escape></code> to activate or cancel the filter option.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_html">GENERATE_HTML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_server_based_search"></a></p> +</dd> +<dt><code>SERVER_BASED_SEARCH</code> </dt> +<dd><p class="startdd"><a name="aSERVER_BASED_SEARCH"></a> When the <code>SERVER_BASED_SEARCH</code> tag is enabled the search engine will be implemented using a web server instead of a web client using Javascript.</p> +<p>There are two flavors of web server based searching depending on the <a class="el" href="config.html#cfg_external_search">EXTERNAL_SEARCH</a> setting. When disabled, doxygen will generate a PHP script for searching and an index file used by the script. When <a class="el" href="config.html#cfg_external_search">EXTERNAL_SEARCH</a> is enabled the indexing and searching needs to be provided by external tools. See the section <a class="el" href="extsearch.html">External Indexing and Searching</a> for details.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_searchengine">SEARCHENGINE</a> is set to <code>YES</code>. <a class="anchor" id="cfg_external_search"></a></p> +</dd> +<dt><code>EXTERNAL_SEARCH</code> </dt> +<dd><p class="startdd"><a name="aEXTERNAL_SEARCH"></a> When <code>EXTERNAL_SEARCH</code> tag is enabled doxygen will no longer generate the PHP script for searching. Instead the search results are written to an XML file which needs to be processed by an external indexer. Doxygen will invoke an external search engine pointed to by the <a class="el" href="config.html#cfg_searchengine_url">SEARCHENGINE_URL</a> option to obtain the search results. <br /> +Doxygen ships with an example indexer (<code>doxyindexer</code>) and search engine (<code>doxysearch.cgi</code>) which are based on the open source search engine library <a href="http://xapian.org/">Xapian</a>. <br /> +See the section <a class="el" href="extsearch.html">External Indexing and Searching</a> for details.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_searchengine">SEARCHENGINE</a> is set to <code>YES</code>. <a class="anchor" id="cfg_searchengine_url"></a></p> +</dd> +<dt><code>SEARCHENGINE_URL</code> </dt> +<dd><p class="startdd"><a name="aSEARCHENGINE_URL"></a> The <code>SEARCHENGINE_URL</code> should point to a search engine hosted by a web server which will return the search results when <a class="el" href="config.html#cfg_external_search">EXTERNAL_SEARCH</a> is enabled. <br /> +Doxygen ships with an example indexer (<code>doxyindexer</code>) and search engine (<code>doxysearch.cgi</code>) which are based on the open source search engine library <a href="http://xapian.org/">Xapian</a>. See the section <a class="el" href="extsearch.html">External Indexing and Searching</a> for details.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_searchengine">SEARCHENGINE</a> is set to <code>YES</code>. <a class="anchor" id="cfg_searchdata_file"></a></p> +</dd> +<dt><code>SEARCHDATA_FILE</code> </dt> +<dd><p class="startdd"><a name="aSEARCHDATA_FILE"></a> When <a class="el" href="config.html#cfg_server_based_search">SERVER_BASED_SEARCH</a> and <a class="el" href="config.html#cfg_external_search">EXTERNAL_SEARCH</a> are both enabled the unindexed search data is written to a file for indexing by an external tool. With the <code>SEARCHDATA_FILE</code> tag the name of this file can be specified.</p> +<p>The default file is: <code>searchdata.xml</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_searchengine">SEARCHENGINE</a> is set to <code>YES</code>. <a class="anchor" id="cfg_external_search_id"></a></p> +</dd> +<dt><code>EXTERNAL_SEARCH_ID</code> </dt> +<dd><p class="startdd"><a name="aEXTERNAL_SEARCH_ID"></a> When <a class="el" href="config.html#cfg_server_based_search">SERVER_BASED_SEARCH</a> and <a class="el" href="config.html#cfg_external_search">EXTERNAL_SEARCH</a> are both enabled the <code>EXTERNAL_SEARCH_ID</code> tag can be used as an identifier for the project. This is useful in combination with <a class="el" href="config.html#cfg_extra_search_mappings">EXTRA_SEARCH_MAPPINGS</a> to search through multiple projects and redirect the results back to the right project.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_searchengine">SEARCHENGINE</a> is set to <code>YES</code>. <a class="anchor" id="cfg_extra_search_mappings"></a></p> +</dd> +<dt><code>EXTRA_SEARCH_MAPPINGS</code> </dt> +<dd><p class="startdd"><a name="aEXTRA_SEARCH_MAPPINGS"></a> The <code>EXTRA_SEARCH_MAPPINGS</code> tag can be used to enable searching through doxygen projects other than the one defined by this configuration file, but that are all added to the same external search index. Each project needs to have a unique id set via <a class="el" href="config.html#cfg_external_search_id">EXTERNAL_SEARCH_ID</a>. The search mapping then maps the id of to a relative location where the documentation can be found.</p> +<p>The format is: </p><pre class="fragment">EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... +</pre><p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_searchengine">SEARCHENGINE</a> is set to <code>YES</code>. </p> +</dd> +</dl> +<h1><a class="anchor" id="config_latex"></a> +Configuration options related to the LaTeX output</h1> +<p><a class="anchor" id="cfg_generate_latex"></a></p><dl> +<dt><code>GENERATE_LATEX</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_LATEX"></a> If the <code>GENERATE_LATEX</code> tag is set to <code>YES</code>, doxygen will generate <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> output.</p> +<p>The default value is: <code>YES</code>.</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="aLATEX_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 <a class="el" href="config.html#cfg_output_directory">OUTPUT_DIRECTORY</a> will be put in front of it.</p> +<p>The default directory is: <code>latex</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_latex_cmd_name"></a></p> +</dd> +<dt><code>LATEX_CMD_NAME</code> </dt> +<dd><p class="startdd"><a name="aLATEX_CMD_NAME"></a> The <code>LATEX_CMD_NAME</code> tag can be used to specify the <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> command name to be invoked. <br /> +Note that when enabling <a class="el" href="config.html#cfg_use_pdflatex">USE_PDFLATEX</a> this option is only used for generating bitmaps for formulas in the HTML output, but not in the <code>Makefile</code> that is written to the output directory.</p> +<p>The default file is: <code>latex</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_makeindex_cmd_name"></a></p> +</dd> +<dt><code>MAKEINDEX_CMD_NAME</code> </dt> +<dd><p class="startdd"><a name="aMAKEINDEX_CMD_NAME"></a> The <code>MAKEINDEX_CMD_NAME</code> tag can be used to specify the command name to generate index for <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/>.</p> +<p>The default file is: <code>makeindex</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_compact_latex"></a></p> +</dd> +<dt><code>COMPACT_LATEX</code> </dt> +<dd><p class="startdd"><a name="aCOMPACT_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>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_paper_type"></a></p> +</dd> +<dt><code>PAPER_TYPE</code> </dt> +<dd><p class="startdd"><a name="aPAPER_TYPE"></a> The <code>PAPER_TYPE</code> tag can be used to set the paper type that is used by the printer.</p> +<p>Possible values are: <code>a4</code> (210 x 297 mm), <code>letter</code> (8.5 x 11 inches), <code>legal</code> (8.5 x 14 inches) and <code>executive</code> (7.25 x 10.5 inches).</p> +<p>The default value is: <code>a4</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_extra_packages"></a></p> +</dd> +<dt><code>EXTRA_PACKAGES</code> </dt> +<dd><p class="startdd"><a name="aEXTRA_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. The package can be specified just by its name or with the correct syntax as to be used with the <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> <code>\usepackage</code> command.</p> +<p>To get the <code>times</code> font for instance you can specify : </p><pre class="fragment"> EXTRA_PACKAGES=times +or + EXTRA_PACKAGES={times} +</pre><p> To use the option <code>intlimits</code> with the <code>amsmath</code> package you can specify: </p><pre class="fragment"> EXTRA_PACKAGES=[intlimits]{amsmath} +</pre><p> If left blank no extra packages will be included.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_latex_header"></a></p> +</dd> +<dt><code>LATEX_HEADER</code> </dt> +<dd><p class="startdd"><a name="aLATEX_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> +<p><br /> +Note: Only use a user-defined header if you know what you are doing!</p> +<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>, <code>$projectbrief</code>, <code>$projectlogo</code>. Doxygen will replace <code>$title</code> with the empty string, for the replacement values of the other commands the user is referred to <a class="el" href="config.html#cfg_html_header">HTML_HEADER</a>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_latex_footer"></a></p> +</dd> +<dt><code>LATEX_FOOTER</code> </dt> +<dd><p class="startdd"><a name="aLATEX_FOOTER"></a> The <code>LATEX_FOOTER</code> tag can be used to specify a personal <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> footer for the generated <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> document. The footer should contain everything after the last chapter. If it is left blank doxygen will generate a standard footer. See <a class="el" href="config.html#cfg_latex_header">LATEX_HEADER</a> for more information on how to generate a default footer and what special commands can be used inside the footer.</p> +<p><br /> +Note: Only use a user-defined footer if you know what you are doing!</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_latex_extra_stylesheet"></a></p> +</dd> +<dt><code>LATEX_EXTRA_STYLESHEET</code> </dt> +<dd><a name="aLATEX_EXTRA_STYLESHEET"></a> The <code>LATEX_EXTRA_STYLESHEET</code> tag can be used to specify additional user-defined <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> style sheets that are included after the standard style sheets created by doxygen. Using this option one can overrule certain style aspects. Doxygen will copy the style sheet files to the output directory. <dl class="section note"><dt>Note</dt><dd>The order of the extra style sheet files is of importance (e.g. the last style sheet in the list overrules the setting of the previous ones in the list).</dd></dl> +This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_latex_extra_files"></a></dd> +<dt><code>LATEX_EXTRA_FILES</code> </dt> +<dd><p class="startdd"><a name="aLATEX_EXTRA_FILES"></a> The <code>LATEX_EXTRA_FILES</code> tag can be used to specify one or more extra images or other source files which should be copied to the <a class="el" href="config.html#cfg_latex_output">LATEX_OUTPUT</a> output directory. Note that the files will be copied as-is; there are no commands or markers available.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_pdf_hyperlinks"></a></p> +</dd> +<dt><code>PDF_HYPERLINKS</code> </dt> +<dd><p class="startdd"><a name="aPDF_HYPERLINKS"></a> 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 <code>ps2pdf</code> or <code>pdflatex</code>). 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>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_use_pdflatex"></a></p> +</dd> +<dt><code>USE_PDFLATEX</code> </dt> +<dd><p class="startdd"><a name="aUSE_PDFLATEX"></a> If the <code>USE_PDFLATEX</code> tag is set to <code>YES</code>, doxygen will use <code>pdflatex</code> to generate the PDF file directly from the <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> files. Set this option to <code>YES</code>, to get a higher quality PDF documentation.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_latex_batchmode"></a></p> +</dd> +<dt><code>LATEX_BATCHMODE</code> </dt> +<dd><p class="startdd"><a name="aLATEX_BATCHMODE"></a> If the <code>LATEX_BATCHMODE</code> tag is set to <code>YES</code>, doxygen will add the <code>\batchmode</code> 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>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_latex_hide_indices"></a></p> +</dd> +<dt><code>LATEX_HIDE_INDICES</code> </dt> +<dd><p class="startdd"><a name="aLATEX_HIDE_INDICES"></a> If the <code>LATEX_HIDE_INDICES</code> tag 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>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_latex_source_code"></a></p> +</dd> +<dt><code>LATEX_SOURCE_CODE</code> </dt> +<dd><p class="startdd"><a name="aLATEX_SOURCE_CODE"></a> If the <code>LATEX_SOURCE_CODE</code> tag is set to <code>YES</code> then doxygen will include source code with syntax highlighting in the <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> output. <br /> +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>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_latex_bib_style"></a></p> +</dd> +<dt><code>LATEX_BIB_STYLE</code> </dt> +<dd><p class="startdd"><a name="aLATEX_BIB_STYLE"></a> 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>. 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>The default value is: <code>plain</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. <a class="anchor" id="cfg_latex_timestamp"></a></p> +</dd> +<dt><code>LATEX_TIMESTAMP</code> </dt> +<dd><p class="startdd"><a name="aLATEX_TIMESTAMP"></a> If the <code>LATEX_TIMESTAMP</code> tag is set to <code>YES</code> then the footer of each generated page will contain the date and time when the page was generated. Setting this to <code>NO</code> can help when comparing the output of multiple runs.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_latex">GENERATE_LATEX</a> is set to <code>YES</code>. </p> +</dd> +</dl> +<h1><a class="anchor" id="config_rtf"></a> +Configuration options related to the RTF output</h1> +<p><a class="anchor" id="cfg_generate_rtf"></a></p><dl> +<dt><code>GENERATE_RTF</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_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 RTF readers/editors.</p> +<p>The default value is: <code>NO</code>.</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="aRTF_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 <a class="el" href="config.html#cfg_output_directory">OUTPUT_DIRECTORY</a> will be put in front of it.</p> +<p>The default directory is: <code>rtf</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_rtf">GENERATE_RTF</a> is set to <code>YES</code>. <a class="anchor" id="cfg_compact_rtf"></a></p> +</dd> +<dt><code>COMPACT_RTF</code> </dt> +<dd><p class="startdd"><a name="aCOMPACT_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>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_rtf">GENERATE_RTF</a> is set to <code>YES</code>. <a class="anchor" id="cfg_rtf_hyperlinks"></a></p> +</dd> +<dt><code>RTF_HYPERLINKS</code> </dt> +<dd><p class="startdd"><a name="aRTF_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 readers that support those fields.</p> +<p><br /> +Note: WordPad (write) and others do not support links.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_rtf">GENERATE_RTF</a> is set to <code>YES</code>. <a class="anchor" id="cfg_rtf_stylesheet_file"></a></p> +</dd> +<dt><code>RTF_STYLESHEET_FILE</code> </dt> +<dd><p class="startdd"><a name="aRTF_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. <br /> + 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">This tag requires that the tag <a class="el" href="config.html#cfg_generate_rtf">GENERATE_RTF</a> is set to <code>YES</code>. <a class="anchor" id="cfg_rtf_extensions_file"></a></p> +</dd> +<dt><code>RTF_EXTENSIONS_FILE</code> </dt> +<dd><p class="startdd"><a name="aRTF_EXTENSIONS_FILE"></a> 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">This tag requires that the tag <a class="el" href="config.html#cfg_generate_rtf">GENERATE_RTF</a> is set to <code>YES</code>. <a class="anchor" id="cfg_rtf_source_code"></a></p> +</dd> +<dt><code>RTF_SOURCE_CODE</code> </dt> +<dd><p class="startdd"><a name="aRTF_SOURCE_CODE"></a> If the <code>RTF_SOURCE_CODE</code> tag is set to <code>YES</code> then doxygen will include source code with syntax highlighting in the RTF output. <br /> +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>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_rtf">GENERATE_RTF</a> is set to <code>YES</code>. </p> +</dd> +</dl> +<h1><a class="anchor" id="config_man"></a> +Configuration options related to the man page output</h1> +<p><a class="anchor" id="cfg_generate_man"></a></p><dl> +<dt><code>GENERATE_MAN</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_MAN"></a> If the <code>GENERATE_MAN</code> tag is set to <code>YES</code>, doxygen will generate man pages for classes and files.</p> +<p>The default value is: <code>NO</code>.</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="aMAN_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 <a class="el" href="config.html#cfg_output_directory">OUTPUT_DIRECTORY</a> will be put in front of it. A directory <code>man3</code> will be created inside the directory specified by <code>MAN_OUTPUT</code>.</p> +<p>The default directory is: <code>man</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_man">GENERATE_MAN</a> is set to <code>YES</code>. <a class="anchor" id="cfg_man_extension"></a></p> +</dd> +<dt><code>MAN_EXTENSION</code> </dt> +<dd><p class="startdd"><a name="aMAN_EXTENSION"></a> The <code>MAN_EXTENSION</code> tag determines the extension that is added to the generated man pages. In case the manual section does not start with a number, the number 3 is prepended. The dot (.) at the beginning of the <code>MAN_EXTENSION</code> tag is optional.</p> +<p>The default value is: <code>.3</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_man">GENERATE_MAN</a> is set to <code>YES</code>. <a class="anchor" id="cfg_man_subdir"></a></p> +</dd> +<dt><code>MAN_SUBDIR</code> </dt> +<dd><p class="startdd"><a name="aMAN_SUBDIR"></a> The <code>MAN_SUBDIR</code> tag determines the name of the directory created within <code>MAN_OUTPUT</code> in which the man pages are placed. If defaults to man followed by <code>MAN_EXTENSION</code> with the initial . removed.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_man">GENERATE_MAN</a> is set to <code>YES</code>. <a class="anchor" id="cfg_man_links"></a></p> +</dd> +<dt><code>MAN_LINKS</code> </dt> +<dd><p class="startdd"><a name="aMAN_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 <code>man</code> command would be unable to find the correct page.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_man">GENERATE_MAN</a> is set to <code>YES</code>. </p> +</dd> +</dl> +<h1><a class="anchor" id="config_xml"></a> +Configuration options related to the XML output</h1> +<p><a class="anchor" id="cfg_generate_xml"></a></p><dl> +<dt><code>GENERATE_XML</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_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>The default value is: <code>NO</code>.</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="aXML_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 <a class="el" href="config.html#cfg_output_directory">OUTPUT_DIRECTORY</a> will be put in front of it.</p> +<p>The default directory is: <code>xml</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_xml">GENERATE_XML</a> is set to <code>YES</code>. <a class="anchor" id="cfg_xml_programlisting"></a></p> +</dd> +<dt><code>XML_PROGRAMLISTING</code> </dt> +<dd><p class="startdd"><a name="aXML_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>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_xml">GENERATE_XML</a> is set to <code>YES</code>. </p> +</dd> +</dl> +<h1><a class="anchor" id="config_docbook"></a> +Configuration options related to the DOCBOOK output</h1> +<p><a class="anchor" id="cfg_generate_docbook"></a></p><dl> +<dt><code>GENERATE_DOCBOOK</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_DOCBOOK"></a> If the <code>GENERATE_DOCBOOK</code> tag is set to <code>YES</code>, doxygen will generate Docbook files that can be used to generate PDF.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_docbook_output"></a></p> +</dd> +<dt><code>DOCBOOK_OUTPUT</code> </dt> +<dd><p class="startdd"><a name="aDOCBOOK_OUTPUT"></a> The <code>DOCBOOK_OUTPUT</code> tag is used to specify where the Docbook pages will be put. If a relative path is entered the value of <a class="el" href="config.html#cfg_output_directory">OUTPUT_DIRECTORY</a> will be put in front of it.</p> +<p>The default directory is: <code>docbook</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_docbook">GENERATE_DOCBOOK</a> is set to <code>YES</code>. <a class="anchor" id="cfg_docbook_programlisting"></a></p> +</dd> +<dt><code>DOCBOOK_PROGRAMLISTING</code> </dt> +<dd><p class="startdd"><a name="aDOCBOOK_PROGRAMLISTING"></a> If the <code>DOCBOOK_PROGRAMLISTING</code> tag is set to <code>YES</code>, doxygen will include the program listings (including syntax highlighting and cross-referencing information) to the DOCBOOK output. Note that enabling this will significantly increase the size of the DOCBOOK output.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_docbook">GENERATE_DOCBOOK</a> is set to <code>YES</code>. </p> +</dd> +</dl> +<h1><a class="anchor" id="config_autogen"></a> +Configuration options for the AutoGen Definitions output</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="aGENERATE_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>The default value is: <code>NO</code>.</p> +<p class="enddd"></p> +</dd> +</dl> +<h1><a class="anchor" id="config_perlmod"></a> +Configuration options related to the Perl module output</h1> +<p><a class="anchor" id="cfg_generate_perlmod"></a></p><dl> +<dt><code>GENERATE_PERLMOD</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_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. <br /> +Note that this feature is still experimental and incomplete at the moment.</p> +<p>The default value is: <code>NO</code>.</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="aPERLMOD_LATEX"></a> If the <code>PERLMOD_LATEX</code> tag is set to <code>YES</code>, doxygen will generate the necessary <code>Makefile</code> rules, <code>Perl</code> scripts and <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> code to be able to generate PDF and DVI output from the Perl module output.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_perlmod">GENERATE_PERLMOD</a> is set to <code>YES</code>. <a class="anchor" id="cfg_perlmod_pretty"></a></p> +</dd> +<dt><code>PERLMOD_PRETTY</code> </dt> +<dd><p class="startdd"><a name="aPERLMOD_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>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_perlmod">GENERATE_PERLMOD</a> is set to <code>YES</code>. <a class="anchor" id="cfg_perlmod_makevar_prefix"></a></p> +</dd> +<dt><code>PERLMOD_MAKEVAR_PREFIX</code> </dt> +<dd><p class="startdd"><a name="aPERLMOD_MAKEVAR_PREFIX"></a> The names of the make variables in the generated <code>doxyrules.make</code> file are prefixed with the string contained in <code>PERLMOD_MAKEVAR_PREFIX</code>. This is useful so different <code>doxyrules.make</code> files included by the same <code>Makefile</code> don't overwrite each other's variables.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_generate_perlmod">GENERATE_PERLMOD</a> is set to <code>YES</code>. </p> +</dd> +</dl> +<h1><a class="anchor" id="config_preprocessor"></a> +Configuration options related to the preprocessor</h1> +<p><a class="anchor" id="cfg_enable_preprocessing"></a></p><dl> +<dt><code>ENABLE_PREPROCESSING</code> </dt> +<dd><p class="startdd"><a name="aENABLE_PREPROCESSING"></a> If the <code>ENABLE_PREPROCESSING</code> tag is set to <code>YES</code>, doxygen will evaluate all C-preprocessor directives found in the sources and include files.</p> +<p>The default value is: <code>YES</code>.</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="aMACRO_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>, only conditional compilation will be performed. Macro expansion can be done in a controlled way by setting <a class="el" href="config.html#cfg_expand_only_predef">EXPAND_ONLY_PREDEF</a> to <code>YES</code>.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_enable_preprocessing">ENABLE_PREPROCESSING</a> is set to <code>YES</code>. <a class="anchor" id="cfg_expand_only_predef"></a></p> +</dd> +<dt><code>EXPAND_ONLY_PREDEF</code> </dt> +<dd><p class="startdd"><a name="aEXPAND_ONLY_PREDEF"></a> If the <code>EXPAND_ONLY_PREDEF</code> and <a class="el" href="config.html#cfg_macro_expansion">MACRO_EXPANSION</a> tags are both set to <code>YES</code> then the macro expansion is limited to the macros specified with the <a class="el" href="config.html#cfg_predefined">PREDEFINED</a> and <a class="el" href="config.html#cfg_expand_as_defined">EXPAND_AS_DEFINED</a> tags.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_enable_preprocessing">ENABLE_PREPROCESSING</a> is set to <code>YES</code>. <a class="anchor" id="cfg_search_includes"></a></p> +</dd> +<dt><code>SEARCH_INCLUDES</code> </dt> +<dd><p class="startdd"><a name="aSEARCH_INCLUDES"></a> If the <code>SEARCH_INCLUDES</code> tag is set to <code>YES</code>, the include files in the <a class="el" href="config.html#cfg_include_path">INCLUDE_PATH</a> will be searched if a <code>#include</code> is found.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_enable_preprocessing">ENABLE_PREPROCESSING</a> is set to <code>YES</code>. <a class="anchor" id="cfg_include_path"></a></p> +</dd> +<dt><code>INCLUDE_PATH</code> </dt> +<dd><p class="startdd"><a name="aINCLUDE_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">This tag requires that the tag <a class="el" href="config.html#cfg_search_includes">SEARCH_INCLUDES</a> is set to <code>YES</code>. <a class="anchor" id="cfg_include_file_patterns"></a></p> +</dd> +<dt><code>INCLUDE_FILE_PATTERNS</code> </dt> +<dd><p class="startdd"><a name="aINCLUDE_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 <a class="el" href="config.html#cfg_file_patterns">FILE_PATTERNS</a> will be used.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_enable_preprocessing">ENABLE_PREPROCESSING</a> is set to <code>YES</code>. <a class="anchor" id="cfg_predefined"></a></p> +</dd> +<dt><code>PREDEFINED</code> </dt> +<dd><p class="startdd"><a name="aPREDEFINED"></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 <code>-D</code> option of e.g. <code>gcc</code>). 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 <code>"="</code> are omitted, <code>"=1"</code> is assumed. To prevent a macro definition from being undefined via <code>#undef</code> or recursively expanded use the <code>:=</code> operator instead of the <code>=</code> operator.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_enable_preprocessing">ENABLE_PREPROCESSING</a> is set to <code>YES</code>. <a class="anchor" id="cfg_expand_as_defined"></a></p> +</dd> +<dt><code>EXPAND_AS_DEFINED</code> </dt> +<dd><p class="startdd"><a name="aEXPAND_AS_DEFINED"></a> If the <a class="el" href="config.html#cfg_macro_expansion">MACRO_EXPANSION</a> and <a class="el" href="config.html#cfg_expand_only_predef">EXPAND_ONLY_PREDEF</a> 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 <a class="el" href="config.html#cfg_predefined">PREDEFINED</a> tag if you want to use a different macro definition that overrules the definition found in the source code.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_enable_preprocessing">ENABLE_PREPROCESSING</a> is set to <code>YES</code>. <a class="anchor" id="cfg_skip_function_macros"></a></p> +</dd> +<dt><code>SKIP_FUNCTION_MACROS</code> </dt> +<dd><p class="startdd"><a name="aSKIP_FUNCTION_MACROS"></a> If the <code>SKIP_FUNCTION_MACROS</code> tag is set to <code>YES</code> then doxygen's preprocessor will remove all references to 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>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_enable_preprocessing">ENABLE_PREPROCESSING</a> is set to <code>YES</code>. </p> +</dd> +</dl> +<h1><a class="anchor" id="config_external"></a> +Configuration options related to external references</h1> +<p><a class="anchor" id="cfg_tagfiles"></a></p><dl> +<dt><code>TAGFILES</code> </dt> +<dd><p class="startdd"><a name="aTAGFILES"></a> The <code>TAGFILES</code> tag can be used to specify one or more tag files.</p> +<p>For each tag file the location of the external documentation should be added. The format of a tag file without this location is as follows: </p><pre class="fragment"> TAGFILES = file1 file2 ... +</pre><p> Adding location for the tag files is done as follows: </p><pre class="fragment"> TAGFILES = file1=loc1 "file2 = loc2" ... +</pre><p> where <code>loc1</code> and <code>loc2</code> can be relative or absolute paths or URLs. See the section <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="aGENERATE_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="aALLEXTERNALS"></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>The default value is: <code>NO</code>.</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="aEXTERNAL_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>The default value is: <code>YES</code>.</p> +<p class="enddd"><a class="anchor" id="cfg_external_pages"></a></p> +</dd> +<dt><code>EXTERNAL_PAGES</code> </dt> +<dd><p class="startdd"><a name="aEXTERNAL_PAGES"></a> If the <code>EXTERNAL_PAGES</code> tag is set to <code>YES</code>, all external pages will be listed in the related pages index. If set to <code>NO</code>, only the current project's pages will be listed.</p> +<p>The default value is: <code>YES</code>.</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="aPERL_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>The default file (with absolute path) is: <code>/usr/bin/perl</code>.</p> +<p class="enddd"></p> +</dd> +</dl> +<h1><a class="anchor" id="config_dot"></a> +Configuration options related to the dot tool</h1> +<p><a class="anchor" id="cfg_class_diagrams"></a></p><dl> +<dt><code>CLASS_DIAGRAMS</code> </dt> +<dd><p class="startdd"><a name="aCLASS_DIAGRAMS"></a> If the <code>CLASS_DIAGRAMS</code> tag is set to <code>YES</code>, doxygen will generate a class diagram (in HTML and <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/>) for classes with base or super classes. Setting the tag to <code>NO</code> turns the diagrams off. Note that this option also works with <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> disabled, but it is recommended to install and use <code>dot</code>, since it yields more powerful graphs.</p> +<p>The default value is: <code>YES</code>.</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="aMSCGEN_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 <code>mscgen</code> 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_dia_path"></a></p> +</dd> +<dt><code>DIA_PATH</code> </dt> +<dd><p class="startdd"><a name="aDIA_PATH"></a> You can include diagrams made with dia in doxygen documentation. Doxygen will then run dia to produce the diagram and insert it in the documentation. The DIA_PATH tag allows you to specify the directory where the dia binary resides. If left empty dia is assumed to be found in the default search path.</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="aHIDE_UNDOC_RELATIONS"></a> If set to <code>YES</code> the inheritance and collaboration graphs will hide inheritance and usage relations if the target is undocumented or is not a class.</p> +<p>The default value is: <code>YES</code>.</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="aHAVE_DOT"></a> If you set the <code>HAVE_DOT</code> tag to <code>YES</code> then doxygen will assume the <code>dot</code> tool is available from the <code>path</code>. This tool is part of <a href="http://www.graphviz.org/">Graphviz</a>, a graph visualization toolkit from AT&T and Lucent Bell Labs. The other options in this section have no effect if this option is set to <code>NO</code> </p> +<p>The default value is: <code>NO</code>.</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="aDOT_NUM_THREADS"></a> The <code>DOT_NUM_THREADS</code> specifies the number of <code>dot</code> invocations doxygen is allowed to run in parallel. When set to <code>0</code> 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>Minimum value: <code>0</code>, maximum value: <code>32</code>, default value: <code>0</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_dot_fontname"></a></p> +</dd> +<dt><code>DOT_FONTNAME</code> </dt> +<dd><p class="startdd"><a name="aDOT_FONTNAME"></a> When you want a differently looking font in the dot files that doxygen generates 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 <a class="el" href="config.html#cfg_dot_fontpath">DOT_FONTPATH</a> to the directory containing the font.</p> +<p>The default value is: <code>Helvetica</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_dot_fontsize"></a></p> +</dd> +<dt><code>DOT_FONTSIZE</code> </dt> +<dd><p class="startdd"><a name="aDOT_FONTSIZE"></a> The <code>DOT_FONTSIZE</code> tag can be used to set the size (in points) of the font of dot graphs.</p> +<p>Minimum value: <code>4</code>, maximum value: <code>24</code>, default value: <code>10</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_dot_fontpath"></a></p> +</dd> +<dt><code>DOT_FONTPATH</code> </dt> +<dd><p class="startdd"><a name="aDOT_FONTPATH"></a> By default doxygen will tell <code>dot</code> to use the default font as specified with <a class="el" href="config.html#cfg_dot_fontname">DOT_FONTNAME</a>. If you specify a different font using <a class="el" href="config.html#cfg_dot_fontname">DOT_FONTNAME</a> you can set the path where <code>dot</code> can find it using this tag.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_class_graph"></a></p> +</dd> +<dt><code>CLASS_GRAPH</code> </dt> +<dd><p class="startdd"><a name="aCLASS_GRAPH"></a> If the <code>CLASS_GRAPH</code> tag is 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 <a class="el" href="config.html#cfg_class_diagrams">CLASS_DIAGRAMS</a> tag to <code>NO</code>.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_collaboration_graph"></a></p> +</dd> +<dt><code>COLLABORATION_GRAPH</code> </dt> +<dd><p class="startdd"><a name="aCOLLABORATION_GRAPH"></a> If the <code>COLLABORATION_GRAPH</code> tag is 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>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_group_graphs"></a></p> +</dd> +<dt><code>GROUP_GRAPHS</code> </dt> +<dd><p class="startdd"><a name="aGROUP_GRAPHS"></a> If the <code>GROUP_GRAPHS</code> tag is set to <code>YES</code> then doxygen will generate a graph for groups, showing the direct groups dependencies.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_uml_look"></a></p> +</dd> +<dt><code>UML_LOOK</code> </dt> +<dd><p class="startdd"><a name="aUML_LOOK"></a> If the <code>UML_LOOK</code> tag is set to <code>YES</code>, doxygen will generate inheritance and collaboration diagrams in a style similar to the OMG's Unified Modeling Language.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <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="aUML_LIMIT_NUM_FIELDS"></a> If the <a class="el" href="config.html#cfg_uml_look">UML_LOOK</a> 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 manageable. 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>Minimum value: <code>0</code>, maximum value: <code>100</code>, default value: <code>10</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_template_relations"></a></p> +</dd> +<dt><code>TEMPLATE_RELATIONS</code> </dt> +<dd><p class="startdd"><a name="aTEMPLATE_RELATIONS"></a> If the <code>TEMPLATE_RELATIONS</code> tag is set to <code>YES</code> then the inheritance and collaboration graphs will show the relations between templates and their instances.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_include_graph"></a></p> +</dd> +<dt><code>INCLUDE_GRAPH</code> </dt> +<dd><p class="startdd"><a name="aINCLUDE_GRAPH"></a> If the <code>INCLUDE_GRAPH</code>, <a class="el" href="config.html#cfg_enable_preprocessing">ENABLE_PREPROCESSING</a> and <a class="el" href="config.html#cfg_search_includes">SEARCH_INCLUDES</a> 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>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_included_by_graph"></a></p> +</dd> +<dt><code>INCLUDED_BY_GRAPH</code> </dt> +<dd><p class="startdd"><a name="aINCLUDED_BY_GRAPH"></a> If the <code>INCLUDED_BY_GRAPH</code>, <a class="el" href="config.html#cfg_enable_preprocessing">ENABLE_PREPROCESSING</a> and <a class="el" href="config.html#cfg_search_includes">SEARCH_INCLUDES</a> 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>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_call_graph"></a></p> +</dd> +<dt><code>CALL_GRAPH</code> </dt> +<dd><p class="startdd"><a name="aCALL_GRAPH"></a> If the <code>CALL_GRAPH</code> tag is set to <code>YES</code> then doxygen will generate a call dependency graph for every global function or class method. <br /> +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 <a class="el" href="commands.html#cmdcallgraph">\callgraph</a> command. Disabling a call graph can be accomplished by means of the command <a class="el" href="commands.html#cmdhidecallgraph">\hidecallgraph</a>.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_caller_graph"></a></p> +</dd> +<dt><code>CALLER_GRAPH</code> </dt> +<dd><p class="startdd"><a name="aCALLER_GRAPH"></a> If the <code>CALLER_GRAPH</code> tag is set to <code>YES</code> then doxygen will generate a caller dependency graph for every global function or class method. <br /> +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 <a class="el" href="commands.html#cmdcallergraph">\callergraph</a> command. Disabling a caller graph can be accomplished by means of the command <a class="el" href="commands.html#cmdhidecallergraph">\hidecallergraph</a>.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_graphical_hierarchy"></a></p> +</dd> +<dt><code>GRAPHICAL_HIERARCHY</code> </dt> +<dd><p class="startdd"><a name="aGRAPHICAL_HIERARCHY"></a> If the <code>GRAPHICAL_HIERARCHY</code> tag is set to <code>YES</code> then doxygen will graphical hierarchy of all classes instead of a textual one.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_directory_graph"></a></p> +</dd> +<dt><code>DIRECTORY_GRAPH</code> </dt> +<dd><p class="startdd"><a name="aDIRECTORY_GRAPH"></a> If the <code>DIRECTORY_GRAPH</code> tag is 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 <code>#include</code> relations between the files in the directories.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_dot_image_format"></a></p> +</dd> +<dt><code>DOT_IMAGE_FORMAT</code> </dt> +<dd><p class="startdd"><a name="aDOT_IMAGE_FORMAT"></a> The <code>DOT_IMAGE_FORMAT</code> tag can be used to set the image format of the images generated by <code>dot</code>. For an explanation of the image formats see the section output formats in the documentation of the <code>dot</code> tool (<a href="http://www.graphviz.org/">Graphviz</a>). </p><dl class="section note"><dt>Note</dt><dd>If you choose <code>svg</code> you need to set <a class="el" href="config.html#cfg_html_file_extension">HTML_FILE_EXTENSION</a> to <code>xhtml</code> in order to make the SVG files visible in IE 9+ (other browsers do not have this requirement).</dd></dl> +<p>Possible values are: <code>png</code>, <code>jpg</code>, <code>gif</code>, <code>svg</code>, <code>png:gd</code>, <code>png:gd:gd</code>, <code>png:cairo</code>, <code>png:cairo:gd</code>, <code>png:cairo:cairo</code>, <code>png:cairo:gdiplus</code>, <code>png:gdiplus</code> and <code>png:gdiplus:gdiplus</code>.</p> +<p>The default value is: <code>png</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_interactive_svg"></a></p> +</dd> +<dt><code>INTERACTIVE_SVG</code> </dt> +<dd><p class="startdd"><a name="aINTERACTIVE_SVG"></a> If <a class="el" href="config.html#cfg_dot_image_format">DOT_IMAGE_FORMAT</a> is set to <code>svg</code>, then this option can be set to <code>YES</code> to enable generation of interactive SVG images that allow zooming and panning. <br /> +Note that this requires a modern browser other than Internet Explorer. Tested and working are Firefox, Chrome, Safari, and Opera. </p><dl class="section note"><dt>Note</dt><dd>For IE 9+ you need to set <a class="el" href="config.html#cfg_html_file_extension">HTML_FILE_EXTENSION</a> to <code>xhtml</code> in order to make the SVG files visible. Older versions of IE do not have SVG support.</dd></dl> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_dot_path"></a></p> +</dd> +<dt><code>DOT_PATH</code> </dt> +<dd><p class="startdd"><a name="aDOT_PATH"></a> The <code>DOT_PATH</code> tag can be used to specify the path where the <code>dot</code> tool can be found. If left blank, it is assumed the <code>dot</code> tool can be found in the <code>path</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_dotfile_dirs"></a></p> +</dd> +<dt><code>DOTFILE_DIRS</code> </dt> +<dd><p class="startdd"><a name="aDOTFILE_DIRS"></a> The <code>DOTFILE_DIRS</code> 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">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_mscfile_dirs"></a></p> +</dd> +<dt><code>MSCFILE_DIRS</code> </dt> +<dd><p class="startdd"><a name="aMSCFILE_DIRS"></a> The <code>MSCFILE_DIRS</code> 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_diafile_dirs"></a></p> +</dd> +<dt><code>DIAFILE_DIRS</code> </dt> +<dd><p class="startdd"><a name="aDIAFILE_DIRS"></a> The <code>DIAFILE_DIRS</code> tag can be used to specify one or more directories that contain dia files that are included in the documentation (see the <a class="el" href="commands.html#cmddiafile">\diafile</a> command).</p> +<p class="enddd"><a class="anchor" id="cfg_plantuml_jar_path"></a></p> +</dd> +<dt><code>PLANTUML_JAR_PATH</code> </dt> +<dd><p class="startdd"><a name="aPLANTUML_JAR_PATH"></a> When using plantuml, the <code>PLANTUML_JAR_PATH</code> tag should be used to specify the path where java can find the <code>plantuml.jar</code> file. If left blank, it is assumed PlantUML is not used or called during a preprocessing step. Doxygen will generate a warning when it encounters a <a class="el" href="commands.html#cmdstartuml">\startuml</a> command in this case and will not generate output for the diagram.</p> +<p class="enddd"><a class="anchor" id="cfg_plantuml_include_path"></a></p> +</dd> +<dt><code>PLANTUML_INCLUDE_PATH</code> </dt> +<dd><p class="startdd"><a name="aPLANTUML_INCLUDE_PATH"></a> When using plantuml, the specified paths are searched for files specified by the <code>!include</code> statement in a plantuml block.</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="aDOT_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 <a class="el" href="config.html#cfg_max_dot_graph_depth">MAX_DOT_GRAPH_DEPTH</a>.</p> +<p>Minimum value: <code>0</code>, maximum value: <code>10000</code>, default value: <code>50</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <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="aMAX_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 <code>dot</code>. 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 <a class="el" href="config.html#cfg_dot_graph_max_nodes">DOT_GRAPH_MAX_NODES</a>. Using a depth of 0 means no depth restriction.</p> +<p>Minimum value: <code>0</code>, maximum value: <code>1000</code>, default value: <code>0</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_dot_transparent"></a></p> +</dd> +<dt><code>DOT_TRANSPARENT</code> </dt> +<dd><p class="startdd"><a name="aDOT_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. <br /> + 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>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_dot_multi_targets"></a></p> +</dd> +<dt><code>DOT_MULTI_TARGETS</code> </dt> +<dd><p class="startdd"><a name="aDOT_MULTI_TARGETS"></a> Set the <code>DOT_MULTI_TARGETS</code> tag to <code>YES</code> to allow dot to generate multiple output files in one run (i.e. multiple -o and -T options on the command line). This makes <code>dot</code> run faster, but since only newer versions of <code>dot</code> (>1.8.10) support this, this feature is disabled by default.</p> +<p>The default value is: <code>NO</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_generate_legend"></a></p> +</dd> +<dt><code>GENERATE_LEGEND</code> </dt> +<dd><p class="startdd"><a name="aGENERATE_LEGEND"></a> If the <code>GENERATE_LEGEND</code> tag is set to <code>YES</code> doxygen will generate a legend page explaining the meaning of the various boxes and arrows in the dot generated graphs.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. <a class="anchor" id="cfg_dot_cleanup"></a></p> +</dd> +<dt><code>DOT_CLEANUP</code> </dt> +<dd><p class="startdd"><a name="aDOT_CLEANUP"></a> If the <code>DOT_CLEANUP</code> tag is set to <code>YES</code>, doxygen will remove the intermediate dot files that are used to generate the various graphs.</p> +<p>The default value is: <code>YES</code>.</p> +<p class="enddd">This tag requires that the tag <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> is set to <code>YES</code>. </p> +</dd> +</dl> +<h1><a class="anchor" id="config_examples"></a> +Examples</h1> +<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 <code>perl</code> 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> +<p> +Go to the <a href="commands.html">next</a> section or return to the + <a href="index.html">index</a>. + </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.12 </li> + </ul> +</div> +</body> +</html> |