config.doc 111 KB
Newer Older
mueller's avatar
mueller committed
1 2
/******************************************************************************
 *
dimitri's avatar
dimitri committed
3
 * 
mueller's avatar
mueller committed
4
 *
dimitri's avatar
dimitri committed
5
 * Copyright (C) 1997-2012 by Dimitri van Heesch.
mueller's avatar
mueller committed
6 7 8 9 10 11 12
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
dimitri's avatar
dimitri committed
13 14
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
mueller's avatar
mueller committed
15 16
 *
 */
dimitri's avatar
dimitri committed
17
/*! \page config Configuration
mueller's avatar
mueller committed
18

dimitri's avatar
dimitri committed
19
\tableofcontents
dimitri's avatar
dimitri committed
20
\section config_format Format
mueller's avatar
mueller committed
21

dimitri's avatar
dimitri committed
22
A configuration file is a free-form ASCII text file with a structure
dimitri's avatar
dimitri committed
23
that is similar to that of a Makefile, with the default name \c Doxyfile. It is
dimitri's avatar
dimitri committed
24 25
parsed by \c doxygen.  The file may contain tabs and newlines for
formatting purposes.  The statements in the file are case-sensitive.
mueller's avatar
mueller committed
26
Comments may be placed anywhere within the file (except within quotes).
dimitri's avatar
dimitri committed
27
Comments begin with the \# character and end at the end of the line.
mueller's avatar
mueller committed
28 29 30

The file essentially consists of a list of assignment statements.
Each statement consists of a \c TAG_NAME written in capitals,
dimitri's avatar
dimitri committed
31 32 33 34 35 36
followed by the <code>=</code> character and one or more values. If the same tag
is assigned more than once, the last assignment overwrites any earlier
assignment. For options that take a list as their argument,
the <code>+=</code> operator can be used instead of <code>=</code> to append 
new values to the list. Values are sequences of non-blanks. If the value should 
contain one or more blanks it must be surrounded by quotes (&quot;...&quot;).
mueller's avatar
mueller committed
37
Multiple lines can be concatenated by inserting a backslash (\\)
dimitri's avatar
dimitri committed
38
as the last character of a line. Environment variables can be expanded 
dimitri's avatar
dimitri committed
39
using the pattern <code>\$(ENV_VARIABLE_NAME)</code>.
mueller's avatar
mueller committed
40

dimitri's avatar
dimitri committed
41 42 43 44 45 46 47
You can also include part of a configuration file from another configuration
file using a <code>\@INCLUDE</code> tag as follows:
\verbatim
@INCLUDE = config_file_name
\endverbatim 
The include file is searched in the current working directory. You can 
also specify a list of directories that should be searched before looking
dimitri's avatar
dimitri committed
48
in the current working directory. Do this by putting a <code>\@INCLUDE_PATH</code> tag 
dimitri's avatar
dimitri committed
49
with these paths before the <code>\@INCLUDE</code> tag, e.g.:
dimitri's avatar
dimitri committed
50
\verbatim
dimitri's avatar
dimitri committed
51
@INCLUDE_PATH = my_config_dir
dimitri's avatar
dimitri committed
52 53
\endverbatim

mueller's avatar
mueller committed
54
The configuration options can be divided into several categories.
mueller's avatar
mueller committed
55 56 57
Below is an alphabetical index of the tags that are recognized 
followed by the descriptions of the tags grouped by category.

dimitri's avatar
dimitri committed
58
\secreflist
dimitri's avatar
dimitri committed
59
\refitem cfg_abbreviate_brief ABBREVIATE_BRIEF
dimitri's avatar
dimitri committed
60 61
\refitem cfg_aliases ALIASES
\refitem cfg_allexternals ALLEXTERNALS 
dimitri's avatar
dimitri committed
62
\refitem cfg_alphabetical_index ALPHABETICAL_INDEX 
dimitri's avatar
dimitri committed
63 64 65
\refitem cfg_always_detailed_sec ALWAYS_DETAILED_SEC
\refitem cfg_binary_toc BINARY_TOC
\refitem cfg_brief_member_desc BRIEF_MEMBER_DESC 
dimitri's avatar
dimitri committed
66
\refitem cfg_builtin_stl_support BUILTIN_STL_SUPPORT
dimitri's avatar
dimitri committed
67
\refitem cfg_call_graph CALL_GRAPH
dimitri's avatar
dimitri committed
68
\refitem cfg_caller_graph CALLER_GRAPH
dimitri's avatar
dimitri committed
69 70
\refitem cfg_case_sense_names CASE_SENSE_NAMES 
\refitem cfg_chm_file CHM_FILE
dimitri's avatar
dimitri committed
71
\refitem cfg_chm_index_encoding CHM_INDEX_ENCODING
dimitri's avatar
dimitri committed
72
\refitem cfg_cite_bib_files CITE_BIB_FILES
dimitri's avatar
dimitri committed
73
\refitem cfg_class_diagrams CLASS_DIAGRAMS 
dimitri's avatar
dimitri committed
74 75
\refitem cfg_class_graph CLASS_GRAPH
\refitem cfg_collaboration_graph COLLABORATION_GRAPH
dimitri's avatar
dimitri committed
76 77 78
\refitem cfg_cols_in_alpha_index COLS_IN_ALPHA_INDEX
\refitem cfg_compact_latex COMPACT_LATEX 
\refitem cfg_compact_rtf COMPACT_RTF
dimitri's avatar
dimitri committed
79
\refitem cfg_cpp_cli_support CPP_CLI_SUPPORT
dimitri's avatar
dimitri committed
80
\refitem cfg_create_subdirs CREATE_SUBDIRS
dimitri's avatar
dimitri committed
81
\refitem cfg_directory_graph DIRECTORY_GRAPH
dimitri's avatar
dimitri committed
82 83
\refitem cfg_disable_index DISABLE_INDEX 
\refitem cfg_distribute_group_doc DISTRIBUTE_GROUP_DOC
dimitri's avatar
dimitri committed
84 85
\refitem cfg_docset_bundle_id DOCSET_BUNDLE_ID
\refitem cfg_docset_feedname DOCSET_FEEDNAME
dimitri's avatar
dimitri committed
86 87
\refitem cfg_docset_publisher_id DOCSET_PUBLISHER_ID
\refitem cfg_docset_publisher_name DOCSET_PUBLISHER_NAME
dimitri's avatar
dimitri committed
88
\refitem cfg_dot_cleanup DOT_CLEANUP
dimitri's avatar
dimitri committed
89 90
\refitem cfg_dot_fontname DOT_FONTNAME
\refitem cfg_dot_fontpath DOT_FONTPATH
dimitri's avatar
dimitri committed
91
\refitem cfg_dot_fontsize DOT_FONTSIZE
dimitri's avatar
dimitri committed
92
\refitem cfg_dot_graph_max_nodes DOT_GRAPH_MAX_NODES
dimitri's avatar
dimitri committed
93
\refitem cfg_dot_image_format DOT_IMAGE_FORMAT
dimitri's avatar
dimitri committed
94
\refitem cfg_dot_multi_targets DOT_MULTI_TARGETS
dimitri's avatar
dimitri committed
95
\refitem cfg_dot_num_threads DOT_NUM_THREADS
dimitri's avatar
dimitri committed
96
\refitem cfg_dot_path DOT_PATH
dimitri's avatar
dimitri committed
97
\refitem cfg_dot_transparent DOT_TRANSPARENT
dimitri's avatar
dimitri committed
98
\refitem cfg_dotfile_dirs DOTFILE_DIRS
dimitri's avatar
dimitri committed
99
\refitem cfg_doxyfile_encoding DOXYFILE_ENCODING
dimitri's avatar
dimitri committed
100
\refitem cfg_eclipse_doc_id ECLIPSE_DOC_ID
dimitri's avatar
dimitri committed
101 102
\refitem cfg_enable_preprocessing ENABLE_PREPROCESSING
\refitem cfg_enabled_sections ENABLED_SECTIONS
dimitri's avatar
dimitri committed
103
\refitem cfg_enum_values_per_line ENUM_VALUES_PER_LINE
dimitri's avatar
dimitri committed
104 105 106 107 108
\refitem cfg_example_path EXAMPLE_PATH
\refitem cfg_example_patterns EXAMPLE_PATTERNS
\refitem cfg_example_recursive EXAMPLE_RECURSIVE
\refitem cfg_exclude EXCLUDE
\refitem cfg_exclude_patterns EXCLUDE_PATTERNS
dimitri's avatar
dimitri committed
109
\refitem cfg_exclude_symbols EXCLUDE_SYMBOLS
dimitri's avatar
dimitri committed
110 111 112
\refitem cfg_exclude_symlinks EXCLUDE_SYMLINKS
\refitem cfg_expand_as_defined EXPAND_AS_DEFINED
\refitem cfg_expand_only_predef EXPAND_ONLY_PREDEF
dimitri's avatar
dimitri committed
113
\refitem cfg_ext_links_in_window EXT_LINKS_IN_WINDOW
dimitri's avatar
dimitri committed
114
\refitem cfg_extension_mapping EXTENSION_MAPPING
dimitri's avatar
dimitri committed
115 116 117
\refitem cfg_external_groups EXTERNAL_GROUPS
\refitem cfg_extra_packages EXTRA_PACKAGES
\refitem cfg_extract_all EXTRACT_ALL
dimitri's avatar
dimitri committed
118
\refitem cfg_extract_anon_nspaces EXTRACT_ANON_NSPACES
dimitri's avatar
dimitri committed
119
\refitem cfg_extract_local_classes EXTRACT_LOCAL_CLASSES
dimitri's avatar
dimitri committed
120
\refitem cfg_extract_local_methods EXTRACT_LOCAL_METHODS
dimitri's avatar
dimitri committed
121 122 123
\refitem cfg_extract_private EXTRACT_PRIVATE
\refitem cfg_extract_static EXTRACT_STATIC
\refitem cfg_file_patterns FILE_PATTERNS
dimitri's avatar
dimitri committed
124
\refitem cfg_file_version_filter FILE_VERSION_FILTER
dimitri's avatar
dimitri committed
125
\refitem cfg_filter_patterns FILTER_PATTERNS
dimitri's avatar
dimitri committed
126
\refitem cfg_filter_source_files FILTER_SOURCE_FILES
dimitri's avatar
dimitri committed
127
\refitem cfg_filter_source_patterns FILTER_SOURCE_PATTERNS
dimitri's avatar
dimitri committed
128
\refitem cfg_force_local_includes FORCE_LOCAL_INCLUDES
dimitri's avatar
dimitri committed
129
\refitem cfg_formula_fontsize FORMULA_FONTSIZE
dimitri's avatar
dimitri committed
130
\refitem cfg_formula_transparent FORMULA_TRANSPARENT
dimitri's avatar
dimitri committed
131
\refitem cfg_full_path_names FULL_PATH_NAMES
dimitri's avatar
dimitri committed
132
\refitem cfg_generate_autogen_def GENERATE_AUTOGEN_DEF
dimitri's avatar
dimitri committed
133 134
\refitem cfg_generate_buglist GENERATE_BUGLIST
\refitem cfg_generate_chi GENERATE_CHI
dimitri's avatar
dimitri committed
135
\refitem cfg_generate_deprecatedlist GENERATE_DEPRECIATEDLIST
dimitri's avatar
dimitri committed
136
\refitem cfg_generate_docset GENERATE_DOCSET
dimitri's avatar
dimitri committed
137
\refitem cfg_generate_eclipsehelp GENERATE_ECLIPSEHELP
dimitri's avatar
dimitri committed
138 139 140 141 142
\refitem cfg_generate_html GENERATE_HTML
\refitem cfg_generate_htmlhelp GENERATE_HTMLHELP
\refitem cfg_generate_latex GENERATE_LATEX
\refitem cfg_generate_legend GENERATE_LEGEND
\refitem cfg_generate_man GENERATE_MAN
dimitri's avatar
dimitri committed
143
\refitem cfg_generate_perlmod GENERATE_PERLMOD
dimitri's avatar
dimitri committed
144
\refitem cfg_generate_qhp GENERATE_QHP
dimitri's avatar
dimitri committed
145 146 147 148 149
\refitem cfg_generate_rtf GENERATE_RTF
\refitem cfg_generate_tagfile GENERATE_TAGFILE
\refitem cfg_generate_testlist GENERATE_TESTLIST
\refitem cfg_generate_todolist GENERATE_TODOLIST
\refitem cfg_generate_treeview GENERATE_TREEVIEW
dimitri's avatar
dimitri committed
150
\refitem cfg_generate_xml GENERATE_XML
dimitri's avatar
dimitri committed
151
\refitem cfg_graphical_hierarchy GRAPHICAL_HIERARCHY
dimitri's avatar
dimitri committed
152
\refitem cfg_group_graphs GROUP_GRAPHS
dimitri's avatar
dimitri committed
153 154
\refitem cfg_have_dot HAVE_DOT
\refitem cfg_hhc_location HHC_LOCATION
dimitri's avatar
dimitri committed
155
\refitem cfg_hide_friend_compounds HIDE_FRIEND_COMPOUNDS
dimitri's avatar
dimitri committed
156
\refitem cfg_hide_in_body_docs HIDE_IN_BODY_DOCS
dimitri's avatar
dimitri committed
157 158 159 160 161
\refitem cfg_hide_scope_names HIDE_SCOPE_NAMES
\refitem cfg_hide_undoc_classes HIDE_UNDOC_CLASSES
\refitem cfg_hide_undoc_members HIDE_UNDOC_MEMBERS
\refitem cfg_hide_undoc_relations HIDE_UNDOC_RELATIONS
\refitem cfg_html_align_members HTML_ALIGN_MEMBERS
dimitri's avatar
dimitri committed
162 163 164
\refitem cfg_html_colorstyle_gamma HTML_COLORSTYLE_GAMMA
\refitem cfg_html_colorstyle_hue HTML_COLORSTYLE_HUE
\refitem cfg_html_colorstyle_sat HTML_COLORSTYLE_SAT
dimitri's avatar
dimitri committed
165
\refitem cfg_html_dynamic_sections HTML_DYNAMIC_SECTIONS
dimitri's avatar
dimitri committed
166
\refitem cfg_html_extra_files HTML_EXTRA_FILES
dimitri's avatar
dimitri committed
167
\refitem cfg_html_file_extension HTML_FILE_EXTENSION
dimitri's avatar
dimitri committed
168 169 170 171
\refitem cfg_html_footer HTML_FOOTER
\refitem cfg_html_header HTML_HEADER
\refitem cfg_html_output HTML_OUTPUT
\refitem cfg_html_stylesheet HTML_STYLESHEET
dimitri's avatar
dimitri committed
172
\refitem cfg_html_timestamp HTML_TIMESTAMP
dimitri's avatar
dimitri committed
173
\refitem cfg_idl_property_support IDL_PROPERTY_SUPPORT
dimitri's avatar
dimitri committed
174 175
\refitem cfg_ignore_prefix IGNORE_PREFIX
\refitem cfg_image_path IMAGE_PATH
dimitri's avatar
dimitri committed
176
\refitem cfg_include_file_patterns INCLUDE_FILE_PATTERNS
dimitri's avatar
dimitri committed
177
\refitem cfg_include_graph INCLUDE_GRAPH
dimitri's avatar
dimitri committed
178
\refitem cfg_include_path INCLUDE_PATH
dimitri's avatar
dimitri committed
179
\refitem cfg_included_by_graph INCLUDED_BY_GRAPH
dimitri's avatar
dimitri committed
180
\refitem cfg_inherit_docs INHERIT_DOCS
dimitri's avatar
dimitri committed
181
\refitem cfg_inline_grouped_classes INLINE_GROUPED_CLASSES
dimitri's avatar
dimitri committed
182 183 184 185
\refitem cfg_inline_info INLINE_INFO
\refitem cfg_inline_inherited_memb INLINE_INHERITED_MEMB
\refitem cfg_inline_sources INLINE_SOURCES
\refitem cfg_input INPUT
dimitri's avatar
dimitri committed
186
\refitem cfg_input_encoding INPUT_ENCODING
dimitri's avatar
dimitri committed
187
\refitem cfg_input_filter INPUT_FILTER
dimitri's avatar
dimitri committed
188
\refitem cfg_interactive_svg INTERACTIVE_SVG
dimitri's avatar
dimitri committed
189 190 191
\refitem cfg_internal_docs INTERNAL_DOCS
\refitem cfg_javadoc_autobrief JAVADOC_AUTOBRIEF
\refitem cfg_latex_batchmode LATEX_BATCHMODE
dimitri's avatar
dimitri committed
192
\refitem cfg_latex_bib_style LATEX_BIB_STYLE
dimitri's avatar
dimitri committed
193
\refitem cfg_latex_cmd_name LATEX_CMD_NAME
dimitri's avatar
dimitri committed
194
\refitem cfg_latex_footer LATEX_FOOTER
dimitri's avatar
dimitri committed
195
\refitem cfg_latex_header LATEX_HEADER
dimitri's avatar
dimitri committed
196
\refitem cfg_latex_hide_indices LATEX_HIDE_INDICES
dimitri's avatar
dimitri committed
197
\refitem cfg_latex_output LATEX_OUTPUT
dimitri's avatar
dimitri committed
198
\refitem cfg_latex_source_code LATEX_SOURCE_CODE
dimitri's avatar
dimitri committed
199
\refitem cfg_layout_file LAYOUT_FILE
dimitri's avatar
dimitri committed
200
\refitem cfg_lookup_cache_size LOOKUP_CACHE_SIZE
dimitri's avatar
dimitri committed
201 202 203 204 205
\refitem cfg_macro_expansion MACRO_EXPANSION
\refitem cfg_makeindex_cmd_name MAKEINDEX_CMD_NAME
\refitem cfg_man_extension MAN_EXTENSION
\refitem cfg_man_links MAN_LINKS
\refitem cfg_man_output MAN_OUTPUT
dimitri's avatar
dimitri committed
206
\refitem cfg_markdown_support MARKDOWN_SUPPORT
dimitri's avatar
dimitri committed
207
\refitem cfg_mathjax_extensions MATHJAX_EXTENSIONS
dimitri's avatar
dimitri committed
208
\refitem cfg_mathjax_relpath MATHJAX_RELPATH
dimitri's avatar
dimitri committed
209
\refitem cfg_max_dot_graph_depth MAX_DOT_GRAPH_DEPTH
dimitri's avatar
dimitri committed
210
\refitem cfg_max_initializer_lines MAX_INITIALIZER_LINES
dimitri's avatar
dimitri committed
211
\refitem cfg_mscfile_dirs MSCFILE_DIRS
dimitri's avatar
dimitri committed
212
\refitem cfg_mscgen_path MSCGEN_PATH
dimitri's avatar
dimitri committed
213
\refitem cfg_multiline_cpp_is_brief MULTILINE_CPP_IS_BRIEF
dimitri's avatar
dimitri committed
214
\refitem cfg_optimize_for_fortran OPTIMIZE_FOR_FORTRAN
dimitri's avatar
dimitri committed
215 216
\refitem cfg_optimize_output_for_c OPTIMIZE_OUTPUT_FOR_C
\refitem cfg_optimize_output_java OPTIMIZE_OUTPUT_JAVA
dimitri's avatar
dimitri committed
217
\refitem cfg_optimize_output_vhdl OPTIMIZE_OUTPUT_VHDL
dimitri's avatar
dimitri committed
218 219 220 221 222
\refitem cfg_output_directory OUTPUT_DIRECTORY
\refitem cfg_output_language OUTPUT_LANGUAGE
\refitem cfg_paper_type PAPER_TYPE
\refitem cfg_pdf_hyperlinks PDF_HYPERLINKS
\refitem cfg_perl_path PERL_PATH
dimitri's avatar
dimitri committed
223 224
\refitem cfg_perlmod_latex PERLMOD_LATEX
\refitem cfg_perlmod_makevar_prefix PERLMOD_MAKEVAR_PREFIX
dimitri's avatar
dimitri committed
225
\refitem cfg_perlmod_pretty PERLMOD_PRETTY
dimitri's avatar
dimitri committed
226
\refitem cfg_predefined PREDEFINED
dimitri's avatar
dimitri committed
227 228
\refitem cfg_project_brief PROJECT_BRIEF
\refitem cfg_project_logo PROJECT_LOGO
dimitri's avatar
dimitri committed
229 230
\refitem cfg_project_name PROJECT_NAME
\refitem cfg_project_number PROJECT_NUMBER
dimitri's avatar
dimitri committed
231
\refitem cfg_qch_file QCH_FILE
dimitri's avatar
dimitri committed
232
\refitem cfg_qhg_location QHG_LOCATION
dimitri's avatar
dimitri committed
233
\refitem cfg_qhp_cust_filter_attrs QHP_CUST_FILTER_ATTRS
dimitri's avatar
dimitri committed
234 235
\refitem cfg_qhp_cust_filter_name QHP_CUST_FILTER_NAME
\refitem cfg_qhp_namespace QHP_NAMESPACE
dimitri's avatar
dimitri committed
236
\refitem cfg_qhp_sect_filter_attrs QHP_SECT_FILTER_ATTRS
dimitri's avatar
dimitri committed
237
\refitem cfg_qhp_virtual_folder QHP_VIRTUAL_FOLDER
dimitri's avatar
dimitri committed
238
\refitem cfg_qt_autobrief QT_AUTOBRIEF
dimitri's avatar
dimitri committed
239 240 241
\refitem cfg_quiet QUIET
\refitem cfg_recursive RECURSIVE
\refitem cfg_referenced_by_relation REFERENCED_BY_RELATION
dimitri's avatar
dimitri committed
242
\refitem cfg_references_link_source REFERENCES_LINK_SOURCE
dimitri's avatar
dimitri committed
243
\refitem cfg_references_relation REFERENCES_RELATION
dimitri's avatar
dimitri committed
244 245 246 247 248 249 250
\refitem cfg_repeat_brief REPEAT_BRIEF
\refitem cfg_rtf_extensions_file RTF_EXTENSIONS_FILE
\refitem cfg_rtf_hyperlinks RTF_HYPERLINKS
\refitem cfg_rtf_output RTF_OUTPUT
\refitem cfg_rtf_stylesheet_file RTF_STYLESHEET_FILE
\refitem cfg_search_includes SEARCH_INCLUDES
\refitem cfg_searchengine SEARCHENGINE
dimitri's avatar
dimitri committed
251
\refitem cfg_separate_member_pages SEPARATE_MEMBER_PAGES
dimitri's avatar
dimitri committed
252
\refitem cfg_server_based_search SERVER_BASED_SEARCH
dimitri's avatar
dimitri committed
253
\refitem cfg_short_names SHORT_NAMES
dimitri's avatar
dimitri committed
254
\refitem cfg_show_files SHOW_FILES
dimitri's avatar
dimitri committed
255
\refitem cfg_show_include_files SHOW_INCLUDE_FILES
dimitri's avatar
dimitri committed
256
\refitem cfg_show_namespaces SHOW_NAMESPACES
dimitri's avatar
dimitri committed
257
\refitem cfg_show_used_files SHOW_USED_FILES
dimitri's avatar
dimitri committed
258
\refitem cfg_sip_support SIP_SUPPORT
dimitri's avatar
dimitri committed
259
\refitem cfg_skip_function_macros SKIP_FUNCTION_MACROS
dimitri's avatar
dimitri committed
260
\refitem cfg_sort_brief_docs SORT_BRIEF_DOCS
dimitri's avatar
dimitri committed
261 262
\refitem cfg_sort_by_scope_name SORT_BY_SCOPE_NAME
\refitem cfg_sort_group_names SORT_GROUP_NAMES
dimitri's avatar
dimitri committed
263
\refitem cfg_sort_member_docs SORT_MEMBER_DOCS
dimitri's avatar
dimitri committed
264
\refitem cfg_sort_members_constructors_first SORT_MEMBERS_CTORS_1ST
dimitri's avatar
dimitri committed
265 266
\refitem cfg_source_browser SOURCE_BROWSER
\refitem cfg_strip_code_comments STRIP_CODE_COMMENTS
dimitri's avatar
dimitri committed
267
\refitem cfg_strip_from_inc_path STRIP_FROM_INC_PATH
dimitri's avatar
dimitri committed
268
\refitem cfg_strip_from_path STRIP_FROM_PATH
dimitri's avatar
dimitri committed
269
\refitem cfg_subgrouping SUBGROUPING
dimitri's avatar
dimitri committed
270
\refitem cfg_symbol_cache_size SYMBOL_CACHE_SIZE
dimitri's avatar
dimitri committed
271 272 273 274 275
\refitem cfg_tab_size TAB_SIZE
\refitem cfg_tagfiles TAGFILES
\refitem cfg_template_relations TEMPLATE_RELATIONS
\refitem cfg_toc_expand TOC_EXPAND
\refitem cfg_treeview_width TREEVIEW_WIDTH
dimitri's avatar
dimitri committed
276
\refitem cfg_typedef_hides_struct TYPEDEF_HIDES_STRUCT
dimitri's avatar
dimitri committed
277
\refitem cfg_uml_limit_num_fields UML_LIMIT_NUM_FIELDS
dimitri's avatar
dimitri committed
278
\refitem cfg_uml_look UML_LOOK
dimitri's avatar
dimitri committed
279
\refitem cfg_use_htags USE_HTAGS
dimitri's avatar
dimitri committed
280
\refitem cfg_use_mathjax USE_MATHJAX
dimitri's avatar
dimitri committed
281
\refitem cfg_use_pdflatex USE_PDFLATEX
dimitri's avatar
dimitri committed
282 283
\refitem cfg_verbatim_headers VERBATIM_HEADERS
\refitem cfg_warn_format WARN_FORMAT
dimitri's avatar
dimitri committed
284
\refitem cfg_warn_if_doc_error WARN_IF_DOC_ERROR
dimitri's avatar
dimitri committed
285 286
\refitem cfg_warn_if_undocumented WARN_IF_UNDOCUMENTED
\refitem cfg_warn_logfile WARN_LOGFILE
dimitri's avatar
dimitri committed
287
\refitem cfg_warn_no_paramdoc WARN_NO_PARAMDOC
dimitri's avatar
dimitri committed
288
\refitem cfg_warnings WARNINGS
dimitri's avatar
dimitri committed
289
\refitem cfg_xml_dtd XML_DTD
dimitri's avatar
dimitri committed
290
\refitem cfg_xml_output XML_OUTPUT
dimitri's avatar
dimitri committed
291
\refitem cfg_xml_programlisting XML_PROGRAMLISTING
dimitri's avatar
dimitri committed
292
\refitem cfg_xml_schema XML_SCHEMA
dimitri's avatar
dimitri committed
293 294
\endsecreflist

dimitri's avatar
dimitri committed
295
\section config_project Project related options
dimitri's avatar
dimitri committed
296
\anchor cfg_doxyfile_encoding
mueller's avatar
mueller committed
297 298
<dl>

dimitri's avatar
dimitri committed
299 300 301 302 303 304 305 306 307
<dt>\c DOXYFILE_ENCODING <dd>
 \addindex DOXYFILE_ENCODING
 This tag specifies the encoding used for all characters in the config file that 
 follow. The default is UTF-8 which is also the encoding used for all text before
 the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
 libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
 possible encodings.

\anchor cfg_project_name
mueller's avatar
mueller committed
308 309 310 311 312 313 314
<dt>\c PROJECT_NAME <dd>
 \addindex PROJECT_NAME
 The \c PROJECT_NAME tag is a single word (or a sequence of words
 surrounded by double-quotes) that should identify the project for which the 
 documentation is generated. This name is used in the title of most 
 generated pages and in a few other places.

mueller's avatar
mueller committed
315
\anchor cfg_project_number
mueller's avatar
mueller committed
316 317 318 319 320 321
<dt>\c PROJECT_NUMBER <dd>
 \addindex PROJECT_NUMBER
 The \c PROJECT_NUMBER 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.

dimitri's avatar
dimitri committed
322 323 324 325 326 327 328 329 330 331 332 333 334
\anchor cfg_project_brief
<dt>\c PROJECT_BRIEF <dd>
 Using the \c PROJECT_BRIEF 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. 

\anchor cfg_project_logo
<dt>\c PROJECT_LOGO <dd>
 With the \c PROJECT_LOGO tag one can specify an logo or icon that is 
 included in the documentation. The maximum height of the logo should not 
 exceed 55 pixels and the maximum width should not exceed 200 pixels. 
 Doxygen will copy the logo to the output directory.

mueller's avatar
mueller committed
335
\anchor cfg_output_directory
mueller's avatar
mueller committed
336 337 338
<dt>\c OUTPUT_DIRECTORY <dd> 
 \addindex OUTPUT_DIRECTORY
 The \c OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
dimitri's avatar
dimitri committed
339
 path into which the generated documentation will be written. 
mueller's avatar
mueller committed
340 341 342
 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.

dimitri's avatar
dimitri committed
343 344 345 346
\anchor cfg_create_subdirs
<dt>\c CREATE_SUBDIRS <dd> 
 \addindex CREATE_SUBDIRS
 If the \c CREATE_SUBDIRS tag is set to \c YES, then doxygen will create
dimitri's avatar
dimitri committed
347
 4096 sub-directories (in 2 levels) under the output directory of each output 
dimitri's avatar
dimitri committed
348 349 350 351 352
 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. 

mueller's avatar
mueller committed
353
\anchor cfg_output_language
mueller's avatar
mueller committed
354 355 356 357 358 359
<dt>\c OUTPUT_LANGUAGE <dd>
 \addindex OUTPUT_LANGUAGE
 The \c OUTPUT_LANGUAGE tag is used to specify the language in which all
 documentation generated by doxygen is written. Doxygen will use this
 information to generate all constant output in the proper language.
 The default language is English, other supported languages are:
dimitri's avatar
dimitri committed
360 361 362
 Afrikaans, Arabic, Brazilian, Catalan, Chinese, Croatian, Czech, Danish, Dutch, 
 Finnish, French, German, Greek, Hungarian, Italian, Japanese, Korean, 
 Lithuanian, Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Serbian, 
dimitri's avatar
dimitri committed
363
 Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
mueller's avatar
mueller committed
364

mueller's avatar
mueller committed
365
\anchor cfg_brief_member_desc
mueller's avatar
mueller committed
366 367
<dt>\c BRIEF_MEMBER_DESC <dd>
 \addindex BRIEF_MEMBER_DESC
dimitri's avatar
dimitri committed
368
 If the \c BRIEF_MEMBER_DESC tag is set to \c YES (the default) doxygen will
mueller's avatar
mueller committed
369 370 371 372
 include brief member descriptions after the members that are listed in
 the file and class documentation (similar to JavaDoc).
 Set to NO to disable this.

mueller's avatar
mueller committed
373
\anchor cfg_repeat_brief
mueller's avatar
mueller committed
374 375
<dt>\c REPEAT_BRIEF <dd>
 \addindex REPEAT_BRIEF
dimitri's avatar
dimitri committed
376
 If the \c REPEAT_BRIEF tag is set to \c YES (the default) doxygen will 
mueller's avatar
mueller committed
377 378 379
 prepend the brief description of a member or function before the detailed 
 description 

mueller's avatar
mueller committed
380
 \par Note: 
mueller's avatar
mueller committed
381 382 383
 If both \c HIDE_UNDOC_MEMBERS and \c BRIEF_MEMBER_DESC are set to \c NO, the 
 brief descriptions will be completely suppressed.

dimitri's avatar
dimitri committed
384 385 386 387 388 389 390 391 392 393 394 395
\anchor cfg_abbreviate_brief
<dt>\c ABBREVIATE_BRIEF <dd>
 \addindex ABBREVIATE_BRIEF
 This tag implements a quasi-intelligent brief description abbreviator
 that is used to form the text in various listings. Each string
 in this list, if found as the leading text of the brief description, will be
 stripped from the text and the result after processing the whole list, is used
 as the annotated text. Otherwise, the brief description is used as-is. If left
 blank, the following values are used ("\$name" is automatically replaced with the
 name of the entity): "The $name class" "The $name widget" "The $name file"
 "is" "provides" "specifies" "contains" "represents" "a" "an" "the".

dimitri's avatar
dimitri committed
396 397
\anchor cfg_always_detailed_sec
<dt>\c ALWAYS_DETAILED_SEC <dd>
dimitri's avatar
dimitri committed
398
 \addindex ALWAYS_DETAILED_SEC
dimitri's avatar
dimitri committed
399
 If the \c ALWAYS_DETAILED_SEC and \c REPEAT_BRIEF tags are both set to \c YES then
dimitri's avatar
dimitri committed
400
 doxygen will generate a detailed section even if there is only a brief
dimitri's avatar
dimitri committed
401
 description.
dimitri's avatar
dimitri committed
402

dimitri's avatar
dimitri committed
403 404 405 406 407 408 409 410
\anchor cfg_inline_inherited_memb
<dt>\c INLINE_INHERITED_MEMB <dd>
\addindex INLINE_INHERITED_MEMB
 If the \c INLINE_INHERITED_MEMB tag is set to \c YES, 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.

mueller's avatar
mueller committed
411
\anchor cfg_full_path_names
mueller's avatar
mueller committed
412 413
<dt>\c FULL_PATH_NAMES <dd>
 \addindex FULL_PATH_NAMES
dimitri's avatar
dimitri committed
414
 If the \c FULL_PATH_NAMES tag is set to \c YES doxygen will prepend the full
mueller's avatar
mueller committed
415 416 417
 path before files name in the file list and in the header files. If set
 to NO the shortest path that makes the file name unique will be used

mueller's avatar
mueller committed
418
\anchor cfg_strip_from_path
mueller's avatar
mueller committed
419 420 421
<dt>\c STRIP_FROM_PATH <dd>
 \addindex STRIP_FROM_PATH
 If the \c FULL_PATH_NAMES tag is set to \c YES then the \c STRIP_FROM_PATH tag
dimitri's avatar
dimitri committed
422
 can be used to strip a user-defined part of the path. Stripping is
mueller's avatar
mueller committed
423
 only done if one of the specified strings matches the left-hand part of the 
dimitri's avatar
dimitri committed
424 425 426 427 428
 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.

\anchor cfg_strip_from_inc_path
dimitri's avatar
dimitri committed
429 430
<dt>\c STRIP_FROM_INC_PATH <dd>
 \addindex STRIP_FROM_INC_PATH
dimitri's avatar
dimitri committed
431 432 433 434 435 436 437
 The \c STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
 the path mentioned in the documentation of a class, which tells
 the reader which header file to include in order to use a class. 
 If left blank only the name of the header file containing the class
 definition is used. Otherwise one should specify the include paths that 
 are normally passed to the compiler using the -I flag.

dimitri's avatar
dimitri committed
438 439 440 441 442 443 444
\anchor cfg_short_names
<dt>\c SHORT_NAMES <dd>
 \addindex SHORT_NAMES
 If the \c SHORT_NAMES tag is set to \c YES, 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.

mueller's avatar
mueller committed
445
\anchor cfg_javadoc_autobrief
mueller's avatar
mueller committed
446
<dt>\c JAVADOC_AUTOBRIEF <dd>
mueller's avatar
mueller committed
447
 \addindex JAVADOC_AUTOBRIEF
dimitri's avatar
dimitri committed
448
  If the \c JAVADOC_AUTOBRIEF is set to \c YES then doxygen
mueller's avatar
mueller committed
449
  will interpret the first line (until the first dot) of a JavaDoc-style
dimitri's avatar
dimitri committed
450
  comment as the brief description. If set to NO (the default), the 
dimitri's avatar
dimitri committed
451 452 453 454 455 456 457 458 459 460 461
  Javadoc-style will behave just like regular Qt-style comments
  (thus requiring an explicit \@brief command for a brief description.)

\anchor cfg_qt_autobrief
<dt>\c QT_AUTOBRIEF <dd>
 \addindex QT_AUTOBRIEF
  If the \c QT_AUTOBRIEF is set to \c YES then doxygen
  will interpret the first line (until the first dot) of a Qt-style
  comment as the brief description. If set to NO (the default), the
  Qt-style will behave just like regular Qt-style comments (thus
  requiring an explicit \\brief command for a brief description.)
mueller's avatar
mueller committed
462

dimitri's avatar
dimitri committed
463 464 465 466 467 468 469 470 471 472
\anchor cfg_markdown_support
<dt>\c MARKDOWN_SUPPORT <dd>
 \addindex MARKDOWN_SUPPORT
 If \c MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 
 comments according to the Markdown format, which allows for more readable 
 documentation. See http://daringfireball.net/projects/markdown/ 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. 

dimitri's avatar
dimitri committed
473 474 475 476 477 478
\anchor cfg_builtin_stl_support
<dt>\c BUILTIN_STL_SUPPORT <dd>
 \addindex BUILTIN_STL_SUPPORT
 If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
 include (a tag file for) the STL sources as input, then you should
 set this tag to \c YES in order to let doxygen match functions declarations and
dimitri's avatar
dimitri committed
479
 definitions whose arguments contain STL classes (e.g. func(std::string); versus
dimitri's avatar
dimitri committed
480 481 482
 func(std::string) {}). This also make the inheritance and collaboration
 diagrams that involve STL classes more complete and accurate.

dimitri's avatar
dimitri committed
483 484 485 486 487 488
\anchor cfg_cpp_cli_support
<dt>\c CPP_CLI_SUPPORT <dd>
 \addindex CPP_CLI_SUPPORT
 If you use Microsoft's C++/CLI language, you should set this option to YES to
 enable parsing support.

dimitri's avatar
dimitri committed
489 490 491 492 493 494 495 496
\anchor cfg_sip_support
<dt>\c SIP_SUPPORT <dd>
 \addindex OPTIMIZE_OUTPUT_SIP
 Set the SIP_SUPPORT tag to YES if your project consists 
 of <a href="http://www.riverbankcomputing.co.uk/sip/">sip</a> sources only. 
 Doxygen will parse them like normal C++ but will assume all classes use public 
 instead of private inheritance when no explicit protection keyword is present. 

dimitri's avatar
dimitri committed
497 498 499 500 501 502 503 504 505 506
\anchor cfg_idl_property_support
<dt>\c IDL_PROPERTY_SUPPORT <dd>
 \addindex IDL_PROPERTY_SUPPORT
 For Microsoft's IDL there are propget and propput attributes to indicate getter
 and setter methods for a property. Setting this option to \c YES (the default)
 will make doxygen to replace the get and set methods by a property in the
 documentation. This will only work if the methods are indeed getting or 
 setting a simple type. If this is not the case, or you want to show the 
 methods anyway, you should set this option to \c NO.

dimitri's avatar
dimitri committed
507 508 509 510 511 512 513 514
\anchor cfg_distribute_group_doc
<dt>\c DISTRIBUTE_GROUP_DOC <dd>
 \addindex DISTRIBUTE_GROUP_DOC
 If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
 tag is set to YES, then doxygen will reuse the documentation of the first
 member in the group (if any) for the other members of the group. By default
 all members of a group must be documented explicitly.

dimitri's avatar
dimitri committed
515 516 517 518 519
\anchor cfg_multiline_cpp_is_brief
<dt>\c MULTILINE_CPP_IS_BRIEF <dd>
 \addindex MULTILINE_CPP_IS_BRIEF
  The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
  treat a multi-line C++ special comment block (i.e. a block of //! or ///
dimitri's avatar
dimitri committed
520
  comments) as a brief description. This used to be the default behavior.
dimitri's avatar
dimitri committed
521
  The new default is to treat a multi-line C++ comment block as a detailed
dimitri's avatar
dimitri committed
522
  description. Set this tag to YES if you prefer the old behavior instead.
dimitri's avatar
dimitri committed
523
  Note that setting this tag to YES also means that rational rose comments
dimitri's avatar
dimitri committed
524
  are not recognized any more.
dimitri's avatar
dimitri committed
525

dimitri's avatar
dimitri committed
526
<!--
dimitri's avatar
dimitri committed
527 528 529 530 531 532 533
\anchor cfg_details_at_top
<dt>\c DETAILS_AT_TOP <dd>
 \addindex DETAILS_AT_TOP
  If the DETAILS_AT_TOP tag is set to YES then Doxygen
  will output the detailed description near the top, like JavaDoc.
  If set to NO, the detailed description appears after the member
  documentation.
dimitri's avatar
dimitri committed
534
-->
dimitri's avatar
dimitri committed
535

mueller's avatar
mueller committed
536 537 538 539 540
\anchor cfg_inherit_docs
<dt>\c INHERIT_DOCS <dd>
 \addindex INHERIT_DOCS
 If the \c INHERIT_DOCS tag is set to \c YES (the default) then an undocumented
 member inherits the documentation from any documented member that it
dimitri's avatar
dimitri committed
541
 re-implements.
mueller's avatar
mueller committed
542

dimitri's avatar
dimitri committed
543 544 545 546 547 548 549
\anchor cfg_separate_member_pages
<dt>\c SEPARATE_MEMBER_PAGES <dd>
 \addindex SEPARATE_MEMBER_PAGES
 If the \c SEPARATE_MEMBER_PAGES tag is set to \c YES, then doxygen will produce
 a new page for each member. If set to \c NO, the documentation of a member will
 be part of the file/class/namespace that contains it.

mueller's avatar
mueller committed
550 551
\anchor cfg_tab_size
<dt>\c TAB_SIZE <dd>
dimitri's avatar
dimitri committed
552 553 554
 \addindex TAB_SIZE
 the \c TAB_SIZE tag can be used to set the number of spaces in a tab.
 Doxygen uses this value to replace tabs by spaces in code fragments.
mueller's avatar
mueller committed
555

dimitri's avatar
dimitri committed
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
\anchor cfg_aliases
<dt>\c ALIASES <dd>
 \addindex ALIASES
 This tag can be used to specify a number of aliases that acts 
 as commands in the documentation. An alias has the form 
\verbatim
 name=value
\endverbatim
 For example adding 
\verbatim
 "sideeffect=\par Side Effects:\n" 
\endverbatim
 will allow you to
 put the command \\sideeffect (or \@sideeffect) in the documentation, which 
 will result in a user-defined paragraph with heading "Side Effects:".
 You can put \\n's in the value part of an alias to insert newlines.

\anchor cfg_optimize_output_for_c
<dt>\c OPTIMIZE_OUTPUT_FOR_C <dd>
 \addindex OPTIMIZE_OUTPUT_FOR_C
 Set the \c OPTIMIZE_OUTPUT_FOR_C tag to \c YES 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. 

\anchor cfg_optimize_output_java
<dt>\c OPTIMIZE_OUTPUT_JAVA <dd>
 \addindex OPTIMIZE_OUTPUT_JAVA
dimitri's avatar
dimitri committed
584 585 586 587
 Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
 Python sources only. Doxygen will then generate output that is more tailored 
 for that language. For instance, namespaces will be presented as packages, 
 qualified scopes will look different, etc. 
dimitri's avatar
dimitri committed
588

dimitri's avatar
dimitri committed
589 590 591
\anchor cfg_optimize_for_fortran
<dt>\c OPTIMIZE_FOR_FORTRAN <dd>
 \addindex OPTIMIZE_FOR_FORTRAN
dimitri's avatar
dimitri committed
592 593
 Set the \c OPTIMIZE_FOR_FORTRAN tag to \c YES if your project consists of Fortran 
 sources. Doxygen will then generate output that is tailored for Fortran.
dimitri's avatar
dimitri committed
594 595 596 597

\anchor cfg_optimize_output_vhdl
<dt>\c OPTIMIZE_OUTPUT_VHDL <dd>
 \addindex OPTIMIZE_OUTPUT_VHDL
dimitri's avatar
dimitri committed
598 599 600 601 602 603 604 605 606 607 608
 Set the \c OPTIMIZE_OUTPUT_VHDL tag to \c YES if your project consists of VHDL 
 sources. Doxygen will then generate output that is tailored for VHDL.

\anchor cfg_extension_mapping
<dt>\c EXTENSION_MAPPING <dd>
 \addindex EXTENSION_MAPPING
 Doxygen selects the parser to use depending on the extension of the files it parses.
 With this tag you can assign which parser to use for a given extension.
 Doxygen has a built-in mapping, but you can override or extend it using this tag.
 The format is ext=language, where ext is a file extension, and language is one of
 the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
dimitri's avatar
dimitri committed
609
 Objective-C, Python, Fortran, VHDL. For instance to make doxygen treat
dimitri's avatar
dimitri committed
610 611
 .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
 use: inc=Fortran f=C
dimitri's avatar
dimitri committed
612

dimitri's avatar
dimitri committed
613 614 615 616 617 618 619 620 621
\anchor cfg_subgrouping
<dt>\c SUBGROUPING <dd>
 \addindex SUBGROUPING
 Set the \c SUBGROUPING tag to \c YES (the default) to allow class member groups of
 the same type (for instance a group of public functions) to be put as a
 subgroup of that type (e.g. under the Public Functions section). Set it to
 \c NO to prevent subgrouping. Alternatively, this can be done per class using
 the \ref cmdnosubgrouping "\\nosubgrouping" command. 

dimitri's avatar
dimitri committed
622 623 624 625 626 627 628 629 630
\anchor cfg_inline_grouped_classes
<dt>\c INLINE_GROUPED_CLASSES <dd>
 \addindex INLINE_GROUPED_CLASSES
When the \c INLINE_GROUPED_CLASSES tag is set to \c YES, classes, structs and 
unions are shown inside the group in which they are included 
(e.g. using @@ingroup) instead of on a separate page (for HTML and Man pages) 
or section (for LaTeX and RTF). Note that this feature does not work in
combination with \ref cfg_separate_member_pages "SEPARATE_MEMBER_PAGES".

dimitri's avatar
dimitri committed
631 632 633
\anchor cfg_typedef_hides_struct 
<dt>\c TYPEDEF_HIDES_STRUCT <dd>
 \addindex TYPEDEF_HIDES_STRUCT
dimitri's avatar
dimitri committed
634 635 636 637 638 639 640
 When \c TYPEDEF_HIDES_STRUCT 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 \c TypeT. When disabled the typedef will appear as a member of a file, 
 namespace, or class. And the struct will be named \c TypeS. 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.
dimitri's avatar
dimitri committed
641

dimitri's avatar
dimitri committed
642 643 644 645 646 647 648 649 650
\anchor cfg_symbol_cache_size
<dt>\c SYMBOL_CACHE_SIZE <dd>
 \addindex SYMBOL_CACHE_SIZE
 The \c SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
 determine which symbols to keep in memory and which to flush to disk.
 When the cache is full, less often used symbols will be written to disk.
 For small to medium size projects (<1000 input files) the default value is
 probably good enough. For larger projects a too small cache size can cause 
 doxygen to be busy swapping symbols to and from disk most of the time
dimitri's avatar
dimitri committed
651
 causing a significant performance penalty.
dimitri's avatar
dimitri committed
652 653
 If the system has enough physical memory increasing the cache will improve the
 performance by keeping more symbols in memory. Note that the value works on
dimitri's avatar
dimitri committed
654
 a logarithmic scale so increasing the size by one will roughly double the
dimitri's avatar
dimitri committed
655 656 657 658
 memory usage. The cache size is given by this formula: 
 \f$2^{(16+\mbox{SYMBOL\_CACHE\_SIZE})}\f$. The valid range is 0..9, the default is 0, 
 corresponding to a cache size of \f$2^{16} = 65536\f$ symbols.

dimitri's avatar
dimitri committed
659 660 661 662 663 664 665 666 667 668 669 670
\anchor cfg_lookup_cache_size
<dt>\c LOOKUP_CACHE_SIZE <dd>
 \addindex LOOKUP_CACHE_SIZE
 Similar to the \c SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 
 set using \c LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 
 their name and scope. Since this can be an expensive process and often the 
 same symbol appear multiple times in the code, doxygen keeps a cache of 
 pre-resolved symbols. If the cache is too small doxygen will become slower. 
 If the cache is too large, memory is wasted. The cache size is given by this 
 formula: \f$2^{(16+\mbox{LOOKUP\_CACHE\_SIZE})}\f$. The valid range is 0..9, the default is 0, 
 corresponding to a cache size of \f$2^{16} = 65536\f$ symbols. 

dimitri's avatar
dimitri committed
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
</dl>

\section config_build Build related options
\anchor cfg_extract_all
<dl>

<dt>\c EXTRACT_ALL <dd>
 \addindex EXTRACT_ALL
 If the \c EXTRACT_ALL tag is set to \c YES 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 \c EXTRACT_PRIVATE and \c EXTRACT_STATIC tags are set to \c YES

 \par Note: 
 This will also disable the warnings about undocumented members 
 that are normally produced when \c WARNINGS is set to \c YES

\anchor cfg_extract_private
<dt>\c EXTRACT_PRIVATE <dd>
 \addindex EXTRACT_PRIVATE
 If the \c EXTRACT_PRIVATE tag is set to \c YES all private members of a 
 class will be included in the documentation.

\anchor cfg_extract_static
<dt>\c EXTRACT_STATIC <dd>
 \addindex EXTRACT_STATIC
 If the \c EXTRACT_STATIC tag is set to \c YES all static members of a file
 will be included in the documentation.

\anchor cfg_extract_local_classes
<dt>\c EXTRACT_LOCAL_CLASSES <dd>
 \addindex EXTRACT_LOCAL_CLASSES
 If the \c EXTRACT_LOCAL_CLASSES tag is set to \c YES classes (and structs) 
 defined locally in source files will be included in the documentation. 
 If set to NO only classes defined in header files are included. Does not
 have any effect for Java sources.

dimitri's avatar
dimitri committed
708 709 710 711 712 713 714 715
\anchor cfg_extract_anon_nspaces
<dt>\c EXTRACT_ANON_NSPACES <dd>
 \addindex EXTRACT_ANON_NSPACES
 If this flag is set to YES, the members of anonymous namespaces will be extracted
 and appear in the documentation as a namespace called 'anonymous_namespace{file}',
 where file will be replaced with the base name of the file that contains the anonymous
 namespace. By default anonymous namespace are hidden.

dimitri's avatar
dimitri committed
716 717 718 719 720 721 722 723
\anchor cfg_extract_local_methods
<dt>\c EXTRACT_LOCAL_METHODS <dd>
 \addindex EXTRACT_LOCAL_METHODS
 This flag is only useful for Objective-C code. When set to \c YES local 
 methods, which are defined in the implementation section but not in
 the interface are included in the documentation.
 If set to \c NO (the default) only methods in the interface are included.

dimitri's avatar
dimitri committed
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
\anchor cfg_hide_undoc_members
<dt>\c HIDE_UNDOC_MEMBERS <dd>
 \addindex HIDE_UNDOC_MEMBERS
 If the \c HIDE_UNDOC_MEMBERS tag is set to \c YES, doxygen will hide all
 undocumented members inside documented classes or files. 
 If set to \c NO (the default) these members will be included in the
 various overviews, but no documentation section is generated.
 This option has no effect if \c EXTRACT_ALL is enabled.

\anchor cfg_hide_undoc_classes
<dt>\c HIDE_UNDOC_CLASSES <dd>
 \addindex HIDE_UNDOC_CLASSES
 If the \c HIDE_UNDOC_CLASSESS tag is set to \c YES, doxygen will hide all
 undocumented classes.
 If set to \c NO (the default) these classes will be included in the
 various overviews.
 This option has no effect if \c EXTRACT_ALL is enabled.

\anchor cfg_hide_friend_compounds
<dt>\c HIDE_FRIEND_COMPOUNDS <dd>
 \addindex HIDE_FRIEND_COMPOUNDS
 If the \c HIDE_FRIEND_COMPOUNDS tag is set to \c YES, Doxygen will hide all
 friend (class|struct|union) declarations.
 If set to \c NO (the default) these declarations will be included in the
 documentation.
 
\anchor cfg_hide_in_body_docs
<dt>\c HIDE_IN_BODY_DOCS <dd>
 \addindex HIDE_IN_BODY_DOCS
If the \c HIDE_IN_BODY_DOCS tag is set to \c YES, Doxygen will hide any 
documentation blocks found inside the body of a function.
If set to \c NO (the default) these blocks will be appended to the 
function's detailed documentation block.
 
\anchor cfg_internal_docs
<dt>\c INTERNAL_DOCS <dd>
 \addindex INTERNAL_DOCS
 The \c INTERNAL_DOCS tag determines if documentation
 that is typed after a \ref cmdinternal "\\internal" command is included. If the tag is set
 to \c NO (the default) then the documentation will be excluded.
 Set it to \c YES to include the internal documentation.

dimitri's avatar
dimitri committed
766 767 768 769 770 771 772 773 774 775
\anchor cfg_case_sense_names
<dt>\c CASE_SENSE_NAMES <dd>
 \addindex CASE_SENSE_NAMES
 If the \c CASE_SENSE_NAMES tag is set to \c NO then doxygen
 will only generate file names in lower-case letters. If set to
 \c YES upper-case letters are also allowed. This is useful if you have
 classes or files whose names only differ in case and if your file system
 supports case sensitive file names. Windows users are advised to set this
 option to NO.

dimitri's avatar
dimitri committed
776 777 778 779 780 781 782 783 784 785
\anchor cfg_hide_scope_names
<dt>\c HIDE_SCOPE_NAMES <dd>
 \addindex HIDE_SCOPE_NAMES
 If the \c HIDE_SCOPE_NAMES tag is set to \c NO (the default) then doxygen 
 will show members with their full class and namespace scopes in the
 documentation. If set to \c YES the scope will be hidden. 

\anchor cfg_show_include_files
<dt>\c SHOW_INCLUDE_FILES <dd>
 \addindex SHOW_INCLUDE_FILES
dimitri's avatar
dimitri committed
786
 If the SHOW_INCLUDE_FILES tag is set to \c YES (the default) then doxygen
dimitri's avatar
dimitri committed
787 788 789
 will put a list of the files that are included by a file in the documentation 
 of that file.

dimitri's avatar
dimitri committed
790 791 792 793 794 795 796
\anchor cfg_force_local_includes
<dt>\c FORCE_LOCAL_INCLUDES <dd>
 \addindex FORCE_LOCAL_INCLUDES
 If the \c FORCE_LOCAL_INCLUDES tag is set to \c YES then Doxygen 
 will list include files with double quotes in the documentation 
 rather than with sharp brackets.

dimitri's avatar
dimitri committed
797 798 799 800 801 802 803 804 805 806 807 808 809
\anchor cfg_inline_info
<dt>\c INLINE_INFO <dd>
 \addindex INLINE_INFO 
 If the \c INLINE_INFO tag is set to \c YES (the default) then a tag [inline]
 is inserted in the documentation for inline members.

\anchor cfg_sort_member_docs
<dt>\c SORT_MEMBER_DOCS <dd>
 \addindex SORT_MEMBER_DOCS
 If the \c SORT_MEMBER_DOCS tag is set to \c YES (the default) then doxygen
 will sort the (detailed) documentation of file and class members
 alphabetically by member name. If set to \c NO the members will appear in
 declaration order.
dimitri's avatar
dimitri committed
810

dimitri's avatar
dimitri committed
811 812 813 814 815 816 817 818
\anchor cfg_sort_brief_docs
<dt>\c SORT_BRIEF_DOCS <dd>
 \addindex SORT_BRIEF_DOCS
 If the \c SORT_BRIEF_DOCS tag is set to \c YES then doxygen will sort the
 brief descriptions of file, namespace and class members alphabetically
 by member name. If set to \c NO (the default) the members will appear in
 declaration order.

dimitri's avatar
dimitri committed
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837

\anchor cfg_sort_group_names
<dt>\c SORT_GROUP_NAMES <dd>
 \addindex SORT_GROUP_NAMES
 If the \c SORT_GROUP_NAMES tag is set to \c YES then doxygen will sort the 
 hierarchy of group names into alphabetical order. If set to \c NO (the default)
 the group names will appear in their defined order. 

\anchor cfg_sort_by_scope_name
<dt>\c SORT_BY_SCOPE_NAME <dd>
 \addindex SORT_BY_SCOPE_NAME
 If the \c SORT_BY_SCOPE_NAME tag is set to \c YES, the class list will be
 sorted by fully-qualified names, including namespaces. If set to
 NO (the default), the class list will be sorted only by class name,
 not including the namespace part.
 @note This option is not very useful if \c HIDE_SCOPE_NAMES is set to \c YES.
 @note This option applies only to the class list, not to the 
       alphabetical list.

dimitri's avatar
dimitri committed
838 839 840 841 842 843 844 845 846 847 848 849
\anchor cfg_sort_members_constructors_first
<dt>\c SORT_MEMBERS_CTORS_1ST <dd>
 \addindex SORT_MEMBERS_CTORS_1ST
 If the \c SORT_MEMBERS_CTORS_1ST tag is set to \c YES then doxygen
 will sort the (brief and detailed) documentation of class members so that
 constructors and destructors are listed first. If set to NO (the default)
 the constructors will appear in the respective orders defined by
 \c SORT_MEMBER_DOCS and \c SORT_BRIEF_DOCS.
 @note If \c SORT_BRIEF_DOCS is set to \c NO this option is ignored for
       sorting brief member documentation.
 @note If \c SORT_MEMBER_DOCS is set to \c NO this option is ignored for
       sorting detailed member documentation.
dimitri's avatar
dimitri committed
850

dimitri's avatar
dimitri committed
851 852 853 854 855 856 857 858
\anchor cfg_generate_deprecatedlist
<dt>\c GENERATE_DEPRECATEDLIST <dd>
 \addindex GENERATE_DEPRECATEDLIST
 The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
 disable (NO) the deprecated list. This list is created by 
 putting \ref cmddeprecated "\\deprecated"
 commands in the documentation.

dimitri's avatar
dimitri committed
859 860 861 862 863 864 865 866 867 868
\anchor cfg_strict_proto_matching
<dt>\c STRICT_PROTO_MATCHING <dd>
 \addindex STRICT_PROTO_MATCHING
 If the \c STRICT_PROTO_MATCHING 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 \c STRICT_PROTO_MATCHING doxygen 
 will still accept a match between prototype and implementation in such cases.

dimitri's avatar
dimitri committed
869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
\anchor cfg_generate_todolist
<dt>\c GENERATE_TODOLIST <dd>
 \addindex GENERATE_TODOLIST
 The GENERATE_TODOLIST tag can be used to enable (YES) or
 disable (NO) the todo list. This list is created by 
 putting \ref cmdtodo "\\todo"
 commands in the documentation.

\anchor cfg_generate_testlist
<dt>\c GENERATE_TESTLIST <dd>
 \addindex GENERATE_TESTLIST
 The GENERATE_TESTLIST tag can be used to enable (YES) or
 disable (NO) the test list. This list is created by 
 putting \ref cmdtest "\\test" commands in the documentation.

dimitri's avatar
dimitri committed
884 885 886 887 888 889 890
\anchor cfg_generate_buglist
<dt>\c GENERATE_BUGLIST <dd>
 \addindex GENERATE_BUGLIST
 The GENERATE_BUGLIST tag can be used to enable (YES) or
 disable (NO) the bug list. This list is created by 
 putting \ref cmdbug "\\bug" commands in the documentation.

dimitri's avatar
dimitri committed
891 892 893 894 895
\anchor cfg_enabled_sections
<dt>\c ENABLED_SECTIONS <dd>
 \addindex ENABLED_SECTIONS
 The \c ENABLED_SECTIONS tag can be used to enable conditional
 documentation sections, marked by \ref cmdif "\\if" \<section-label\> ... 
dimitri's avatar
dimitri committed
896 897
 \ref cmdendif "\\endif" and \ref cmdcond "\\cond" \<section-label\> ...
 \ref cmdendcond "\\endcond" blocks.
dimitri's avatar
dimitri committed
898

dimitri's avatar
dimitri committed
899 900 901 902 903 904 905 906
\anchor cfg_max_initializer_lines
<dt>\c MAX_INITIALIZER_LINES <dd>
 \addindex MAX_INITIALIZER_LINES
 The \c MAX_INITIALIZER_LINES tag determines the maximum number of lines
 that the initial value of a variable or define can be. If the initializer
 consists of more lines than specified here it will be hidden. Use a value
 of 0 to hide initializers completely. The appearance of the value of
 individual variables and defines can be controlled using \ref cmdshowinitializer "\\showinitializer"
dimitri's avatar
dimitri committed
907
 or \ref cmdhideinitializer "\\hideinitializer" command in the documentation.
dimitri's avatar
dimitri committed
908

dimitri's avatar
dimitri committed
909 910 911 912 913 914 915
\anchor cfg_show_used_files
<dt>\c SHOW_USED_FILES <dd>
 \addindex SHOW_USED_FILES
 Set the \c SHOW_USED_FILES tag to \c NO to disable the list of files generated
 at the bottom of the documentation of classes and structs. If set to \c YES the
 list will mention the files that were used to generate the documentation.

dimitri's avatar
dimitri committed
916 917 918 919 920 921 922 923 924 925 926 927 928 929
\anchor cfg_show_files
<dt>\c SHOW_FILES <dd>
 \addindex SHOW_FILES
 Set the \c SHOW_FILES tag to \c NO to disable the generation of the Files page.
 This will remove the Files entry from the Quick Index and from the
 Folder Tree View (if specified). The default is \c YES.

\anchor cfg_show_namespaces
<dt>\c SHOW_NAMESPACES <dd>
 \addindex SHOW_NAMESPACES
 Set the \c SHOW_NAMESPACES tag to \c NO to disable the generation of the
 Namespaces page.  This will remove the Namespaces entry from the Quick Index
 and from the Folder Tree View (if specified). The default is \c YES.

dimitri's avatar
dimitri committed
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
\anchor cfg_file_version_filter
<dt>\c FILE_VERSION_FILTER <dd>
 \addindex FILE_VERSION_FILTER
 The \c FILE_VERSION_FILTER tag can be used to specify a program or script that
 doxygen should invoke to get the current version for each file (typically from the
 version control system). Doxygen will invoke the program by executing (via
 popen()) the command <code>command input-file</code>, where \c command is 
 the value of the \c FILE_VERSION_FILTER tag, and \c input-file 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:
\verbatim
 FILE_VERSION_FILTER = "/bin/sh versionfilter.sh"
\endverbatim

Example shell script for CVS:
\verbatim
#!/bin/sh
cvs status $1 | sed -n 's/^[ \]*Working revision:[ \t]*\([0-9][0-9\.]*\).*/\1/p'
\endverbatim 
 
