1 #############################################################################
3 ## Purpose: Main configuration file for the wxWidgets manual
4 ## Author: Francesco Montorsi
6 ## Licence: wxWindows license
7 #############################################################################
9 #---------------------------------------------------------------------------
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
25 STRIP_FROM_PATH = "$(WXWIDGETS)/"
26 STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \
27 "$(WXWIDGETS)/interface/"
29 JAVADOC_AUTOBRIEF = NO
31 MULTILINE_CPP_IS_BRIEF = NO
34 SEPARATE_MEMBER_PAGES = NO
36 OPTIMIZE_OUTPUT_FOR_C = NO
37 OPTIMIZE_OUTPUT_JAVA = NO
38 BUILTIN_STL_SUPPORT = NO
40 DISTRIBUTE_GROUP_DOC = YES
43 #---------------------------------------------------------------------------
45 #---------------------------------------------------------------------------
47 # This is the most important part of the wxWidgets Doxyfile; aliases allow
48 # us to keep the headers readable and "implement" wxWidgets-specific commands.
51 ALIASES = beginEventTable{1}="\n<span class='events'>Events:</span><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void handlerFuncName(\1& event)</span></div></p><br>Event macros:<div>"
52 ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
53 ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
54 ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
55 ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
56 ALIASES += endEventTable="</div>\n"
59 ALIASES += beginStyleTable="\n<span class='styles'>Styles:</span><div>"
60 ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
61 ALIASES += endStyleTable="</div>\n"
64 ALIASES += beginExtraStyleTable="\n<span class='styles'>Extra styles:</span><div>"
65 ALIASES += endExtraStyleTable="</div>\n"
68 ALIASES += beginFlagTable="<div>"
69 ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
70 ALIASES += endFlagTable="</div>\n"
72 # aliases for additional wx-specific infos
73 ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span> <span class='category_text'>\ref group_class_\1</span></div>"
74 ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n<div><span class='category'>Category:</span> <span class='category_text'>\ref group_class_\1, \ref group_class_\2</span></div>"
75 ALIASES += library{1}="<div><span class='lib'>Library:</span> <span class='lib_text'>\ref page_libs_\1</span></div>"
76 ALIASES += nolibrary="<div><span class='lib'>Library:</span> <span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
77 ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
79 # native implementation infos:
80 ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
81 ALIASES += nativeimpl{2}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1, \ref page_port_\2 ports; a generic implementation is used elsewhere.</div>"
82 ALIASES += nativeimpl{3}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; a generic implementation is used elsewhere.</div>"
83 ALIASES += nativeimpl{4}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports; a generic implementation is used elsewhere.</div>"
86 # NOTE: we need to be able to retrieve these infos also from the XML output, thus
87 # we use the \xmlonly and \endxmlonly commands to include custom XML tags
88 ALIASES += onlyfor{1}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1 port.</div> \xmlonly <onlyfor>\1</onlyfor> \endxmlonly"
89 ALIASES += onlyfor{2}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1, \ref page_port_\2 ports.</div> \xmlonly <onlyfor>\1,\2</onlyfor> \endxmlonly"
90 ALIASES += onlyfor{3}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports.</div> \xmlonly <onlyfor>\1,\2,\3</onlyfor> \endxmlonly"
91 ALIASES += onlyfor{4}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports.</div> \xmlonly <onlyfor>\1,\2,\3,\4</onlyfor> \endxmlonly"
93 # creates appearance section: this should be used for all main GUI controls
94 ALIASES += appearance{1}="\htmlonly <br><div><span class='appearance'>Appearance:</span><br><table class='appearance'><tr><td><img src='wxmsw/\1' alt='wxMSW appearance' class='appearance'></td><td><img src='wxgtk/\1' alt='wxGTK appearance' class='appearance'></td><td><img src='wxmac/\1' alt='wxMac appearance' class='appearance'></td></tr><tr><td>wxMSW appearance</td><td>wxGTK appearance</td><td>wxMac appearance</td></tr></table></div> \endhtmlonly"
96 # IMPORTANT: the \headerfile command does not work everywhere we'd need it,
97 # e.g. in the constants page we need to specify an header file
98 # even if they're not inside a \class, \function or \struct command:
99 ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
101 # IMPORTANT: inside a \class, we want to specify the header file only once
102 # and not twice as the \headerfile command requires:
103 ALIASES += wxheader{1}="\headerfile \1 wx/\1"
105 # some formatting aliases
106 ALIASES += true="<span class='literal'>true</span>"
107 ALIASES += false="<span class='literal'>false</span>"
108 ALIASES += NULL="<span class='literal'>NULL</span>"
110 # NOTE: these are important as you can't write in the docs
111 # just #ifdef since the # character is used by Doxygen
112 # for explicit linking; use the following aliases instead!
113 # However to avoid overwriting e.g. \if Doxygen command the _
114 # character is postfixed
115 ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
116 ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
117 ALIASES += if_="<span class='literal'>\#if</span>"
118 ALIASES += endif_="<span class='literal'>\#endif</span>"
120 # table aliases for 2 and 3 column tables
121 ALIASES += beginTable="<center><table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
122 ALIASES += beginInvisibleTable="<center><table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
123 ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
124 ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
125 ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
126 ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
127 ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
128 ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
129 ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
130 ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
131 ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
132 ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
133 ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
134 ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
135 ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
136 ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
137 ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
138 ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
139 ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
140 ALIASES += endTable="</table></center>"
142 # definition list aliases
143 # a definition list currently is rendered as 2-column table but it may use as
144 # well the <dl>, <dt> and <dd> HTML tags in future.
145 # In any case a definition list differs from a table because of its semantic
146 # nature and because it is always the association of a "title" with a "description"
147 # (in contrast a table may have more than 2 columns of data)...
148 ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
149 ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
150 ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
151 ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
152 ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
153 ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
154 ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
155 ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
156 ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
157 ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
158 ALIASES += endDefList="</table>"
160 # See ENABLED_SECTIONS configuration key for more info about these:
161 ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
162 ALIASES += endWxPerlOnly="\endif"
163 ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> "
164 ALIASES += endWxPythonOnly="\endif"
166 # This is to get around a bug in Doxygen that prevents use of '{' or '}'
167 # inside of any aliased command in parameters.
168 ALIASES += leftCurly="{"
169 ALIASES += rightCurly="}"
171 # Sample documentation related aliases
172 # For indicating the a directory containing a sample
173 ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim"
174 # For refering to the corresponding sample in a class document or a overview
175 # Usually placed in the queue of @see
176 ALIASES += sample{1}="\ref page_samples_\1"
177 # For generating a general description for a sample
178 # \1 could be a class or an overview or a descriptive sentence
179 # Shall be replaced by manual written description soon
180 ALIASES += sampleabout{1}="This sample demonstrates \1."
181 # For indicating the necessary condition of a sample or a class
182 # \1 is the wxUSE_XXX macro
183 ALIASES += buildwith{1}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info."
184 ALIASES += buildwith{2}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> and <tt>\2</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info."
186 #---------------------------------------------------------------------------
188 #---------------------------------------------------------------------------
193 EXTRACT_LOCAL_CLASSES = YES
194 EXTRACT_LOCAL_METHODS = NO
195 EXTRACT_ANON_NSPACES = YES
196 HIDE_UNDOC_MEMBERS = NO
197 HIDE_UNDOC_CLASSES = NO
198 HIDE_FRIEND_COMPOUNDS = NO
199 HIDE_IN_BODY_DOCS = NO
201 CASE_SENSE_NAMES = NO
202 HIDE_SCOPE_NAMES = NO
203 SHOW_INCLUDE_FILES = YES
205 SORT_MEMBER_DOCS = YES
206 SORT_BRIEF_DOCS = NO # don't set it to YES! see http://bugzilla.gnome.org/show_bug.cgi?id=312655
207 SORT_BY_SCOPE_NAME = NO
208 GENERATE_TODOLIST = YES
209 GENERATE_TESTLIST = YES
210 GENERATE_BUGLIST = YES
211 GENERATE_DEPRECATEDLIST= YES
213 # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
214 ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL
216 MAX_INITIALIZER_LINES = 30
218 SHOW_DIRECTORIES = YES
219 SHOW_FILES = YES # Doxygen 1.5.6+
220 FILE_VERSION_FILTER =
222 #---------------------------------------------------------------------------
223 # Warning and Progress Message Options
224 #---------------------------------------------------------------------------
228 WARN_IF_UNDOCUMENTED = YES
229 WARN_IF_DOC_ERROR = YES
230 WARN_NO_PARAMDOC = YES
231 WARN_FORMAT = "$file:$line: $text "
232 WARN_LOGFILE = doxygen.log
234 #---------------------------------------------------------------------------
236 #---------------------------------------------------------------------------
238 INPUT = ./mainpages ./groups ./overviews ../../interface
239 INPUT_ENCODING = UTF-8
240 FILE_PATTERNS = *.h *.txt
243 EXCLUDE_SYMLINKS = NO
248 EXAMPLE_RECURSIVE = NO
252 FILTER_SOURCE_FILES = NO
254 #---------------------------------------------------------------------------
255 # Source Browsing Options
256 #---------------------------------------------------------------------------
260 STRIP_CODE_COMMENTS = YES
261 REFERENCED_BY_RELATION = NO
262 REFERENCES_RELATION = NO
263 REFERENCES_LINK_SOURCE = YES
265 VERBATIM_HEADERS = NO
267 #---------------------------------------------------------------------------
268 # Alphabetical Class Index Options
269 #---------------------------------------------------------------------------
271 ALPHABETICAL_INDEX = YES
272 COLS_IN_ALPHA_INDEX = 5
275 #---------------------------------------------------------------------------
276 # configuration options related to the HTML output
277 #---------------------------------------------------------------------------
278 GENERATE_HTML = NO # Only change in format output configs
280 HTML_FILE_EXTENSION = .html
281 HTML_HEADER = htmlheader.inc
282 HTML_FOOTER = htmlfooter.inc
284 HTML_ALIGN_MEMBERS = YES
285 GENERATE_HTMLHELP = NO # Only change in format output configs
286 HTML_DYNAMIC_SECTIONS = YES
287 CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed
288 HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
293 ENUM_VALUES_PER_LINE = 1
294 GENERATE_TREEVIEW = NO
297 #---------------------------------------------------------------------------
298 # LaTeX Output Options
299 #---------------------------------------------------------------------------
301 GENERATE_LATEX = NO # Only change in format output configs
303 LATEX_CMD_NAME = latex
304 MAKEINDEX_CMD_NAME = makeindex
308 LATEX_HEADER = latexdocstart.inc
311 LATEX_BATCHMODE = YES
312 LATEX_HIDE_INDICES = NO
314 #---------------------------------------------------------------------------
316 #---------------------------------------------------------------------------
318 GENERATE_RTF = NO # Only change in format output configs
322 RTF_STYLESHEET_FILE =
323 RTF_EXTENSIONS_FILE =
325 #---------------------------------------------------------------------------
326 # Man Page Output Options
327 #---------------------------------------------------------------------------
329 GENERATE_MAN = NO # Only change in format output configs
334 #---------------------------------------------------------------------------
336 #---------------------------------------------------------------------------
338 GENERATE_XML = NO # Only change in format output configs
342 XML_PROGRAMLISTING = NO
344 #---------------------------------------------------------------------------
345 # AutoGen Definitions Output Options
346 #---------------------------------------------------------------------------
348 GENERATE_AUTOGEN_DEF = NO # Only change in format output configs
350 #---------------------------------------------------------------------------
351 # Perl Module Output Options
352 #---------------------------------------------------------------------------
354 GENERATE_PERLMOD = NO # Only change in format output configs
357 PERLMOD_MAKEVAR_PREFIX =
359 #---------------------------------------------------------------------------
360 # Preprocessor Options
361 #---------------------------------------------------------------------------
363 ENABLE_PREPROCESSING = YES
365 EXPAND_ONLY_PREDEF = NO
366 SEARCH_INCLUDES = YES
368 INCLUDE_FILE_PATTERNS =
371 SKIP_FUNCTION_MACROS = YES
373 #---------------------------------------------------------------------------
374 # Additions Related to External References
375 #---------------------------------------------------------------------------
380 EXTERNAL_GROUPS = YES
381 PERL_PATH = /usr/bin/perl
383 #---------------------------------------------------------------------------
385 #---------------------------------------------------------------------------
389 HIDE_UNDOC_RELATIONS = YES
392 COLLABORATION_GRAPH = NO
395 TEMPLATE_RELATIONS = NO
397 INCLUDED_BY_GRAPH = NO
400 GRAPHICAL_HIERARCHY = NO
402 DOT_IMAGE_FORMAT = png
405 DOT_GRAPH_MAX_NODES = 50
406 MAX_DOT_GRAPH_DEPTH = 1000
408 DOT_MULTI_TARGETS = NO
409 GENERATE_LEGEND = YES
412 #---------------------------------------------------------------------------
413 # Search Engine Options
414 #---------------------------------------------------------------------------