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 = YES
31 MULTILINE_CPP_IS_BRIEF = NO
33 SEPARATE_MEMBER_PAGES = NO
35 OPTIMIZE_OUTPUT_FOR_C = NO
36 OPTIMIZE_OUTPUT_JAVA = NO
37 OPTIMIZE_FOR_FORTRAN = NO
38 OPTIMIZE_OUTPUT_VHDL = NO
39 BUILTIN_STL_SUPPORT = NO
42 IDL_PROPERTY_SUPPORT = NO
43 DISTRIBUTE_GROUP_DOC = YES
45 TYPEDEF_HIDES_STRUCT = NO
48 # This is the most important part of the wxWidgets Doxyfile; aliases allow
49 # us to keep the headers readable and "implement" wxWidgets-specific commands:
51 #---------------------------------------------------------------------------
52 # Aliases - for use when documenting C++ classes
53 #---------------------------------------------------------------------------
56 ALIASES = beginEventTable{1}="\n<h2>Events</h2><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>Event macros:<div>"
57 ALIASES += beginEventTable{2}="\n<h2>Events</h2><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> or <span>void handlerFuncName(\2& event)</span></div></p>Event macros:<div>"
58 ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
59 ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
60 ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
61 ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
62 ALIASES += endEventTable="</div>\n"
65 ALIASES += beginStyleTable="\n<h2>Styles</h2><p>This class supports the following styles:</p><div>"
66 ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
67 ALIASES += endStyleTable="</div>\n"
70 ALIASES += beginExtraStyleTable="\n<hr><h2>Extra styles</h2><p>This class supports the following extra styles:</p><div>"
71 ALIASES += endExtraStyleTable="</div>\n"
74 ALIASES += beginFlagTable="<div>"
75 ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
76 ALIASES += endFlagTable="</div>\n"
78 # creates appearance section: this should be used for all main GUI controls
79 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"
81 #---------------------------------------------------------------------------
82 # Aliases - for use when documenting any C++ entity
83 #---------------------------------------------------------------------------
85 # aliases for additional wx-specific infos
86 ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span> <span class='category_text'>\ref group_class_\1</span></div>"
87 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>"
88 ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span> <span class='lib_text'>\ref page_libs_\1</span></div>"
89 ALIASES += nolibrary="<h2></h2><div><span class='lib'>Library:</span> <span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
90 ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
92 # native implementation infos:
93 ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
94 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>"
95 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>"
96 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>"
99 # NOTE: we need to be able to retrieve these infos also from the XML output, thus
100 # we use the \xmlonly and \endxmlonly commands to include custom XML tags
101 ALIASES += onlyfor{1}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1 port.</div> \xmlonly <onlyfor>\1</onlyfor> \endxmlonly"
102 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"
103 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"
104 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"
106 # Use this in grouped global functions, and macros since they
107 # wouldn't otherwise indicate what header they are defined in.
108 ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
110 # some formatting aliases
111 ALIASES += true="<span class='literal'>true</span>"
112 ALIASES += false="<span class='literal'>false</span>"
113 ALIASES += NULL="<span class='literal'>NULL</span>"
114 ALIASES += NUL="<span class='literal'>NUL</span>"
116 # NOTE: these are important as you can't write in the docs
117 # just #ifdef since the # character is used by Doxygen
118 # for explicit linking; use the following aliases instead!
119 # However to avoid overwriting e.g. \if Doxygen command the _
120 # character is postfixed
121 ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
122 ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
123 ALIASES += if_="<span class='literal'>\#if</span>"
124 ALIASES += endif_="<span class='literal'>\#endif</span>"
126 # table aliases for 2 and 3 column tables
127 ALIASES += beginTable="<table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
128 ALIASES += beginInvisibleTable="<table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
129 ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
130 ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
131 ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
132 ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
133 ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
134 ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
135 ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
136 ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
137 ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
138 ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
139 ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
140 ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
141 ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
142 ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
143 ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
144 ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
145 ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
146 ALIASES += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>"
147 ALIASES += endTable="</table>"
149 # definition list aliases
150 # a definition list currently is rendered as 2-column table but it may use as
151 # well the <dl>, <dt> and <dd> HTML tags in future.
152 # In any case a definition list differs from a table because of its semantic
153 # nature and because it is always the association of a "title" with a "description"
154 # (in contrast a table may have more than 2 columns of data)...
155 ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
156 ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
157 ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
158 ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
159 ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
160 ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
161 ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
162 ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
163 ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
164 ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
165 ALIASES += endDefList="</table>"
166 ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td> @image html gtk-\2.png\n</td><td>\3</td></tr>"
168 #---------------------------------------------------------------------------
169 # Aliases - for use when documenting wxPerl/wxPython-specific parts
170 #---------------------------------------------------------------------------
172 # See ENABLED_SECTIONS configuration key for more info about these:
173 ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
174 ALIASES += endWxPerlOnly="\endif"
175 ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> "
176 ALIASES += endWxPythonOnly="\endif"
178 # This is to get around a bug in Doxygen that prevents use of '{' or '}'
179 # inside of any aliased command in parameters.
180 ALIASES += leftCurly="{"
181 ALIASES += rightCurly="}"
183 #---------------------------------------------------------------------------
184 # Aliases - for use when documenting samples
185 #---------------------------------------------------------------------------
187 # For indicating the a directory containing a sample
188 ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim"
190 # For refering to the corresponding sample in a class document or a overview
191 # Usually placed in the queue of @see
192 ALIASES += sample{1}="\ref page_samples_\1"
194 # For generating a general description for a sample
195 # \1 could be a class or an overview or a descriptive sentence
196 # Shall be replaced by manual written description soon
197 ALIASES += sampleabout{1}="This sample demonstrates \1."
199 # For indicating the necessary condition of a sample or a class
200 # \1 is the wxUSE_XXX macro
201 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."
202 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."
204 #---------------------------------------------------------------------------
206 #---------------------------------------------------------------------------
211 EXTRACT_LOCAL_CLASSES = YES
212 EXTRACT_LOCAL_METHODS = NO
213 EXTRACT_ANON_NSPACES = YES
214 HIDE_UNDOC_MEMBERS = NO
215 HIDE_UNDOC_CLASSES = NO
216 HIDE_FRIEND_COMPOUNDS = NO
217 HIDE_IN_BODY_DOCS = NO
219 CASE_SENSE_NAMES = NO
220 HIDE_SCOPE_NAMES = NO
221 SHOW_INCLUDE_FILES = YES
223 SORT_MEMBER_DOCS = YES
224 SORT_BRIEF_DOCS = NO # Don't set to YES, it renders our named groups out of order.
225 SORT_GROUP_NAMES = YES
226 SORT_BY_SCOPE_NAME = NO
227 GENERATE_TODOLIST = YES
228 GENERATE_TESTLIST = YES
229 GENERATE_BUGLIST = YES
230 GENERATE_DEPRECATEDLIST= YES
232 # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
233 ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL
235 MAX_INITIALIZER_LINES = 30
237 SHOW_DIRECTORIES = YES
240 FILE_VERSION_FILTER =
241 LAYOUT_FILE = DoxygenLayout.xml
243 #---------------------------------------------------------------------------
244 # Warning and Progress Message Options
245 #---------------------------------------------------------------------------
249 WARN_IF_UNDOCUMENTED = YES
250 WARN_IF_DOC_ERROR = YES
251 WARN_NO_PARAMDOC = YES
252 WARN_FORMAT = "$file:$line: $text "
253 WARN_LOGFILE = doxygen.log
255 #---------------------------------------------------------------------------
257 #---------------------------------------------------------------------------
259 INPUT = ./mainpages ./groups ./overviews ../../interface
260 INPUT_ENCODING = UTF-8
261 FILE_PATTERNS = *.h *.txt
264 EXCLUDE_SYMLINKS = NO
269 EXAMPLE_RECURSIVE = NO
273 FILTER_SOURCE_FILES = NO
275 #---------------------------------------------------------------------------
276 # Source Browsing Options
277 #---------------------------------------------------------------------------
281 STRIP_CODE_COMMENTS = YES
282 REFERENCED_BY_RELATION = NO
283 REFERENCES_RELATION = NO
284 REFERENCES_LINK_SOURCE = YES
286 VERBATIM_HEADERS = NO
288 #---------------------------------------------------------------------------
289 # Alphabetical Class Index Options
290 #---------------------------------------------------------------------------
292 ALPHABETICAL_INDEX = YES
293 COLS_IN_ALPHA_INDEX = 5
296 #---------------------------------------------------------------------------
297 # configuration options related to the HTML output
298 #---------------------------------------------------------------------------
299 GENERATE_HTML = NO # Only change in format output configs
301 HTML_FILE_EXTENSION = .html
302 HTML_HEADER = htmlheader.inc
303 HTML_FOOTER = htmlfooter.inc
305 HTML_ALIGN_MEMBERS = YES
306 HTML_DYNAMIC_SECTIONS = YES
307 GENERATE_DOCSET = NO # Only change in format output configs
308 DOCSET_FEEDNAME = "wxWidgets"
309 DOCSET_BUNDLE_ID = org.wxwidgets.doxygen
310 GENERATE_HTMLHELP = NO # Only change in format output configs
311 CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed
312 HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
318 QHP_NAMESPACE = org.wxwidgets.doxygen
319 QHP_VIRTUAL_FOLDER = doc
322 ENUM_VALUES_PER_LINE = 1
323 GENERATE_TREEVIEW = NONE
325 FORMULA_FONTSIZE = 10
327 #---------------------------------------------------------------------------
328 # LaTeX Output Options
329 #---------------------------------------------------------------------------
331 GENERATE_LATEX = NO # Only change in format output configs
333 LATEX_CMD_NAME = latex
334 MAKEINDEX_CMD_NAME = makeindex
338 LATEX_HEADER = latexdocstart.inc
341 LATEX_BATCHMODE = YES
342 LATEX_HIDE_INDICES = NO
344 #---------------------------------------------------------------------------
346 #---------------------------------------------------------------------------
348 GENERATE_RTF = NO # Only change in format output configs
352 RTF_STYLESHEET_FILE =
353 RTF_EXTENSIONS_FILE =
355 #---------------------------------------------------------------------------
356 # Man Page Output Options
357 #---------------------------------------------------------------------------
359 GENERATE_MAN = NO # Only change in format output configs
364 #---------------------------------------------------------------------------
366 #---------------------------------------------------------------------------
368 GENERATE_XML = NO # Only change in format output configs
372 XML_PROGRAMLISTING = NO
374 #---------------------------------------------------------------------------
375 # AutoGen Definitions Output Options
376 #---------------------------------------------------------------------------
378 GENERATE_AUTOGEN_DEF = NO # Only change in format output configs
380 #---------------------------------------------------------------------------
381 # Perl Module Output Options
382 #---------------------------------------------------------------------------
384 GENERATE_PERLMOD = NO # Only change in format output configs
387 PERLMOD_MAKEVAR_PREFIX =
389 #---------------------------------------------------------------------------
390 # Preprocessor Options
391 #---------------------------------------------------------------------------
393 ENABLE_PREPROCESSING = YES
395 EXPAND_ONLY_PREDEF = NO
396 SEARCH_INCLUDES = YES
398 INCLUDE_FILE_PATTERNS =
401 SKIP_FUNCTION_MACROS = YES
403 #---------------------------------------------------------------------------
404 # Additions Related to External References
405 #---------------------------------------------------------------------------
410 EXTERNAL_GROUPS = YES
411 PERL_PATH = /usr/bin/perl
413 #---------------------------------------------------------------------------
415 #---------------------------------------------------------------------------
419 HIDE_UNDOC_RELATIONS = YES
421 DOT_FONTNAME = FreeSans
425 COLLABORATION_GRAPH = NO
428 TEMPLATE_RELATIONS = NO
430 INCLUDED_BY_GRAPH = NO
433 GRAPHICAL_HIERARCHY = NO
435 DOT_IMAGE_FORMAT = png
438 DOT_GRAPH_MAX_NODES = 50
439 MAX_DOT_GRAPH_DEPTH = 1000
441 DOT_MULTI_TARGETS = NO
442 GENERATE_LEGEND = YES
445 #---------------------------------------------------------------------------
446 # Search Engine Options
447 #---------------------------------------------------------------------------