Example shell script for Subversion:
\verbatim
#!/bin/sh
svn stat -v $1 | sed -n 's/^[ A-Z?\*|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ .*//p'
\endverbatim

Example filter for ClearCase:
\verbatim
FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
\endverbatim

\anchor cfg_layout_file
<dt>\c LAYOUT_FILE <dd>
 The \c LAYOUT_FILE 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. The create the layout file that represents
 doxygen's defaults, run doxygen with the -l option. You can optionally specify a
 file name after the option, if omitted DoxygenLayout.xml will be used as the name
 of the layout file. Note that if you run doxygen from a directory containing 
 a file called DoxygenLayout.xml, doxygen will parse it automatically even if 
 the \c LAYOUT_FILE tag is left empty.

dimitri's avatar
dimitri committed
974 975 976 977 978 979 980 981 982 983 984
\anchor cfg_cite_bib_files
<dt>\c CITE_BIB_FILES <dd>
 \addindex CITE_BIB_FILES
 The \c CITE_BIB_FILES tag can be used to specify one or more bib files 
 containing the reference definitions. This must be a list of .bib files. The 
 .bib extension is automatically appended if omitted. This requires the 
 bibtex tool to be installed. See also http://en.wikipedia.org/wiki/BibTeX 
 for more info. For LaTeX the style of the bibliography can be controlled 
 using \ref cfg_latex_bib_style "LATEX_BIB_STYLE". See 
 also \ref cmdcite "\\cite" for info how to create references.

