1 #############################################################################
3 ## Purpose: Doxygen configuration file for wxWidgets manual
4 ## Author: wxWidgets team
6 ## Licence: wxWindows license
7 #############################################################################
9 #---------------------------------------------------------------------------
10 # Project related configuration options
11 #---------------------------------------------------------------------------
13 DOXYFILE_ENCODING = UTF-8
14 PROJECT_NAME = wxWidgets
15 PROJECT_NUMBER = 2.9.0
16 OUTPUT_DIRECTORY = out
18 OUTPUT_LANGUAGE = English
19 BRIEF_MEMBER_DESC = YES
22 ALWAYS_DETAILED_SEC = YES
23 INLINE_INHERITED_MEMB = NO
28 JAVADOC_AUTOBRIEF = NO
30 MULTILINE_CPP_IS_BRIEF = NO
33 SEPARATE_MEMBER_PAGES = NO
35 OPTIMIZE_OUTPUT_FOR_C = NO
36 OPTIMIZE_OUTPUT_JAVA = NO
37 BUILTIN_STL_SUPPORT = NO
39 DISTRIBUTE_GROUP_DOC = NO
42 #---------------------------------------------------------------------------
44 #---------------------------------------------------------------------------
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.
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"
56 ALIASES += beginStyleTable="\section class_styles Styles\n"
57 ALIASES += style{1}="\li \b \c \1"
58 ALIASES += endStyleTable="\n"
61 ALIASES += beginExtraStyleTable="\section class_extrastyles Extra Styles\n"
62 ALIASES += endExtraStyleTable="\n"
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"
69 # IMPORTANT: the default \sa command does not generate a \section!
70 ALIASES += seealso="\section class_sa See also\n"
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"
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>"
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>"
93 # NOTE: we could put aliases also for e.g. @wxDefaultSize, @wxDefaultPosition, @wxID_ANY,
94 # @wxEmptyString, @wxNullIcon, etc etc
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>"
105 #---------------------------------------------------------------------------
106 # Build related configuration options
107 #---------------------------------------------------------------------------
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
119 CASE_SENSE_NAMES = NO
120 HIDE_SCOPE_NAMES = NO
121 SHOW_INCLUDE_FILES = 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
131 MAX_INITIALIZER_LINES = 30
132 SHOW_USED_FILES = YES
133 SHOW_DIRECTORIES = NO
134 FILE_VERSION_FILTER =
136 #---------------------------------------------------------------------------
137 # configuration options related to warning and progress messages
138 #---------------------------------------------------------------------------
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
147 #---------------------------------------------------------------------------
148 # configuration options related to the input files
149 #---------------------------------------------------------------------------
150 INPUT = . ./overviews ../../interface
151 INPUT_ENCODING = UTF-8
152 FILE_PATTERNS = *.h *.txt
155 EXCLUDE_SYMLINKS = NO
160 EXAMPLE_RECURSIVE = YES
164 FILTER_SOURCE_FILES = NO
166 #---------------------------------------------------------------------------
167 # configuration options related to source browsing
168 #---------------------------------------------------------------------------
171 STRIP_CODE_COMMENTS = YES
172 REFERENCED_BY_RELATION = NO
173 REFERENCES_RELATION = NO
174 REFERENCES_LINK_SOURCE = YES
176 VERBATIM_HEADERS = NO
178 #---------------------------------------------------------------------------
179 # configuration options related to the alphabetical class index
180 #---------------------------------------------------------------------------
181 ALPHABETICAL_INDEX = YES
182 COLS_IN_ALPHA_INDEX = 5
185 #---------------------------------------------------------------------------
186 # configuration options related to the HTML output
187 #---------------------------------------------------------------------------
190 HTML_FILE_EXTENSION = .html
191 HTML_HEADER = htmlheader.inc
192 HTML_FOOTER = htmlfooter.inc
194 HTML_ALIGN_MEMBERS = YES
195 GENERATE_HTMLHELP = NO
196 HTML_DYNAMIC_SECTIONS = NO
203 ENUM_VALUES_PER_LINE = 4
204 GENERATE_TREEVIEW = NO
207 #---------------------------------------------------------------------------
208 # configuration options related to the LaTeX output
209 #---------------------------------------------------------------------------
212 LATEX_CMD_NAME = latex
213 MAKEINDEX_CMD_NAME = makeindex
221 LATEX_HIDE_INDICES = NO
223 #---------------------------------------------------------------------------
224 # configuration options related to the RTF output
225 #---------------------------------------------------------------------------
230 RTF_STYLESHEET_FILE =
231 RTF_EXTENSIONS_FILE =
233 #---------------------------------------------------------------------------
234 # configuration options related to the man page output
235 #---------------------------------------------------------------------------
241 #---------------------------------------------------------------------------
242 # configuration options related to the XML output
243 #---------------------------------------------------------------------------
248 XML_PROGRAMLISTING = YES
250 #---------------------------------------------------------------------------
251 # configuration options for the AutoGen Definitions output
252 #---------------------------------------------------------------------------
253 GENERATE_AUTOGEN_DEF = NO
255 #---------------------------------------------------------------------------
256 # configuration options related to the Perl module output
257 #---------------------------------------------------------------------------
258 GENERATE_PERLMOD = NO
261 PERLMOD_MAKEVAR_PREFIX =
263 #---------------------------------------------------------------------------
264 # Configuration options related to the preprocessor
265 #---------------------------------------------------------------------------
266 ENABLE_PREPROCESSING = YES
268 EXPAND_ONLY_PREDEF = NO
269 SEARCH_INCLUDES = YES
271 INCLUDE_FILE_PATTERNS =
274 SKIP_FUNCTION_MACROS = YES
276 #---------------------------------------------------------------------------
277 # Configuration::additions related to external references
278 #---------------------------------------------------------------------------
282 EXTERNAL_GROUPS = YES
283 PERL_PATH = /usr/bin/perl
285 #---------------------------------------------------------------------------
286 # Configuration options related to the dot tool
287 #---------------------------------------------------------------------------
290 HIDE_UNDOC_RELATIONS = YES
293 COLLABORATION_GRAPH = NO
296 TEMPLATE_RELATIONS = NO
298 INCLUDED_BY_GRAPH = NO
301 GRAPHICAL_HIERARCHY = NO
303 DOT_IMAGE_FORMAT = png
306 DOT_GRAPH_MAX_NODES = 50
307 MAX_DOT_GRAPH_DEPTH = 1000
309 DOT_MULTI_TARGETS = NO
310 GENERATE_LEGEND = YES
313 #---------------------------------------------------------------------------
314 # Configuration::additions related to the search engine
315 #---------------------------------------------------------------------------