docs/doxygen/Doxyfile

   1 #############################################################################
   2 ## Name:        Doxyfile
   3 ## Purpose:     Doxygen configuration file for wxWidgets manual
   4 ## Author:      wxWidgets team
   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 events Events\n"
  51 ALIASES += event{1}="\li \b \1"
  52 ALIASES += event{2}="\li \b \1, \2"
  53 ALIASES += endEventTable="\n"
  54
  55 # style aliases
  56 ALIASES += beginStyleTable="\section styles Styles\n"
  57 ALIASES += style{1}="\li \b \1"
  58 ALIASES += endStyleTable="\n"
  59
  60 # extra style aliases
  61 ALIASES += beginExtraStyleTable="\section extrastyles Extra Styles\n"
  62 ALIASES += endExtraStyleTable="\n"
  63
  64 # misc aliases
  65 ALIASES += library{1}="\section lib Library\n \b \1"
  66 ALIASES += seealso="\section sa See also\n"    # the default \sa command does not generate a \section!
  67 ALIASES += stdobjects="\section stdobj Predefined objects\n \b"
  68
  69 # some formatting aliases
  70 ALIASES += true="\b true"
  71 ALIASES += false="\b false"
  72 ALIASES += NULL="\b NULL"
  73
  74 # these are useful for creation of tables
  75 ALIASES += row{2}=""
  76
  77 # NOTE: we could put aliases also for e.g. @wxDefaultSize, @wxDefaultPosition, @wxID_ANY, etc
  78
  79 # NOTE: these are important as you can't write in the docs
  80 #       just #ifdef since the # character is used by Doxygen
  81 #       for explicit linking; use the following aliases instead!
  82 ALIASES += ifdef="\b \c \#ifdef"
  83 ALIASES += ifndef="\b \c \#ifndef"
  84 ALIASES += if="\b \c \#if"          # NOTE: this overrides the Doxygen \if command
  85 ALIASES += endif="\b \c \#endif"
  86
  87
  88 #---------------------------------------------------------------------------
  89 # Build related configuration options
  90 #---------------------------------------------------------------------------
  91 EXTRACT_ALL            = YES
  92 EXTRACT_PRIVATE        = NO
  93 EXTRACT_STATIC         = YES
  94 EXTRACT_LOCAL_CLASSES  = YES
  95 EXTRACT_LOCAL_METHODS  = NO
  96 EXTRACT_ANON_NSPACES   = YES
  97 HIDE_UNDOC_MEMBERS     = YES
  98 HIDE_UNDOC_CLASSES     = YES
  99 HIDE_FRIEND_COMPOUNDS  = NO
 100 HIDE_IN_BODY_DOCS      = NO
 101 INTERNAL_DOCS          = NO
 102 CASE_SENSE_NAMES       = NO
 103 HIDE_SCOPE_NAMES       = NO
 104 SHOW_INCLUDE_FILES     = YES
 105 INLINE_INFO            = YES
 106 SORT_MEMBER_DOCS       = YES
 107 SORT_BRIEF_DOCS        = YES
 108 SORT_BY_SCOPE_NAME     = NO
 109 GENERATE_TODOLIST      = YES
 110 GENERATE_TESTLIST      = YES
 111 GENERATE_BUGLIST       = YES
 112 GENERATE_DEPRECATEDLIST= YES
 113 ENABLED_SECTIONS       =
 114 MAX_INITIALIZER_LINES  = 30
 115 SHOW_USED_FILES        = YES
 116 SHOW_DIRECTORIES       = NO
 117 FILE_VERSION_FILTER    =
 118
 119 #---------------------------------------------------------------------------
 120 # configuration options related to warning and progress messages
 121 #---------------------------------------------------------------------------
 122 QUIET                  = NO
 123 WARNINGS               = YES
 124 WARN_IF_UNDOCUMENTED   = NO
 125 WARN_IF_DOC_ERROR      = YES
 126 WARN_NO_PARAMDOC       = NO
 127 WARN_FORMAT            = "$file:$line: $text   "
 128 WARN_LOGFILE           = doxygen.log
 129
 130 #---------------------------------------------------------------------------
 131 # configuration options related to the input files
 132 #---------------------------------------------------------------------------
 133 INPUT                  = . ./overviews ../../interface
 134 INPUT_ENCODING         = UTF-8
 135 FILE_PATTERNS          = *.h *.txt
 136 RECURSIVE              = YES
 137 EXCLUDE                =
 138 EXCLUDE_SYMLINKS       = NO
 139 EXCLUDE_PATTERNS       =
 140 EXCLUDE_SYMBOLS        =
 141 EXAMPLE_PATH           =
 142 EXAMPLE_PATTERNS       = *
 143 EXAMPLE_RECURSIVE      = YES
 144 IMAGE_PATH             = images
 145 INPUT_FILTER           =
 146 FILTER_PATTERNS        =
 147 FILTER_SOURCE_FILES    = NO
 148
 149 #---------------------------------------------------------------------------
 150 # configuration options related to source browsing
 151 #---------------------------------------------------------------------------
 152 SOURCE_BROWSER         = NO
 153 INLINE_SOURCES         = NO
 154 STRIP_CODE_COMMENTS    = YES
 155 REFERENCED_BY_RELATION = NO
 156 REFERENCES_RELATION    = NO
 157 REFERENCES_LINK_SOURCE = YES
 158 USE_HTAGS              = NO
 159 VERBATIM_HEADERS       = NO
 160
 161 #---------------------------------------------------------------------------
 162 # configuration options related to the alphabetical class index
 163 #---------------------------------------------------------------------------
 164 ALPHABETICAL_INDEX     = YES
 165 COLS_IN_ALPHA_INDEX    = 5
 166 IGNORE_PREFIX          = wx
 167
 168 #---------------------------------------------------------------------------
 169 # configuration options related to the HTML output
 170 #---------------------------------------------------------------------------
 171 GENERATE_HTML          = YES
 172 HTML_OUTPUT            = html
 173 HTML_FILE_EXTENSION    = .html
 174 HTML_HEADER            = htmlheader.inc
 175 HTML_FOOTER            = htmlfooter.inc
 176 HTML_STYLESHEET        =
 177 HTML_ALIGN_MEMBERS     = YES
 178 GENERATE_HTMLHELP      = NO
 179 HTML_DYNAMIC_SECTIONS  = NO
 180 CHM_FILE               =
 181 HHC_LOCATION           =
 182 GENERATE_CHI           = NO
 183 BINARY_TOC             = NO
 184 TOC_EXPAND             = NO
 185 DISABLE_INDEX          = NO
 186 ENUM_VALUES_PER_LINE   = 4
 187 GENERATE_TREEVIEW      = NO
 188 TREEVIEW_WIDTH         = 250
 189
 190 #---------------------------------------------------------------------------
 191 # configuration options related to the LaTeX output
 192 #---------------------------------------------------------------------------
 193 GENERATE_LATEX         = NO
 194 LATEX_OUTPUT           = latex
 195 LATEX_CMD_NAME         = latex
 196 MAKEINDEX_CMD_NAME     = makeindex
 197 COMPACT_LATEX          = NO
 198 PAPER_TYPE             = a4wide
 199 EXTRA_PACKAGES         =
 200 LATEX_HEADER           =
 201 PDF_HYPERLINKS         = NO
 202 USE_PDFLATEX           = NO
 203 LATEX_BATCHMODE        = NO
 204 LATEX_HIDE_INDICES     = NO
 205
 206 #---------------------------------------------------------------------------
 207 # configuration options related to the RTF output
 208 #---------------------------------------------------------------------------
 209 GENERATE_RTF           = NO
 210 RTF_OUTPUT             = rtf
 211 COMPACT_RTF            = NO
 212 RTF_HYPERLINKS         = NO
 213 RTF_STYLESHEET_FILE    =
 214 RTF_EXTENSIONS_FILE    =
 215
 216 #---------------------------------------------------------------------------
 217 # configuration options related to the man page output
 218 #---------------------------------------------------------------------------
 219 GENERATE_MAN           = NO
 220 MAN_OUTPUT             = man
 221 MAN_EXTENSION          = .3
 222 MAN_LINKS              = NO
 223
 224 #---------------------------------------------------------------------------
 225 # configuration options related to the XML output
 226 #---------------------------------------------------------------------------
 227 GENERATE_XML           = NO
 228 XML_OUTPUT             = xml
 229 XML_SCHEMA             =
 230 XML_DTD                =
 231 XML_PROGRAMLISTING     = YES
 232
 233 #---------------------------------------------------------------------------
 234 # configuration options for the AutoGen Definitions output
 235 #---------------------------------------------------------------------------
 236 GENERATE_AUTOGEN_DEF   = NO
 237
 238 #---------------------------------------------------------------------------
 239 # configuration options related to the Perl module output
 240 #---------------------------------------------------------------------------
 241 GENERATE_PERLMOD       = NO
 242 PERLMOD_LATEX          = NO
 243 PERLMOD_PRETTY         = YES
 244 PERLMOD_MAKEVAR_PREFIX =
 245
 246 #---------------------------------------------------------------------------
 247 # Configuration options related to the preprocessor
 248 #---------------------------------------------------------------------------
 249 ENABLE_PREPROCESSING   = YES
 250 MACRO_EXPANSION        = NO
 251 EXPAND_ONLY_PREDEF     = NO
 252 SEARCH_INCLUDES        = YES
 253 INCLUDE_PATH           =
 254 INCLUDE_FILE_PATTERNS  =
 255 PREDEFINED             =
 256 EXPAND_AS_DEFINED      =
 257 SKIP_FUNCTION_MACROS   = YES
 258
 259 #---------------------------------------------------------------------------
 260 # Configuration::additions related to external references
 261 #---------------------------------------------------------------------------
 262 TAGFILES               =
 263 GENERATE_TAGFILE       =
 264 ALLEXTERNALS           = NO
 265 EXTERNAL_GROUPS        = YES
 266 PERL_PATH              = /usr/bin/perl
 267
 268 #---------------------------------------------------------------------------
 269 # Configuration options related to the dot tool
 270 #---------------------------------------------------------------------------
 271 CLASS_DIAGRAMS         = YES
 272 MSCGEN_PATH            =
 273 HIDE_UNDOC_RELATIONS   = YES
 274 HAVE_DOT               = YES
 275 CLASS_GRAPH            = NO
 276 COLLABORATION_GRAPH    = NO
 277 GROUP_GRAPHS           = NO
 278 UML_LOOK               = NO
 279 TEMPLATE_RELATIONS     = NO
 280 INCLUDE_GRAPH          = NO
 281 INCLUDED_BY_GRAPH      = NO
 282 CALL_GRAPH             = NO
 283 CALLER_GRAPH           = NO
 284 GRAPHICAL_HIERARCHY    = NO
 285 DIRECTORY_GRAPH        = NO
 286 DOT_IMAGE_FORMAT       = png
 287 DOT_PATH               =
 288 DOTFILE_DIRS           =
 289 DOT_GRAPH_MAX_NODES    = 50
 290 MAX_DOT_GRAPH_DEPTH    = 1000
 291 DOT_TRANSPARENT        = NO
 292 DOT_MULTI_TARGETS      = NO
 293 GENERATE_LEGEND        = YES
 294 DOT_CLEANUP            = YES
 295
 296 #---------------------------------------------------------------------------
 297 # Configuration::additions related to the search engine
 298 #---------------------------------------------------------------------------
 299 SEARCHENGINE           = YES