mueller's avatar
mueller committed
985 986
</dl>

dimitri's avatar
dimitri committed
987
\section messages_input Options related to warning and progress messages 
dimitri's avatar
dimitri committed
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
\anchor cfg_quiet
<dl>

<dt>\c QUIET <dd>
 \addindex QUIET
 The \c QUIET tag can be used to turn on/off the messages that are generated
 to standard output by doxygen. Possible values are \c YES and \c NO, 
 where \c YES implies that the messages are off.
 If left blank \c NO is used.

\anchor cfg_warnings
<dt>\c WARNINGS <dd>
 \addindex WARNINGS
 The \c WARNINGS tag can be used to turn on/off the warning messages that are
 generated to standard error by doxygen. Possible values are \c YES and \c NO, 
 where \c YES implies that the warnings are on. If left blank \c NO is used.

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

\anchor cfg_warn_if_undocumented
<dt>\c WARN_IF_UNDOCUMENTED <dd>
 \addindex WARN_IF_UNDOCUMENTED
dimitri's avatar
dimitri committed
1010 1011
 If \c WARN_IF_UNDOCUMENTED is set to \c YES, then doxygen will generate warnings
 for undocumented members. If \c EXTRACT_ALL is set to \c YES then this flag will
dimitri's avatar
dimitri committed
1012 1013
 automatically be disabled.

