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
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 # This is the most important part of the wxWidgets Doxyfile; aliases allow
44 # us to keep the headers readable and "implement" wxWidgets-specific commands:
46 #---------------------------------------------------------------------------
47 # Aliases - for use when documenting C++ classes
48 #---------------------------------------------------------------------------
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>Event macros:<div>"
52 ALIASES += beginEventTable{2}="\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> or <span>void handlerFuncName(\2& event)</span></div></p>Event macros:<div>"
53 ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
54 ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
55 ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
56 ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
57 ALIASES += endEventTable="</div>\n"
60 ALIASES += beginStyleTable="\n<span class='styles'>Styles:</span><div>"
61 ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
62 ALIASES += endStyleTable="</div>\n"
65 ALIASES += beginExtraStyleTable="\n<span class='styles'>Extra styles:</span><div>"
66 ALIASES += endExtraStyleTable="</div>\n"
69 ALIASES += beginFlagTable="<div>"
70 ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
71 ALIASES += endFlagTable="</div>\n"
73 # creates appearance section: this should be used for all main GUI controls
74 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"
76 #---------------------------------------------------------------------------
77 # Aliases - for use when documenting any C++ entity
78 #---------------------------------------------------------------------------
80 # aliases for additional wx-specific infos
81 ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span> <span class='category_text'>\ref group_class_\1</span></div>"
82 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>"
83 ALIASES += library{1}="<div><span class='lib'>Library:</span> <span class='lib_text'>\ref page_libs_\1</span></div>"
84 ALIASES += nolibrary="<div><span class='lib'>Library:</span> <span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
85 ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
87 # native implementation infos:
88 ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
89 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>"
90 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>"
91 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>"
94 # NOTE: we need to be able to retrieve these infos also from the XML output, thus
95 # we use the \xmlonly and \endxmlonly commands to include custom XML tags
96 ALIASES += onlyfor{1}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1 port.</div> \xmlonly <onlyfor>\1</onlyfor> \endxmlonly"
97 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"
98 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"
99 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"
101 # Use this in grouped global functions, and macros since they
102 # wouldn't otherwise indicate what header they are defined in.
103 ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
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="<table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
122 ALIASES += beginInvisibleTable="<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 += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>"
141 ALIASES += endTable="</table>"
143 # definition list aliases
144 # a definition list currently is rendered as 2-column table but it may use as
145 # well the <dl>, <dt> and <dd> HTML tags in future.
146 # In any case a definition list differs from a table because of its semantic
147 # nature and because it is always the association of a "title" with a "description"
148 # (in contrast a table may have more than 2 columns of data)...
149 ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
150 ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
151 ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
152 ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
153 ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
154 ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
155 ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
156 ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
157 ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
158 ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
159 ALIASES += endDefList="</table>"
160 ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td> @image html gtk-\2.png\n</td><td>\3</td></tr>"
162 #---------------------------------------------------------------------------
163 # Aliases - for use when documenting wxPerl/wxPython-specific parts
164 #---------------------------------------------------------------------------
166 # See ENABLED_SECTIONS configuration key for more info about these:
167 ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
168 ALIASES += endWxPerlOnly="\endif"
169 ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> "
170 ALIASES += endWxPythonOnly="\endif"
172 # This is to get around a bug in Doxygen that prevents use of '{' or '}'
173 # inside of any aliased command in parameters.
174 ALIASES += leftCurly="{"
175 ALIASES += rightCurly="}"
177 #---------------------------------------------------------------------------
178 # Aliases - for use when documenting samples
179 #---------------------------------------------------------------------------
181 # For indicating the a directory containing a sample
182 ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim"
184 # For refering to the corresponding sample in a class document or a overview
185 # Usually placed in the queue of @see
186 ALIASES += sample{1}="\ref page_samples_\1"
188 # For generating a general description for a sample
189 # \1 could be a class or an overview or a descriptive sentence
190 # Shall be replaced by manual written description soon
191 ALIASES += sampleabout{1}="This sample demonstrates \1."
193 # For indicating the necessary condition of a sample or a class
194 # \1 is the wxUSE_XXX macro
195 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."
196 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."
198 #---------------------------------------------------------------------------
200 #---------------------------------------------------------------------------
205 EXTRACT_LOCAL_CLASSES = YES
206 EXTRACT_LOCAL_METHODS = NO
207 EXTRACT_ANON_NSPACES = YES
208 HIDE_UNDOC_MEMBERS = NO
209 HIDE_UNDOC_CLASSES = NO
210 HIDE_FRIEND_COMPOUNDS = NO
211 HIDE_IN_BODY_DOCS = NO
213 CASE_SENSE_NAMES = NO
214 HIDE_SCOPE_NAMES = NO
215 SHOW_INCLUDE_FILES = YES
217 SORT_MEMBER_DOCS = YES
218 SORT_BRIEF_DOCS = NO # don't set it to YES! see http://bugzilla.gnome.org/show_bug.cgi?id=312655
219 SORT_BY_SCOPE_NAME = NO
220 GENERATE_TODOLIST = YES
221 GENERATE_TESTLIST = YES
222 GENERATE_BUGLIST = YES
223 GENERATE_DEPRECATEDLIST= YES
225 # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
226 ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL
228 MAX_INITIALIZER_LINES = 30
230 SHOW_DIRECTORIES = YES
231 #SHOW_FILES = YES # Doxygen 1.5.6+ only
232 FILE_VERSION_FILTER =
234 #---------------------------------------------------------------------------
235 # Warning and Progress Message Options
236 #---------------------------------------------------------------------------
240 WARN_IF_UNDOCUMENTED = YES
241 WARN_IF_DOC_ERROR = YES
242 WARN_NO_PARAMDOC = YES
243 WARN_FORMAT = "$file:$line: $text "
244 WARN_LOGFILE = doxygen.log
246 #---------------------------------------------------------------------------
248 #---------------------------------------------------------------------------
250 INPUT = ./mainpages ./groups ./overviews ../../interface
251 INPUT_ENCODING = UTF-8
252 FILE_PATTERNS = *.h *.txt
255 EXCLUDE_SYMLINKS = NO
260 EXAMPLE_RECURSIVE = NO
264 FILTER_SOURCE_FILES = NO
266 #---------------------------------------------------------------------------
267 # Source Browsing Options
268 #---------------------------------------------------------------------------
272 STRIP_CODE_COMMENTS = YES
273 REFERENCED_BY_RELATION = NO
274 REFERENCES_RELATION = NO
275 REFERENCES_LINK_SOURCE = YES
277 VERBATIM_HEADERS = NO
279 #---------------------------------------------------------------------------
280 # Alphabetical Class Index Options
281 #---------------------------------------------------------------------------
283 ALPHABETICAL_INDEX = YES
284 COLS_IN_ALPHA_INDEX = 5
287 #---------------------------------------------------------------------------
288 # configuration options related to the HTML output
289 #---------------------------------------------------------------------------
290 GENERATE_HTML = NO # Only change in format output configs
292 HTML_FILE_EXTENSION = .html
293 HTML_HEADER = htmlheader.inc
294 HTML_FOOTER = htmlfooter.inc
296 HTML_ALIGN_MEMBERS = YES
297 GENERATE_HTMLHELP = NO # Only change in format output configs
298 HTML_DYNAMIC_SECTIONS = YES
299 CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed
300 HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
305 ENUM_VALUES_PER_LINE = 1
306 GENERATE_TREEVIEW = NO
309 #---------------------------------------------------------------------------
310 # LaTeX Output Options
311 #---------------------------------------------------------------------------
313 GENERATE_LATEX = NO # Only change in format output configs
315 LATEX_CMD_NAME = latex
316 MAKEINDEX_CMD_NAME = makeindex
320 LATEX_HEADER = latexdocstart.inc
323 LATEX_BATCHMODE = YES
324 LATEX_HIDE_INDICES = NO
326 #---------------------------------------------------------------------------
328 #---------------------------------------------------------------------------
330 GENERATE_RTF = NO # Only change in format output configs
334 RTF_STYLESHEET_FILE =
335 RTF_EXTENSIONS_FILE =
337 #---------------------------------------------------------------------------
338 # Man Page Output Options
339 #---------------------------------------------------------------------------
341 GENERATE_MAN = NO # Only change in format output configs
346 #---------------------------------------------------------------------------
348 #---------------------------------------------------------------------------
350 GENERATE_XML = NO # Only change in format output configs
354 XML_PROGRAMLISTING = NO
356 #---------------------------------------------------------------------------
357 # AutoGen Definitions Output Options
358 #---------------------------------------------------------------------------
360 GENERATE_AUTOGEN_DEF = NO # Only change in format output configs
362 #---------------------------------------------------------------------------
363 # Perl Module Output Options
364 #---------------------------------------------------------------------------
366 GENERATE_PERLMOD = NO # Only change in format output configs
369 PERLMOD_MAKEVAR_PREFIX =
371 #---------------------------------------------------------------------------
372 # Preprocessor Options
373 #---------------------------------------------------------------------------
375 ENABLE_PREPROCESSING = YES
377 EXPAND_ONLY_PREDEF = NO
378 SEARCH_INCLUDES = YES
380 INCLUDE_FILE_PATTERNS =
383 SKIP_FUNCTION_MACROS = YES
385 #---------------------------------------------------------------------------
386 # Additions Related to External References
387 #---------------------------------------------------------------------------
392 EXTERNAL_GROUPS = YES
393 PERL_PATH = /usr/bin/perl
395 #---------------------------------------------------------------------------
397 #---------------------------------------------------------------------------
401 HIDE_UNDOC_RELATIONS = YES
404 COLLABORATION_GRAPH = NO
407 TEMPLATE_RELATIONS = NO
409 INCLUDED_BY_GRAPH = NO
412 GRAPHICAL_HIERARCHY = NO
414 DOT_IMAGE_FORMAT = png
417 DOT_GRAPH_MAX_NODES = 50
418 MAX_DOT_GRAPH_DEPTH = 1000
420 DOT_MULTI_TARGETS = NO
421 GENERATE_LEGEND = YES
424 #---------------------------------------------------------------------------
425 # Search Engine Options
426 #---------------------------------------------------------------------------