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 related configuration 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           = NO
  21 ABBREVIATE_BRIEF       =
  22 ALWAYS_DETAILED_SEC    = YES
  23 INLINE_INHERITED_MEMB  = NO
  24 FULL_PATH_NAMES        = NO
  25 STRIP_FROM_PATH        =
  26 STRIP_FROM_INC_PATH    =
  27 SHORT_NAMES            = NO
  28 JAVADOC_AUTOBRIEF      = NO
  29 QT_AUTOBRIEF           = NO
  30 MULTILINE_CPP_IS_BRIEF = NO
  31 DETAILS_AT_TOP         = YES
  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 BUILTIN_STL_SUPPORT    = NO
  38 CPP_CLI_SUPPORT        = NO
  39 DISTRIBUTE_GROUP_DOC   = YES
  40 SUBGROUPING            = YES
  41
  42 #---------------------------------------------------------------------------
  43 # Aliases
  44 #---------------------------------------------------------------------------
  45
  46 # This is the most important part of the wxWidgets Doxyfile; aliases allow
  47 # us to keep the headers readable and "implement" wxWidgets-specific commands.
  48
  49 # event aliases
  50 ALIASES = beginEventTable{1}="\n<span class='events'>Events:</span><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><br>Event macros:<div>"
  51 ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
  52 ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
  53 ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
  54 ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
  55 ALIASES += endEventTable="</div>\n"
  56
  57 # style aliases
  58 ALIASES += beginStyleTable="\n<span class='styles'>Styles:</span><div>"
  59 ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
  60 ALIASES += endStyleTable="</div>\n"
  61
  62 # extra style aliases
  63 ALIASES += beginExtraStyleTable="\n<span class='styles'>Extra styles:</span><div>"
  64 ALIASES += endExtraStyleTable="</div>\n"
  65
  66 # flag aliases
  67 ALIASES += beginFlagTable="<div>"
  68 ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
  69 ALIASES += endFlagTable="</div>\n"
  70
  71 # aliases for additional wx-specific infos
  72 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>"
  73 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>"
  74 ALIASES += library{1}="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
  75 ALIASES += nolibrary="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
  76 ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
  77
  78 # native implementation infos:
  79 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>"
  80 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>"
  81 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>"
  82 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>"
  83
  84 # onlyfor infos:
  85 # NOTE: we need to be able to retrieve these infos also from the XML output, thus
  86 #       we use the \xmlonly and \endxmlonly commands to include custom XML tags
  87 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"
  88 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"
  89 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"
  90 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"
  91
  92 # creates appearance section: this should be used for all main GUI controls
  93 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"
  94
  95 # IMPORTANT: the \headerfile command does not work everywhere we'd need it,
  96 #            e.g. in the constants page we need to specify an header file
  97 #            even if they're not inside a \class, \function or \struct command:
  98 ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
  99
 100 # IMPORTANT: inside a \class, we want to specify the header file only once
 101 #            and not twice as the \headerfile command requires:
 102 ALIASES += wxheader{1}="\headerfile \1 wx/\1"
 103
 104 # the following alias avoids to repeat lots of times the same statement:
 105 ALIASES += wxsince{1}="\since This function is new since wxWidgets version \1."
 106
 107 # some formatting aliases
 108 ALIASES += true="<span class='literal'>true</span>"
 109 ALIASES += false="<span class='literal'>false</span>"
 110 ALIASES += NULL="<span class='literal'>NULL</span>"
 111
 112 # NOTE: these are important as you can't write in the docs
 113 #       just #ifdef since the # character is used by Doxygen
 114 #       for explicit linking; use the following aliases instead!
 115 #       However to avoid overwriting e.g. \if Doxygen command the _
 116 #       character is postfixed
 117 ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
 118 ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
 119 ALIASES += if_="<span class='literal'>\#if</span>"
 120 ALIASES += endif_="<span class='literal'>\#endif</span>"
 121
 122 # table aliases for 2 and 3 column tables
 123 ALIASES += beginTable="<center><table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
 124 ALIASES += beginInvisibleTable="<center><table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
 125 ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
 126 ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
 127 ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
 128 ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
 129 ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
 130 ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
 131 ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
 132 ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
 133 ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
 134 ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
 135 ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
 136 ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
 137 ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
 138 ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
 139 ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
 140 ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
 141 ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
 142 ALIASES += endTable="</table></center>"
 143
 144 # definition list aliases
 145 # a definition list currently is rendered as 2-column table but it may use as
 146 # well the <dl>, <dt> and <dd> HTML tags in future.
 147 # In any case a definition list differs from a table because of its semantic
 148 # nature and because it is always the association of a "title" with a "description"
 149 # (in contrast a table may have more than 2 columns of data)...
 150 ALIASES += beginDefList="<table class='doclist'>"
 151 ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
 152 ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
 153 ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
 154 ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
 155 ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
 156 ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
 157 ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
 158 ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
 159 ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
 160 ALIASES += endDefList="</table>"
 161
 162 # See ENABLED_SECTIONS configuration key for more info about these:
 163 ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL \n <b>wxPerl note</b>\n\n"
 164 ALIASES += endWxPerlOnly="\endif"
 165 ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL \n <b>wxPython note</b>\n\n"
 166 ALIASES += endWxPythonOnly="\endif"
 167
 168 # This is to get around a bug in Doxygen that prevents use of '{' or '}'
 169 # inside of any aliased command in parameters.
 170 ALIASES += leftCurly="{"
 171 ALIASES += rightCurly="}"
 172
 173
 174 #---------------------------------------------------------------------------
 175 # Build related configuration options
 176 #---------------------------------------------------------------------------
 177 EXTRACT_ALL            = YES
 178 EXTRACT_PRIVATE        = NO
 179 EXTRACT_STATIC         = YES
 180 EXTRACT_LOCAL_CLASSES  = YES
 181 EXTRACT_LOCAL_METHODS  = NO
 182 EXTRACT_ANON_NSPACES   = YES
 183 HIDE_UNDOC_MEMBERS     = NO
 184 HIDE_UNDOC_CLASSES     = NO
 185 HIDE_FRIEND_COMPOUNDS  = NO
 186 HIDE_IN_BODY_DOCS      = NO
 187 INTERNAL_DOCS          = NO
 188 CASE_SENSE_NAMES       = NO
 189 HIDE_SCOPE_NAMES       = NO
 190 SHOW_INCLUDE_FILES     = YES
 191 INLINE_INFO            = YES
 192 SORT_MEMBER_DOCS       = YES
 193 SORT_BRIEF_DOCS        = NO     # don't set it to YES! see http://bugzilla.gnome.org/show_bug.cgi?id=312655
 194 SORT_BY_SCOPE_NAME     = NO
 195 GENERATE_TODOLIST      = YES
 196 GENERATE_TESTLIST      = YES
 197 GENERATE_BUGLIST       = YES
 198 GENERATE_DEPRECATEDLIST= YES
 199
 200 # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
 201 ENABLED_SECTIONS       =
 202
 203 MAX_INITIALIZER_LINES  = 30
 204 SHOW_USED_FILES        = YES
 205 SHOW_DIRECTORIES       = YES
 206 FILE_VERSION_FILTER    =
 207
 208 #---------------------------------------------------------------------------
 209 # configuration options related to warning and progress messages
 210 #---------------------------------------------------------------------------
 211 QUIET                  = YES
 212 WARNINGS               = YES
 213 WARN_IF_UNDOCUMENTED   = YES
 214 WARN_IF_DOC_ERROR      = YES
 215 WARN_NO_PARAMDOC       = YES
 216 WARN_FORMAT            = "$file:$line: $text   "
 217 WARN_LOGFILE           = doxygen.log
 218
 219 #---------------------------------------------------------------------------
 220 # configuration options related to the input files
 221 #---------------------------------------------------------------------------
 222 INPUT                  = ./mainpages ./groups ./overviews ../../interface
 223 INPUT_ENCODING         = UTF-8
 224 FILE_PATTERNS          = *.h *.txt
 225 RECURSIVE              = YES
 226 EXCLUDE                =
 227 EXCLUDE_SYMLINKS       = NO
 228 EXCLUDE_PATTERNS       =
 229 EXCLUDE_SYMBOLS        =
 230 EXAMPLE_PATH           = ../
 231 EXAMPLE_PATTERNS       = *
 232 EXAMPLE_RECURSIVE      = NO
 233 IMAGE_PATH             = images
 234 INPUT_FILTER           =
 235 FILTER_PATTERNS        =
 236 FILTER_SOURCE_FILES    = NO
 237
 238 #---------------------------------------------------------------------------
 239 # configuration options related to source browsing
 240 #---------------------------------------------------------------------------
 241 SOURCE_BROWSER         = NO
 242 INLINE_SOURCES         = NO
 243 STRIP_CODE_COMMENTS    = YES
 244 REFERENCED_BY_RELATION = NO
 245 REFERENCES_RELATION    = NO
 246 REFERENCES_LINK_SOURCE = YES
 247 USE_HTAGS              = NO
 248 VERBATIM_HEADERS       = NO
 249
 250 #---------------------------------------------------------------------------
 251 # configuration options related to the alphabetical class index
 252 #---------------------------------------------------------------------------
 253 ALPHABETICAL_INDEX     = YES
 254 COLS_IN_ALPHA_INDEX    = 5
 255 IGNORE_PREFIX          = wx
 256
 257 #---------------------------------------------------------------------------
 258 # configuration options related to the HTML output
 259 #---------------------------------------------------------------------------
 260 GENERATE_HTML          = NO # Only change in format output configs
 261 HTML_OUTPUT            = html
 262 HTML_FILE_EXTENSION    = .html
 263 HTML_HEADER            = htmlheader.inc
 264 HTML_FOOTER            = htmlfooter.inc
 265 HTML_STYLESHEET        =
 266 HTML_ALIGN_MEMBERS     = YES
 267 GENERATE_HTMLHELP      = NO # Only change in format output configs
 268 HTML_DYNAMIC_SECTIONS  = YES
 269 CHM_FILE               = ..\wx.chm # NOTE: Windows style separator needed
 270 HHC_LOCATION           = hhc.exe # Don't modify, see Doxyfile_chm for info
 271 GENERATE_CHI           = NO
 272 BINARY_TOC             = NO
 273 TOC_EXPAND             = NO
 274 DISABLE_INDEX          = NO
 275 ENUM_VALUES_PER_LINE   = 4
 276 GENERATE_TREEVIEW      = NO
 277 TREEVIEW_WIDTH         = 250
 278
 279 #---------------------------------------------------------------------------
 280 # configuration options related to the LaTeX output
 281 #---------------------------------------------------------------------------
 282 GENERATE_LATEX         = NO # Only change in format output configs
 283 LATEX_OUTPUT           = latex
 284 LATEX_CMD_NAME         = latex
 285 MAKEINDEX_CMD_NAME     = makeindex
 286 COMPACT_LATEX          = NO
 287 PAPER_TYPE             = a4wide
 288 EXTRA_PACKAGES         =
 289 LATEX_HEADER           = latexdocstart.inc
 290 PDF_HYPERLINKS         = YES
 291 USE_PDFLATEX           = YES
 292 LATEX_BATCHMODE        = YES
 293 LATEX_HIDE_INDICES     = NO
 294
 295 #---------------------------------------------------------------------------
 296 # configuration options related to the RTF output
 297 #---------------------------------------------------------------------------
 298 GENERATE_RTF           = NO # Only change in format output configs
 299 RTF_OUTPUT             = rtf
 300 COMPACT_RTF            = NO
 301 RTF_HYPERLINKS         = NO
 302 RTF_STYLESHEET_FILE    =
 303 RTF_EXTENSIONS_FILE    =
 304
 305 #---------------------------------------------------------------------------
 306 # configuration options related to the man page output
 307 #---------------------------------------------------------------------------
 308 GENERATE_MAN           = NO # Only change in format output configs
 309 MAN_OUTPUT             = man
 310 MAN_EXTENSION          = .3
 311 MAN_LINKS              = NO
 312
 313 #---------------------------------------------------------------------------
 314 # configuration options related to the XML output
 315 #---------------------------------------------------------------------------
 316 GENERATE_XML           = NO # Only change in format output configs
 317 XML_OUTPUT             = xml
 318 XML_SCHEMA             =
 319 XML_DTD                =
 320 XML_PROGRAMLISTING     = YES
 321
 322 #---------------------------------------------------------------------------
 323 # configuration options for the AutoGen Definitions output
 324 #---------------------------------------------------------------------------
 325 GENERATE_AUTOGEN_DEF   = NO # Only change in format output configs
 326
 327 #---------------------------------------------------------------------------
 328 # configuration options related to the Perl module output
 329 #---------------------------------------------------------------------------
 330 GENERATE_PERLMOD       = NO # Only change in format output configs
 331 PERLMOD_LATEX          = YES
 332 PERLMOD_PRETTY         = YES
 333 PERLMOD_MAKEVAR_PREFIX =
 334
 335 #---------------------------------------------------------------------------
 336 # Configuration options related to the preprocessor
 337 #---------------------------------------------------------------------------
 338 ENABLE_PREPROCESSING   = YES
 339 MACRO_EXPANSION        = NO
 340 EXPAND_ONLY_PREDEF     = NO
 341 SEARCH_INCLUDES        = YES
 342 INCLUDE_PATH           =
 343 INCLUDE_FILE_PATTERNS  =
 344 PREDEFINED             =
 345 EXPAND_AS_DEFINED      =
 346 SKIP_FUNCTION_MACROS   = YES
 347
 348 #---------------------------------------------------------------------------
 349 # Configuration::additions related to external references
 350 #---------------------------------------------------------------------------
 351 TAGFILES               =
 352 GENERATE_TAGFILE       =
 353 ALLEXTERNALS           = NO
 354 EXTERNAL_GROUPS        = YES
 355 PERL_PATH              = /usr/bin/perl
 356
 357 #---------------------------------------------------------------------------
 358 # Configuration options related to the dot tool
 359 #---------------------------------------------------------------------------
 360 CLASS_DIAGRAMS         = YES
 361 MSCGEN_PATH            =
 362 HIDE_UNDOC_RELATIONS   = YES
 363 HAVE_DOT               = YES
 364 CLASS_GRAPH            = NO
 365 COLLABORATION_GRAPH    = NO
 366 GROUP_GRAPHS           = NO
 367 UML_LOOK               = NO
 368 TEMPLATE_RELATIONS     = NO
 369 INCLUDE_GRAPH          = NO
 370 INCLUDED_BY_GRAPH      = NO
 371 CALL_GRAPH             = NO
 372 CALLER_GRAPH           = NO
 373 GRAPHICAL_HIERARCHY    = NO
 374 DIRECTORY_GRAPH        = NO
 375 DOT_IMAGE_FORMAT       = png
 376 DOT_PATH               =
 377 DOTFILE_DIRS           =
 378 DOT_GRAPH_MAX_NODES    = 50
 379 MAX_DOT_GRAPH_DEPTH    = 1000
 380 DOT_TRANSPARENT        = NO
 381 DOT_MULTI_TARGETS      = NO
 382 GENERATE_LEGEND        = YES
 383 DOT_CLEANUP            = YES
 384
 385 #---------------------------------------------------------------------------
 386 # Configuration::additions related to the search engine
 387 #---------------------------------------------------------------------------
 388 SEARCHENGINE           = NO
 389