dimitri's avatar
dimitri committed
1014 1015
\anchor cfg_warn_if_doc_error
<dt>\c WARN_IF_DOC_ERROR <dd>
dimitri's avatar
dimitri committed
1016
 \addindex WARN_IF_DOC_ERROR
dimitri's avatar
dimitri committed
1017 1018 1019 1020 1021
 If \c WARN_IF_DOC_ERROR is set to \c YES, 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. 

dimitri's avatar
dimitri committed
1022
\anchor cfg_warn_no_paramdoc
dimitri's avatar
dimitri committed
1023 1024
<dt>\c WARN_NO_PARAMDOC <dd>
 \addindex WARN_NO_PARAMDOC
dimitri's avatar
dimitri committed
1025
 This \c WARN_NO_PARAMDOC option can be enabled to get warnings for 
dimitri's avatar
dimitri committed
1026 1027 1028 1029
 functions that are documented, but have no documentation for their parameters
 or return value. If set to \c NO (the default) doxygen will only warn about
 wrong or incomplete parameter documentation, but not about the absence of
 documentation.
dimitri's avatar
dimitri committed
1030

dimitri's avatar
dimitri committed
1031 1032 1033
\anchor cfg_warn_format
<dt>\c WARN_FORMAT <dd>
 \addindex WARN_FORMAT
dimitri's avatar
dimitri committed
1034
 The \c WARN_FORMAT tag determines the format of the warning messages that
dimitri's avatar
dimitri committed
1035 1036
 doxygen can produce. The string should contain the <code>\$file</code>, 
 <code>\$line</code>, and <code>\$text</code> 
dimitri's avatar
dimitri committed
1037 1038 1039
 tags, which will be replaced by the file and line number from which the
 warning originated and the warning text.

dimitri's avatar
dimitri committed
1040 1041 1042 1043 1044 1045 1046
\anchor cfg_warn_logfile
<dt>\c WARN_LOGFILE <dd>
 \addindex WARN_LOGFILE
 The \c WARN_LOGFILE tag can be used to specify a file to which warning
 and error messages should be written. If left blank the output is written 
 to stderr.

dimitri's avatar
dimitri committed
1047 1048
</dl>

dimitri's avatar
dimitri committed
1049
\section config_input Input related options
dimitri's avatar
dimitri committed
1050
\anchor cfg_input
mueller's avatar
mueller committed
1051 1052 1053 1054 1055 1056 1057 1058 1059
<dl>

<dt>\c INPUT <dd>
 \addindex INPUT
 The \c INPUT tag is used to specify the files and/or directories that contain 
 documented source files. You may enter file names like 
 \c myfile.cpp or directories like \c /usr/src/myproject. 
 Separate the files or directories with spaces.<br>

mueller's avatar
mueller committed
1060
 \b Note: 
dimitri's avatar
dimitri committed
1061
 If this tag is empty the current directory is searched.
mueller's avatar
mueller committed
1062

dimitri's avatar
dimitri committed
1063
\anchor cfg_input_encoding
dimitri's avatar
dimitri committed
1064 1065
<dt>\c INPUT_ENCODING <dd>
 \addindex INPUT_ENCODING
dimitri's avatar
dimitri committed
1066 1067 1068 1069 1070 1071
 This tag can be used to specify the character encoding of the source files that 
 doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 
 input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 
 See <a href="http://www.gnu.org/software/libiconv">the libiconv documentation</a> for 
 the list of possible encodings.

mueller's avatar
mueller committed
1072
\anchor cfg_file_patterns
mueller's avatar
mueller committed
1073 1074 1075 1076 1077
<dt>\c FILE_PATTERNS <dd>
 \addindex FILE_PATTERNS
 If the value of the \c INPUT tag contains directories, you can use the 
 \c FILE_PATTERNS tag to specify one or more wildcard patterns 
 (like \c *.cpp and \c *.h ) to filter out the source-files 
dimitri's avatar
dimitri committed
1078 1079
 in the directories. If left blank the following patterns are tested:
 <code>
dimitri's avatar
dimitri committed
1080
 *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 
dimitri's avatar
dimitri committed
1081 1082
 *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.markdown *.md 
 *.mm *.dox *.py *.f90 *.f *.vhd *.vhdl
dimitri's avatar
dimitri committed
1083
 </code>
mueller's avatar
mueller committed
1084

mueller's avatar
mueller committed
1085
\anchor cfg_recursive
mueller's avatar
mueller committed
1086 1087 1088 1089 1090 1091
<dt>\c RECURSIVE <dd>
 \addindex RECURSIVE
 The \c RECURSIVE tag can be used to specify whether or not subdirectories
 should be searched for input files as well. Possible values are \c YES 
 and \c NO.  If left blank \c NO is used.

mueller's avatar
mueller committed
1092
\anchor cfg_exclude
mueller's avatar
mueller committed
1093 1094
<dt>\c EXCLUDE <dd>
 \addindex EXCLUDE
dimitri's avatar
dimitri committed
1095
 The \c EXCLUDE tag can be used to specify files and/or directories that should be
mueller's avatar
mueller committed
1096 1097
 excluded from the \c INPUT source files. This way you can easily exclude a
 subdirectory from a directory tree whose root is specified with the \c INPUT tag.
dimitri's avatar
dimitri committed
1098
 Note that relative paths are relative to the directory from which doxygen is run.
mueller's avatar
mueller committed
1099

dimitri's avatar
dimitri committed
1100 1101 1102
\anchor cfg_exclude_symlinks
<dt>\c EXCLUDE_SYMLINKS <dd>
 \addindex EXCLUDE_SYMLINKS
dimitri's avatar
dimitri committed
1103
 The \c EXCLUDE_SYMLINKS tag can be used to select whether or not files or directories 
dimitri's avatar
dimitri committed
1104
 that are symbolic links (a Unix file system feature) are excluded from the input.
dimitri's avatar
dimitri committed
1105

mueller's avatar
mueller committed
1106
\anchor cfg_exclude_patterns
mueller's avatar
mueller committed
1107 1108
<dt>\c EXCLUDE_PATTERNS <dd>
 \addindex EXCLUDE_PATTERNS
dimitri's avatar
dimitri committed
1109
 If the value of the \c INPUT tag contains directories, you can use the
mueller's avatar
mueller committed
1110 1111 1112
 \c EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
 certain files from those directories.

dimitri's avatar
dimitri committed
1113 1114 1115 1116 1117 1118 1119 1120
\anchor cfg_exclude_symbols
<dt>\c EXCLUDE_SYMBOLS <dd>
The \c EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
(namespaces, classes, functions, etc.) that should be excluded from the 
output. The symbol name can be a fully qualified name, a word, or if the 
wildcard * is used, a substring. Examples: ANamespace, AClass, 
AClass::ANamespace, ANamespace::*Test 

dimitri's avatar
dimitri committed
1121 1122
 Note that the wildcards are matched against the file with absolute path, 
 so to exclude all test directories use the pattern 
dimitri's avatar
dimitri committed
1123
 `*``/test/``*`
dimitri's avatar
dimitri committed
1124

mueller's avatar
mueller committed
1125
\anchor cfg_example_path
mueller's avatar
mueller committed
1126 1127 1128 1129
<dt>\c EXAMPLE_PATH <dd>
 \addindex EXAMPLE_PATH
 The \c EXAMPLE_PATH tag can be used to specify one or more files or
 directories that contain example code fragments that are included (see
mueller's avatar
mueller committed
1130
 the \\include command in section \ref cmdinclude "\\include").
mueller's avatar
mueller committed
1131

dimitri's avatar
dimitri committed
1132 1133 1134 1135 1136 1137 1138 1139
\anchor cfg_example_recursive
<dt>\c EXAMPLE_RECURSIVE <dd>
 \addindex EXAMPLE_RECURSIVE
 If the \c EXAMPLE_RECURSIVE tag is set to \c YES then subdirectories will be
 searched for input files to be used with the \\include or \\dontinclude 
 commands irrespective of the value of the \c RECURSIVE tag. 
 Possible values are \c YES and \c NO. If left blank \c NO is used. 

mueller's avatar
mueller committed
1140 1141 1142 1143
\anchor cfg_example_patterns
<dt>\c EXAMPLE_PATTERNS <dd>
 \addindex EXAMPLE_PATTERNS
 If the value of the \c EXAMPLE_PATH tag contains directories, you can use the
dimitri's avatar
dimitri committed
1144 1145
 \c EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like `*.cpp`
 and `*.h`) to filter out the source-files in the directories. If left
mueller's avatar
mueller committed
1146 1147 1148 1149 1150 1151 1152
 blank all files are included.

\anchor cfg_image_path
<dt>\c IMAGE_PATH <dd>
 \addindex IMAGE_PATH
 The \c IMAGE_PATH tag can be used to specify one or more files or
 directories that contain images that are to be included in the 
dimitri's avatar
dimitri committed
1153
 documentation (see the \ref cmdimage "\\image" command).
mueller's avatar
mueller committed
1154

mueller's avatar
mueller committed
1155
\anchor cfg_input_filter
mueller's avatar
mueller committed
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
<dt>\c INPUT_FILTER <dd>
 \addindex INPUT_FILTER
 The \c INPUT_FILTER tag can be used to specify a program that doxygen should
 invoke to filter for each input file. Doxygen will invoke the filter program
 by executing (via popen()) the command:
\verbatim <filter> <input-file>
\endverbatim
 
 where \<filter\>
 is the value of the \c INPUT_FILTER tag, and \<input-file\> is the name of an
 input file. Doxygen will then use the output that the filter program writes
 to standard output.

dimitri's avatar
dimitri committed
1169 1170 1171 1172 1173 1174
\anchor cfg_filter_patterns
<dt>\c FILTER_PATTERNS <dd>
 \addindex FILTER_PATTERNS
 The \c FILTER_PATTERNS 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:
dimitri's avatar
dimitri committed
1175
 pattern=filter (like `*.cpp=my_cpp_filter`). See \c INPUT_FILTER for further
dimitri's avatar
dimitri committed
1176
 info on how filters are used. If \c FILTER_PATTERNS is empty or if
dimitri's avatar
dimitri committed
1177
 none of the patterns match the file name, \c INPUT_FILTER is applied.
dimitri's avatar
dimitri committed
1178

dimitri's avatar
dimitri committed
1179 1180 1181 1182
\anchor cfg_filter_source_files
<dt>\c FILTER_SOURCE_FILES <dd>
 \addindex FILTER_SOURCE_FILES
 If the \c FILTER_SOURCE_FILES tag is set to \c YES, the input filter (if set using
dimitri's avatar
dimitri committed
1183 1184 1185
 \ref cfg_input_filter "INPUT_FILTER" ) will also be used to filter the input
 files that are used for producing the source files to browse 
 (i.e. when SOURCE_BROWSER is set to YES).
dimitri's avatar
dimitri committed
1186

dimitri's avatar
dimitri committed
1187 1188 1189 1190 1191 1192
\anchor cfg_filter_source_patterns
<dt>\c FILTER_SOURCE_PATTERNS <dd>
 \addindex FILTER_SOURCE_PATTERNS
 The \c FILTER_SOURCE_PATTERNS tag can be used to specify source filters per 
 file pattern. A pattern will override the setting for \c FILTER_PATTERN (if any) 
 and it is also possible to disable source filtering for a specific pattern 
dimitri's avatar
dimitri committed
1193
 using `*.ext=` (so without naming a filter). This option only has effect when 
dimitri's avatar
dimitri committed
1194 1195
 \c FILTER_SOURCE_FILES is enabled.

mueller's avatar
mueller committed
1196 1197
</dl>

dimitri's avatar
dimitri committed
1198
\section sourcebrowser_index Source browsing related options
dimitri's avatar
dimitri committed
1199 1200 1201 1202 1203
\anchor cfg_source_browser
<dl>

<dt>\c SOURCE_BROWSER <dd>
 \addindex SOURCE_BROWSER
dimitri's avatar
dimitri committed
1204 1205 1206 1207
 If the \c SOURCE_BROWSER tag is set to \c YES then a list of source files will
 be generated. Documented entities will be cross-referenced with these sources.
 Note: To get rid of all source code in the generated output, make sure also
 \c VERBATIM_HEADERS is set to NO.
dimitri's avatar
dimitri committed
1208 1209 1210 1211 1212 1213 1214

\anchor cfg_inline_sources
<dt>\c INLINE_SOURCES <dd>
 \addindex INLINE_SOURCES
 Setting the \c INLINE_SOURCES tag to \c YES will include the body
 of functions, classes and enums directly into the documentation.

dimitri's avatar
dimitri committed
1215 1216 1217 1218 1219 1220 1221
\anchor cfg_strip_code_comments
<dt>\c STRIP_CODE_COMMENTS <dd>
 \addindex STRIP_CODE_COMMENTS
 Setting the \c STRIP_CODE_COMMENTS tag to \c YES (the default) will instruct
 doxygen to hide any special comment blocks from generated source code
 fragments. Normal C and C++ comments will always remain visible.

dimitri's avatar
dimitri committed
1222 1223 1224
\anchor cfg_referenced_by_relation
<dt>\c REFERENCED_BY_RELATION <dd>
 \addindex REFERENCED_BY_RELATION
