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