docs/doxygen/Doxyfile

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