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