1 /******************************************************************************

     2  *

     3  * 

     4  *

     5  * Copyright (C) 1997-2008 by Dimitri van Heesch.

     6  *

     7  * Permission to use, copy, modify, and distribute this software and its

     8  * documentation under the terms of the GNU General Public License is hereby 

     9  * granted. No representations are made about the suitability of this software 

    10  * for any purpose. It is provided "as is" without express or implied warranty.

    11  * See the GNU General Public License for more details.

    12  *

    13  * Documents produced by Doxygen are derivative works derived from the

    14  * input used in their production; they are not affected by this license.

    15  *

    16  */

    17 /*! \page config Configuration

    18 

    19 \section config_format Format

    20 

    21 A configuration file is a free-form ASCII text file with a structure

    22 that is similar to that of a Makefile, with the default name \c Doxyfile. It is

    23 parsed by \c doxygen.  The file may contain tabs and newlines for

    24 formatting purposes.  The statements in the file are case-sensitive.

    25 Comments may be placed anywhere within the file (except within quotes).

    26 Comments begin with the \# character and end at the end of the line.

    27 

    28 The file essentially consists of a list of assignment statements.

    29 Each statement consists of a \c TAG_NAME written in capitals,

    30 followed by the <code>=</code> character and one or more values. If the same tag

    31 is assigned more than once, the last assignment overwrites any earlier

    32 assignment. For options that take a list as their argument,

    33 the <code>+=</code> operator can be used instead of <code>=</code> to append 

    34 new values to the list. Values are sequences of non-blanks. If the value should 

    35 contain one or more blanks it must be surrounded by quotes ("...").

    36 Multiple lines can be concatenated by inserting a backslash (\\)

    37 as the last character of a line. Environment variables can be expanded 

    38 using the pattern <code>\$(ENV_VARIABLE_NAME)</code>.

    39 

    40 You can also include part of a configuration file from another configuration

    41 file using a <code>\@INCLUDE</code> tag as follows:

    42 \verbatim

    43 @INCLUDE = config_file_name

    44 \endverbatim 

    45 The include file is searched in the current working directory. You can 

    46 also specify a list of directories that should be searched before looking

    47 in the current working directory. Do this by putting a <code>\@INCLUDE_PATH</code> tag 

    48 with these paths before the <code>\@INCLUDE</code> tag, e.g:

    49 \verbatim

    50 @INCLUDE_PATH = my_config_dir

    51 \endverbatim

    52 

    53 The configuration options can be divided into several categories.

    54 Below is an alphabetical index of the tags that are recognized 

    55 followed by the descriptions of the tags grouped by category.

    56 

    57 \secreflist

    58 \refitem cfg_abbreviate_brief ABBREVIATE_BRIEF

    59 \refitem cfg_aliases ALIASES

    60 \refitem cfg_allexternals ALLEXTERNALS 

    61 \refitem cfg_alphabetical_index ALPHABETICAL_INDEX 

    62 \refitem cfg_always_detailed_sec ALWAYS_DETAILED_SEC

    63 \refitem cfg_binary_toc BINARY_TOC

    64 \refitem cfg_brief_member_desc BRIEF_MEMBER_DESC 

    65 \refitem cfg_builtin_stl_support BUILTIN_STL_SUPPORT

    66 \refitem cfg_call_graph CALL_GRAPH

    67 \refitem cfg_caller_graph CALLER_GRAPH

    68 \refitem cfg_case_sense_names CASE_SENSE_NAMES 

    69 \refitem cfg_chm_file CHM_FILE

    70 \refitem cfg_class_diagrams CLASS_DIAGRAMS 

    71 \refitem cfg_class_graph CLASS_GRAPH

    72 \refitem cfg_collaboration_graph COLLABORATION_GRAPH

    73 \refitem cfg_cols_in_alpha_index COLS_IN_ALPHA_INDEX

    74 \refitem cfg_compact_latex COMPACT_LATEX 

    75 \refitem cfg_compact_rtf COMPACT_RTF

    76 \refitem cfg_cpp_cli_support CPP_CLI_SUPPORT

    77 \refitem cfg_create_subdirs CREATE_SUBDIRS

    78 \refitem cfg_directory_graph DIRECTORY_GRAPH

    79 \refitem cfg_disable_index DISABLE_INDEX 

    80 \refitem cfg_distribute_group_doc DISTRIBUTE_GROUP_DOC

    81 \refitem cfg_docset_bundle_id DOCSET_BUNDLE_ID

    82 \refitem cfg_docset_feedname DOCSET_FEEDNAME

    83 \refitem cfg_dot_cleanup DOT_CLEANUP

    84 \refitem cfg_dot_fontname DOT_FONTNAME

    85 \refitem cfg_dot_fontpath DOT_FONTPATH

    86 \refitem cfg_dot_fontsize DOT_FONTSIZE

    87 \refitem cfg_dot_graph_max_nodes DOT_GRAPH_MAX_NODES

    88 \refitem cfg_dot_image_format DOT_IMAGE_FORMAT

    89 \refitem cfg_dot_multi_targets DOT_MULTI_TARGETS

    90 \refitem cfg_dot_path DOT_PATH

    91 \refitem cfg_dot_transparent DOT_TRANSPARENT

    92 \refitem cfg_dotfile_dirs DOTFILE_DIRS

    93 \refitem cfg_doxyfile_encoding DOXYFILE_ENCODING

    94 \refitem cfg_eclipse_doc_id ECLIPSE_DOC_ID

    95 \refitem cfg_enable_preprocessing ENABLE_PREPROCESSING

    96 \refitem cfg_enabled_sections ENABLED_SECTIONS

    97 \refitem cfg_enum_values_per_line ENUM_VALUES_PER_LINE

    98 \refitem cfg_example_path EXAMPLE_PATH

    99 \refitem cfg_example_patterns EXAMPLE_PATTERNS

   100 \refitem cfg_example_recursive EXAMPLE_RECURSIVE

   101 \refitem cfg_exclude EXCLUDE

   102 \refitem cfg_exclude_patterns EXCLUDE_PATTERNS

   103 \refitem cfg_exclude_symlinks EXCLUDE_SYMLINKS

   104 \refitem cfg_expand_as_defined EXPAND_AS_DEFINED

   105 \refitem cfg_expand_only_predef EXPAND_ONLY_PREDEF

   106 \refitem cfg_extension_mapping EXTENSION_MAPPING

   107 \refitem cfg_external_groups EXTERNAL_GROUPS

   108 \refitem cfg_extra_packages EXTRA_PACKAGES

   109 \refitem cfg_extract_all EXTRACT_ALL

   110 \refitem cfg_extract_anon_nspaces EXTRACT_ANON_NSPACES

   111 \refitem cfg_extract_local_classes EXTRACT_LOCAL_CLASSES

   112 \refitem cfg_extract_local_methods EXTRACT_LOCAL_METHODS

   113 \refitem cfg_extract_private EXTRACT_PRIVATE

   114 \refitem cfg_extract_static EXTRACT_STATIC

   115 \refitem cfg_file_patterns FILE_PATTERNS

   116 \refitem cfg_file_version_filter FILE_VERSION_FILTER

   117 \refitem cfg_filter_patterns FILTER_PATTERNS

   118 \refitem cfg_filter_source_files FILTER_SOURCE_FILES

   119 \refitem cfg_force_local_includes FORCE_LOCAL_INCLUDES

   120 \refitem cfg_formula_fontsize FORMULA_FONTSIZE

   121 \refitem cfg_full_path_names FULL_PATH_NAMES

   122 \refitem cfg_generate_autogen_def GENERATE_AUTOGEN_DEF

   123 \refitem cfg_generate_buglist GENERATE_BUGLIST

   124 \refitem cfg_generate_chi GENERATE_CHI

   125 \refitem cfg_generate_deprecatedlist GENERATE_DEPRECIATEDLIST

   126 \refitem cfg_generate_docset GENERATE_DOCSET

   127 \refitem cfg_generate_eclipsehelp GENERATE_ECLIPSEHELP

   128 \refitem cfg_generate_html GENERATE_HTML

   129 \refitem cfg_generate_htmlhelp GENERATE_HTMLHELP

   130 \refitem cfg_generate_latex GENERATE_LATEX

   131 \refitem cfg_generate_legend GENERATE_LEGEND

   132 \refitem cfg_generate_man GENERATE_MAN

   133 \refitem cfg_generate_perlmod GENERATE_PERLMOD

   134 \refitem cfg_generate_qhp GENERATE_QHP

   135 \refitem cfg_generate_rtf GENERATE_RTF

   136 \refitem cfg_generate_tagfile GENERATE_TAGFILE

   137 \refitem cfg_generate_testlist GENERATE_TESTLIST

   138 \refitem cfg_generate_todolist GENERATE_TODOLIST

   139 \refitem cfg_generate_treeview GENERATE_TREEVIEW

   140 \refitem cfg_generate_xml GENERATE_XML

   141 \refitem cfg_graphical_hierarchy GRAPHICAL_HIERARCHY

   142 \refitem cfg_group_graphs GROUP_GRAPHS

   143 \refitem cfg_have_dot HAVE_DOT

   144 \refitem cfg_hhc_location HHC_LOCATION

   145 \refitem cfg_hide_friend_compounds HIDE_FRIEND_COMPOUNDS

   146 \refitem cfg_hide_in_body_docs HIDE_IN_BODY_DOCS

   147 \refitem cfg_hide_scope_names HIDE_SCOPE_NAMES

   148 \refitem cfg_hide_undoc_classes HIDE_UNDOC_CLASSES

   149 \refitem cfg_hide_undoc_members HIDE_UNDOC_MEMBERS

   150 \refitem cfg_hide_undoc_relations HIDE_UNDOC_RELATIONS

   151 \refitem cfg_html_align_members HTML_ALIGN_MEMBERS

   152 \refitem cfg_html_dynamic_sections HTML_DYNAMIC_SECTIONS

   153 \refitem cfg_html_file_extension HTML_FILE_EXTENSION

   154 \refitem cfg_html_footer HTML_FOOTER

   155 \refitem cfg_html_header HTML_HEADER

   156 \refitem cfg_html_output HTML_OUTPUT

   157 \refitem cfg_html_stylesheet HTML_STYLESHEET

   158 \refitem cfg_html_timestamp HTML_TIMESTAMP

   159 \refitem cfg_idl_property_support IDL_PROPERTY_SUPPORT

   160 \refitem cfg_ignore_prefix IGNORE_PREFIX

   161 \refitem cfg_image_path IMAGE_PATH

   162 \refitem cfg_include_graph INCLUDE_GRAPH

   163 \refitem cfg_include_path INCLUDE_PATH

   164 \refitem cfg_included_by_graph INCLUDED_BY_GRAPH

   165 \refitem cfg_inherit_docs INHERIT_DOCS

   166 \refitem cfg_inline_info INLINE_INFO

   167 \refitem cfg_inline_inherited_memb INLINE_INHERITED_MEMB

   168 \refitem cfg_inline_sources INLINE_SOURCES

   169 \refitem cfg_input INPUT

   170 \refitem cfg_input_encoding INPUT_ENCODING

   171 \refitem cfg_input_filter INPUT_FILTER

   172 \refitem cfg_internal_docs INTERNAL_DOCS

   173 \refitem cfg_javadoc_autobrief JAVADOC_AUTOBRIEF

   174 \refitem cfg_latex_batchmode LATEX_BATCHMODE

   175 \refitem cfg_latex_cmd_name LATEX_CMD_NAME

   176 \refitem cfg_latex_header LATEX_HEADER

   177 \refitem cfg_latex_hide_indices LATEX_HIDE_INDICES

   178 \refitem cfg_latex_output LATEX_OUTPUT

   179 \refitem cfg_layout_file LAYOUT_FILE

   180 \refitem cfg_macro_expansion MACRO_EXPANSION

   181 \refitem cfg_makeindex_cmd_name MAKEINDEX_CMD_NAME

   182 \refitem cfg_man_extension MAN_EXTENSION

   183 \refitem cfg_man_links MAN_LINKS

   184 \refitem cfg_man_output MAN_OUTPUT

   185 \refitem cfg_max_dot_graph_depth MAX_DOT_GRAPH_DEPTH

   186 \refitem cfg_max_initializer_lines MAX_INITIALIZER_LINES

   187 \refitem cfg_mscgen_path MSCGEN_PATH

   188 \refitem cfg_multiline_cpp_is_brief MULTILINE_CPP_IS_BRIEF

   189 \refitem cfg_optimize_for_fortran OPTIMIZE_FOR_FORTRAN

   190 \refitem cfg_optimize_output_for_c OPTIMIZE_OUTPUT_FOR_C

   191 \refitem cfg_optimize_output_java OPTIMIZE_OUTPUT_JAVA

   192 \refitem cfg_optimize_output_vhdl OPTIMIZE_OUTPUT_VHDL

   193 \refitem cfg_output_directory OUTPUT_DIRECTORY

   194 \refitem cfg_output_language OUTPUT_LANGUAGE

   195 \refitem cfg_paper_type PAPER_TYPE

   196 \refitem cfg_pdf_hyperlinks PDF_HYPERLINKS

   197 \refitem cfg_perl_path PERL_PATH

   198 \refitem cfg_perlmod_latex PERLMOD_LATEX

   199 \refitem cfg_perlmod_makevar_prefix PERLMOD_MAKEVAR_PREFIX

   200 \refitem cfg_perlmod_pretty PERLMOD_PRETTY

   201 \refitem cfg_predefined PREDEFINED

   202 \refitem cfg_project_name PROJECT_NAME

   203 \refitem cfg_project_number PROJECT_NUMBER

   204 \refitem cfg_qhg_location QHG_LOCATION

   205 \refitem cfg_qhp_cust_filter_attrs QHP_CUST_FILTER_ATTRS

   206 \refitem cfg_qhp_cust_filter_name QHP_CUST_FILTER_NAME

   207 \refitem cfg_qhp_namespace QHP_NAMESPACE

   208 \refitem cfg_qhp_sect_filter_attrs QHP_SECT_FILTER_ATTRS

   209 \refitem cfg_qhp_virtual_folder QHP_VIRTUAL_FOLDER

   210 \refitem cfg_qt_autobrief QT_AUTOBRIEF

   211 \refitem cfg_quiet QUIET

   212 \refitem cfg_recursive RECURSIVE

   213 \refitem cfg_referenced_by_relation REFERENCED_BY_RELATION

   214 \refitem cfg_references_link_source REFERENCES_LINK_SOURCE

   215 \refitem cfg_references_relation REFERENCES_RELATION

   216 \refitem cfg_repeat_brief REPEAT_BRIEF

   217 \refitem cfg_rtf_extensions_file RTF_EXTENSIONS_FILE

   218 \refitem cfg_rtf_hyperlinks RTF_HYPERLINKS

   219 \refitem cfg_rtf_output RTF_OUTPUT

   220 \refitem cfg_rtf_stylesheet_file RTF_STYLESHEET_FILE

   221 \refitem cfg_search_includes SEARCH_INCLUDES

   222 \refitem cfg_searchengine SEARCHENGINE

   223 \refitem cfg_separate_member_pages SEPARATE_MEMBER_PAGES

   224 \refitem cfg_server_based_search SERVER_BASED_SEARCH

   225 \refitem cfg_short_names SHORT_NAMES

   226 \refitem cfg_show_dirs SHOW_DIRECTORIES

   227 \refitem cfg_show_files SHOW_FILES

   228 \refitem cfg_show_include_files SHOW_INCLUDE_FILES

   229 \refitem cfg_show_namespaces SHOW_NAMESPACES

   230 \refitem cfg_show_used_files SHOW_USED_FILES

   231 \refitem cfg_sip_support SIP_SUPPORT

   232 \refitem cfg_skip_function_macros SKIP_FUNCTION_MACROS

   233 \refitem cfg_sort_brief_docs SORT_BRIEF_DOCS

   234 \refitem cfg_sort_by_scope_name SORT_BY_SCOPE_NAME

   235 \refitem cfg_sort_group_names SORT_GROUP_NAMES

   236 \refitem cfg_sort_member_docs SORT_MEMBER_DOCS

   237 \refitem cfg_sort_members_constructors_first SORT_MEMBERS_CTORS_1ST

   238 \refitem cfg_source_browser SOURCE_BROWSER

   239 \refitem cfg_strip_code_comments STRIP_CODE_COMMENTS

   240 \refitem cfg_strip_from_inc_path STRIP_FROM_INC_PATH

   241 \refitem cfg_strip_from_path STRIP_FROM_PATH

   242 \refitem cfg_subgrouping SUBGROUPING

   243 \refitem cfg_symbol_cache_size SYMBOL_CACHE_SIZE

   244 \refitem cfg_tab_size TAB_SIZE

   245 \refitem cfg_tagfiles TAGFILES

   246 \refitem cfg_template_relations TEMPLATE_RELATIONS

   247 \refitem cfg_toc_expand TOC_EXPAND

   248 \refitem cfg_treeview_width TREEVIEW_WIDTH

   249 \refitem cfg_typedef_hides_struct TYPEDEF_HIDES_STRUCT

   250 \refitem cfg_uml_look UML_LOOK

   251 \refitem cfg_use_htags USE_HTAGS

   252 \refitem cfg_use_inline_trees USE_INLINE_TREES

   253 \refitem cfg_use_pdflatex USE_PDFLATEX

   254 \refitem cfg_verbatim_headers VERBATIM_HEADERS

   255 \refitem cfg_warn_format WARN_FORMAT

   256 \refitem cfg_warn_if_doc_error WARN_IF_DOC_ERROR

   257 \refitem cfg_warn_if_undocumented WARN_IF_UNDOCUMENTED

   258 \refitem cfg_warn_logfile WARN_LOGFILE

   259 \refitem cfg_warn_no_paramdoc WARN_NO_PARAMDOC

   260 \refitem cfg_warnings WARNINGS

   261 \refitem cfg_xml_dtd XML_DTD

   262 \refitem cfg_xml_output XML_OUTPUT

   263 \refitem cfg_xml_programlisting XML_PROGRAMLISTING

   264 \refitem cfg_xml_schema XML_SCHEMA

   265 \endsecreflist

   266 

   267 \section config_project Project related options

   268 \anchor cfg_doxyfile_encoding

   269 <dl>

   270 

   271 <dt>\c DOXYFILE_ENCODING <dd>

   272  \addindex DOXYFILE_ENCODING

   273  This tag specifies the encoding used for all characters in the config file that 

   274  follow. The default is UTF-8 which is also the encoding used for all text before

   275  the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into

   276  libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of

   277  possible encodings.

   278 

   279 \anchor cfg_project_name

   280 <dt>\c PROJECT_NAME <dd>

   281  \addindex PROJECT_NAME

   282  The \c PROJECT_NAME tag is a single word (or a sequence of words

   283  surrounded by double-quotes) that should identify the project for which the 

   284  documentation is generated. This name is used in the title of most 

   285  generated pages and in a few other places.

   286 

   287 \anchor cfg_project_number

   288 <dt>\c PROJECT_NUMBER <dd>

   289  \addindex PROJECT_NUMBER

   290  The \c PROJECT_NUMBER tag can be used to enter a project or revision number.

   291  This could be handy for archiving the generated documentation or

   292  if some version control system is used.

   293 

   294 \anchor cfg_output_directory

   295 <dt>\c OUTPUT_DIRECTORY <dd> 

   296  \addindex OUTPUT_DIRECTORY

   297  The \c OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 

   298  path into which the generated documentation will be written. 

   299  If a relative path is entered, it will be relative to the location 

   300  where doxygen was started. If left blank the current directory will be used.

   301 

   302 \anchor cfg_create_subdirs

   303 <dt>\c CREATE_SUBDIRS <dd> 

   304  \addindex CREATE_SUBDIRS

   305  If the \c CREATE_SUBDIRS tag is set to \c YES, then doxygen will create

   306  4096 sub-directories (in 2 levels) under the output directory of each output 

   307  format and will distribute the generated files over these directories. 

   308  Enabling this option can be useful when feeding doxygen a huge amount of source

   309  files, where putting all generated files in the same directory would otherwise

   310  causes performance problems for the file system. 

   311 

   312 \anchor cfg_output_language

   313 <dt>\c OUTPUT_LANGUAGE <dd>

   314  \addindex OUTPUT_LANGUAGE

   315  The \c OUTPUT_LANGUAGE tag is used to specify the language in which all

   316  documentation generated by doxygen is written. Doxygen will use this

   317  information to generate all constant output in the proper language.

   318  The default language is English, other supported languages are:

   319  Afrikaans, Arabic, Brazilian, Catalan, Chinese, Croatian, Czech, Danish, Dutch, 

   320  Finnish, French, German, Greek, Hungarian, Italian, Japanese, Korean, 

   321  Lithuanian, Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Serbian, 

   322  Slovak, Slovene, Spanish, Swedish, and Ukrainian.

   323 

   324 \anchor cfg_brief_member_desc

   325 <dt>\c BRIEF_MEMBER_DESC <dd>

   326  \addindex BRIEF_MEMBER_DESC

   327  If the \c BRIEF_MEMBER_DESC tag is set to \c YES (the default) doxygen will

   328  include brief member descriptions after the members that are listed in

   329  the file and class documentation (similar to JavaDoc).

   330  Set to NO to disable this.

   331 

   332 \anchor cfg_repeat_brief

   333 <dt>\c REPEAT_BRIEF <dd>

   334  \addindex REPEAT_BRIEF

   335  If the \c REPEAT_BRIEF tag is set to \c YES (the default) doxygen will 

   336  prepend the brief description of a member or function before the detailed 

   337  description 

   338 

   339  \par Note: 

   340  If both \c HIDE_UNDOC_MEMBERS and \c BRIEF_MEMBER_DESC are set to \c NO, the 

   341  brief descriptions will be completely suppressed.

   342 

   343 \anchor cfg_abbreviate_brief

   344 <dt>\c ABBREVIATE_BRIEF <dd>

   345  \addindex ABBREVIATE_BRIEF

   346  This tag implements a quasi-intelligent brief description abbreviator

   347  that is used to form the text in various listings. Each string

   348  in this list, if found as the leading text of the brief description, will be

   349  stripped from the text and the result after processing the whole list, is used

   350  as the annotated text. Otherwise, the brief description is used as-is. If left

   351  blank, the following values are used ("\$name" is automatically replaced with the

   352  name of the entity): "The $name class" "The $name widget" "The $name file"

   353  "is" "provides" "specifies" "contains" "represents" "a" "an" "the".

   354 

   355 \anchor cfg_always_detailed_sec

   356 <dt>\c ALWAYS_DETAILED_SEC <dd>

   357  \addindex ALWAYS_DETAILED_SEC

   358  If the \c ALWAYS_DETAILED_SEC and \c REPEAT_BRIEF tags are both set to \c YES then

   359  doxygen will generate a detailed section even if there is only a brief

   360  description.

   361 

   362 \anchor cfg_inline_inherited_memb

   363 <dt>\c INLINE_INHERITED_MEMB <dd>

   364 \addindex INLINE_INHERITED_MEMB

   365  If the \c INLINE_INHERITED_MEMB tag is set to \c YES, doxygen will show all inherited

   366  members of a class in the documentation of that class as if those members were

   367  ordinary class members. Constructors, destructors and assignment operators of

   368  the base classes will not be shown.

   369 

   370 \anchor cfg_full_path_names

   371 <dt>\c FULL_PATH_NAMES <dd>

   372  \addindex FULL_PATH_NAMES

   373  If the \c FULL_PATH_NAMES tag is set to \c YES doxygen will prepend the full

   374  path before files name in the file list and in the header files. If set

   375  to NO the shortest path that makes the file name unique will be used

   376 

   377 \anchor cfg_strip_from_path

   378 <dt>\c STRIP_FROM_PATH <dd>

   379  \addindex STRIP_FROM_PATH

   380  If the \c FULL_PATH_NAMES tag is set to \c YES then the \c STRIP_FROM_PATH tag

   381  can be used to strip a user-defined part of the path. Stripping is

   382  only done if one of the specified strings matches the left-hand part of the 

   383  path. The tag can be used to show relative paths in the file list.

   384  If left blank the directory from which doxygen is run is used as the

   385  path to strip.

   386 

   387 \anchor cfg_strip_from_inc_path

   388 <dt>\c STRIP_FROM_INC_PATH <dd>

   389  \addindex STRIP_FROM_INC_PATH

   390  The \c STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 

   391  the path mentioned in the documentation of a class, which tells

   392  the reader which header file to include in order to use a class. 

   393  If left blank only the name of the header file containing the class

   394  definition is used. Otherwise one should specify the include paths that 

   395  are normally passed to the compiler using the -I flag.

   396 

   397 

   398 

   399 \anchor cfg_case_sense_names

   400 <dt>\c CASE_SENSE_NAMES <dd>

   401  \addindex CASE_SENSE_NAMES

   402  If the \c CASE_SENSE_NAMES tag is set to \c NO then doxygen

   403  will only generate file names in lower-case letters. If set to

   404  \c YES upper-case letters are also allowed. This is useful if you have

   405  classes or files whose names only differ in case and if your file system

   406  supports case sensitive file names. Windows users are advised to set this

   407  option to NO.

   408 

   409 \anchor cfg_short_names

   410 <dt>\c SHORT_NAMES <dd>

   411  \addindex SHORT_NAMES

   412  If the \c SHORT_NAMES tag is set to \c YES, doxygen will generate much shorter

   413  (but less readable) file names. This can be useful is your file systems

   414  doesn't support long names like on DOS, Mac, or CD-ROM.

   415 

   416 \anchor cfg_javadoc_autobrief

   417 <dt>\c JAVADOC_AUTOBRIEF <dd>

   418  \addindex JAVADOC_AUTOBRIEF

   419   If the \c JAVADOC_AUTOBRIEF is set to \c YES then doxygen

   420   will interpret the first line (until the first dot) of a JavaDoc-style

   421   comment as the brief description. If set to NO (the default), the 

   422   Javadoc-style will behave just like regular Qt-style comments

   423   (thus requiring an explicit \@brief command for a brief description.)

   424 

   425 \anchor cfg_qt_autobrief

   426 <dt>\c QT_AUTOBRIEF <dd>

   427  \addindex QT_AUTOBRIEF

   428   If the \c QT_AUTOBRIEF is set to \c YES then doxygen

   429   will interpret the first line (until the first dot) of a Qt-style

   430   comment as the brief description. If set to NO (the default), the

   431   Qt-style will behave just like regular Qt-style comments (thus

   432   requiring an explicit \\brief command for a brief description.)

   433 

   434 \anchor cfg_builtin_stl_support

   435 <dt>\c BUILTIN_STL_SUPPORT <dd>

   436  \addindex BUILTIN_STL_SUPPORT

   437  If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to

   438  include (a tag file for) the STL sources as input, then you should

   439  set this tag to \c YES in order to let doxygen match functions declarations and

   440  definitions whose arguments contain STL classes (e.g. func(std::string); v.s.

   441  func(std::string) {}). This also make the inheritance and collaboration

   442  diagrams that involve STL classes more complete and accurate.

   443 

   444 \anchor cfg_cpp_cli_support

   445 <dt>\c CPP_CLI_SUPPORT <dd>

   446  \addindex CPP_CLI_SUPPORT

   447  If you use Microsoft's C++/CLI language, you should set this option to YES to

   448  enable parsing support.

   449 

   450 \anchor cfg_sip_support

   451 <dt>\c SIP_SUPPORT <dd>

   452  \addindex OPTIMIZE_OUTPUT_SIP

   453  Set the SIP_SUPPORT tag to YES if your project consists 

   454  of <a href="http://www.riverbankcomputing.co.uk/sip/">sip</a> sources only. 

   455  Doxygen will parse them like normal C++ but will assume all classes use public 

   456  instead of private inheritance when no explicit protection keyword is present. 

   457 

   458 \anchor cfg_idl_property_support

   459 <dt>\c IDL_PROPERTY_SUPPORT <dd>

   460  \addindex IDL_PROPERTY_SUPPORT

   461  For Microsoft's IDL there are propget and propput attributes to indicate getter

   462  and setter methods for a property. Setting this option to \c YES (the default)

   463  will make doxygen to replace the get and set methods by a property in the

   464  documentation. This will only work if the methods are indeed getting or 

   465  setting a simple type. If this is not the case, or you want to show the 

   466  methods anyway, you should set this option to \c NO.

   467 

   468 \anchor cfg_distribute_group_doc

   469 <dt>\c DISTRIBUTE_GROUP_DOC <dd>

   470  \addindex DISTRIBUTE_GROUP_DOC

   471  If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC

   472  tag is set to YES, then doxygen will reuse the documentation of the first

   473  member in the group (if any) for the other members of the group. By default

   474  all members of a group must be documented explicitly.

   475 

   476 \anchor cfg_multiline_cpp_is_brief

   477 <dt>\c MULTILINE_CPP_IS_BRIEF <dd>

   478  \addindex MULTILINE_CPP_IS_BRIEF

   479   The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen

   480   treat a multi-line C++ special comment block (i.e. a block of //! or ///

   481   comments) as a brief description. This used to be the default behaviour.

   482   The new default is to treat a multi-line C++ comment block as a detailed

   483   description. Set this tag to YES if you prefer the old behaviour instead.

   484   Note that setting this tag to YES also means that rational rose comments

   485   are not recognized any more.

   486 

   487 <!--

   488 \anchor cfg_details_at_top

   489 <dt>\c DETAILS_AT_TOP <dd>

   490  \addindex DETAILS_AT_TOP

   491   If the DETAILS_AT_TOP tag is set to YES then Doxygen

   492   will output the detailed description near the top, like JavaDoc.

   493   If set to NO, the detailed description appears after the member

   494   documentation.

   495 -->

   496 

   497 \anchor cfg_inherit_docs

   498 <dt>\c INHERIT_DOCS <dd>

   499  \addindex INHERIT_DOCS

   500  If the \c INHERIT_DOCS tag is set to \c YES (the default) then an undocumented

   501  member inherits the documentation from any documented member that it

   502  re-implements.

   503 

   504 \anchor cfg_separate_member_pages

   505 <dt>\c SEPARATE_MEMBER_PAGES <dd>

   506  \addindex SEPARATE_MEMBER_PAGES

   507  If the \c SEPARATE_MEMBER_PAGES tag is set to \c YES, then doxygen will produce

   508  a new page for each member. If set to \c NO, the documentation of a member will

   509  be part of the file/class/namespace that contains it.

   510 

   511 \anchor cfg_tab_size

   512 <dt>\c TAB_SIZE <dd>

   513  \addindex TAB_SIZE

   514  the \c TAB_SIZE tag can be used to set the number of spaces in a tab.

   515  Doxygen uses this value to replace tabs by spaces in code fragments.

   516 

   517 \anchor cfg_aliases

   518 <dt>\c ALIASES <dd>

   519  \addindex ALIASES

   520  This tag can be used to specify a number of aliases that acts 

   521  as commands in the documentation. An alias has the form 

   522 \verbatim

   523  name=value

   524 \endverbatim

   525  For example adding 

   526 \verbatim

   527  "sideeffect=\par Side Effects:\n" 

   528 \endverbatim

   529  will allow you to

   530  put the command \\sideeffect (or \@sideeffect) in the documentation, which 

   531  will result in a user-defined paragraph with heading "Side Effects:".

   532  You can put \\n's in the value part of an alias to insert newlines.

   533 

   534 \anchor cfg_optimize_output_for_c

   535 <dt>\c OPTIMIZE_OUTPUT_FOR_C <dd>

   536  \addindex OPTIMIZE_OUTPUT_FOR_C

   537  Set the \c OPTIMIZE_OUTPUT_FOR_C tag to \c YES if your project consists 

   538  of C sources only. Doxygen will then generate output that is more tailored 

   539  for C. For instance, some of the names that are used will be different. 

   540  The list of all members will be omitted, etc. 

   541 

   542 \anchor cfg_optimize_output_java

   543 <dt>\c OPTIMIZE_OUTPUT_JAVA <dd>

   544  \addindex OPTIMIZE_OUTPUT_JAVA

   545  Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or

   546  Python sources only. Doxygen will then generate output that is more tailored 

   547  for that language. For instance, namespaces will be presented as packages, 

   548  qualified scopes will look different, etc. 

   549 

   550 \anchor cfg_optimize_for_fortran

   551 <dt>\c OPTIMIZE_FOR_FORTRAN <dd>

   552  \addindex OPTIMIZE_FOR_FORTRAN

   553  Set the \c OPTIMIZE_FOR_FORTRAN tag to \c YES if your project consists of Fortran 

   554  sources. Doxygen will then generate output that is tailored for Fortran.

   555 

   556 \anchor cfg_optimize_output_vhdl

   557 <dt>\c OPTIMIZE_OUTPUT_VHDL <dd>

   558  \addindex OPTIMIZE_OUTPUT_VHDL

   559  Set the \c OPTIMIZE_OUTPUT_VHDL tag to \c YES if your project consists of VHDL 

   560  sources. Doxygen will then generate output that is tailored for VHDL.

   561 

   562 \anchor cfg_extension_mapping

   563 <dt>\c EXTENSION_MAPPING <dd>

   564  \addindex EXTENSION_MAPPING

   565  Doxygen selects the parser to use depending on the extension of the files it parses.

   566  With this tag you can assign which parser to use for a given extension.

   567  Doxygen has a built-in mapping, but you can override or extend it using this tag.

   568  The format is ext=language, where ext is a file extension, and language is one of

   569  the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,

   570  Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat

   571  .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),

   572  use: inc=Fortran f=C

   573 

   574 \anchor cfg_subgrouping

   575 <dt>\c SUBGROUPING <dd>

   576  \addindex SUBGROUPING

   577  Set the \c SUBGROUPING tag to \c YES (the default) to allow class member groups of

   578  the same type (for instance a group of public functions) to be put as a

   579  subgroup of that type (e.g. under the Public Functions section). Set it to

   580  \c NO to prevent subgrouping. Alternatively, this can be done per class using

   581  the \ref cmdnosubgrouping "\\nosubgrouping" command. 

   582 

   583 \anchor cfg_typedef_hides_struct 

   584 <dt>\c TYPEDEF_HIDES_STRUCT <dd>

   585  \addindex TYPEDEF_HIDES_STRUCT

   586  When \c TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum

   587  is documented as struct, union, or enum with the name of the typedef. So 

   588  <code>typedef struct TypeS {} TypeT</code>, will appear in the documentation as a struct 

   589  with name \c TypeT. When disabled the typedef will appear as a member of a file, 

   590  namespace, or class. And the struct will be named \c TypeS. This can typically 

   591  be useful for C code in case the coding convention dictates that all compound 

   592  types are typedef'ed and only the typedef is referenced, never the tag name.

   593 

   594 \anchor cfg_symbol_cache_size

   595 <dt>\c SYMBOL_CACHE_SIZE <dd>

   596  \addindex SYMBOL_CACHE_SIZE

   597  The \c SYMBOL_CACHE_SIZE determines the size of the internal cache use to 

   598  determine which symbols to keep in memory and which to flush to disk.

   599  When the cache is full, less often used symbols will be written to disk.

   600  For small to medium size projects (<1000 input files) the default value is

   601  probably good enough. For larger projects a too small cache size can cause 

   602  doxygen to be busy swapping symbols to and from disk most of the time

   603  causing a significant performance penality.

   604  If the system has enough physical memory increasing the cache will improve the

   605  performance by keeping more symbols in memory. Note that the value works on

   606  a logarithmic scale so increasing the size by one will rougly double the

   607  memory usage. The cache size is given by this formula: 

   608  \f$2^{(16+\mbox{SYMBOL\_CACHE\_SIZE})}\f$. The valid range is 0..9, the default is 0, 

   609  corresponding to a cache size of \f$2^{16} = 65536\f$ symbols.

   610 

   611 </dl>

   612 

   613 \section config_build Build related options

   614 \anchor cfg_extract_all

   615 <dl>

   616 

   617 <dt>\c EXTRACT_ALL <dd>

   618  \addindex EXTRACT_ALL

   619  If the \c EXTRACT_ALL tag is set to \c YES doxygen will assume all 

   620  entities in documentation are documented, even if no documentation was 

   621  available. Private class members and static file members will be hidden 

   622  unless the \c EXTRACT_PRIVATE and \c EXTRACT_STATIC tags are set to \c YES

   623 

   624  \par Note: 

   625  This will also disable the warnings about undocumented members 

   626  that are normally produced when \c WARNINGS is set to \c YES

   627 

   628 \anchor cfg_extract_private

   629 <dt>\c EXTRACT_PRIVATE <dd>

   630  \addindex EXTRACT_PRIVATE

   631  If the \c EXTRACT_PRIVATE tag is set to \c YES all private members of a 

   632  class will be included in the documentation.

   633 

   634 \anchor cfg_extract_static

   635 <dt>\c EXTRACT_STATIC <dd>

   636  \addindex EXTRACT_STATIC

   637  If the \c EXTRACT_STATIC tag is set to \c YES all static members of a file

   638  will be included in the documentation.

   639 

   640 \anchor cfg_extract_local_classes

   641 <dt>\c EXTRACT_LOCAL_CLASSES <dd>

   642  \addindex EXTRACT_LOCAL_CLASSES

   643  If the \c EXTRACT_LOCAL_CLASSES tag is set to \c YES classes (and structs) 

   644  defined locally in source files will be included in the documentation. 

   645  If set to NO only classes defined in header files are included. Does not

   646  have any effect for Java sources.

   647 

   648 \anchor cfg_extract_anon_nspaces

   649 <dt>\c EXTRACT_ANON_NSPACES <dd>

   650  \addindex EXTRACT_ANON_NSPACES

   651  If this flag is set to YES, the members of anonymous namespaces will be extracted

   652  and appear in the documentation as a namespace called 'anonymous_namespace{file}',

   653  where file will be replaced with the base name of the file that contains the anonymous

   654  namespace. By default anonymous namespace are hidden.

   655 

   656 \anchor cfg_extract_local_methods

   657 <dt>\c EXTRACT_LOCAL_METHODS <dd>

   658  \addindex EXTRACT_LOCAL_METHODS

   659  This flag is only useful for Objective-C code. When set to \c YES local 

   660  methods, which are defined in the implementation section but not in

   661  the interface are included in the documentation.

   662  If set to \c NO (the default) only methods in the interface are included.

   663 

   664 \anchor cfg_hide_undoc_members

   665 <dt>\c HIDE_UNDOC_MEMBERS <dd>

   666  \addindex HIDE_UNDOC_MEMBERS

   667  If the \c HIDE_UNDOC_MEMBERS tag is set to \c YES, doxygen will hide all

   668  undocumented members inside documented classes or files. 

   669  If set to \c NO (the default) these members will be included in the

   670  various overviews, but no documentation section is generated.

   671  This option has no effect if \c EXTRACT_ALL is enabled.

   672 

   673 \anchor cfg_hide_undoc_classes

   674 <dt>\c HIDE_UNDOC_CLASSES <dd>

   675  \addindex HIDE_UNDOC_CLASSES

   676  If the \c HIDE_UNDOC_CLASSESS tag is set to \c YES, doxygen will hide all

   677  undocumented classes.

   678  If set to \c NO (the default) these classes will be included in the

   679  various overviews.

   680  This option has no effect if \c EXTRACT_ALL is enabled.

   681 

   682 \anchor cfg_hide_friend_compounds

   683 <dt>\c HIDE_FRIEND_COMPOUNDS <dd>

   684  \addindex HIDE_FRIEND_COMPOUNDS

   685  If the \c HIDE_FRIEND_COMPOUNDS tag is set to \c YES, Doxygen will hide all

   686  friend (class|struct|union) declarations.

   687  If set to \c NO (the default) these declarations will be included in the

   688  documentation.

   689  

   690 \anchor cfg_hide_in_body_docs

   691 <dt>\c HIDE_IN_BODY_DOCS <dd>

   692  \addindex HIDE_IN_BODY_DOCS

   693 If the \c HIDE_IN_BODY_DOCS tag is set to \c YES, Doxygen will hide any 

   694 documentation blocks found inside the body of a function.

   695 If set to \c NO (the default) these blocks will be appended to the 

   696 function's detailed documentation block.

   697  

   698 \anchor cfg_internal_docs

   699 <dt>\c INTERNAL_DOCS <dd>

   700  \addindex INTERNAL_DOCS

   701  The \c INTERNAL_DOCS tag determines if documentation

   702  that is typed after a \ref cmdinternal "\\internal" command is included. If the tag is set

   703  to \c NO (the default) then the documentation will be excluded.

   704  Set it to \c YES to include the internal documentation.

   705 

   706 \anchor cfg_hide_scope_names

   707 <dt>\c HIDE_SCOPE_NAMES <dd>

   708  \addindex HIDE_SCOPE_NAMES

   709  If the \c HIDE_SCOPE_NAMES tag is set to \c NO (the default) then doxygen 

   710  will show members with their full class and namespace scopes in the

   711  documentation. If set to \c YES the scope will be hidden. 

   712 

   713 \anchor cfg_show_include_files

   714 <dt>\c SHOW_INCLUDE_FILES <dd>

   715  \addindex SHOW_INCLUDE_FILES

   716  If the SHOW_INCLUDE_FILES tag is set to \c YES (the default) then doxygen

   717  will put a list of the files that are included by a file in the documentation 

   718  of that file.

   719 

   720 \anchor cfg_force_local_includes

   721 <dt>\c FORCE_LOCAL_INCLUDES <dd>

   722  \addindex FORCE_LOCAL_INCLUDES

   723  If the \c FORCE_LOCAL_INCLUDES tag is set to \c YES then Doxygen 

   724  will list include files with double quotes in the documentation 

   725  rather than with sharp brackets.

   726 

   727 \anchor cfg_inline_info

   728 <dt>\c INLINE_INFO <dd>

   729  \addindex INLINE_INFO 

   730  If the \c INLINE_INFO tag is set to \c YES (the default) then a tag [inline]

   731  is inserted in the documentation for inline members.

   732 

   733 \anchor cfg_sort_member_docs

   734 <dt>\c SORT_MEMBER_DOCS <dd>

   735  \addindex SORT_MEMBER_DOCS

   736  If the \c SORT_MEMBER_DOCS tag is set to \c YES (the default) then doxygen

   737  will sort the (detailed) documentation of file and class members

   738  alphabetically by member name. If set to \c NO the members will appear in

   739  declaration order.

   740 

   741 \anchor cfg_sort_brief_docs

   742 <dt>\c SORT_BRIEF_DOCS <dd>

   743  \addindex SORT_BRIEF_DOCS

   744  If the \c SORT_BRIEF_DOCS tag is set to \c YES then doxygen will sort the

   745  brief descriptions of file, namespace and class members alphabetically

   746  by member name. If set to \c NO (the default) the members will appear in

   747  declaration order.

   748 

   749 

   750 \anchor cfg_sort_group_names

   751 <dt>\c SORT_GROUP_NAMES <dd>

   752  \addindex SORT_GROUP_NAMES

   753  If the \c SORT_GROUP_NAMES tag is set to \c YES then doxygen will sort the 

   754  hierarchy of group names into alphabetical order. If set to \c NO (the default)

   755  the group names will appear in their defined order. 

   756 

   757 \anchor cfg_sort_by_scope_name

   758 <dt>\c SORT_BY_SCOPE_NAME <dd>

   759  \addindex SORT_BY_SCOPE_NAME

   760  If the \c SORT_BY_SCOPE_NAME tag is set to \c YES, the class list will be

   761  sorted by fully-qualified names, including namespaces. If set to

   762  NO (the default), the class list will be sorted only by class name,

   763  not including the namespace part.

   764  @note This option is not very useful if \c HIDE_SCOPE_NAMES is set to \c YES.

   765  @note This option applies only to the class list, not to the 

   766        alphabetical list.

   767 

   768 \anchor cfg_sort_members_constructors_first

   769 <dt>\c SORT_MEMBERS_CTORS_1ST <dd>

   770  \addindex SORT_MEMBERS_CTORS_1ST

   771  If the \c SORT_MEMBERS_CTORS_1ST tag is set to \c YES then doxygen

   772  will sort the (brief and detailed) documentation of class members so that

   773  constructors and destructors are listed first. If set to NO (the default)

   774  the constructors will appear in the respective orders defined by

   775  \c SORT_MEMBER_DOCS and \c SORT_BRIEF_DOCS.

   776  @note If \c SORT_BRIEF_DOCS is set to \c NO this option is ignored for

   777        sorting brief member documentation.

   778  @note If \c SORT_MEMBER_DOCS is set to \c NO this option is ignored for

   779        sorting detailed member documentation.

   780 

   781 \anchor cfg_generate_deprecatedlist

   782 <dt>\c GENERATE_DEPRECATEDLIST <dd>

   783  \addindex GENERATE_DEPRECATEDLIST

   784  The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or

   785  disable (NO) the deprecated list. This list is created by 

   786  putting \ref cmddeprecated "\\deprecated"

   787  commands in the documentation.

   788 

   789 \anchor cfg_generate_todolist

   790 <dt>\c GENERATE_TODOLIST <dd>

   791  \addindex GENERATE_TODOLIST

   792  The GENERATE_TODOLIST tag can be used to enable (YES) or

   793  disable (NO) the todo list. This list is created by 

   794  putting \ref cmdtodo "\\todo"

   795  commands in the documentation.

   796 

   797 \anchor cfg_generate_testlist

   798 <dt>\c GENERATE_TESTLIST <dd>

   799  \addindex GENERATE_TESTLIST

   800  The GENERATE_TESTLIST tag can be used to enable (YES) or

   801  disable (NO) the test list. This list is created by 

   802  putting \ref cmdtest "\\test" commands in the documentation.

   803 

   804 \anchor cfg_generate_buglist

   805 <dt>\c GENERATE_BUGLIST <dd>

   806  \addindex GENERATE_BUGLIST

   807  The GENERATE_BUGLIST tag can be used to enable (YES) or

   808  disable (NO) the bug list. This list is created by 

   809  putting \ref cmdbug "\\bug" commands in the documentation.

   810 

   811 \anchor cfg_enabled_sections

   812 <dt>\c ENABLED_SECTIONS <dd>

   813  \addindex ENABLED_SECTIONS

   814  The \c ENABLED_SECTIONS tag can be used to enable conditional

   815  documentation sections, marked by \ref cmdif "\\if" \<section-label\> ... 

   816  \ref cmdendif "\\endif" and \ref cmdcond "\\cond" \<section-label\> ...

   817  \ref cmdendcond "\\endcond" blocks.

   818 

   819 \anchor cfg_max_initializer_lines

   820 <dt>\c MAX_INITIALIZER_LINES <dd>

   821  \addindex MAX_INITIALIZER_LINES

   822  The \c MAX_INITIALIZER_LINES tag determines the maximum number of lines

   823  that the initial value of a variable or define can be. If the initializer

   824  consists of more lines than specified here it will be hidden. Use a value

   825  of 0 to hide initializers completely. The appearance of the value of

   826  individual variables and defines can be controlled using \ref cmdshowinitializer "\\showinitializer"

   827  or \ref cmdhideinitializer "\\hideinitializer" command in the documentation.

   828 

   829 \anchor cfg_show_used_files

   830 <dt>\c SHOW_USED_FILES <dd>

   831  \addindex SHOW_USED_FILES

   832  Set the \c SHOW_USED_FILES tag to \c NO to disable the list of files generated

   833  at the bottom of the documentation of classes and structs. If set to \c YES the

   834  list will mention the files that were used to generate the documentation.

   835 

   836 \anchor cfg_show_dirs

   837 <dt>\c SHOW_DIRECTORIES <dd>

   838  \addindex SHOW_DIRECTORIES

   839  If the sources in your project are distributed over multiple directories

   840  then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy

   841  in the documentation.

   842 

   843 \anchor cfg_show_files

   844 <dt>\c SHOW_FILES <dd>

   845  \addindex SHOW_FILES

   846  Set the \c SHOW_FILES tag to \c NO to disable the generation of the Files page.

   847  This will remove the Files entry from the Quick Index and from the

   848  Folder Tree View (if specified). The default is \c YES.

   849 

   850 \anchor cfg_show_namespaces

   851 <dt>\c SHOW_NAMESPACES <dd>

   852  \addindex SHOW_NAMESPACES

   853  Set the \c SHOW_NAMESPACES tag to \c NO to disable the generation of the

   854  Namespaces page.  This will remove the Namespaces entry from the Quick Index

   855  and from the Folder Tree View (if specified). The default is \c YES.

   856 

   857 </dl>

   858 

   859 \section messages_input Options related to warning and progress messages 

   860 \anchor cfg_quiet

   861 <dl>

   862 

   863 <dt>\c QUIET <dd>

   864  \addindex QUIET

   865  The \c QUIET tag can be used to turn on/off the messages that are generated

   866  to standard output by doxygen. Possible values are \c YES and \c NO, 

   867  where \c YES implies that the messages are off.

   868  If left blank \c NO is used.

   869 

   870 \anchor cfg_warnings

   871 <dt>\c WARNINGS <dd>

   872  \addindex WARNINGS

   873  The \c WARNINGS tag can be used to turn on/off the warning messages that are

   874  generated to standard error by doxygen. Possible values are \c YES and \c NO, 

   875  where \c YES implies that the warnings are on. If left blank \c NO is used.

   876 

   877  \b Tip: Turn warnings on while writing the documentation.

   878 

   879 \anchor cfg_warn_if_undocumented

   880 <dt>\c WARN_IF_UNDOCUMENTED <dd>

   881  \addindex WARN_IF_UNDOCUMENTED

   882  If \c WARN_IF_UNDOCUMENTED is set to \c YES, then doxygen will generate warnings

   883  for undocumented members. If \c EXTRACT_ALL is set to \c YES then this flag will

   884  automatically be disabled.

   885 

   886 \anchor cfg_warn_if_doc_error

   887 <dt>\c WARN_IF_DOC_ERROR <dd>

   888  \addindex WARN_IF_DOC_ERROR

   889  If \c WARN_IF_DOC_ERROR is set to \c YES, doxygen will generate warnings for

   890  potential errors in the documentation, such as not documenting some

   891  parameters in a documented function, or documenting parameters that

   892  don't exist or using markup commands wrongly. 

   893 

   894 \anchor cfg_warn_no_paramdoc

   895 <dt>\c WARN_NO_PARAMDOC <dd>

   896  \addindex WARN_NO_PARAMDOC

   897  This \c WARN_NO_PARAMDOC option can be abled to get warnings for 

   898  functions that are documented, but have no documentation for their parameters

   899  or return value. If set to \c NO (the default) doxygen will only warn about

   900  wrong or incomplete parameter documentation, but not about the absence of

   901  documentation.

   902 

   903 \anchor cfg_warn_format

   904 <dt>\c WARN_FORMAT <dd>

   905  \addindex WARN_FORMAT

   906  The \c WARN_FORMAT tag determines the format of the warning messages that

   907  doxygen can produce. The string should contain the <code>\$file</code>, 

   908  <code>\$line</code>, and <code>\$text</code> 

   909  tags, which will be replaced by the file and line number from which the

   910  warning originated and the warning text.

   911 

   912 \anchor cfg_warn_logfile

   913 <dt>\c WARN_LOGFILE <dd>

   914  \addindex WARN_LOGFILE

   915  The \c WARN_LOGFILE tag can be used to specify a file to which warning

   916  and error messages should be written. If left blank the output is written 

   917  to stderr.

   918 

   919 </dl>

   920 

   921 \section config_input Input related options

   922 \anchor cfg_input

   923 <dl>

   924 

   925 <dt>\c INPUT <dd>

   926  \addindex INPUT

   927  The \c INPUT tag is used to specify the files and/or directories that contain 

   928  documented source files. You may enter file names like 

   929  \c myfile.cpp or directories like \c /usr/src/myproject. 

   930  Separate the files or directories with spaces.<br>

   931 

   932  \b Note: 

   933  If this tag is empty the current directory is searched.

   934 

   935 \anchor cfg_input_encoding

   936 <dt>\c INPUT_ENCODING <dd>

   937  \addindex INPUT_ENCODING

   938  This tag can be used to specify the character encoding of the source files that 

   939  doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 

   940  input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 

   941  See <a href="http://www.gnu.org/software/libiconv">the libiconv documentation</a> for 

   942  the list of possible encodings.

   943 

   944 \anchor cfg_file_patterns

   945 <dt>\c FILE_PATTERNS <dd>

   946  \addindex FILE_PATTERNS

   947  If the value of the \c INPUT tag contains directories, you can use the 

   948  \c FILE_PATTERNS tag to specify one or more wildcard patterns 

   949  (like \c *.cpp and \c *.h ) to filter out the source-files 

   950  in the directories. If left blank the following patterns are tested:

   951  <code>

   952  *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 

   953  *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm

   954  </code>

   955 

   956 \anchor cfg_file_version_filter

   957 <dt>\c FILE_VERSION_FILTER <dd>

   958  \addindex FILE_VERSION_FILTER

   959  The \c FILE_VERSION_FILTER tag can be used to specify a program or script that

   960  doxygen should invoke to get the current version for each file (typically from the

   961  version control system). Doxygen will invoke the program by executing (via

   962  popen()) the command <code>command input-file</code>, where \c command is 

   963  the value of the \c FILE_VERSION_FILTER tag, and \c input-file is the name 

   964  of an input file provided by doxygen. 

   965  Whatever the program writes to standard output is used as the file version. 

   966 

   967 Example of using a shell script as a filter for Unix:

   968 \verbatim

   969  FILE_VERSION_FILTER = "/bin/sh versionfilter.sh"

   970 \endverbatim

   971 

   972 Example shell script for CVS:

   973 \verbatim

   974 #!/bin/sh

   975 cvs status $1 | sed -n 's/^[ \]*Working revision:[ \t]*\([0-9][0-9\.]*\).*/\1/p'

   976 \endverbatim 

   977  

   978 Example shell script for Subversion:

   979 \verbatim

   980 #!/bin/sh

   981 svn stat -v $1 | sed -n 's/^[ A-Z?\*|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ .*//p'

   982 \endverbatim

   983 

   984 Example filter for ClearCase:

   985 \verbatim

   986 FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"

   987 \endverbatim

   988 

   989 \anchor cfg_layout_file

   990 <dt>\c LAYOUT_FILE <dd>

   991  The \c LAYOUT_FILE tag can be used to specify a layout file which will be parsed by

   992  doxygen. The layout file controls the global structure of the generated output files

   993  in an output format independent way. The create the layout file that represents

   994  doxygen's defaults, run doxygen with the -l option. You can optionally specify a

   995  file name after the option, if omitted DoxygenLayout.xml will be used as the name

   996  of the layout file. Note that if you run doxygen from a directory containing 

   997  a file called DoxygenLayout.xml, doxygen will parse it automatically even if 

   998  the \c LAYOUT_FILE tag is left empty.

   999 

  1000 \anchor cfg_recursive

  1001 <dt>\c RECURSIVE <dd>

  1002  \addindex RECURSIVE

  1003  The \c RECURSIVE tag can be used to specify whether or not subdirectories

  1004  should be searched for input files as well. Possible values are \c YES 

  1005  and \c NO.  If left blank \c NO is used.

  1006 

  1007 \anchor cfg_exclude

  1008 <dt>\c EXCLUDE <dd>

  1009  \addindex EXCLUDE

  1010  The \c EXCLUDE tag can be used to specify files and/or directories that should

  1011  excluded from the \c INPUT source files. This way you can easily exclude a

  1012  subdirectory from a directory tree whose root is specified with the \c INPUT tag.

  1013 

  1014 \anchor cfg_exclude_symlinks

  1015 <dt>\c EXCLUDE_SYMLINKS <dd>

  1016  \addindex EXCLUDE_SYMLINKS

  1017  The \c EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 

  1018  that are symbolic links (a Unix filesystem feature) are excluded from the input.

  1019 

  1020 \anchor cfg_exclude_patterns

  1021 <dt>\c EXCLUDE_PATTERNS <dd>

  1022  \addindex EXCLUDE_PATTERNS

  1023  If the value of the \c INPUT tag contains directories, you can use the

  1024  \c EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude

  1025  certain files from those directories.

  1026 

  1027  Note that the wildcards are matched against the file with absolute path, 

  1028  so to exclude all test directories use the pattern 

  1029  <code>*</code><code>/test/</code><code>*</code>

  1030 

  1031 \anchor cfg_example_path

  1032 <dt>\c EXAMPLE_PATH <dd>

  1033  \addindex EXAMPLE_PATH

  1034  The \c EXAMPLE_PATH tag can be used to specify one or more files or

  1035  directories that contain example code fragments that are included (see

  1036  the \\include command in section \ref cmdinclude "\\include").

  1037 

  1038 \anchor cfg_example_recursive

  1039 <dt>\c EXAMPLE_RECURSIVE <dd>

  1040  \addindex EXAMPLE_RECURSIVE

  1041  If the \c EXAMPLE_RECURSIVE tag is set to \c YES then subdirectories will be

  1042  searched for input files to be used with the \\include or \\dontinclude 

  1043  commands irrespective of the value of the \c RECURSIVE tag. 

  1044  Possible values are \c YES and \c NO. If left blank \c NO is used. 

  1045 

  1046 \anchor cfg_example_patterns

  1047 <dt>\c EXAMPLE_PATTERNS <dd>

  1048  \addindex EXAMPLE_PATTERNS

  1049  If the value of the \c EXAMPLE_PATH tag contains directories, you can use the

  1050  \c EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp

  1051  and *.h) to filter out the source-files in the directories. If left

  1052  blank all files are included.

  1053 

  1054 \anchor cfg_image_path

  1055 <dt>\c IMAGE_PATH <dd>

  1056  \addindex IMAGE_PATH

  1057  The \c IMAGE_PATH tag can be used to specify one or more files or

  1058  directories that contain images that are to be included in the 

  1059  documentation (see the \ref cmdimage "\\image" command).

  1060 

  1061 \anchor cfg_input_filter

  1062 <dt>\c INPUT_FILTER <dd>

  1063  \addindex INPUT_FILTER

  1064  The \c INPUT_FILTER tag can be used to specify a program that doxygen should

  1065  invoke to filter for each input file. Doxygen will invoke the filter program

  1066  by executing (via popen()) the command:

  1067 \verbatim <filter> <input-file>

  1068 \endverbatim

  1069  

  1070  where \<filter\>

  1071  is the value of the \c INPUT_FILTER tag, and \<input-file\> is the name of an

  1072  input file. Doxygen will then use the output that the filter program writes

  1073  to standard output.

  1074 

  1075 \anchor cfg_filter_patterns

  1076 <dt>\c FILTER_PATTERNS <dd>

  1077  \addindex FILTER_PATTERNS

  1078  The \c FILTER_PATTERNS tag can be used to specify filters on a per file pattern

  1079  basis.  Doxygen will compare the file name with each pattern and apply the

  1080  filter if there is a match.  The filters are a list of the form:

  1081  pattern=filter (like <code>*.cpp=my_cpp_filter</code>). See \c INPUT_FILTER for further

  1082  info on how filters are used. If \c FILTER_PATTERNS is empty, \c INPUT_FILTER

  1083  is applied to all files. 

  1084 

  1085 \anchor cfg_filter_source_files

  1086 <dt>\c FILTER_SOURCE_FILES <dd>

  1087  \addindex FILTER_SOURCE_FILES

  1088  If the \c FILTER_SOURCE_FILES tag is set to \c YES, the input filter (if set using

  1089  \ref cfg_input_filter "INPUT_FILTER" ) will also be used to filter the input

  1090  files that are used for producing the source files to browse 

  1091  (i.e. when SOURCE_BROWSER is set to YES).

  1092 

  1093 </dl>

  1094 

  1095 \section sourcebrowser_index Source browsing related options

  1096 \anchor cfg_source_browser

  1097 <dl>

  1098 

  1099 <dt>\c SOURCE_BROWSER <dd>

  1100  \addindex SOURCE_BROWSER

  1101  If the \c SOURCE_BROWSER tag is set to \c YES then a list of source files will

  1102  be generated. Documented entities will be cross-referenced with these sources.

  1103  Note: To get rid of all source code in the generated output, make sure also

  1104  \c VERBATIM_HEADERS is set to NO.

  1105 

  1106 \anchor cfg_inline_sources

  1107 <dt>\c INLINE_SOURCES <dd>

  1108  \addindex INLINE_SOURCES

  1109  Setting the \c INLINE_SOURCES tag to \c YES will include the body

  1110  of functions, classes and enums directly into the documentation.

  1111 

  1112 \anchor cfg_strip_code_comments

  1113 <dt>\c STRIP_CODE_COMMENTS <dd>

  1114  \addindex STRIP_CODE_COMMENTS

  1115  Setting the \c STRIP_CODE_COMMENTS tag to \c YES (the default) will instruct

  1116  doxygen to hide any special comment blocks from generated source code

  1117  fragments. Normal C and C++ comments will always remain visible.

  1118 

  1119 \anchor cfg_referenced_by_relation

  1120 <dt>\c REFERENCED_BY_RELATION <dd>

  1121  \addindex REFERENCED_BY_RELATION

  1122  If the \c REFERENCED_BY_RELATION tag is set to \c YES

  1123  then for each documented function all documented

  1124  functions referencing it will be listed. 

  1125 

  1126 \anchor cfg_references_relation

  1127 <dt>\c REFERENCES_RELATION <dd>

  1128  \addindex REFERENCES_RELATION

  1129  If the \c REFERENCES_RELATION tag is set to \c YES

  1130  then for each documented function all documented entities

  1131  called/used by that function will be listed. 

  1132 

  1133 \anchor cfg_references_link_source

  1134 <dt>\c REFERENCES_LINK_SOURCE <dd>