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