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