dimitri's avatar
dimitri committed
1225
 If the \c REFERENCED_BY_RELATION tag is set to \c YES
dimitri's avatar
dimitri committed
1226 1227 1228 1229
 then for each documented function all documented
 functions referencing it will be listed. 

\anchor cfg_references_relation
dimitri's avatar
dimitri committed
1230
<dt>\c REFERENCES_RELATION <dd>
dimitri's avatar
dimitri committed
1231
 \addindex REFERENCES_RELATION
dimitri's avatar
dimitri committed
1232
 If the \c REFERENCES_RELATION tag is set to \c YES
dimitri's avatar
dimitri committed
1233 1234 1235
 then for each documented function all documented entities
 called/used by that function will be listed. 

dimitri's avatar
dimitri committed
1236 1237 1238 1239 1240 1241
\anchor cfg_references_link_source
<dt>\c REFERENCES_LINK_SOURCE <dd>
 \addindex REFERENCES_LINK_SOURCE
 If the \c REFERENCES_LINK_SOURCE tag is set to \c YES (the default)
 and SOURCE_BROWSER tag is set to \c YES, then the hyperlinks from 
 functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
dimitri's avatar
dimitri committed
1242
 link to the source code.  Otherwise they will link to the documentation.
dimitri's avatar
dimitri committed
1243

dimitri's avatar
dimitri committed
1244 1245 1246 1247 1248 1249 1250 1251
\anchor cfg_verbatim_headers
<dt>\c VERBATIM_HEADERS <dd>
 \addindex VERBATIM_HEADERS
  If the \c VERBATIM_HEADERS tag is set the \c YES (the default) then doxygen
  will generate a verbatim copy of the header file for each class for
  which an include is specified. Set to NO to disable this.
  \sa Section \ref cmdclass "\\class".

dimitri's avatar
dimitri committed
1252 1253 1254 1255 1256 1257
\anchor cfg_use_htags
<dt>\c USE_HTAGS <dd>
 \addindex USE_HTAGS
 If the \c USE_HTAGS tag is set to \c YES then the references to source code
 will point to the HTML generated by the htags(1) tool instead of doxygen
 built-in source browser. The htags tool is part of GNU's global source
