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