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