dimitri's avatar
dimitri committed
1258
 tagging system (see http://www.gnu.org/software/global/global.html).
dimitri's avatar
dimitri committed
1259
 To use it do the following:
dimitri's avatar
dimitri committed
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270

 -# Install the latest version of global (i.e. 4.8.6 or better)
 -# Enable SOURCE_BROWSER and USE_HTAGS in the config file
 -# Make sure the INPUT points to the root of the source tree
 -# Run doxygen as normal

 Doxygen will invoke htags (and that will in turn invoke gtags), so these tools
 must be available from the command line (i.e. in the search path).

 The result: instead of the source browser generated by doxygen, the links to
 source code will now point to the output of htags.
dimitri's avatar
dimitri committed
1271

dimitri's avatar
dimitri committed
1272 1273
</dl>

dimitri's avatar
dimitri committed
1274
\section alphabetical_index Alphabetical index options
dimitri's avatar
dimitri committed
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
\anchor cfg_alphabetical_index
<dl>

<dt>\c ALPHABETICAL_INDEX <dd>
 \addindex ALPHABETICAL_INDEX
 If the \c ALPHABETICAL_INDEX tag is set to \c YES, an alphabetical index
 of all compounds will be generated. Enable this if the project contains 
 a lot of classes, structs, unions or interfaces.

<dt>\c COLS_IN_ALPHA_INDEX <dd>
dimitri's avatar
dimitri committed
1285
 \anchor cfg_cols_in_alpha_index
dimitri's avatar
dimitri committed
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
 \addindex COLS_IN_ALPHA_INDEX
 If the alphabetical index is enabled 
 (see \c ALPHABETICAL_INDEX) then the \c COLS_IN_ALPHA_INDEX tag can be 
 used to specify the number of columns in which this list will be split (can be a number in the range [1..20])

\anchor cfg_ignore_prefix
<dt>\c IGNORE_PREFIX <dd>
 \addindex IGNORE_PREFIX
 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 \c IGNORE_PREFIX tag can be used to specify a prefix 
 (or a list of prefixes) that should be ignored while generating the index 
 headers.

</dl>
dimitri's avatar
dimitri committed
1301
\section html_output HTML related options
dimitri's avatar
dimitri committed
1302
\anchor cfg_generate_html
mueller's avatar
mueller committed
1303 1304 1305 1306
<dl>

<dt>\c GENERATE_HTML <dd>
 \addindex GENERATE_HTML
dimitri's avatar
dimitri committed
1307
 If the \c GENERATE_HTML tag is set to \c YES (the default) doxygen will
mueller's avatar
mueller committed
1308 1309
 generate HTML output

mueller's avatar
mueller committed
1310
\anchor cfg_html_output
mueller's avatar
mueller committed
1311 1312 1313 1314
<dt>\c HTML_OUTPUT <dd>
 \addindex HTML_OUTPUT
 The \c HTML_OUTPUT tag is used to specify where the HTML docs will be put.
 If a relative path is entered the value of \c OUTPUT_DIRECTORY will be
dimitri's avatar
dimitri committed
1315
 put in front of it. If left blank 'html' will be used as the default path.
mueller's avatar
mueller committed
1316

dimitri's avatar
dimitri committed
1317 1318 1319 1320 1321 1322 1323
\anchor cfg_html_file_extension
<dt>\c HTML_FILE_EXTENSION <dd>
 \addindex HTML_FILE_EXTENSION
 The \c HTML_FILE_EXTENSION tag can be used to specify the file extension for 
 each generated HTML page (for example: .htm, .php, .asp). If it is left blank
 doxygen will generate files with .html extension.

mueller's avatar
mueller committed
1324
\anchor cfg_html_header
mueller's avatar
mueller committed
1325 1326
<dt>\c HTML_HEADER <dd>      
 \addindex HTML_HEADER
dimitri's avatar
dimitri committed
1327
 The \c HTML_HEADER tag can be used to specify a user-defined HTML 
dimitri's avatar
dimitri committed
1328
 header file for each generated HTML page. 
mueller's avatar
mueller committed
1329 1330
 If the tag is left blank doxygen will generate a 
 standard header. 
mueller's avatar
mueller committed
1331

dimitri's avatar
dimitri committed
1332 1333 1334 1335 1336 1337 1338 1339
 To get valid HTML the header file that
 includes any scripts and style sheets that doxygen
 needs, it is highly recommended to start with a default header using
\verbatim
doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFile
\endverbatim
 and then modify the file \c new_header.html.

dimitri's avatar
dimitri committed
1340 1341 1342 1343 1344 1345 1346 1347
 The following markers have a special meaning inside the header and footer:
 <dl>
 <dt><code>\$title</code><dd>will be replaced with the title of the page.
 <dt><code>\$datetime</code><dd>will be replaced with current the date and time.
 <dt><code>\$date</code><dd>will be replaced with the current date.
 <dt><code>\$year</code><dd>will be replaces with the current year.
 <dt><code>\$doxygenversion</code><dd>will be replaced with the version of doxygen
 <dt><code>\$projectname</code><dd>will be replaced with the name of 
dimitri's avatar
dimitri committed
1348
            the project (see \ref cfg_project_name "PROJECT_NAME")
dimitri's avatar
dimitri committed
1349
 <dt><code>\$projectnumber</code><dd>will be replaced with the project number
dimitri's avatar
dimitri committed
1350
            (see \ref cfg_project_number "PROJECT_NUMBER")
dimitri's avatar
dimitri committed
1351
 <dt><code>\$projectbrief</code><dd>will be replaced with the project brief
dimitri's avatar
dimitri committed
1352
            description (see \ref cfg_project_brief "PROJECT_BRIEF")
dimitri's avatar
dimitri committed
1353
 <dt><code>\$projectlogo</code><dd>will be replaced with the project logo
dimitri's avatar
dimitri committed
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365
            (see \ref cfg_project_logo "PROJECT_LOGO")
 <dt><code>\$treeview</code><dd>will be replaced with links to 
            the javascript and style sheets needed for the navigation tree 
            (or an empty string when \ref cfg_generate_treeview "GENERATE_TREEVIEW" 
            is disabled).
 <dt><code>\$search</code><dd>will be replaced with a links to 
            the javascript and style sheets needed for the search engine 
            (or an empty string when \ref cfg_searchengine "SEARCHENGINE" 
            is disabled).
 <dt><code>\$mathjax</code><dd>will be replaced with a links to 
            the javascript and style sheets needed for the MathJax feature 
            (or an empty string when \ref cfg_use_mathjax "USE_MATHJAX" is disabled).
dimitri's avatar
dimitri committed
1366
 <dt><code>\$relpath\$</code><dd>
dimitri's avatar
dimitri committed
1367 1368 1369
 If \c CREATE_SUBDIRS is enabled, the command <code>\$relpath\$</code> can be 
 used to produce a relative path to the root of the HTML output directory,
 e.g. use \$relpath\$doxygen.css, to refer to the standard style sheet.
dimitri's avatar
dimitri committed
1370
 </dl>
dimitri's avatar
dimitri committed
1371

dimitri's avatar
dimitri committed
1372 1373 1374 1375
 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:
dimitri's avatar
dimitri committed
1376
\verbatim
dimitri's avatar
dimitri committed
1377 1378 1379 1380 1381 1382
 <!--BEGIN BLOCKNAME-->
 Some context copied when condition BLOCKNAME holds
 <!--END BLOCKNAME-->
 <!--BEGIN !BLOCKNAME-->
 Some context copied when condition BLOCKNAME does not hold
 <!--END !BLOCKNAME-->
dimitri's avatar
dimitri committed
1383
\endverbatim
dimitri's avatar
dimitri committed
1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409
 The following block names are supported:
 <dl>
 <dt><code>DISABLE_INDEX</code><dd>Content within this block is copied to the output
     when the \ref cfg_disable_index "DISABLE_INDEX" option is enabled (so when the index is disabled).
 <dt><code>GENERATE_TREEVIEW</code><dd>Content within this block is copied to the output
     when the \ref cfg_generate_treeview "GENERATE_TREEVIEW" option is enabled.
 <dt><code>SEARCHENGINE</code><dd>Content within this block is copied to the output
     when the \ref cfg_searchengine "SEARCHENGINE" option is enabled.
 <dt><code>PROJECT_NAME</code><dd>Content within the block is copied to the output
      when the \ref cfg_project_name "PROJECT_NAME" option is not empty.
 <dt><code>PROJECT_NUMBER</code><dd>Content within the block is copied to the output
      when the \ref cfg_project_number "PROJECT_NUMBER" option is not empty.
 <dt><code>PROJECT_BRIEF</code><dd>Content within the block is copied to the output
      when the \ref cfg_project_brief "PROJECT_BRIEF" option is not empty.
 <dt><code>PROJECT_LOGO</code><dd>Content within the block is copied to the output
      when the \ref cfg_project_logo "PROJECT_LOGO" option is not empty.
 <dt><code>TITLEAREA</code><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 \ref cfg_project_name "PROJECT_NAME", 
     \ref cfg_project_brief "PROJECT_BRIEF", \ref cfg_project_logo "PROJECT_LOGO" 
     is filled in or if both \ref cfg_disable_index "DISABLE_INDEX" and 
     \ref cfg_searchengine "SEARCHENGINE" are enabled.
 </dl>

 See also section \ref doxygen_usage for information on how to generate
 the default header that doxygen normally uses.
dimitri's avatar
dimitri committed
1410 1411

 @note The header is subject to change so you typically
dimitri's avatar
dimitri committed
1412 1413
 have to regenerate the default header when upgrading to a newer version of 
 doxygen.
dimitri's avatar
dimitri committed
1414
   
mueller's avatar
mueller committed
1415
\anchor cfg_html_footer
mueller's avatar
mueller committed
1416 1417
<dt>\c HTML_FOOTER <dd>
 \addindex HTML_FOOTER
dimitri's avatar
dimitri committed
1418
 The \c HTML_FOOTER tag can be used to specify a user-defined HTML footer for 
dimitri's avatar
dimitri committed
1419
 each generated HTML page. 
mueller's avatar
mueller committed
1420 1421
 If the tag is left blank doxygen will generate a standard footer.

dimitri's avatar
dimitri committed
1422 1423 1424
 See \ref cfg_html_header "HTML_HEADER" for more information on 
 how to generate a default footer and what special commands can be 
 used inside the footer.
dimitri's avatar
dimitri committed
1425 1426 1427

 See also section \ref doxygen_usage for information on how to generate
 the default footer that doxygen normally uses.
mueller's avatar
mueller committed
1428

mueller's avatar
mueller committed
1429 1430 1431
\anchor cfg_html_stylesheet
<dt>\c HTML_STYLESHEET <dd>
 \addindex HTML_STYLESHEET
dimitri's avatar
dimitri committed
1432
 The \c HTML_STYLESHEET tag can be used to specify a user-defined cascading
mueller's avatar
mueller committed
1433 1434
 style sheet that is used by each HTML page. It can be used to
 fine-tune the look of the HTML output. If the tag is left blank doxygen
dimitri's avatar
dimitri committed
1435
 will generate a default style sheet. 
mueller's avatar
mueller committed
1436

dimitri's avatar
dimitri committed
1437 1438
 See also section \ref doxygen_usage for information on how to generate
 the style sheet that doxygen normally uses.
mueller's avatar
mueller committed
1439

dimitri's avatar
dimitri committed
1440 1441 1442 1443 1444 1445 1446 1447 1448 1449
\anchor cfg_html_extra_files
<dt>\c HTML_EXTRA_FILES <dd>
 \addindex HTML_EXTRA_FILES
 The \c HTML_EXTRA_FILES tag can be used to specify one or more extra images or 
 other source files which should be copied to the HTML output directory. Note 
 that these files will be copied to the base HTML output directory. Use the 
 $relpath$ marker in the \c HTML_HEADER and/or \c HTML_FOOTER files to load these 
 files. In the \c HTML_STYLESHEET file, use the file name only. Also note that 
 the files will be copied as-is; there are no commands or markers available.

dimitri's avatar
dimitri committed
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
\anchor cfg_html_colorstyle_hue
<dt>\c HTML_COLORSTYLE_HUE <dd>
 \addindex HTML_COLOR_STYLE_HUE
 The \c HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 
 Doxygen will adjust the colors in the stylesheet and background images 
 according to this color. Hue is specified as an angle on a colorwheel, 
 see http://en.wikipedia.org/wiki/Hue for more information. 
 For instance the value 0 represents red, 60 is yellow, 120 is green, 
 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 
 The allowed range is 0 to 359. 

\anchor cfg_html_colorstyle_sat
<dt>\c HTML_COLORSTYLE_SAT <dd>
 \addindex HTML_COLORSTYLE_SAT
 The \c HTML_COLORSTYLE_SAT 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. 

\anchor cfg_html_colorstyle_gamma
<dt>\c HTML_COLORSTYLE_GAMMA <dd>
 The \c HTML_COLORSTYLE_GAMMA 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.

dimitri's avatar
dimitri committed
1477 1478 1479 1480 1481 1482 1483 1484
\anchor cfg_html_timestamp
<dt>\c HTML_TIMESTAMP <dd>
 \addindex HTML_TIMESTAMP
 If the \c HTML_TIMESTAMP tag is set to \c YES then the footer of 
 each generated HTML page will contain the date and time when the page 
 was generated. Setting this to NO can help when comparing the output of 
 multiple runs.

mueller's avatar
mueller committed
1485
\anchor cfg_html_align_members
mueller's avatar
mueller committed
1486
<dt>\c HTML_ALIGN_MEMBERS <dd>
dimitri's avatar
dimitri committed
1487 1488 1489
 \addindex HTML_ALIGN_MEMBERS
 If the \c HTML_ALIGN_MEMBERS tag is set to \c YES, the members of classes,
 files or namespaces will be aligned in HTML using tables. If set to
dimitri's avatar
dimitri committed
1490
 \c NO a bullet list will be used. 
mueller's avatar
mueller committed
1491

dimitri's avatar
dimitri committed
1492
 <b>Note:</b>
dimitri's avatar
dimitri committed
1493
 Setting this tag to \c NO will become obsolete in the future, since I only
dimitri's avatar
dimitri committed
1494
 intent to support and test the aligned representation.
mueller's avatar
mueller committed
1495

dimitri's avatar
dimitri committed
1496 1497 1498 1499 1500 1501 1502 1503
\anchor cfg_html_dynamic_sections
<dt>\c HTML_DYNAMIC_SECTIONS <dd>
 \addindex HTML_DYNAMIC_SECTIONS
 If the \c HTML_DYNAMIC_SECTIONS tag is set to \c YES then the generated HTML
 documentation will contain sections that can be hidden and shown after the
 page has loaded. For this to work a browser that supports
 JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
 Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 
mueller's avatar
mueller committed
1504

dimitri's avatar
dimitri committed
1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
\anchor cfg_generate_docset
<dt>\c GENERATE_DOCSET <dd>
 \addindex GENERATE_DOCSET
 If the \c GENERATE_DOCSET tag is set to \c YES, 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 \c make 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> 
dimitri's avatar
dimitri committed
1516 1517 1518
 so that Xcode will find it at startup. See
 <a href="http://developer.apple.com/tools/creatingdocsetswithdoxygen.html">
 this article</a> for more information.
dimitri's avatar
dimitri committed
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534

\anchor cfg_docset_feedname 
<dt>\c DOCSET_FEEDNAME <dd>
 \addindex DOCSET_FEEDNAME
 When \c GENERATE_DOCSET tag is set to \c YES, this tag determines the name of the
 feed. A documentation feed provides an umbrella under which multiple
 documentation sets from a single provider (such as a company or product suite) 
 can be grouped.

\anchor cfg_docset_bundle_id
<dt>\c DOCSET_BUNDLE_ID <dd>
 When \c GENERATE_DOCSET tag is set to \c YES, 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.

dimitri's avatar
dimitri committed
1535 1536 1537 1538 1539 1540 1541 1542 1543
\anchor cfg_docset_publisher_id
<dt>\c DOCSET_PUBLISHER_ID <dd>
When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 
the documentation publisher. This should be a reverse domain-name style 
string, e.g. com.mycompany.MyDocSet.documentation. 

\anchor cfg_docset_publisher_name
<dt>\c DOCSET_PUBLISHER_NAME <dd>
The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
dimitri's avatar
dimitri committed
1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562

\anchor cfg_generate_htmlhelp
<dt>\c GENERATE_HTMLHELP <dd>
 \addindex GENERATE_HTMLHELP
 If the \c GENERATE_HTMLHELP tag is set to \c YES then
 doxygen generates three additional HTML index files: 
 \c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a 
 project file that can be read by 
 <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/vsconHH1Start.asp">
 Microsoft's HTML Help Workshop</a>
 on Windows.

 The HTML Help Workshop contains a compiler that can convert all HTML output 
 generated by doxygen into a single compiled HTML file (.chm). Compiled
 HTML files are now used as the Windows 98 help format, and will replace
 the old Windows help format (.hlp) on all Windows platforms in the future.
 Compressed HTML files also contain an index, a table of contents,
 and you can search for words in the documentation.
 The HTML workshop also contains a viewer for compressed HTML files.
dimitri's avatar
dimitri committed
1563

dimitri's avatar
dimitri committed
1564 1565 1566 1567 1568 1569
\anchor cfg_chm_file 
<dt>\c CHM_FILE <dd>
 \addindex CHM_FILE
  If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c CHM_FILE tag can
  be used to specify the file name of the resulting .chm file. You
  can add a path in front of the file if the result should not be
dimitri's avatar
dimitri committed
1570
  written to the html output directory.
dimitri's avatar
dimitri committed
1571 1572 1573 1574 1575 1576

\anchor cfg_hhc_location 
<dt>\c HHC_LOCATION <dd>
 \addindex HHC_LOCATION
  If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c HHC_LOCATION tag can
  be used to specify the location (absolute path including file name) of 
dimitri's avatar
dimitri committed
1577
  the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
dimitri's avatar
dimitri committed
1578
  the HTML help compiler on the generated index.hhp.
dimitri's avatar
dimitri committed
1579

dimitri's avatar
dimitri committed
1580 1581 1582 1583 1584 1585 1586
\anchor cfg_generate_chi
<dt>\c GENERATE_CHI <dd>
 \addindex GENERATE_CHI
 If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c GENERATE_CHI flag
 controls if a separate .chi index file is generated (<code>YES</code>) or that
 it should be included in the master .chm file (<code>NO</code>).

dimitri's avatar
dimitri committed
1587 1588 1589 1590 1591 1592 1593
\anchor cfg_chm_index_encoding
<dt>\c CHM_INDEX_ENCODING <dd>
 \addindex CHM_INDEX_ENCODING
 If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c CHM_INDEX_ENCODING 
 is used to encode HtmlHelp index (hhk), content (hhc) and project file 
 content. 

dimitri's avatar
dimitri committed
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616
\anchor cfg_binary_toc
<dt>\c BINARY_TOC <dd>
 \addindex BINARY_TOC
 If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c BINARY_TOC flag
 controls whether a binary table of contents is generated (<code>YES</code>) or a
 normal table of contents (<code>NO</code>) in the .chm file.

\anchor cfg_toc_expand
<dt>\c TOC_EXPAND <dd>
 \addindex TOC_EXPAND
 The \c TOC_EXPAND flag can be set to YES to add extra items for 
 group members to the table of contents of the HTML help documentation 
 and to the tree view.

\anchor cfg_generate_qhp
<dt>\c GENERATE_QHP <dd>
 \addindex GENERATE_QHP
 If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE
 and QHP_VIRTUAL_FOLDER are set, an additional index file will
 be generated that can be used as input for Qt's qhelpgenerator
 to generate a Qt Compressed Help (.qch) of the generated HTML
 documentation.

dimitri's avatar
dimitri committed
1617 1618 1619 1620 1621 1622 1623
\anchor cfg_qch_file
<dt>\c QCH_FILE <dd>
 \addindex QCH_FILE
 If the QHG_LOCATION tag is specified, the QCH_FILE tag can
 be used to specify the file name of the resulting .qch file.
 The path specified is relative to the HTML output folder.

dimitri's avatar
dimitri committed
1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637
\anchor cfg_qhp_namespace
<dt>\c QHP_NAMESPACE <dd>
 \addindex QHP_NAMESPACE
 The QHP_NAMESPACE tag specifies the namespace to use when generating
 Qt Help Project output. For more information please see
 <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.

\anchor cfg_qhp_virtual_folder
<dt>\c QHP_VIRTUAL_FOLDER <dd>
 \addindex QHP_VIRTUAL_FOLDER
 The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when
 generating Qt Help Project output. For more information please see
 <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.

dimitri's avatar
dimitri committed
1638 1639 1640 1641
\anchor cfg_qhp_cust_filter_name
<dt>\c QHP_CUST_FILTER_NAME <dd>
  \addindex QHP_CUST_FILTER_NAME
  If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. For more information please see
dimitri's avatar
dimitri committed
1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656
  <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.

\anchor cfg_qhp_cust_filter_attrs
<dt>\c QHP_CUST_FILTER_ATTRS <dd>
  \addindex QHP_CUST_FILTER_ATTRS
  The QHP_CUST_FILTER_ATTRIBUTES tag specifies the list of the attributes of the custom filter to add.
  For more information please see
  <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.

\anchor cfg_qhp_sect_filter_attrs
<dt>\c QHP_SECT_FILTER_ATTRS <dd>
  \addindex QHP_SECT_FILTER_ATTRS
  The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's filter section matches.
  <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.

dimitri's avatar
dimitri committed
1657 1658 1659 1660 1661 1662 1663 1664
\anchor cfg_qhg_location
<dt>\c QHG_LOCATION <dd>
 \addindex QHG_LOCATION
 If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
 be used to specify the location of Qt's qhelpgenerator.
 If non-empty doxygen will try to run qhelpgenerator on the generated
 .qhp file.

dimitri's avatar
dimitri committed
1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686
\anchor cfg_generate_eclipsehelp
<dt>\c GENERATE_ECLIPSEHELP <dd>
 \addindex GENERATE_ECLIPSEHELP
 If the \c GENERATE_ECLIPSEHELP tag is set to \c YES, additional index files  
 will be generated, which together with the HTML files, form an Eclipse help  
 plugin. 

 To install this plugin and make it available under the help contents 
 menu in Eclipse, the contents of the directory containing the HTML and XML 
 files needs to be copied into the plugins directory of eclipse. The name of 
 the directory within the plugins directory should be the same as 
 the \ref cfg_eclipse_doc_id "ECLIPSE_DOC_ID" value. 

 After copying Eclipse needs to be restarted before the help appears.

\anchor cfg_eclipse_doc_id
<dt>\c ECLIPSE_DOC_ID <dd>
 \addindex ECLIPSE_DOC_ID
 A unique identifier for the eclipse help plugin. When installing the plugin 
 the directory name containing the HTML and XML files should also have 
 this name. Each documentation set should have its own identifier.

dimitri's avatar
dimitri committed
1687 1688 1689
\anchor cfg_searchengine
<dt>\c SEARCHENGINE <dd>
 \addindex SEARCHENGINE
dimitri's avatar
dimitri committed
1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700

 When the \c SEARCHENGINE 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 (\ref cfg_generate_htmlhelp "GENERATE_HTMLHELP"), 
 Qt help (\ref cfg_generate_qhp "GENERATE_QHP"), or docsets
 (\ref cfg_generate_docset "GENERATE_DOCSET") 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 
 \ref cfg_server_based_search "SERVER_BASED_SEARCH" may provide a 
 better solution. 
dimitri's avatar
dimitri committed
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711

 It is possible to search using the keyboard;
 to jump to the search box use access key + S (what the access key is
 depends on the OS and browser, but it is typically CTRL, ALT/option, or both).
 Inside the search box use the cursor down key to jump into the search 
 results window, the results can be navigated using the cursor keys.
 Press Enter to select an item or escape to cancel the search. The
 filter options can be selected when the cursor is inside the search box
 by pressing Shift+cursor down. Also here use the cursor keys to 
 select a filter and enter or escape to activate or cancel the filter option.

dimitri's avatar
dimitri committed
1712 1713 1714 1715 1716 1717 1718 1719 1720
\anchor cfg_server_based_search
<dt>\c SERVER_BASED_SEARCH <dd>
 \addindex SERVER_BASED_SEARCH

When the SERVER_BASED_SEARCH tag is enabled the search engine will be
implemented using a PHP enabled web server instead of at the web client
using Javascript. Doxygen will generate the search PHP script and index 
file to put on the web server. The advantage of the server
based approach is that it scales better to large projects and also allows
dimitri's avatar
dimitri committed
1721
full text search. The disadvantages are that it is more difficult to setup 
dimitri's avatar
dimitri committed
1722
and does not have live searching capabilities.
dimitri's avatar
dimitri committed
1723

dimitri's avatar
dimitri committed
1724 1725 1726 1727 1728 1729 1730
\anchor cfg_disable_index
<dt>\c DISABLE_INDEX <dd>
 \addindex DISABLE_INDEX
 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 \c DISABLE_INDEX tag can be used to turn on/off the condensed index at
 top of each page. A value of NO (the default) enables the index and the
dimitri's avatar
dimitri committed
1731 1732 1733
 value \c YES disables it. Since the tabs have the same information as the 
 navigation tree you can set this option to \c NO if you already set 
 \ref cfg_generate_treeview "GENERATE_TREEVIEW" to \c YES.
dimitri's avatar
dimitri committed
1734 1735 1736 1737

\anchor cfg_enum_values_per_line
<dt>\c ENUM_VALUES_PER_LINE <dd>
 \addindex ENUM_VALUES_PER_LINE
dimitri's avatar
dimitri committed
1738 1739 1740 1741
 This tag can be used to set the number of enum values (range [0,1..20]) 
 that doxygen will group on one line in the generated HTML documentation. 
 Note that a value of 0 will completely suppress the enum values from
 appearing in the overview section.
dimitri's avatar
dimitri committed
1742

dimitri's avatar
dimitri committed
1743 1744 1745
\anchor cfg_generate_treeview
<dt>\c GENERATE_TREEVIEW <dd>
 \addindex GENERATE_TREEVIEW
dimitri's avatar
dimitri committed
1746 1747
 The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
 structure should be generated to display hierarchical information.
dimitri's avatar
dimitri committed
1748
 If the tag value is set to YES, a side panel will be generated
dimitri's avatar
dimitri committed
1749
 containing a tree-like index structure (just like the one that
dimitri's avatar
dimitri committed
1750
 is generated for HTML Help). For this to work a browser that supports
dimitri's avatar
dimitri committed
1751 1752
 JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
 Windows users are probably better off using the HTML help feature.
dimitri's avatar
dimitri committed
1753

dimitri's avatar
dimitri committed
1754
 Via custom stylesheets (see \ref cfg_html_stylesheet "HTML_STYLESHEET")
dimitri's avatar
dimitri committed
1755
 one can further \ref doxygen_finetune "fine-tune" the look of the index.
dimitri's avatar
dimitri committed
1756 1757
 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
dimitri's avatar
dimitri committed
1758 1759
 the \ref cfg_project_name "project name".

dimitri's avatar
dimitri committed
1760 1761 1762 1763 1764 1765 1766
\anchor cfg_treeview_width
<dt>\c TREEVIEW_WIDTH <dd>
 \addindex TREEVIEW_WIDTH
 If the treeview is enabled (see \c GENERATE_TREEVIEW) then this tag can be
 used to set the initial width (in pixels) of the frame in which the tree
 is shown.

dimitri's avatar
dimitri committed
1767 1768 1769 1770 1771 1772
\anchor cfg_ext_links_in_window
<dt>\c EXT_LINKS_IN_WINDOW <dd>
 \addindex EXT_LINKS_IN_WINDOW
 When the \c EXT_LINKS_IN_WINDOW option is set to \c YES doxygen will open 
 links to external symbols imported via tag files in a separate window. 

dimitri's avatar
dimitri committed
1773 1774 1775 1776 1777 1778
\anchor cfg_formula_fontsize
<dt>\c FORMULA_FONTSIZE <dd>
 \addindex FORMULA_FONTSIZE
 Use this tag to change the font size of Latex formulas included
 as images in the HTML documentation. The default is 10.
 when you change the font size after a successful doxygen run you need
dimitri's avatar
dimitri committed
1779
 to manually remove any `form_*.png` images from the HTML 
dimitri's avatar
dimitri committed
1780
 output directory to force them to be regenerated.
dimitri's avatar
dimitri committed
1781 1782 1783 1784 1785 1786 1787

\anchor cfg_formula_transparent
<dt>\c FORMULA_TRANSPARENT <dd>
 \addindex FORMULA_TRANSPARENT
 Use the \c FORMULA_TRANPARENT 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. 
dimitri's avatar
dimitri committed
1788
 Note that when changing this option you need to delete any `form_*.png` files 
dimitri's avatar
dimitri committed
1789
 in the HTML output before the changes have effect. 
dimitri's avatar
dimitri committed
1790 1791 1792 1793 1794 1795 1796 1797

\anchor cfg_use_mathjax
<dt>\c USE_MATHJAX <dd>
 \addindex USE_MATHJAX
 Enable the \c USE_MATHJAX option to render LaTeX formulas using MathJax 
 (see http://www.mathjax.org) which uses client side Javascript for the 
 rendering instead of using prerendered bitmaps. Use this if you do not 
 have LaTeX installed or if you want to formulas look prettier in the HTML 
dimitri's avatar
dimitri committed
1798 1799 1800
 output. When enabled you may also need to install MathJax separately and 
 configure the path to it using the \ref cfg_mathjax_relpath "MATHJAX_RELPATH" 
 option.
dimitri's avatar
dimitri committed
1801 1802 1803 1804 1805 1806 1807 1808 1809

\anchor cfg_mathjax_relpath
<dt>\c MATHJAX_RELPATH <dd>
 \addindex MATHJAX_RELPATH
 When MathJax is enabled you need to specify the location relative to the 
 HTML output directory using the \c MATHJAX_RELPATH option. The destination 
 directory should contain the MathJax.js script. For instance, if the mathjax 
 directory is located at the same level as the HTML output directory, then 
 \c MATHJAX_RELPATH should be <code>../mathjax</code>. The default value points to 
dimitri's avatar
dimitri committed
1810 1811 1812
 the MathJax Content Delivery Network so you can quickly see the result without 
 installing MathJax.  However, it is strongly recommended to install a local 
 copy of MathJax from http://www.mathjax.org before deployment.
dimitri's avatar
dimitri committed
1813 1814 1815 1816 1817 1818 1819 1820 1821

\anchor cfg_mathjax_extensions
<dt>\c MATHJAX_EXTENSIONS <dd>
 \addindex MATHJAX_EXTENSIONS
 The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 
 names that should be enabled during MathJax rendering. For example
\verbatim
MATHJAX_EXTENSIONS     = TeX/AMSmath TeX/AMSsymbols
\endverbatim
dimitri's avatar
dimitri committed
1822
 
mueller's avatar
mueller committed
1823
</dl>
dimitri's avatar
dimitri committed
1824
\section latex_output LaTeX related options
dimitri's avatar
dimitri committed
1825
\anchor cfg_generate_latex
mueller's avatar
mueller committed
1826 1827 1828 1829
<dl>

<dt>\c GENERATE_LATEX <dd>
 \addindex GENERATE_LATEX
dimitri's avatar
dimitri committed
1830 1831
 If the \c GENERATE_LATEX tag is set to \c YES (the default) doxygen will
 generate \f$\mbox{\LaTeX}\f$ output.
mueller's avatar
mueller committed
1832

mueller's avatar
mueller committed
1833
\anchor cfg_latex_output
mueller's avatar
mueller committed
1834 1835
<dt>\c LATEX_OUTPUT <dd>
 \addindex LATEX_OUTPUT
mueller's avatar
mueller committed
1836 1837
 The \c LATEX_OUTPUT tag is used to specify where the \f$\mbox{\LaTeX}\f$ 
 docs will be put.
mueller's avatar
mueller committed
1838
 If a relative path is entered the value of \c OUTPUT_DIRECTORY will be
dimitri's avatar
dimitri committed
1839
 put in front of it. If left blank 'latex' will be used as the default path.
mueller's avatar
mueller committed
1840

dimitri's avatar
dimitri committed
1841 1842 1843 1844
\anchor cfg_latex_cmd_name
<dt>\c LATEX_CMD_NAME <dd>
 \addindex LATEX_CMD_NAME
 The \c LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. 
dimitri's avatar
dimitri committed
1845
 If left blank 'latex' will be used as the default command name.
dimitri's avatar
dimitri committed
1846 1847 1848
 Note that when enabling USE_PDFLATEX this option is only used for
 generating bitmaps for formulas in the HTML output, but not in the
 Makefile that is written to the output directory.
dimitri's avatar
dimitri committed
1849 1850 1851 1852 1853

\anchor cfg_makeindex_cmd_name
<dt>\c MAKEINDEX_CMD_NAME <dd>
 \addindex MAKEINDEX_CMD_NAME
 The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
dimitri's avatar
dimitri committed
1854
 generate index for LaTeX. If left blank 'makeindex' will be used as the 
dimitri's avatar
dimitri committed
1855 1856
 default command name.

mueller's avatar
mueller committed
1857
\anchor cfg_compact_latex
mueller's avatar
mueller committed
1858 1859
<dt>\c COMPACT_LATEX <dd>
 \addindex COMPACT_LATEX
dimitri's avatar
dimitri committed
1860
 If the \c COMPACT_LATEX tag is set to \c YES doxygen generates more compact
mueller's avatar
mueller committed
1861
 \f$\mbox{\LaTeX}\f$ documents. This may be useful for small projects and may help to
mueller's avatar
mueller committed
1862 1863
 save some trees in general.

mueller's avatar
mueller committed
1864
\anchor cfg_paper_type
mueller's avatar
mueller committed
1865 1866
<dt>\c PAPER_TYPE <dd>
 \addindex PAPER_TYPE
dimitri's avatar
dimitri committed
1867
 The \c PAPER_TYPE tag can be used to set the paper type that is used
mueller's avatar
mueller committed
1868 1869 1870 1871 1872 1873 1874
 by the printer. Possible values are: 
 <ul>
 <li><code>a4</code> (210 x 297 mm).
 <li><code>letter</code> (8.5 x 11 inches).
 <li><code>legal</code> (8.5 x 14 inches).
 <li><code>executive</code> (7.25 x 10.5 inches)
 </ul> 
dimitri's avatar
dimitri committed
1875
 If left blank a4 will be used.
mueller's avatar
mueller committed
1876

mueller's avatar
mueller committed
1877
\anchor cfg_extra_packages
mueller's avatar
mueller committed
1878 1879
<dt>\c EXTRA_PACKAGES <dd>
 \addindex EXTRA_PACKAGES
mueller's avatar
mueller committed
1880
 The \c EXTRA_PACKAGES tag can be used to specify one or more \f$\mbox{\LaTeX}\f$ 
mueller's avatar
mueller committed
1881
 package names that should be included in the \f$\mbox{\LaTeX}\f$ output.
mueller's avatar
mueller committed
1882 1883 1884 1885 1886
 To get the times font for instance you can specify 
\verbatim
EXTRA_PACKAGES = times
\endverbatim
 If left blank no extra packages will be included.
mueller's avatar
mueller committed
1887 1888 1889 1890 1891

\anchor cfg_latex_header
<dt>\c LATEX_HEADER <dd>
 \addindex LATEX_HEADER
 The \c LATEX_HEADER tag can be used to specify a personal \f$\mbox{\LaTeX}\f$ 
dimitri's avatar
dimitri committed
1892 1893
 header for the generated \f$\mbox{\LaTeX}\f$ document. 
 The header should contain everything until the first chapter. 
mueller's avatar
mueller committed
1894

dimitri's avatar
dimitri committed
1895 1896 1897
 If it is left blank doxygen will generate a 
 standard header. See section \ref doxygen_usage for information on how to 
 let doxygen write the default header to a separate file.
mueller's avatar
mueller committed
1898
 
mueller's avatar
mueller committed
1899
 \par Note: 
dimitri's avatar
dimitri committed
1900
   Only use a user-defined header if you know what you are doing!
mueller's avatar
mueller committed
1901

mueller's avatar
mueller committed
1902 1903 1904 1905 1906 1907
 The following commands have a special meaning inside the header:
 <code>\$title</code>, <code>\$datetime</code>, <code>\$date</code>,
 <code>\$doxygenversion</code>, <code>\$projectname</code>, 
 <code>\$projectnumber</code>. 
 Doxygen will replace them by respectively 
 the title of the page, the current date and time, only the current date,
dimitri's avatar
dimitri committed
1908 1909
 the version number of doxygen, the project name (see \c PROJECT_NAME), or the
 project number (see \c PROJECT_NUMBER).
dimitri's avatar
dimitri committed
1910 1911 1912 1913 1914 1915 1916 1917

\anchor cfg_latex_footer
<dt>\c LATEX_FOOTER <dd>
 \addindex LATEX_FOOTER
 The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 
 the generated latex document. The footer should contain everything after 
 the last chapter. If it is left blank doxygen will generate a 
 standard footer. Notice: only use this tag if you know what you are doing! 
mueller's avatar
mueller committed
1918
   
dimitri's avatar
dimitri committed
1919 1920 1921 1922
\anchor cfg_pdf_hyperlinks
<dt>\c PDF_HYPERLINKS <dd>
 \addindex PDF_HYPERLINKS

dimitri's avatar
dimitri committed
1923
 If the \c PDF_HYPERLINKS tag is set to \c YES, the \f$\mbox{\LaTeX}\f$ that 
dimitri's avatar
dimitri committed
1924
 is generated is prepared for conversion to PDF (using ps2pdf or pdflatex). 
dimitri's avatar
dimitri committed
1925
 The PDF file will
dimitri's avatar
dimitri committed
1926
 contain links (just like the HTML output) instead of page references.
dimitri's avatar
dimitri committed
1927
 This makes the output suitable for online browsing using a PDF viewer.
dimitri's avatar
dimitri committed
1928

dimitri's avatar
dimitri committed
1929
\anchor cfg_use_pdflatex
dimitri's avatar
dimitri committed
1930 1931 1932 1933 1934 1935 1936
<dt>\c USE_PDFLATEX <dd>
 \addindex LATEX_PDFLATEX

 If the \c LATEX_PDFLATEX tag is set to \c YES, doxygen will use
 pdflatex to generate the PDF file directly from the \f$\mbox{\LaTeX}\f$
 files.

dimitri's avatar
dimitri committed
1937 1938 1939 1940
\anchor cfg_latex_batchmode
<dt>\c LATEX_BATCHMODE <dd>
 \addindex LATEX_BATCHMODE

dimitri's avatar
dimitri committed
1941 1942 1943 1944 1945
 If the \c LATEX_BATCHMODE tag is set to \c YES, doxygen will add the \\batchmode.
 command to the generated \f$\mbox{\LaTeX}\f$ files. This will 
 instruct \f$\mbox{\LaTeX}\f$ to keep running if errors occur, instead of 
 asking the user for help. This option is also used when generating formulas 
 in HTML.
dimitri's avatar
dimitri committed
1946

dimitri's avatar
dimitri committed
1947 1948 1949 1950 1951 1952 1953 1954 1955
\anchor cfg_latex_bib_style 
<dt>\c LATEX_BIB_STYLE <dd>
 \addindex LATEX_BIB_STYLE

 The \c LATEX_BIB_STYLE tag can be used to specify the style to use for the 
 bibliography, e.g. \c plainnat, or \c ieeetr. The default style is 
 \c plain. See http://en.wikipedia.org/wiki/BibTeX and \ref cmdcite "\\cite"
 for more info.

dimitri's avatar
dimitri committed
1956 1957 1958 1959 1960 1961 1962 1963
\anchor cfg_latex_hide_indices
<dt>\c LATEX_HIDE_INDICES <dd>
 \addindex LATEX_HIDE_INDICES

 If \c LATEX_HIDE_INDICES is set to \c YES then doxygen will not
 include the index chapters (such as File Index, Compound Index, etc.) 
 in the output. 

dimitri's avatar
dimitri committed
1964 1965 1966 1967 1968 1969 1970
\anchor cfg_latex_source_code
 <dt>\c LATEX_SOURCE_CODE <dd>
 If \c LATEX_SOURCE_CODE is set to \c YES then doxygen will include 
 source code with syntax highlighting in the LaTeX output. 
 Note that which sources are shown also depends on other settings 
 such as \ref cfg_source_browser "SOURCE_BROWSER".

mueller's avatar
mueller committed
1971
</dl>
dimitri's avatar
dimitri committed
1972
\section rtf_output RTF related options
dimitri's avatar
dimitri committed
1973
\anchor cfg_generate_rtf
dimitri's avatar
dimitri committed
1974 1975
<dl>

dimitri's avatar
dimitri committed
1976 1977
<dt>\c GENERATE_RTF <dd>
 \addindex GENERATE_RTF
dimitri's avatar
dimitri committed
1978
 If the \c GENERATE_RTF tag is set to \c YES doxygen will generate RTF output.
dimitri's avatar
dimitri committed
1979
 The RTF output is optimized for Word 97 and may not look too pretty with
dimitri's avatar
dimitri committed
1980
 other readers/editors.
dimitri's avatar
dimitri committed
1981 1982 1983 1984 1985

\anchor cfg_rtf_output
<dt>\c RTF_OUTPUT <dd>
 \addindex RTF_OUTPUT
 The \c RTF_OUTPUT tag is used to specify where the RTF docs will be put.
dimitri's avatar
dimitri committed
1986
 If a relative path is entered the value of \c OUTPUT_DIRECTORY will be
dimitri's avatar
dimitri committed
1987 1988 1989 1990 1991
 put in front of it. If left blank \c rtf will be used as the default path.
 
\anchor cfg_compact_rtf
<dt>\c COMPACT_RTF <dd>
 \addindex COMPACT_RTF
dimitri's avatar
dimitri committed
1992
 If the \c COMPACT_RTF tag is set to \c YES doxygen generates more compact
dimitri's avatar
dimitri committed
1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
 RTF documents. This may be useful for small projects and may help to
 save some trees in general.

\anchor cfg_rtf_hyperlinks
<dt>\c RTF_HYPERLINKS <dd>
 \addindex RTF_HYPERLINKS
 If the \c RTF_HYPERLINKS tag is set to \c YES, the RTF that is generated
 will contain hyperlink fields. The RTF file will
 contain links (just like the HTML output) instead of page references.
 This makes the output suitable for online browsing using Word or some other
 Word compatible reader that support those fields.

 \par note:
dimitri's avatar
dimitri committed
2006
   WordPad (write) and others do not support links.
dimitri's avatar
dimitri committed
2007

dimitri's avatar
dimitri committed
2008
\anchor cfg_rtf_stylesheet_file 
dimitri's avatar
dimitri committed
2009 2010 2011
<dt>\c RTF_STYLESHEET_FILE <dd>
 \addindex RTF_STYLESHEET_FILE
 Load stylesheet definitions from file. Syntax is similar to doxygen's
dimitri's avatar
dimitri committed
2012
 config file, i.e. a series of assignments. You only have to provide
dimitri's avatar
dimitri committed
2013 2014
 replacements, missing definitions are set to their default value.

dimitri's avatar
dimitri committed
2015 2016
 See also section \ref doxygen_usage for information on how to generate
 the default style sheet that doxygen normally uses.
dimitri's avatar
dimitri committed
2017

dimitri's avatar
dimitri committed
2018 2019
\anchor cfg_rtf_extensions_file
<dt>\c RTF_EXTENSIONS_FILE <dd>
dimitri's avatar
dimitri committed
2020
 Set optional variables used in the generation of an RTF document.
dimitri's avatar
dimitri committed
2021 2022 2023 2024
 Syntax is similar to doxygen's config file. 
 A template extensions file can be generated using 
 <code>doxygen -e rtf extensionFile</code>.

dimitri's avatar
dimitri committed
2025 2026
</dl>

dimitri's avatar
dimitri committed
2027
\section man_output Man page related options
dimitri's avatar
dimitri committed
2028
\anchor cfg_generate_man
mueller's avatar
mueller committed
2029 2030 2031 2032
<dl>

<dt>\c GENERATE_MAN <dd>
 \addindex GENERATE_MAN
dimitri's avatar
dimitri committed
2033
 If the \c GENERATE_MAN tag is set to \c YES (the default) doxygen will
mueller's avatar
mueller committed
2034 2035
 generate man pages for classes and files.

mueller's avatar
mueller committed
2036
\anchor cfg_man_output
mueller's avatar
mueller committed
2037 2038 2039 2040
<dt>\c MAN_OUTPUT <dd>
 \addindex MAN_OUTPUT
 The \c MAN_OUTPUT tag is used to specify where the man pages will be put.
 If a relative path is entered the value of \c OUTPUT_DIRECTORY will be
dimitri's avatar
dimitri committed
2041
 put in front of it. If left blank 'man' will be used as the default path.
mueller's avatar
mueller committed
2042 2043 2044
 A directory man3 will be created inside the directory specified by 
 \c MAN_OUTPUT.

mueller's avatar
mueller committed
2045
\anchor cfg_man_extension
mueller's avatar
mueller committed
2046 2047
<dt>\c MAN_EXTENSION <dd>
 \addindex MAX_EXTENSION
mueller's avatar
mueller committed
2048
 The \c MAN_EXTENSION tag determines the extension that is added to
mueller's avatar
mueller committed
2049
 the generated man pages (default is the subroutine's section .3)
dimitri's avatar
dimitri committed
2050 2051 2052

\anchor cfg_man_links
<dt>\c MAN_LINKS <dd> 
dimitri's avatar
dimitri committed
2053
 \addindex MAN_LINKS
dimitri's avatar
dimitri committed
2054
 If the \c MAN_LINKS tag is set to \c YES and doxygen generates man output, 
dimitri's avatar
dimitri committed
2055 2056 2057 2058 2059
 then it will generate one additional man file for each entity documented in 
 the real man page(s). These additional files only source the real man page, 
 but without them the man command would be unable to find the correct page. 
 The default is \c NO.

dimitri's avatar
dimitri committed
2060
</dl>
mueller's avatar
mueller committed
2061

dimitri's avatar
dimitri committed
2062 2063 2064 2065 2066 2067
\section xml_output XML related options
\anchor cfg_generate_xml
<dl>

<dt>\c GENERATE_XML <dd>
 \addindex GENERATE_XML
dimitri's avatar
dimitri committed
2068
 If the \c GENERATE_XML tag is set to \c YES Doxygen will
dimitri's avatar
dimitri committed
2069 2070 2071
 generate an XML file that captures the structure of
 the code including all documentation. 

dimitri's avatar
dimitri committed
2072 2073 2074 2075 2076 2077 2078
\anchor cfg_xml_output
<dt>\c XML_OUTPUT <dd>
 \addindex XML_OUTPUT
 The \c XML_OUTPUT tag is used to specify where the XML pages will be put. 
 If a relative path is entered the value of \c OUTPUT_DIRECTORY will be 
 put in front of it. If left blank \c xml will be used as the default path.

dimitri's avatar
dimitri committed
2079 2080 2081
\anchor cfg_xml_schema
<dt>\c XML_SCHEMA <dd>
 \addindex XML_SCHEMA
dimitri's avatar
dimitri committed
2082
 The \c XML_SCHEMA tag can be used to specify an XML schema,
dimitri's avatar
dimitri committed
2083 2084 2085 2086 2087 2088
 which can be used by a validating XML parser to check the
 syntax of the XML files.

\anchor cfg_xml_dtd
<dt>\c XML_DTD <dd>
 \addindex XML_DTD
dimitri's avatar
dimitri committed
2089
 The \c XML_DTD tag can be used to specify an XML DTD,
dimitri's avatar
dimitri committed
2090 2091 2092
 which can be used by a validating XML parser to check the
 syntax of the XML files.

dimitri's avatar
dimitri committed
2093 2094 2095 2096 2097 2098 2099 2100
\anchor cfg_xml_programlisting
<dt>\c XML_PROGRAMLISTING <dd>
 \addindex XML_PROGRAMLISTING
 If the \c XML_PROGRAMLISTING tag is set to \c YES 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.

dimitri's avatar
dimitri committed
2101 2102
</dl>

dimitri's avatar
dimitri committed
2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154
\section autogen_output AUTOGEN_DEF related options
\anchor cfg_generate_autogen_def
<dl>

<dt>\c GENERATE_AUTOGEN_DEF <dd>
 \addindex GENERATE_AUTOGEN_DEF
 If the \c GENERATE_AUTOGEN_DEF tag is set to \c YES Doxygen will
 generate an AutoGen Definitions (see http://autogen.sf.net) file
 that captures the structure of the code including all
 documentation. Note that this feature is still experimental 
 and incomplete at the moment. 

</dl>

\section perlmod_output PERLMOD related options
\anchor cfg_generate_perlmod
<dl>

<dt>\c GENERATE_PERLMOD <dd>
 \addindex GENERATE_PERLMOD
 If the \c GENERATE_PERLMOD tag is set to \c YES Doxygen will
 generate a Perl module file that captures the structure of
 the code including all documentation. Note that this 
 feature is still experimental and incomplete at the
 moment.

\anchor cfg_perlmod_latex
<dt>\c PERLMOD_LATEX <dd>
 \addindex PERLMOD_LATEX
 If the \c PERLMOD_LATEX tag is set to \c YES Doxygen will generate 
 the necessary Makefile rules, Perl scripts and LaTeX code to be able 
 to generate PDF and DVI output from the Perl module output. 

\anchor cfg_perlmod_pretty
<dt>\c PERLMOD_PRETTY <dd>
 \addindex PERLMOD_PRETTY
 If the \c PERLMOD_PRETTY tag is set to \c YES 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 \c NO the size of the Perl module output will be much smaller
 and Perl will parse it just the same. 

\anchor cfg_perlmod_makevar_prefix
<dt>\c PERLMOD_MAKEVAR_PREFIX <dd>
 \addindex PERLMOD_MAKEVAR_PREFIX
 The names of the make variables in the generated doxyrules.make file 
 are prefixed with the string contained in \c PERLMOD_MAKEVAR_PREFIX. 
 This is useful so different doxyrules.make files included by the same
 Makefile don't overwrite each other's variables.

</dl>

dimitri's avatar
dimitri committed
2155
\section config_prepro Preprocessor related options
dimitri's avatar
dimitri committed
2156
\anchor cfg_enable_preprocessing
mueller's avatar
mueller committed
2157 2158 2159 2160
<dl>

<dt>\c ENABLE_PREPROCESSING <dd>
 \addindex ENABLE_PREPROCESSING
dimitri's avatar
dimitri committed
2161
 If the \c ENABLE_PREPROCESSING tag is set to \c YES (the default) doxygen will
mueller's avatar
mueller committed
2162 2163 2164
 evaluate all C-preprocessor directives found in the sources and include
 files. 

mueller's avatar
mueller committed
2165
\anchor cfg_macro_expansion
mueller's avatar
mueller committed
2166 2167
<dt>\c MACRO_EXPANSION <dd>
 \addindex MACRO_EXPANSION
dimitri's avatar
dimitri committed
2168
 If the \c MACRO_EXPANSION tag is set to \c YES doxygen will expand all macro
mueller's avatar
mueller committed
2169
 names in the source code. If set to \c NO (the default) only conditional 
dimitri's avatar
dimitri committed
2170 2171 2172 2173 2174 2175 2176 2177
 compilation will be performed. Macro expansion can be done in a controlled
 way by setting \c EXPAND_ONLY_PREDEF to \c YES.

\anchor cfg_expand_only_predef
<dt>\c EXPAND_ONLY_PREDEF <dd>
 \addindex EXPAND_ONLY_PREDEF
 If the \c EXPAND_ONLY_PREDEF and \c MACRO_EXPANSION tags are both set to YES
 then the macro expansion is limited to the macros specified with the
dimitri's avatar
dimitri committed
2178
 \c PREDEFINED and \c EXPAND_AS_DEFINED tags.
mueller's avatar
mueller committed
2179

mueller's avatar
mueller committed
2180
\anchor cfg_search_includes
mueller's avatar
mueller committed
2181 2182 2183
<dt>\c SEARCH_INCLUDES <dd>
 \addindex SEARCH_INCLUDES 
 If the \c SEARCH_INCLUDES tag is set to \c YES (the default) the includes files
dimitri's avatar
dimitri committed
2184
 in the \c INCLUDE_PATH (see below) will be searched if a \#include is found.
mueller's avatar
mueller committed
2185

mueller's avatar
mueller committed
2186
\anchor cfg_include_path
mueller's avatar
mueller committed
2187 2188 2189 2190 2191 2192
<dt>\c INCLUDE_PATH <dd>
 \addindex INCLUDE_PATH
 The \c INCLUDE_PATH 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.

dimitri's avatar
dimitri committed
2193 2194 2195 2196
\anchor cfg_include_file_patterns
<dt>\c INCLUDE_FILE_PATTERNS <dd>
 \addindex INCLUDE_FILE_PATTERNS
 You can use the \c INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
dimitri's avatar
dimitri committed
2197
 patterns (like `*.h` and `*.hpp`) to filter out the header-files in the 
dimitri's avatar
dimitri committed
2198 2199 2200
 directories. If left blank, the patterns specified with \c FILE_PATTERNS will 
 be used. 

mueller's avatar
mueller committed
2201
\anchor cfg_predefined
mueller's avatar
mueller committed
2202 2203 2204 2205 2206 2207
<dt>\c PREDEFINED <dd>
 \addindex PREDEFINED
 The \c PREDEFINED tag can be used to specify one or more macro names that
 are defined before the preprocessor is started (similar to the -D option of
 gcc). The argument of the tag is a list of macros of the form:
 <code>name</code> or <code>name=definition</code> (no spaces). 
dimitri's avatar
dimitri committed
2208
 If the definition and the "=" are omitted,  "=1" is assumed. To prevent
dimitri's avatar
dimitri committed
2209
 a macro definition from being undefined via \#undef or recursively expanded
dimitri's avatar
dimitri committed
2210
 use the := operator instead of the = operator.
mueller's avatar
mueller committed
2211

dimitri's avatar
dimitri committed
2212 2213 2214
\anchor cfg_expand_as_defined
<dt>\c EXPAND_AS_DEFINED <dd>
 \addindex EXPAND_AS_DEFINED
dimitri's avatar
dimitri committed
2215
 If the \c MACRO_EXPANSION and \c EXPAND_ONLY_PREDEF tags are set to \c YES then
dimitri's avatar
dimitri committed
2216 2217 2218
 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 \c PREDEFINED tag if you want to use a different macro definition.
mueller's avatar
mueller committed
2219

dimitri's avatar
dimitri committed
2220 2221 2222 2223 2224
\anchor cfg_skip_function_macros
<dt>\c SKIP_FUNCTION_MACROS <dd>
 \addindex SKIP_FUNCTION_MACROS
 If the \c SKIP_FUNCTION_MACROS tag is set to \c YES (the default) then 
 doxygen's preprocessor will remove all function-like macros that are alone 
dimitri's avatar
dimitri committed
2225 2226
 on a line, have an all uppercase name, and do not end with a semicolon. 
 Such function macros are typically 
dimitri's avatar
dimitri committed
2227 2228
 used for boiler-plate code, and will confuse the parser if not removed. 

mueller's avatar
mueller committed
2229
</dl>
dimitri's avatar
dimitri committed
2230
\section config_extref External reference options
dimitri's avatar
dimitri committed
2231
\anchor cfg_tagfiles
mueller's avatar
mueller committed
2232 2233 2234 2235
<dl>

<dt>\c TAGFILES <dd> 
 \addindex TAGFILES
dimitri's avatar
dimitri committed
2236 2237 2238 2239 2240
 The \c TAGFILES tag can be used to specify one or more tag files. 

 See \ref external for more information about the use of tag files.

 \note
dimitri's avatar
dimitri committed
2241
  Each tag file must have a unique name 
dimitri's avatar
dimitri committed
2242
  (where the name does \e not include the path).
dimitri's avatar
dimitri committed
2243 2244
  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.
mueller's avatar
mueller committed
2245

mueller's avatar
mueller committed
2246
\anchor cfg_generate_tagfile
mueller's avatar
mueller committed
2247 2248 2249 2250
<dt>\c GENERATE_TAGFILE <dd>
 \addindex GENERATE_TAGFILE
 When a file name is specified after \c GENERATE_TAGFILE, doxygen will create
 a tag file that is based on the input files it reads.
dimitri's avatar
dimitri committed
2251
 See section \ref external for more information about the usage of 
mueller's avatar
mueller committed
2252 2253
 tag files.

mueller's avatar
mueller committed
2254
\anchor cfg_allexternals
mueller's avatar
mueller committed
2255 2256
<dt>\c ALLEXTERNALS <dd>
 \addindex ALLEXTERNALS
dimitri's avatar
dimitri committed
2257
 If the \c ALLEXTERNALS tag is set to \c YES all external class will be listed
mueller's avatar
mueller committed
2258 2259 2260
 in the class index. If set to \c NO only the inherited external classes
 will be listed.

dimitri's avatar
dimitri committed
2261 2262 2263 2264 2265 2266 2267
\anchor cfg_external_groups
<dt>\c EXTERNAL_GROUPS <dd>
 \addindex EXTERNAL_GROUPS
 If the \c EXTERNAL_GROUPS tag is set to \c YES all external groups will be listed
 in the modules index. If set to \c NO, only the current project's groups will
 be listed.
 
mueller's avatar
mueller committed
2268
\anchor cfg_perl_path
mueller's avatar
mueller committed
2269 2270 2271
<dt>\c PERL_PATH <dd>
 \addindex PERL_PATH
 The \c PERL_PATH should be the absolute path and name of the perl script
dimitri's avatar
dimitri committed
2272
 interpreter (i.e. the result of '<tt>which perl</tt>').
mueller's avatar
mueller committed
2273

dimitri's avatar
dimitri committed
2274
</dl>
dimitri's avatar
dimitri committed
2275
\section config_dot Dot options
dimitri's avatar
dimitri committed
2276
\anchor cfg_class_diagrams
dimitri's avatar
dimitri committed
2277 2278
<dl>

dimitri's avatar
dimitri committed
2279 2280 2281 2282
<dt>\c CLASS_DIAGRAMS <dd>
 \addindex CLASS_DIAGRAMS
 If the \c CLASS_DIAGRAMS tag is set to \c YES (the default) doxygen will
 generate a class diagram (in HTML and \f$\mbox{\LaTeX}\f$) for classes with base or
dimitri's avatar
dimitri committed
2283 2284 2285
super classes. Setting the tag to NO turns the diagrams off. Note that 
this option also works with HAVE_DOT disabled, but it is recommended to 
install and use dot, since it yields more powerful graphs. 
dimitri's avatar
dimitri committed
2286

dimitri's avatar
dimitri committed
2287 2288 2289 2290
\anchor cfg_mscgen_path
<dt>\c MSCGEN_PATH <dd>
 \addindex MSCGEN_PATH
 You can define message sequence charts within doxygen comments using the \ref cmdmsc "\\msc" 
dimitri's avatar
dimitri committed
2291
 command. Doxygen will then run the <a href="http://www.mcternan.me.uk/mscgen/">mscgen tool</a>) to 
dimitri's avatar
dimitri committed
2292 2293 2294 2295
 produce the chart and insert it in the documentation. The <code>MSCGEN_PATH</code> tag allows you to 
 specify the directory where the mscgen tool resides. If left empty the tool is assumed to 
 be found in the default search path.

dimitri's avatar
dimitri committed
2296
\anchor cfg_have_dot
dimitri's avatar
dimitri committed
2297 2298 2299 2300
<dt>\c HAVE_DOT <dd>
 \addindex HAVE_DOT
 If you set the \c HAVE_DOT tag to \c YES then doxygen will assume the dot tool is
 available from the path. This tool is part of 
dimitri's avatar
dimitri committed
2301
 <a href="http://www.research.att.com/sw/tools/graphviz/">Graphviz</a>, a graph 
dimitri's avatar
dimitri committed
2302
 visualization toolkit from AT\&T and Lucent Bell Labs. The other options in 
dimitri's avatar
dimitri committed
2303
 this section have no effect if this option is set to \c NO (the default)
dimitri's avatar
dimitri committed
2304

dimitri's avatar
dimitri committed
2305 2306 2307 2308 2309 2310 2311 2312 2313
\anchor cfg_dot_num_threads
<dt>\c DOT_NUM_THREADS <dd>
 \addindex DOT_NUM_THREADS
 The \c DOT_NUM_THREADS specifies the number of dot invocations doxygen is 
 allowed to run in parallel. When set to 0 (the default) doxygen will 
 base this on the number of processors available in the system. You can set it 
 explicitly to a value larger than 0 to get control over the balance 
 between CPU load and processing speed.  

dimitri's avatar
dimitri committed
2314 2315 2316
\anchor cfg_dot_fontname
<dt>\c DOT_FONTNAME <dd>
 \addindex DOT_FONTNAME
dimitri's avatar
dimitri committed
2317 2318 2319 2320 2321 2322 2323
 By default doxygen will use the Helvetica font for all dot files that 
 doxygen generates. 
 When you want a differently looking font you can specify the font name 
 using \c DOT_FONTNAME. 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 
 \c DOTFONTPATH environment variable or by setting \c DOT_FONTPATH to the 
 directory containing the font. 
dimitri's avatar
dimitri committed
2324

dimitri's avatar
dimitri committed
2325 2326 2327 2328 2329
\anchor cfg_dot_fontsize
<dt>\c DOT_FONTSIZE <dd>
The \c DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
The default size is 10pt. 

dimitri's avatar
dimitri committed
2330 2331 2332 2333 2334 2335 2336
\anchor cfg_dot_fontpath
<dt>\c DOT_FONTPATH <dd>
 \addindex DOT_FONTPATH
 By default doxygen will tell dot to use the output directory to look for the 
 \c FreeSans.ttf font (which doxygen will put there itself). If you specify a 
 different font using \c DOT_FONTNAME you can set the path where dot 
 can find it using this tag.
dimitri's avatar
dimitri committed
2337
 
dimitri's avatar
dimitri committed
2338 2339 2340
\anchor cfg_class_graph
<dt>\c CLASS_GRAPH <dd>
 \addindex CLASS_GRAPH
dimitri's avatar
dimitri committed
2341 2342
 If the \c CLASS_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen
 will generate a graph for each documented class showing the direct and
dimitri's avatar
dimitri committed
2343
 indirect inheritance relations. Setting this tag to \c YES will force 
dimitri's avatar
dimitri committed
2344
 the \c CLASS_DIAGRAMS tag to NO.
dimitri's avatar
dimitri committed
2345

dimitri's avatar
dimitri committed
2346 2347 2348 2349 2350 2351 2352 2353
\anchor cfg_collaboration_graph
<dt>\c COLLABORATION_GRAPH <dd>
 \addindex COLLABORATION_GRAPH
 If the \c COLLABORATION_GRAPH and \c HAVE_DOT tags are set to \c YES 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.

dimitri's avatar
dimitri committed
2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366
\anchor cfg_group_graphs
<dt>\c GROUP_GRAPHS <dd>
 \addindex GROUP_GRAPHS
 If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
 will generate a graph for groups, showing the direct groups dependencies.

\anchor cfg_uml_look
<dt>\c UML_LOOK <dd>
 \addindex UML_LOOK
 If the UML_LOOK tag is set to YES doxygen will generate inheritance and
 collaboration diagrams in a style similar to the OMG's Unified Modeling
 Language.

dimitri's avatar
dimitri committed
2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378
\anchor cfg_uml_limit_num_fields
<dt>\c UML_LIMIT_NUM_FIELDS <dd>
 \addindex UML_LIMIT_NUM_FIELDS
 If the \c UML_LOOK 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 \c UML_LIMIT_NUM_FIELDS 
 threshold limits the number of items for each type to make the size more 
 managable. Set this to 0 for no limit. Note that the threshold may be 
 exceeded by 50% before the limit is enforced. So when you set the threshold
 to 10, up to 15 fields may appear, but if the number exceeds 15, the
 total amount of fields shown is limited to 10.

dimitri's avatar
dimitri committed
2379 2380 2381 2382 2383 2384
\anchor cfg_template_relations
<dt>\c TEMPLATE_RELATIONS <dd>
 \addindex TEMPLATE_RELATIONS
 If the \c TEMPLATE_RELATIONS and \c HAVE_DOT tags are set to \c YES then 
 doxygen will show the relations between templates and their instances.

dimitri's avatar
dimitri committed
2385 2386 2387 2388 2389 2390 2391
\anchor cfg_hide_undoc_relations
<dt>\c HIDE_UNDOC_RELATIONS <dd>
 \addindex HIDE_UNDOC_RELATIONS
 If set to YES, the inheritance and collaboration graphs will hide
 inheritance and usage relations if the target is undocumented
 or is not a class.

dimitri's avatar
dimitri committed
2392 2393 2394
\anchor cfg_include_graph
<dt>\c INCLUDE_GRAPH <dd>
 \addindex INCLUDE_GRAPH 
dimitri's avatar
dimitri committed
2395 2396
 If the \c ENABLE_PREPROCESSING, \c SEARCH_INCLUDES, \c INCLUDE_GRAPH, and \c HAVE_DOT
 tags are set to \c YES then doxygen will generate a graph for each documented file
dimitri's avatar
dimitri committed
2397 2398 2399
 showing the direct and indirect include dependencies of the file with other
 documented files.

dimitri's avatar
dimitri committed
2400 2401 2402
\anchor cfg_included_by_graph
<dt>\c INCLUDED_BY_GRAPH <dd>
 \addindex INCLUDED_BY_GRAPH 
dimitri's avatar
dimitri committed
2403 2404 2405 2406
 If the \c ENABLE_PREPROCESSING, \c SEARCH_INCLUDES, \c INCLUDED_BY_GRAPH, and
 \c HAVE_DOT tags are set to \c YES then doxygen will generate a graph for each
 documented header file showing the documented files that directly or indirectly
 include this file.
dimitri's avatar
dimitri committed
2407

dimitri's avatar
dimitri committed
2408 2409 2410 2411 2412 2413 2414 2415 2416
\anchor cfg_call_graph
<dt>\c CALL_GRAPH <dd>
 \addindex CALL_GRAPH
 If the \c CALL_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen will 
 generate a call dependency graph for every global function or class method. 
 Note that enabling this option will significantly increase the time of a run.
 So in most cases it will be better to enable call graphs for selected 
 functions only using the \\callgraph command.

dimitri's avatar
dimitri committed
2417 2418 2419 2420 2421 2422 2423 2424 2425
\anchor cfg_caller_graph
<dt>\c CALLER_GRAPH <dd>
 \addindex CALLER_GRAPH
 If the \c CALLER_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen will 
 generate a caller dependency graph for every global function or class method. 
 Note that enabling this option will significantly increase the time of a run.
 So in most cases it will be better to enable caller graphs for selected 
 functions only using the \\callergraph command.

dimitri's avatar
dimitri committed
2426 2427
\anchor cfg_graphical_hierarchy
<dt>\c GRAPHICAL_HIERARCHY <dd>
dimitri's avatar
dimitri committed
2428
 \addindex GRAPHICAL_HIERARCHY
dimitri's avatar
dimitri committed
2429 2430 2431
 If the \c GRAPHICAL_HIERARCHY and \c HAVE_DOT tags are set to \c YES then 
 doxygen will graphical hierarchy of all classes instead of a textual one.

dimitri's avatar
dimitri committed
2432 2433 2434
\anchor cfg_directory_graph
<dt>\c DIRECTORY_GRAPH <dd>
 \addindex DIRECTORY_GRAPH		    
dimitri's avatar
dimitri committed
2435
 If the \c DIRECTORY_GRAPH, and \c HAVE_DOT options are set 
dimitri's avatar
dimitri committed
2436
 to \c YES then doxygen will show the dependencies a directory has on other directories
dimitri's avatar
dimitri committed
2437
 in a graphical way. The dependency relations are determined by the \#include
dimitri's avatar
dimitri committed
2438 2439
 relations between the files in the directories.

dimitri's avatar
dimitri committed
2440 2441 2442
\anchor cfg_dot_graph_max_nodes 
<dt>\c DOT_GRAPH_MAX_NODES <dd>
 \addindex DOT_GRAPH_MAX_NODES
dimitri's avatar
dimitri committed
2443
 The \c DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
dimitri's avatar
dimitri committed
2444 2445 2446 2447
 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
dimitri's avatar
dimitri committed
2448
 \c DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
dimitri's avatar
dimitri committed
2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460
 that the size of a graph can be further restricted by \c MAX_DOT_GRAPH_DEPTH.

\anchor cfg_max_dot_graph_depth
<dt>\c MAX_DOT_GRAPH_DEPTH <dd>
 \addindex MAX_DOT_GRAPH_DEPTH
 The \c MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
 graphs generated by dot. A depth value of 3 means that only nodes reachable
 from the root by following a path via at most 3 edges will be shown. Nodes
 that lay further from the root node will be omitted. Note that setting this
 option to 1 or 2 may greatly reduce the computation time needed for large
 code bases. Also note that the size of a graph can be further restricted by
 \c DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction (the default).
dimitri's avatar
dimitri committed
2461

dimitri's avatar
dimitri committed
2462 2463 2464
\anchor cfg_dot_image_format
<dt>\c DOT_IMAGE_FORMAT <dd>
 \addindex DOT_IMAGE_FORMAT
dimitri's avatar
dimitri committed
2465
 The \c DOT_IMAGE_FORMAT tag can be used to set the image format of the images
dimitri's avatar
dimitri committed
2466
 generated by dot. Possible values are svg, png, jpg, or gif.
dimitri's avatar
dimitri committed
2467
 If left blank png will be used.
dimitri's avatar
dimitri committed
2468 2469 2470
 \note If you choose \c svg you need to set 
 HTML_FILE_EXTENSION to xhtml in order to make the SVG files
 visible in IE 9+ (other browsers do not have this requirement).
dimitri's avatar
dimitri committed
2471

dimitri's avatar
dimitri committed
2472
\anchor cfg_interactive_svg
dimitri's avatar
dimitri committed
2473
<dt>\c INTERACTIVE_SVG <dd>
dimitri's avatar
dimitri committed
2474 2475
 If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
 enable generation of interactive SVG images that allow zooming and panning. 
dimitri's avatar
dimitri committed
2476 2477 2478 2479
 Note that this requires a modern browser other than Internet Explorer. 
 Tested and working are Firefox, Chrome, Safari, and Opera.
 \note For IE 9+ you need to set \c HTML_FILE_EXTENSION to xhtml in order 
 to make the SVG files visible. Older versions of IE do not have SVG support.
dimitri's avatar
dimitri committed
2480

dimitri's avatar
dimitri committed
2481 2482 2483 2484 2485 2486
\anchor cfg_dot_path
<dt>\c DOT_PATH <dd>
 \addindex DOT_PATH
 This tag can be used to specify the path where the dot tool can be found. 
 If left blank, it is assumed the dot tool can be found on the path. 

dimitri's avatar
dimitri committed
2487 2488 2489 2490 2491
\anchor cfg_dotfile_dirs
<dt>\c DOTFILE_DIRS <dd>
 \addindex DOTFILE_DIRS
 This tag can be used to specify one or more directories that 
 contain dot files that are included in the documentation (see the
dimitri's avatar
dimitri committed
2492 2493 2494 2495 2496 2497 2498 2499
 \ref cmddotfile "\\dotfile" command).

\anchor cfg_mscfile_dirs
<dt>\c MSCFILE_DIRS <dd>
 \addindex MSCFILE_DIRS
 This tag can be used to specify one or more directories that 
 contain msc files that are included in the documentation (see the
 \ref cmdmscfile "\\mscfile" command).
dimitri's avatar
dimitri committed
2500

dimitri's avatar
dimitri committed
2501 2502 2503
\anchor cfg_dot_transparent
<dt>\c DOT_TRANSPARENT <dd>
 \addindex DOT_TRANSPARENT
dimitri's avatar
dimitri committed
2504 2505 2506 2507 2508
 Set the \c DOT_TRANSPARENT tag to \c YES to generate images with a transparent
 background. This is disabled by default, because dot on Windows does not 
 seem to support this out of the box. Warning: Depending on the platform used, 
 enabling this option may lead to badly anti-aliased labels on the edges of 
 a graph (i.e. they become hard to read). 
dimitri's avatar
dimitri committed
2509 2510 2511 2512 2513 2514 2515 2516 2517
 
\anchor cfg_dot_multi_targets
<dt>\c DOT_MULTI_TARGETS <dd>
 \addindex DOT_MULTI_TARGET
 Set the \c DOT_MULTI_TARGETS tag to \c YES allow dot to generate multiple output
 files in one run (i.e. multiple -o and -T options on the command line). This
 makes dot run faster, but since only newer versions of dot (>1.8.10)
 support this, this feature is disabled by default.

dimitri's avatar
dimitri committed
2518
\anchor cfg_generate_legend 
dimitri's avatar
dimitri committed
2519 2520
<dt>\c GENERATE_LEGEND <dd>
 \addindex GENERATE_LEGEND
dimitri's avatar
dimitri committed
2521
 If the \c GENERATE_LEGEND tag is set to \c YES (the default) doxygen will
dimitri's avatar
dimitri committed
2522 2523 2524
 generate a legend page explaining the meaning of the various boxes and
 arrows in the dot generated graphs.

dimitri's avatar
dimitri committed
2525 2526 2527
\anchor cfg_dot_cleanup
<dt>\c DOT_CLEANUP <dd>
 \addindex DOT_CLEANUP
dimitri's avatar
dimitri committed
2528
If the \c DOT_CLEANUP tag is set to \c YES (the default) doxygen will
dimitri's avatar
dimitri committed
2529
remove the intermediate dot files that are used to generate the various graphs.
dimitri's avatar
dimitri committed
2530

dimitri's avatar
dimitri committed
2531

mueller's avatar
mueller committed
2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548
</dl>
<h2>Examples</h2>

Suppose you have a simple project consisting of two files: a source file 
\c example.cc and a header file \c example.h.
Then a minimal configuration file is as simple as:
\verbatim
INPUT            = example.cc example.h
\endverbatim

Assuming the example makes use of Qt classes and perl is located 
in <code>/usr/bin</code>, a more realistic configuration file would be:
\verbatim
PROJECT_NAME     = Example
INPUT            = example.cc example.h
WARNINGS         = YES
TAGFILES         = qt.tag
dimitri's avatar
dimitri committed
2549
PERL_PATH        = /usr/local/bin/perl
mueller's avatar
mueller committed
2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563
SEARCHENGINE     = NO
\endverbatim

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:
\verbatim
PROJECT_NAME     = QdbtTabular
OUTPUT_DIRECTORY = html
WARNINGS         = YES
INPUT            = examples/examples.doc src
FILE_PATTERNS    = *.cc *.h
INCLUDE_PATH     = examples
TAGFILES         = qt.tag
dimitri's avatar
dimitri committed
2564
PERL_PATH        = /usr/bin/perl
mueller's avatar
mueller committed
2565 2566 2567
SEARCHENGINE     = YES
\endverbatim

mueller's avatar
mueller committed
2568
To regenerate the Qt-1.44 documentation from the sources, you could use the
mueller's avatar
mueller committed
2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581
following config file:
\verbatim
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= \
mueller's avatar
mueller committed
2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597
                       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
mueller's avatar
mueller committed
2598 2599 2600 2601 2602 2603 2604 2605 2606 2607
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
\endverbatim

dimitri's avatar
dimitri committed
2608
For the Qt-2.1 sources I recommend to use the following settings:
dimitri's avatar
dimitri committed
2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636
\verbatim
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
\endverbatim

dimitri's avatar
dimitri committed
2637
Here doxygen's preprocessor is used to substitute some
mueller's avatar
mueller committed
2638 2639 2640 2641 2642
macro names that are normally substituted by the C preprocessor,
but without doing full macro expansion.

*/