]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/doxygen/Doxyfile_inc
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
add comparison operators for UUID class (#9871)
[wxWidgets.git] / docs / doxygen / Doxyfile_inc
... / ...
CommitLineData
1#############################################################################
2## Name: Doxyfile_inc
3## Purpose: Main configuration file for the wxWidgets manual
4## Author: Francesco Montorsi
5## RCS-ID: $Id$
6## Licence: wxWindows license
7#############################################################################
8
9#---------------------------------------------------------------------------
10# Project Options
11#---------------------------------------------------------------------------
12
13DOXYFILE_ENCODING = UTF-8
14PROJECT_NAME = wxWidgets
15PROJECT_NUMBER = 2.9.0
16OUTPUT_DIRECTORY = out
17CREATE_SUBDIRS = NO
18OUTPUT_LANGUAGE = English
19BRIEF_MEMBER_DESC = YES
20REPEAT_BRIEF = NO
21ABBREVIATE_BRIEF =
22ALWAYS_DETAILED_SEC = YES
23INLINE_INHERITED_MEMB = NO
24FULL_PATH_NAMES = YES
25STRIP_FROM_PATH = "$(WXWIDGETS)/"
26STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \
27 "$(WXWIDGETS)/interface/"
28SHORT_NAMES = NO
29JAVADOC_AUTOBRIEF = NO
30QT_AUTOBRIEF = NO
31MULTILINE_CPP_IS_BRIEF = NO
32DETAILS_AT_TOP = YES
33INHERIT_DOCS = YES
34SEPARATE_MEMBER_PAGES = NO
35TAB_SIZE = 4
36OPTIMIZE_OUTPUT_FOR_C = NO
37OPTIMIZE_OUTPUT_JAVA = NO
38BUILTIN_STL_SUPPORT = NO
39CPP_CLI_SUPPORT = NO
40DISTRIBUTE_GROUP_DOC = YES
41SUBGROUPING = YES
42
43#---------------------------------------------------------------------------
44# Aliases
45#---------------------------------------------------------------------------
46
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.
49
50# event aliases
51ALIASES = 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&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p><br>Event macros:<div>"
52ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
53ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
54ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
55ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
56ALIASES += endEventTable="</div>\n"
57
58# style aliases
59ALIASES += beginStyleTable="\n<span class='styles'>Styles:</span><div>"
60ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
61ALIASES += endStyleTable="</div>\n"
62
63# extra style aliases
64ALIASES += beginExtraStyleTable="\n<span class='styles'>Extra styles:</span><div>"
65ALIASES += endExtraStyleTable="</div>\n"
66
67# flag aliases
68ALIASES += beginFlagTable="<div>"
69ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
70ALIASES += endFlagTable="</div>\n"
71
72# aliases for additional wx-specific infos
73ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1</span></div>"
74ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2</span></div>"
75ALIASES += library{1}="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
76ALIASES += nolibrary="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
77ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
78
79# native implementation infos:
80ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
81ALIASES += nativeimpl{2}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1, \ref page_port_\2 ports; a generic implementation is used elsewhere.</div>"
82ALIASES += nativeimpl{3}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; a generic implementation is used elsewhere.</div>"
83ALIASES += nativeimpl{4}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;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>"
84
85# onlyfor infos:
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
88ALIASES += onlyfor{1}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1 port.</div> \xmlonly <onlyfor>\1</onlyfor> \endxmlonly"
89ALIASES += onlyfor{2}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2 ports.</div> \xmlonly <onlyfor>\1,\2</onlyfor> \endxmlonly"
90ALIASES += onlyfor{3}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;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"
91ALIASES += onlyfor{4}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;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
93# creates appearance section: this should be used for all main GUI controls
94ALIASES += 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
96# Use this in grouped global functions, and macros since they
97# wouldn't otherwise indicate what header they are defined in.
98ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
99
100# some formatting aliases
101ALIASES += true="<span class='literal'>true</span>"
102ALIASES += false="<span class='literal'>false</span>"
103ALIASES += NULL="<span class='literal'>NULL</span>"
104
105# NOTE: these are important as you can't write in the docs
106# just #ifdef since the # character is used by Doxygen
107# for explicit linking; use the following aliases instead!
108# However to avoid overwriting e.g. \if Doxygen command the _
109# character is postfixed
110ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
111ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
112ALIASES += if_="<span class='literal'>\#if</span>"
113ALIASES += endif_="<span class='literal'>\#endif</span>"
114
115# table aliases for 2 and 3 column tables
116ALIASES += beginTable="<center><table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
117ALIASES += beginInvisibleTable="<center><table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
118ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
119ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
120ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
121ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
122ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
123ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
124ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
125ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
126ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
127ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
128ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
129ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
130ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
131ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
132ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
133ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
134ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
135ALIASES += endTable="</table></center>"
136
137# definition list aliases
138# a definition list currently is rendered as 2-column table but it may use as
139# well the <dl>, <dt> and <dd> HTML tags in future.
140# In any case a definition list differs from a table because of its semantic
141# nature and because it is always the association of a "title" with a "description"
142# (in contrast a table may have more than 2 columns of data)...
143ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
144ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
145ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
146ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
147ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
148ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
149ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
150ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
151ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
152ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
153ALIASES += endDefList="</table>"
154
155# See ENABLED_SECTIONS configuration key for more info about these:
156ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
157ALIASES += endWxPerlOnly="\endif"
158ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> "
159ALIASES += endWxPythonOnly="\endif"
160
161# This is to get around a bug in Doxygen that prevents use of '{' or '}'
162# inside of any aliased command in parameters.
163ALIASES += leftCurly="{"
164ALIASES += rightCurly="}"
165
166# Sample documentation related aliases
167# For indicating the a directory containing a sample
168ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim"
169# For refering to the corresponding sample in a class document or a overview
170# Usually placed in the queue of @see
171ALIASES += sample{1}="\ref page_samples_\1"
172# For generating a general description for a sample
173# \1 could be a class or an overview or a descriptive sentence
174# Shall be replaced by manual written description soon
175ALIASES += sampleabout{1}="This sample demonstrates \1."
176# For indicating the necessary condition of a sample or a class
177# \1 is the wxUSE_XXX macro
178ALIASES += 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."
179ALIASES += 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."
180
181#---------------------------------------------------------------------------
182# Build Options
183#---------------------------------------------------------------------------
184
185EXTRACT_ALL = YES
186EXTRACT_PRIVATE = NO
187EXTRACT_STATIC = YES
188EXTRACT_LOCAL_CLASSES = YES
189EXTRACT_LOCAL_METHODS = NO
190EXTRACT_ANON_NSPACES = YES
191HIDE_UNDOC_MEMBERS = NO
192HIDE_UNDOC_CLASSES = NO
193HIDE_FRIEND_COMPOUNDS = NO
194HIDE_IN_BODY_DOCS = NO
195INTERNAL_DOCS = NO
196CASE_SENSE_NAMES = NO
197HIDE_SCOPE_NAMES = NO
198SHOW_INCLUDE_FILES = YES
199INLINE_INFO = YES
200SORT_MEMBER_DOCS = YES
201SORT_BRIEF_DOCS = NO # don't set it to YES! see http://bugzilla.gnome.org/show_bug.cgi?id=312655
202SORT_BY_SCOPE_NAME = NO
203GENERATE_TODOLIST = YES
204GENERATE_TESTLIST = YES
205GENERATE_BUGLIST = YES
206GENERATE_DEPRECATEDLIST= YES
207
208# can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
209ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL
210
211MAX_INITIALIZER_LINES = 30
212SHOW_USED_FILES = NO
213SHOW_DIRECTORIES = YES
214SHOW_FILES = YES # Doxygen 1.5.6+
215FILE_VERSION_FILTER =
216
217#---------------------------------------------------------------------------
218# Warning and Progress Message Options
219#---------------------------------------------------------------------------
220
221QUIET = YES
222WARNINGS = YES
223WARN_IF_UNDOCUMENTED = YES
224WARN_IF_DOC_ERROR = YES
225WARN_NO_PARAMDOC = YES
226WARN_FORMAT = "$file:$line: $text "
227WARN_LOGFILE = doxygen.log
228
229#---------------------------------------------------------------------------
230# Input File Options
231#---------------------------------------------------------------------------
232
233INPUT = ./mainpages ./groups ./overviews ../../interface
234INPUT_ENCODING = UTF-8
235FILE_PATTERNS = *.h *.txt
236RECURSIVE = YES
237EXCLUDE =
238EXCLUDE_SYMLINKS = NO
239EXCLUDE_PATTERNS =
240EXCLUDE_SYMBOLS =
241EXAMPLE_PATH = ../
242EXAMPLE_PATTERNS = *
243EXAMPLE_RECURSIVE = NO
244IMAGE_PATH = images
245INPUT_FILTER =
246FILTER_PATTERNS =
247FILTER_SOURCE_FILES = NO
248
249#---------------------------------------------------------------------------
250# Source Browsing Options
251#---------------------------------------------------------------------------
252
253SOURCE_BROWSER = NO
254INLINE_SOURCES = NO
255STRIP_CODE_COMMENTS = YES
256REFERENCED_BY_RELATION = NO
257REFERENCES_RELATION = NO
258REFERENCES_LINK_SOURCE = YES
259USE_HTAGS = NO
260VERBATIM_HEADERS = NO
261
262#---------------------------------------------------------------------------
263# Alphabetical Class Index Options
264#---------------------------------------------------------------------------
265
266ALPHABETICAL_INDEX = YES
267COLS_IN_ALPHA_INDEX = 5
268IGNORE_PREFIX = wx
269
270#---------------------------------------------------------------------------
271# configuration options related to the HTML output
272#---------------------------------------------------------------------------
273GENERATE_HTML = NO # Only change in format output configs
274HTML_OUTPUT = html
275HTML_FILE_EXTENSION = .html
276HTML_HEADER = htmlheader.inc
277HTML_FOOTER = htmlfooter.inc
278HTML_STYLESHEET =
279HTML_ALIGN_MEMBERS = YES
280GENERATE_HTMLHELP = NO # Only change in format output configs
281HTML_DYNAMIC_SECTIONS = YES
282CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed
283HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
284GENERATE_CHI = NO
285BINARY_TOC = NO
286TOC_EXPAND = NO
287DISABLE_INDEX = NO
288ENUM_VALUES_PER_LINE = 1
289GENERATE_TREEVIEW = NO
290TREEVIEW_WIDTH = 250
291
292#---------------------------------------------------------------------------
293# LaTeX Output Options
294#---------------------------------------------------------------------------
295
296GENERATE_LATEX = NO # Only change in format output configs
297LATEX_OUTPUT = latex
298LATEX_CMD_NAME = latex
299MAKEINDEX_CMD_NAME = makeindex
300COMPACT_LATEX = NO
301PAPER_TYPE = a4wide
302EXTRA_PACKAGES =
303LATEX_HEADER = latexdocstart.inc
304PDF_HYPERLINKS = YES
305USE_PDFLATEX = YES
306LATEX_BATCHMODE = YES
307LATEX_HIDE_INDICES = NO
308
309#---------------------------------------------------------------------------
310# RTF Output Options
311#---------------------------------------------------------------------------
312
313GENERATE_RTF = NO # Only change in format output configs
314RTF_OUTPUT = rtf
315COMPACT_RTF = NO
316RTF_HYPERLINKS = NO
317RTF_STYLESHEET_FILE =
318RTF_EXTENSIONS_FILE =
319
320#---------------------------------------------------------------------------
321# Man Page Output Options
322#---------------------------------------------------------------------------
323
324GENERATE_MAN = NO # Only change in format output configs
325MAN_OUTPUT = man
326MAN_EXTENSION = .3
327MAN_LINKS = NO
328
329#---------------------------------------------------------------------------
330# XML Output Options
331#---------------------------------------------------------------------------
332
333GENERATE_XML = NO # Only change in format output configs
334XML_OUTPUT = xml
335XML_SCHEMA =
336XML_DTD =
337XML_PROGRAMLISTING = NO
338
339#---------------------------------------------------------------------------
340# AutoGen Definitions Output Options
341#---------------------------------------------------------------------------
342
343GENERATE_AUTOGEN_DEF = NO # Only change in format output configs
344
345#---------------------------------------------------------------------------
346# Perl Module Output Options
347#---------------------------------------------------------------------------
348
349GENERATE_PERLMOD = NO # Only change in format output configs
350PERLMOD_LATEX = YES
351PERLMOD_PRETTY = YES
352PERLMOD_MAKEVAR_PREFIX =
353
354#---------------------------------------------------------------------------
355# Preprocessor Options
356#---------------------------------------------------------------------------
357
358ENABLE_PREPROCESSING = YES
359MACRO_EXPANSION = NO
360EXPAND_ONLY_PREDEF = NO
361SEARCH_INCLUDES = YES
362INCLUDE_PATH =
363INCLUDE_FILE_PATTERNS =
364PREDEFINED =
365EXPAND_AS_DEFINED =
366SKIP_FUNCTION_MACROS = YES
367
368#---------------------------------------------------------------------------
369# Additions Related to External References
370#---------------------------------------------------------------------------
371
372TAGFILES =
373GENERATE_TAGFILE =
374ALLEXTERNALS = NO
375EXTERNAL_GROUPS = YES
376PERL_PATH = /usr/bin/perl
377
378#---------------------------------------------------------------------------
379# dot Tool Options
380#---------------------------------------------------------------------------
381
382CLASS_DIAGRAMS = YES
383MSCGEN_PATH =
384HIDE_UNDOC_RELATIONS = YES
385HAVE_DOT = YES
386CLASS_GRAPH = NO
387COLLABORATION_GRAPH = NO
388GROUP_GRAPHS = NO
389UML_LOOK = NO
390TEMPLATE_RELATIONS = NO
391INCLUDE_GRAPH = NO
392INCLUDED_BY_GRAPH = NO
393CALL_GRAPH = NO
394CALLER_GRAPH = NO
395GRAPHICAL_HIERARCHY = NO
396DIRECTORY_GRAPH = NO
397DOT_IMAGE_FORMAT = png
398DOT_PATH =
399DOTFILE_DIRS =
400DOT_GRAPH_MAX_NODES = 50
401MAX_DOT_GRAPH_DEPTH = 1000
402DOT_TRANSPARENT = NO
403DOT_MULTI_TARGETS = NO
404GENERATE_LEGEND = YES
405DOT_CLEANUP = YES
406
407#---------------------------------------------------------------------------
408# Search Engine Options
409#---------------------------------------------------------------------------
410
411SEARCHENGINE = NO
412
wxWidgets (Impactor)