docs/doxygen/Doxyfile_inc

   1 #############################################################################
   2 ## Name:        Doxyfile_inc
   3 ## Purpose:     Main configuration file for the wxWidgets manual
   4 ## Author:      Francesco Montorsi
   5 ## RCS-ID:      $Id$
   6 ## Licence:     wxWindows license
   7 #############################################################################
   8
   9 #---------------------------------------------------------------------------
  10 # Project Options
  11 #---------------------------------------------------------------------------
  12
  13 DOXYFILE_ENCODING      = UTF-8
  14 PROJECT_NAME           = wxWidgets
  15 PROJECT_NUMBER         = 2.9.0
  16 OUTPUT_DIRECTORY       = out
  17 CREATE_SUBDIRS         = NO
  18 OUTPUT_LANGUAGE        = English
  19 BRIEF_MEMBER_DESC      = YES
  20 REPEAT_BRIEF           = YES
  21 ABBREVIATE_BRIEF       =
  22 ALWAYS_DETAILED_SEC    = YES
  23 INLINE_INHERITED_MEMB  = NO
  24 FULL_PATH_NAMES        = YES
  25 STRIP_FROM_PATH        = "$(WXWIDGETS)/"
  26 STRIP_FROM_INC_PATH    = "$(WXWIDGETS)/include/" \
  27                          "$(WXWIDGETS)/interface/"
  28 SHORT_NAMES            = NO
  29 JAVADOC_AUTOBRIEF      = YES
  30 QT_AUTOBRIEF           = NO
  31 MULTILINE_CPP_IS_BRIEF = NO
  32 INHERIT_DOCS           = YES
  33 SEPARATE_MEMBER_PAGES  = NO
  34 TAB_SIZE               = 4
  35 OPTIMIZE_OUTPUT_FOR_C  = NO
  36 OPTIMIZE_OUTPUT_JAVA   = NO
  37 OPTIMIZE_FOR_FORTRAN   = NO
  38 OPTIMIZE_OUTPUT_VHDL   = NO
  39 BUILTIN_STL_SUPPORT    = NO
  40 CPP_CLI_SUPPORT        = NO
  41 SIP_SUPPORT            = NO
  42 IDL_PROPERTY_SUPPORT   = NO
  43 DISTRIBUTE_GROUP_DOC   = YES
  44 SUBGROUPING            = YES
  45 TYPEDEF_HIDES_STRUCT   = NO
  46 SYMBOL_CACHE_SIZE      = 0
  47
  48 # This is the most important part of the wxWidgets Doxyfile; aliases allow
  49 # us to keep the headers readable and "implement" wxWidgets-specific commands:
  50
  51 #---------------------------------------------------------------------------
  52 # Aliases - for use when documenting C++ classes
  53 #---------------------------------------------------------------------------
  54
  55 # aliases to be used by classes which emit wxEvents (e.g. wxWindow, wxTextCtrl, etc):
  56 ALIASES = beginEventEmissionTable="\n<h2>Events emitted by this class</h2><p>Event macros for events emitted by this class:</p><div>"
  57 ALIASES += beginEventEmissionTable{1}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros for events emitted by this class:<div>"
  58 ALIASES += beginEventEmissionTable{2}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros for events emitted by this class:<div>"
  59
  60 # aliases to be used in wxEvent-derived classes:
  61 ALIASES += beginEventTable{1}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros:<div>"
  62 ALIASES += beginEventTable{2}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros:<div>"
  63
  64 # common event aliases:
  65 ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
  66 ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
  67 ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
  68 ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
  69 ALIASES += endEventTable="</div>\n"
  70
  71 # style aliases
  72 ALIASES += beginStyleTable="\n<h2>Styles</h2><p>This class supports the following styles:</p><div>"
  73 ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
  74 ALIASES += endStyleTable="</div>\n"
  75
  76 # extra style aliases
  77 ALIASES += beginExtraStyleTable="\n<hr><h2>Extra styles</h2><p>This class supports the following extra styles:</p><div>"
  78 ALIASES += endExtraStyleTable="</div>\n"
  79
  80 # flag aliases
  81 ALIASES += beginFlagTable="<div>"
  82 ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
  83 ALIASES += endFlagTable="</div>\n"
  84
  85 # creates appearance section: this should be used for all main GUI controls
  86 ALIASES += appearance{1}="\htmlonly <br><div><span class='appearance'>Appearance:</span><br><table class='appearance'><tr><td><img src='wxmsw/\1' alt='wxMSW appearance' class='appearance'></td><td><img src='wxgtk/\1' alt='wxGTK appearance' class='appearance'></td><td><img src='wxmac/\1' alt='wxMac appearance' class='appearance'></td></tr><tr><td>wxMSW appearance</td><td>wxGTK appearance</td><td>wxMac appearance</td></tr></table></div> \endhtmlonly"
  87
  88 #---------------------------------------------------------------------------
  89 # Aliases - for use when documenting any C++ entity
  90 #---------------------------------------------------------------------------
  91
  92 # aliases for additional wx-specific infos
  93 ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1</span></div>"
  94 ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2</span></div>"
  95 ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
  96 ALIASES += nolibrary="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
  97 ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
  98
  99 # native implementation infos:
 100 ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
 101 ALIASES += nativeimpl{2}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1, \ref page_port_\2 ports; a generic implementation is used elsewhere.</div>"
 102 ALIASES += nativeimpl{3}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; a generic implementation is used elsewhere.</div>"
 103 ALIASES += nativeimpl{4}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports; a generic implementation is used elsewhere.</div>"
 104
 105 # onlyfor infos:
 106 # NOTE: we need to be able to retrieve these infos also from the XML output, thus
 107 #       we use the \xmlonly and \endxmlonly commands to include custom XML tags
 108 ALIASES += onlyfor{1}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1 port.</div>       \xmlonly <onlyfor>\1</onlyfor> \endxmlonly"
 109 ALIASES += onlyfor{2}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2 ports.</div>       \xmlonly <onlyfor>\1,\2</onlyfor> \endxmlonly"
 110 ALIASES += onlyfor{3}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports.</div>       \xmlonly <onlyfor>\1,\2,\3</onlyfor> \endxmlonly"
 111 ALIASES += onlyfor{4}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports.</div>       \xmlonly <onlyfor>\1,\2,\3,\4</onlyfor> \endxmlonly"
 112
 113 # Use this in grouped global functions, and macros since they
 114 # wouldn't otherwise indicate what header they are defined in.
 115 ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
 116
 117 # some formatting aliases
 118 ALIASES += true="<span class='literal'>true</span>"
 119 ALIASES += false="<span class='literal'>false</span>"
 120 ALIASES += NULL="<span class='literal'>NULL</span>"
 121 ALIASES += NUL="<span class='literal'>NUL</span>"
 122
 123 # NOTE: these are important as you can't write in the docs
 124 #       just #ifdef since the # character is used by Doxygen
 125 #       for explicit linking; use the following aliases instead!
 126 #       However to avoid overwriting e.g. \if Doxygen command the _
 127 #       character is postfixed
 128 ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
 129 ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
 130 ALIASES += if_="<span class='literal'>\#if</span>"
 131 ALIASES += endif_="<span class='literal'>\#endif</span>"
 132
 133 # table aliases for 2 and 3 column tables
 134 ALIASES += beginTable="<table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
 135 ALIASES += beginInvisibleTable="<table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
 136 ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
 137 ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
 138 ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
 139 ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
 140 ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
 141 ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
 142 ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
 143 ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
 144 ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
 145 ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
 146 ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
 147 ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
 148 ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
 149 ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
 150 ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
 151 ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
 152 ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
 153 ALIASES += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>"
 154 ALIASES += endTable="</table>"
 155
 156 # definition list aliases
 157 # a definition list currently is rendered as 2-column table but it may use as
 158 # well the <dl>, <dt> and <dd> HTML tags in future.
 159 # In any case a definition list differs from a table because of its semantic
 160 # nature and because it is always the association of a "title" with a "description"
 161 # (in contrast a table may have more than 2 columns of data)...
 162 ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
 163 ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
 164 ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
 165 ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
 166 ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
 167 ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
 168 ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
 169 ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
 170 ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
 171 ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
 172 ALIASES += endDefList="</table>"
 173 ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td> @image html gtk-\2.png\n</td><td>\3</td></tr>"
 174
 175 #---------------------------------------------------------------------------
 176 # Aliases - for use when documenting wxPerl/wxPython-specific parts
 177 #---------------------------------------------------------------------------
 178
 179 # See ENABLED_SECTIONS configuration key for more info about these:
 180 ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
 181 ALIASES += endWxPerlOnly="\endif"
 182 ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> "
 183 ALIASES += endWxPythonOnly="\endif"
 184
 185 # This is to get around a bug in Doxygen that prevents use of '{' or '}'
 186 # inside of any aliased command in parameters.
 187 ALIASES += leftCurly="{"
 188 ALIASES += rightCurly="}"
 189
 190 #---------------------------------------------------------------------------
 191 # Aliases - for use when documenting samples
 192 #---------------------------------------------------------------------------
 193
 194 # For indicating the a directory containing a sample
 195 ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim"
 196
 197 # For refering to the corresponding sample in a class document or a overview
 198 # Usually placed in the queue of @see
 199 ALIASES += sample{1}="\ref page_samples_\1"
 200
 201 # For generating a general description for a sample
 202 # \1 could be a class or an overview or a descriptive sentence
 203 # Shall be replaced by manual written description soon
 204 ALIASES += sampleabout{1}="This sample demonstrates \1."
 205
 206 # For indicating the necessary condition of a sample or a class
 207 # \1 is the wxUSE_XXX macro
 208 ALIASES += buildwith{1}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info."
 209 ALIASES += buildwith{2}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> and <tt>\2</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info."
 210
 211 #---------------------------------------------------------------------------
 212 # Build Options
 213 #---------------------------------------------------------------------------
 214
 215 EXTRACT_ALL            = YES
 216 EXTRACT_PRIVATE        = NO
 217 EXTRACT_STATIC         = YES
 218 EXTRACT_LOCAL_CLASSES  = YES
 219 EXTRACT_LOCAL_METHODS  = NO
 220 EXTRACT_ANON_NSPACES   = YES
 221 HIDE_UNDOC_MEMBERS     = NO
 222 HIDE_UNDOC_CLASSES     = NO
 223 HIDE_FRIEND_COMPOUNDS  = NO
 224 HIDE_IN_BODY_DOCS      = NO
 225 INTERNAL_DOCS          = NO
 226 CASE_SENSE_NAMES       = NO
 227 HIDE_SCOPE_NAMES       = NO
 228 SHOW_INCLUDE_FILES     = YES
 229 INLINE_INFO            = YES
 230 SORT_MEMBER_DOCS       = YES
 231 SORT_BRIEF_DOCS        = NO  # Don't set to YES, it renders our named groups out of order.
 232 SORT_GROUP_NAMES       = YES
 233 SORT_BY_SCOPE_NAME     = NO
 234 GENERATE_TODOLIST      = YES
 235 GENERATE_TESTLIST      = YES
 236 GENERATE_BUGLIST       = YES
 237 GENERATE_DEPRECATEDLIST= YES
 238
 239 # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
 240 ENABLED_SECTIONS       = WXPERL_MANUAL WXPYTHON_MANUAL
 241
 242 MAX_INITIALIZER_LINES  = 30
 243 SHOW_USED_FILES        = NO
 244 SHOW_DIRECTORIES       = YES
 245 SHOW_FILES             = YES
 246 SHOW_NAMESPACES        = NO
 247 FILE_VERSION_FILTER    =
 248 LAYOUT_FILE            = DoxygenLayout.xml
 249
 250 #---------------------------------------------------------------------------
 251 # Warning and Progress Message Options
 252 #---------------------------------------------------------------------------
 253
 254 QUIET                  = YES
 255 WARNINGS               = YES
 256 WARN_IF_UNDOCUMENTED   = YES
 257 WARN_IF_DOC_ERROR      = YES
 258 WARN_NO_PARAMDOC       = YES
 259 WARN_FORMAT            = "$file:$line: $text   "
 260 WARN_LOGFILE           = doxygen.log
 261
 262 #---------------------------------------------------------------------------
 263 # Input File Options
 264 #---------------------------------------------------------------------------
 265
 266 INPUT                  = ./mainpages ./groups ./overviews ../../interface
 267 INPUT_ENCODING         = UTF-8
 268 FILE_PATTERNS          = *.h *.txt
 269 RECURSIVE              = YES
 270 EXCLUDE                =
 271 EXCLUDE_SYMLINKS       = NO
 272 EXCLUDE_PATTERNS       =
 273 EXCLUDE_SYMBOLS        =
 274 EXAMPLE_PATH           = ../
 275 EXAMPLE_PATTERNS       = *
 276 EXAMPLE_RECURSIVE      = NO
 277 IMAGE_PATH             = images
 278 INPUT_FILTER           =
 279 FILTER_PATTERNS        =
 280 FILTER_SOURCE_FILES    = NO
 281
 282 #---------------------------------------------------------------------------
 283 # Source Browsing Options
 284 #---------------------------------------------------------------------------
 285
 286 SOURCE_BROWSER         = NO
 287 INLINE_SOURCES         = NO
 288 STRIP_CODE_COMMENTS    = YES
 289 REFERENCED_BY_RELATION = NO
 290 REFERENCES_RELATION    = NO
 291 REFERENCES_LINK_SOURCE = YES
 292 USE_HTAGS              = NO
 293 VERBATIM_HEADERS       = NO
 294
 295 #---------------------------------------------------------------------------
 296 # Alphabetical Class Index Options
 297 #---------------------------------------------------------------------------
 298
 299 ALPHABETICAL_INDEX     = YES
 300 COLS_IN_ALPHA_INDEX    = 5
 301 IGNORE_PREFIX          = wx
 302
 303 #---------------------------------------------------------------------------
 304 # configuration options related to the HTML output
 305 #---------------------------------------------------------------------------
 306 GENERATE_HTML          = NO # Only change in format output configs
 307 HTML_OUTPUT            = html
 308 HTML_FILE_EXTENSION    = .html
 309 HTML_HEADER            = htmlheader.inc
 310 HTML_FOOTER            = htmlfooter.inc
 311 HTML_STYLESHEET        =
 312 HTML_ALIGN_MEMBERS     = YES
 313 HTML_DYNAMIC_SECTIONS  = YES
 314 GENERATE_DOCSET        = NO # Only change in format output configs
 315 DOCSET_FEEDNAME        = "wxWidgets"
 316 DOCSET_BUNDLE_ID       = org.wxwidgets.doxygen
 317 GENERATE_HTMLHELP      = NO # Only change in format output configs
 318 CHM_FILE               = ..\wx.chm # NOTE: Windows style separator needed
 319 HHC_LOCATION           = hhc.exe # Don't modify, see Doxyfile_chm for info
 320 GENERATE_CHI           = NO
 321 BINARY_TOC             = NO
 322 TOC_EXPAND             = NO
 323 GENERATE_QHP           = NO
 324 QCH_FILE               =
 325 QHP_NAMESPACE          = org.wxwidgets.doxygen
 326 QHP_VIRTUAL_FOLDER     = doc
 327 QHG_LOCATION           =
 328 DISABLE_INDEX          = NO
 329 ENUM_VALUES_PER_LINE   = 1
 330 GENERATE_TREEVIEW      = NONE
 331 TREEVIEW_WIDTH         = 250
 332 FORMULA_FONTSIZE       = 10
 333
 334 #---------------------------------------------------------------------------
 335 # LaTeX Output Options
 336 #---------------------------------------------------------------------------
 337
 338 GENERATE_LATEX         = NO # Only change in format output configs
 339 LATEX_OUTPUT           = latex
 340 LATEX_CMD_NAME         = latex
 341 MAKEINDEX_CMD_NAME     = makeindex
 342 COMPACT_LATEX          = NO
 343 PAPER_TYPE             = a4wide
 344 EXTRA_PACKAGES         =
 345 LATEX_HEADER           = latexdocstart.inc
 346 PDF_HYPERLINKS         = YES
 347 USE_PDFLATEX           = YES
 348 LATEX_BATCHMODE        = YES
 349 LATEX_HIDE_INDICES     = NO
 350
 351 #---------------------------------------------------------------------------
 352 # RTF Output Options
 353 #---------------------------------------------------------------------------
 354
 355 GENERATE_RTF           = NO # Only change in format output configs
 356 RTF_OUTPUT             = rtf
 357 COMPACT_RTF            = NO
 358 RTF_HYPERLINKS         = NO
 359 RTF_STYLESHEET_FILE    =
 360 RTF_EXTENSIONS_FILE    =
 361
 362 #---------------------------------------------------------------------------
 363 # Man Page Output Options
 364 #---------------------------------------------------------------------------
 365
 366 GENERATE_MAN           = NO # Only change in format output configs
 367 MAN_OUTPUT             = man
 368 MAN_EXTENSION          = .3
 369 MAN_LINKS              = NO
 370
 371 #---------------------------------------------------------------------------
 372 # XML Output Options
 373 #---------------------------------------------------------------------------
 374
 375 GENERATE_XML           = NO # Only change in format output configs
 376 XML_OUTPUT             = xml
 377 XML_SCHEMA             =
 378 XML_DTD                =
 379 XML_PROGRAMLISTING     = NO
 380
 381 #---------------------------------------------------------------------------
 382 # AutoGen Definitions Output Options
 383 #---------------------------------------------------------------------------
 384
 385 GENERATE_AUTOGEN_DEF   = NO # Only change in format output configs
 386
 387 #---------------------------------------------------------------------------
 388 # Perl Module Output Options
 389 #---------------------------------------------------------------------------
 390
 391 GENERATE_PERLMOD       = NO # Only change in format output configs
 392 PERLMOD_LATEX          = YES
 393 PERLMOD_PRETTY         = YES
 394 PERLMOD_MAKEVAR_PREFIX =
 395
 396 #---------------------------------------------------------------------------
 397 # Preprocessor Options
 398 #---------------------------------------------------------------------------
 399
 400 ENABLE_PREPROCESSING   = YES
 401 MACRO_EXPANSION        = NO
 402 EXPAND_ONLY_PREDEF     = NO
 403 SEARCH_INCLUDES        = YES
 404 INCLUDE_PATH           =
 405 INCLUDE_FILE_PATTERNS  =
 406 PREDEFINED             =
 407 EXPAND_AS_DEFINED      =
 408 SKIP_FUNCTION_MACROS   = YES
 409
 410 #---------------------------------------------------------------------------
 411 # Additions Related to External References
 412 #---------------------------------------------------------------------------
 413
 414 TAGFILES               =
 415 GENERATE_TAGFILE       =
 416 ALLEXTERNALS           = NO
 417 EXTERNAL_GROUPS        = YES
 418 PERL_PATH              = /usr/bin/perl
 419
 420 #---------------------------------------------------------------------------
 421 # dot Tool Options
 422 #---------------------------------------------------------------------------
 423
 424 CLASS_DIAGRAMS         = YES
 425 MSCGEN_PATH            =
 426 HIDE_UNDOC_RELATIONS   = YES
 427 HAVE_DOT               = YES
 428 DOT_FONTNAME           = FreeSans
 429 DOT_FONTSIZE           = 10
 430 DOT_FONTPATH           =
 431 CLASS_GRAPH            = YES
 432 COLLABORATION_GRAPH    = NO
 433 GROUP_GRAPHS           = NO
 434 UML_LOOK               = NO
 435 TEMPLATE_RELATIONS     = NO
 436 INCLUDE_GRAPH          = NO
 437 INCLUDED_BY_GRAPH      = NO
 438 CALL_GRAPH             = NO
 439 CALLER_GRAPH           = NO
 440 GRAPHICAL_HIERARCHY    = NO
 441 DIRECTORY_GRAPH        = NO
 442 DOT_IMAGE_FORMAT       = png
 443 DOT_PATH               =
 444 DOTFILE_DIRS           =
 445 DOT_GRAPH_MAX_NODES    = 50
 446 MAX_DOT_GRAPH_DEPTH    = 1000
 447 DOT_TRANSPARENT        = NO
 448 DOT_MULTI_TARGETS      = NO
 449 GENERATE_LEGEND        = YES
 450 DOT_CLEANUP            = YES
 451
 452 #---------------------------------------------------------------------------
 453 # Search Engine Options
 454 #---------------------------------------------------------------------------
 455
 456 SEARCHENGINE           = NO
 457