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 # 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' border='1' cellspacing='0' cellpadding='3'>"
  99 ALIASES += beginInvisibleTable="<center><table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
 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 # This is to get around a bug in Doxygen that prevents use of '{' or '}'
 153 # inside of any aliased command in parameters.
 154 ALIASES += leftCurly="{"
 155 ALIASES += rightCurly="}"
 156
 157
 158 #---------------------------------------------------------------------------
 159 # Build related configuration options
 160 #---------------------------------------------------------------------------
 161 EXTRACT_ALL            = YES
 162 EXTRACT_PRIVATE        = NO
 163 EXTRACT_STATIC         = YES
 164 EXTRACT_LOCAL_CLASSES  = YES
 165 EXTRACT_LOCAL_METHODS  = NO
 166 EXTRACT_ANON_NSPACES   = YES
 167 HIDE_UNDOC_MEMBERS     = YES
 168 HIDE_UNDOC_CLASSES     = YES
 169 HIDE_FRIEND_COMPOUNDS  = NO
 170 HIDE_IN_BODY_DOCS      = NO
 171 INTERNAL_DOCS          = NO
 172 CASE_SENSE_NAMES       = NO
 173 HIDE_SCOPE_NAMES       = NO
 174 SHOW_INCLUDE_FILES     = YES
 175 INLINE_INFO            = YES
 176 SORT_MEMBER_DOCS       = YES
 177 SORT_BRIEF_DOCS        = YES
 178 SORT_BY_SCOPE_NAME     = NO
 179 GENERATE_TODOLIST      = YES
 180 GENERATE_TESTLIST      = YES
 181 GENERATE_BUGLIST       = YES
 182 GENERATE_DEPRECATEDLIST= YES
 183
 184 # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
 185 ENABLED_SECTIONS       =
 186
 187 MAX_INITIALIZER_LINES  = 30
 188 SHOW_USED_FILES        = YES
 189 SHOW_DIRECTORIES       = NO
 190 FILE_VERSION_FILTER    =
 191
 192 #---------------------------------------------------------------------------
 193 # configuration options related to warning and progress messages
 194 #---------------------------------------------------------------------------
 195 QUIET                  = NO
 196 WARNINGS               = YES
 197 WARN_IF_UNDOCUMENTED   = NO
 198 WARN_IF_DOC_ERROR      = YES
 199 WARN_NO_PARAMDOC       = NO
 200 WARN_FORMAT            = "$file:$line: $text   "
 201 WARN_LOGFILE           = doxygen.log
 202
 203 #---------------------------------------------------------------------------
 204 # configuration options related to the input files
 205 #---------------------------------------------------------------------------
 206 INPUT                  = ./mainpages ./overviews # ../../interface
 207 INPUT_ENCODING         = UTF-8
 208 FILE_PATTERNS          = *.h *.txt
 209 RECURSIVE              = YES
 210 EXCLUDE                =
 211 EXCLUDE_SYMLINKS       = NO
 212 EXCLUDE_PATTERNS       =
 213 EXCLUDE_SYMBOLS        =
 214 EXAMPLE_PATH           =
 215 EXAMPLE_PATTERNS       = *
 216 EXAMPLE_RECURSIVE      = YES
 217 IMAGE_PATH             = images
 218 INPUT_FILTER           =
 219 FILTER_PATTERNS        =
 220 FILTER_SOURCE_FILES    = NO
 221
 222 #---------------------------------------------------------------------------
 223 # configuration options related to source browsing
 224 #---------------------------------------------------------------------------
 225 SOURCE_BROWSER         = NO
 226 INLINE_SOURCES         = NO
 227 STRIP_CODE_COMMENTS    = YES
 228 REFERENCED_BY_RELATION = NO
 229 REFERENCES_RELATION    = NO
 230 REFERENCES_LINK_SOURCE = YES
 231 USE_HTAGS              = NO
 232 VERBATIM_HEADERS       = NO
 233
 234 #---------------------------------------------------------------------------
 235 # configuration options related to the alphabetical class index
 236 #---------------------------------------------------------------------------
 237 ALPHABETICAL_INDEX     = YES
 238 COLS_IN_ALPHA_INDEX    = 5
 239 IGNORE_PREFIX          = wx
 240
 241 #---------------------------------------------------------------------------
 242 # configuration options related to the HTML output
 243 #---------------------------------------------------------------------------
 244 HTML_OUTPUT            = html
 245 HTML_FILE_EXTENSION    = .html
 246 HTML_HEADER            = htmlheader.inc
 247 HTML_FOOTER            = htmlfooter.inc
 248 HTML_STYLESHEET        =
 249 HTML_ALIGN_MEMBERS     = YES
 250 HTML_DYNAMIC_SECTIONS  = NO
 251 CHM_FILE               = wx.chm
 252 GENERATE_CHI           = NO
 253 BINARY_TOC             = NO
 254 TOC_EXPAND             = NO
 255 DISABLE_INDEX          = NO
 256 ENUM_VALUES_PER_LINE   = 4
 257 GENERATE_TREEVIEW      = NO
 258 TREEVIEW_WIDTH         = 250
 259
 260 #---------------------------------------------------------------------------
 261 # configuration options related to the LaTeX output
 262 #---------------------------------------------------------------------------
 263 LATEX_OUTPUT           = latex
 264 LATEX_CMD_NAME         = latex
 265 MAKEINDEX_CMD_NAME     = makeindex
 266 COMPACT_LATEX          = NO
 267 PAPER_TYPE             = a4wide
 268 EXTRA_PACKAGES         =
 269 LATEX_HEADER           =
 270 PDF_HYPERLINKS         = NO
 271 USE_PDFLATEX           = NO
 272 LATEX_BATCHMODE        = NO
 273 LATEX_HIDE_INDICES     = NO
 274
 275 #---------------------------------------------------------------------------
 276 # configuration options related to the RTF output
 277 #---------------------------------------------------------------------------
 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 MAN_OUTPUT             = man
 288 MAN_EXTENSION          = .3
 289 MAN_LINKS              = NO
 290
 291 #---------------------------------------------------------------------------
 292 # configuration options related to the XML output
 293 #---------------------------------------------------------------------------
 294 XML_OUTPUT             = xml
 295 XML_SCHEMA             =
 296 XML_DTD                =
 297 XML_PROGRAMLISTING     = YES
 298
 299 #---------------------------------------------------------------------------
 300 # configuration options for the AutoGen Definitions output
 301 #---------------------------------------------------------------------------
 302
 303
 304 #---------------------------------------------------------------------------
 305 # configuration options related to the Perl module output
 306 #---------------------------------------------------------------------------
 307 GENERATE_PERLMOD       = NO
 308 PERLMOD_LATEX          = YES
 309 PERLMOD_PRETTY         = YES
 310 PERLMOD_MAKEVAR_PREFIX =
 311
 312 #---------------------------------------------------------------------------
 313 # Configuration options related to the preprocessor
 314 #---------------------------------------------------------------------------
 315 ENABLE_PREPROCESSING   = YES
 316 MACRO_EXPANSION        = NO
 317 EXPAND_ONLY_PREDEF     = NO
 318 SEARCH_INCLUDES        = YES
 319 INCLUDE_PATH           =
 320 INCLUDE_FILE_PATTERNS  =
 321 PREDEFINED             =
 322 EXPAND_AS_DEFINED      =
 323 SKIP_FUNCTION_MACROS   = YES
 324
 325 #---------------------------------------------------------------------------
 326 # Configuration::additions related to external references
 327 #---------------------------------------------------------------------------
 328 TAGFILES               =
 329 ALLEXTERNALS           = NO
 330 EXTERNAL_GROUPS        = YES
 331 PERL_PATH              = /usr/bin/perl
 332
 333 #---------------------------------------------------------------------------
 334 # Configuration options related to the dot tool
 335 #---------------------------------------------------------------------------
 336 CLASS_DIAGRAMS         = YES
 337 MSCGEN_PATH            =
 338 HIDE_UNDOC_RELATIONS   = YES
 339 HAVE_DOT               = YES
 340 CLASS_GRAPH            = NO
 341 COLLABORATION_GRAPH    = NO
 342 GROUP_GRAPHS           = NO
 343 UML_LOOK               = NO
 344 TEMPLATE_RELATIONS     = NO
 345 INCLUDE_GRAPH          = NO
 346 INCLUDED_BY_GRAPH      = NO
 347 CALL_GRAPH             = NO
 348 CALLER_GRAPH           = NO
 349 GRAPHICAL_HIERARCHY    = NO
 350 DIRECTORY_GRAPH        = NO
 351 DOT_IMAGE_FORMAT       = png
 352 DOT_PATH               =
 353 DOTFILE_DIRS           =
 354 DOT_GRAPH_MAX_NODES    = 50
 355 MAX_DOT_GRAPH_DEPTH    = 1000
 356 DOT_TRANSPARENT        = NO
 357 DOT_MULTI_TARGETS      = NO
 358 GENERATE_LEGEND        = YES
 359 DOT_CLEANUP            = YES
 360
 361 #---------------------------------------------------------------------------
 362 # Configuration::additions related to the search engine
 363 #---------------------------------------------------------------------------
 364 SEARCHENGINE           = NO