1 #############################################################################
3 ## Purpose: Main configuration file for the wxWidgets manual
4 ## Author: Francesco Montorsi
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 = YES
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{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>"
51 ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
52 ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
53 ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
54 ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
55 ALIASES += endEventTable="</div>\n"
58 ALIASES += beginStyleTable="\n<span class='styles'>Styles:</span><div>"
59 ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
60 ALIASES += endStyleTable="</div>\n"
63 ALIASES += beginExtraStyleTable="\n<span class='styles'>Extra styles:</span><div>"
64 ALIASES += endExtraStyleTable="</div>\n"
67 ALIASES += beginFlagTable="<div>"
68 ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
69 ALIASES += endFlagTable="</div>\n"
71 # aliases for additional wx-specific infos
72 ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span> <span class='category_text'>\ref group_class_\1</span></div>"
73 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>"
74 ALIASES += library{1}="<div><span class='lib'>Library:</span> <span class='lib_text'>\ref page_libs_\1</span></div>"
75 ALIASES += nolibrary="<div><span class='lib'>Library:</span> <span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
76 ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
78 # native implementation infos:
79 ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span> native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
80 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>"
81 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>"
82 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>"
85 # NOTE: we need to be able to retrieve these infos also from the XML output, thus
86 # we use the \xmlonly and \endxmlonly commands to include custom XML tags
87 ALIASES += onlyfor{1}="<div><span class='avail'>Availability:</span> only available for the \ref page_port_\1 port.</div> \xmlonly <onlyfor>\1</onlyfor> \endxmlonly"
88 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"
89 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"
90 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"
92 # creates appearance section: this should be used for all main GUI controls
93 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"
95 # IMPORTANT: the \headerfile command does not work everywhere we'd need it,
96 # e.g. in the constants page we need to specify an header file
97 # even if they're not inside a \class, \function or \struct command:
98 ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
100 # IMPORTANT: inside a \class, we want to specify the header file only once
101 # and not twice as the \headerfile command requires:
102 ALIASES += wxheader{1}="\headerfile \1 wx/\1"
104 # some formatting aliases
105 ALIASES += true="<span class='literal'>true</span>"
106 ALIASES += false="<span class='literal'>false</span>"
107 ALIASES += NULL="<span class='literal'>NULL</span>"
109 # NOTE: these are important as you can't write in the docs
110 # just #ifdef since the # character is used by Doxygen
111 # for explicit linking; use the following aliases instead!
112 # However to avoid overwriting e.g. \if Doxygen command the _
113 # character is postfixed
114 ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
115 ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
116 ALIASES += if_="<span class='literal'>\#if</span>"
117 ALIASES += endif_="<span class='literal'>\#endif</span>"
119 # table aliases for 2 and 3 column tables
120 ALIASES += beginTable="<center><table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
121 ALIASES += beginInvisibleTable="<center><table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
122 ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
123 ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
124 ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
125 ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
126 ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
127 ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
128 ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
129 ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
130 ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
131 ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
132 ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
133 ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
134 ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
135 ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
136 ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
137 ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
138 ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
139 ALIASES += endTable="</table></center>"
141 # definition list aliases
142 # a definition list currently is rendered as 2-column table but it may use as
143 # well the <dl>, <dt> and <dd> HTML tags in future.
144 # In any case a definition list differs from a table because of its semantic
145 # nature and because it is always the association of a "title" with a "description"
146 # (in contrast a table may have more than 2 columns of data)...
147 ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
148 ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
149 ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
150 ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
151 ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
152 ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
153 ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
154 ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
155 ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
156 ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
157 ALIASES += endDefList="</table>"
159 # See ENABLED_SECTIONS configuration key for more info about these:
160 ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
161 ALIASES += endWxPerlOnly="\endif"
162 ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> "
163 ALIASES += endWxPythonOnly="\endif"
165 # This is to get around a bug in Doxygen that prevents use of '{' or '}'
166 # inside of any aliased command in parameters.
167 ALIASES += leftCurly="{"
168 ALIASES += rightCurly="}"
170 # For indicating the a directory containing a sample
171 ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim"
172 # For refering to a sample introduction in a class document or a overview
173 # Usually placed in the queue of @see
174 ALIASES += sample{1}="\ref page_samples_\1"
175 # For generating a general description for a sample by associating it with a class
176 # Shall be replaced by manual written description soon
177 ALIASES += sampleabout{1}="This sample demonstrates \1."
178 # For indicating the necessary condition of a sample or a class
179 # \1 is the wxUSE_XXX macro
180 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."
181 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."
184 #---------------------------------------------------------------------------
185 # Build related configuration options
186 #---------------------------------------------------------------------------
190 EXTRACT_LOCAL_CLASSES = YES
191 EXTRACT_LOCAL_METHODS = NO
192 EXTRACT_ANON_NSPACES = YES
193 HIDE_UNDOC_MEMBERS = NO
194 HIDE_UNDOC_CLASSES = NO
195 HIDE_FRIEND_COMPOUNDS = NO
196 HIDE_IN_BODY_DOCS = NO
198 CASE_SENSE_NAMES = NO
199 HIDE_SCOPE_NAMES = NO
200 SHOW_INCLUDE_FILES = YES
202 SORT_MEMBER_DOCS = YES
203 SORT_BRIEF_DOCS = NO # don't set it to YES! see http://bugzilla.gnome.org/show_bug.cgi?id=312655
204 SORT_BY_SCOPE_NAME = NO
205 GENERATE_TODOLIST = YES
206 GENERATE_TESTLIST = YES
207 GENERATE_BUGLIST = YES
208 GENERATE_DEPRECATEDLIST= YES
210 # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
211 ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL
213 MAX_INITIALIZER_LINES = 30
214 SHOW_USED_FILES = YES
215 SHOW_DIRECTORIES = YES
216 #SHOW_FILES = NO # Doxygen 1.5.6+
217 FILE_VERSION_FILTER =
219 #---------------------------------------------------------------------------
220 # configuration options related to warning and progress messages
221 #---------------------------------------------------------------------------
224 WARN_IF_UNDOCUMENTED = YES
225 WARN_IF_DOC_ERROR = YES
226 WARN_NO_PARAMDOC = YES
227 WARN_FORMAT = "$file:$line: $text "
228 WARN_LOGFILE = doxygen.log
230 #---------------------------------------------------------------------------
231 # configuration options related to the input files
232 #---------------------------------------------------------------------------
233 INPUT = ./mainpages ./groups ./overviews ../../interface
234 INPUT_ENCODING = UTF-8
235 FILE_PATTERNS = *.h *.txt
238 EXCLUDE_SYMLINKS = NO
243 EXAMPLE_RECURSIVE = NO
247 FILTER_SOURCE_FILES = NO
249 #---------------------------------------------------------------------------
250 # configuration options related to source browsing
251 #---------------------------------------------------------------------------
254 STRIP_CODE_COMMENTS = YES
255 REFERENCED_BY_RELATION = NO
256 REFERENCES_RELATION = NO
257 REFERENCES_LINK_SOURCE = YES
259 VERBATIM_HEADERS = NO
261 #---------------------------------------------------------------------------
262 # configuration options related to the alphabetical class index
263 #---------------------------------------------------------------------------
264 ALPHABETICAL_INDEX = YES
265 COLS_IN_ALPHA_INDEX = 5
268 #---------------------------------------------------------------------------
269 # configuration options related to the HTML output
270 #---------------------------------------------------------------------------
271 GENERATE_HTML = NO # Only change in format output configs
273 HTML_FILE_EXTENSION = .html
274 HTML_HEADER = htmlheader.inc
275 HTML_FOOTER = htmlfooter.inc
277 HTML_ALIGN_MEMBERS = YES
278 GENERATE_HTMLHELP = NO # Only change in format output configs
279 HTML_DYNAMIC_SECTIONS = YES
280 CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed
281 HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
286 ENUM_VALUES_PER_LINE = 1
287 GENERATE_TREEVIEW = NO
290 #---------------------------------------------------------------------------
291 # configuration options related to the LaTeX output
292 #---------------------------------------------------------------------------
293 GENERATE_LATEX = NO # Only change in format output configs
295 LATEX_CMD_NAME = latex
296 MAKEINDEX_CMD_NAME = makeindex
300 LATEX_HEADER = latexdocstart.inc
303 LATEX_BATCHMODE = YES
304 LATEX_HIDE_INDICES = NO
306 #---------------------------------------------------------------------------
307 # configuration options related to the RTF output
308 #---------------------------------------------------------------------------
309 GENERATE_RTF = NO # Only change in format output configs
313 RTF_STYLESHEET_FILE =
314 RTF_EXTENSIONS_FILE =
316 #---------------------------------------------------------------------------
317 # configuration options related to the man page output
318 #---------------------------------------------------------------------------
319 GENERATE_MAN = NO # Only change in format output configs
324 #---------------------------------------------------------------------------
325 # configuration options related to the XML output
326 #---------------------------------------------------------------------------
327 GENERATE_XML = NO # Only change in format output configs
331 XML_PROGRAMLISTING = NO
333 #---------------------------------------------------------------------------
334 # configuration options for the AutoGen Definitions output
335 #---------------------------------------------------------------------------
336 GENERATE_AUTOGEN_DEF = NO # Only change in format output configs
338 #---------------------------------------------------------------------------
339 # configuration options related to the Perl module output
340 #---------------------------------------------------------------------------
341 GENERATE_PERLMOD = NO # Only change in format output configs
344 PERLMOD_MAKEVAR_PREFIX =
346 #---------------------------------------------------------------------------
347 # Configuration options related to the preprocessor
348 #---------------------------------------------------------------------------
349 ENABLE_PREPROCESSING = YES
351 EXPAND_ONLY_PREDEF = NO
352 SEARCH_INCLUDES = YES
354 INCLUDE_FILE_PATTERNS =
357 SKIP_FUNCTION_MACROS = YES
359 #---------------------------------------------------------------------------
360 # Configuration::additions related to external references
361 #---------------------------------------------------------------------------
365 EXTERNAL_GROUPS = YES
366 PERL_PATH = /usr/bin/perl
368 #---------------------------------------------------------------------------
369 # Configuration options related to the dot tool
370 #---------------------------------------------------------------------------
373 HIDE_UNDOC_RELATIONS = YES
376 COLLABORATION_GRAPH = NO
379 TEMPLATE_RELATIONS = NO
381 INCLUDED_BY_GRAPH = NO
384 GRAPHICAL_HIERARCHY = NO
386 DOT_IMAGE_FORMAT = png
389 DOT_GRAPH_MAX_NODES = 50
390 MAX_DOT_GRAPH_DEPTH = 1000
392 DOT_MULTI_TARGETS = NO
393 GENERATE_LEGEND = YES
396 #---------------------------------------------------------------------------
397 # Configuration::additions related to the search engine
398 #---------------------------------------------------------------------------