]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/Doxyfile.inc
projects / wxWidgets.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
use SPAN.literal CSS style for @true, @false, @ifdef_ and similars
[wxWidgets.git] / docs / doxygen / Doxyfile.inc
CommitLineData
15b6757b 1#############################################################################
de87600c
FM		 2## Name: Doxyfile.inc
3## Purpose: Main configuration file for the wxWidgets manual
4514447c 4## Author: Francesco Montorsi
15b6757b
FM		 5## RCS-ID: $Id$
6## Licence: wxWindows license
7#############################################################################
8
9#---------------------------------------------------------------------------
10# Project related configuration 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 = YES
21ABBREVIATE_BRIEF =
22ALWAYS_DETAILED_SEC = YES
23INLINE_INHERITED_MEMB = NO
24FULL_PATH_NAMES = NO
25STRIP_FROM_PATH =
26STRIP_FROM_INC_PATH =
27SHORT_NAMES = NO
28JAVADOC_AUTOBRIEF = NO
29QT_AUTOBRIEF = NO
30MULTILINE_CPP_IS_BRIEF = NO
31DETAILS_AT_TOP = NO
32INHERIT_DOCS = YES
33SEPARATE_MEMBER_PAGES = NO
34TAB_SIZE = 4
35OPTIMIZE_OUTPUT_FOR_C = NO
36OPTIMIZE_OUTPUT_JAVA = NO
37BUILTIN_STL_SUPPORT = NO
38CPP_CLI_SUPPORT = NO
23324ae1 39DISTRIBUTE_GROUP_DOC = YES
15b6757b
FM		 40SUBGROUPING = YES
41
42#---------------------------------------------------------------------------
43# Aliases
44#---------------------------------------------------------------------------
45
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.
48
49# event aliases
375c892e
FM		 50ALIASES = beginEventTable="\section class_events Events\n"
51ALIASES += event{1}="\li \b <tt>\1</tt>"
52ALIASES += event{2}="\li \b <tt>\1, \2</tt>"
15b6757b
FM		 53ALIASES += endEventTable="\n"
54
55# style aliases
375c892e
FM		 56ALIASES += beginStyleTable="\section class_styles Styles\n"
57ALIASES += style{1}="\li \b \c \1"
15b6757b
FM		 58ALIASES += endStyleTable="\n"
59
60# extra style aliases
375c892e 61ALIASES += beginExtraStyleTable="\section class_extrastyles Extra Styles\n"
15b6757b
FM		 62ALIASES += endExtraStyleTable="\n"
63
469e56bf 64# aliases for additional wx-specific infos
29d21088 65ALIASES += library{1}="\section class_lib Library\n Belongs to library \ref page_libs_\1."
375c892e
FM		 66ALIASES += nolibrary="\section class_lib Library\n None; this class implementation is entirely header-based."
67ALIASES += stdobjects="\section class_stdobj Predefined objects\n \b"
23324ae1 68ALIASES += category{1}="\section class_category Category\n \ref page_class_cat_\1"
469e56bf
FM		 69
70# aliases with references to wxWidgets ports
bc192c07
FM		 71ALIASES += nativeimpl{1}="\section class_impl Implementations\n Native implementations are used for \ref page_port_\1 port; generic implementation is used elsewhere."
72ALIASES += nativeimpl{2}="\section class_impl Implementations\n Native implementations are used for \ref page_port_\1, \ref page_port_\2 ports; generic implementation is used elsewhere."
73ALIASES += nativeimpl{3}="\section class_impl Implementations\n Native implementations are used for \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; generic implementation is used elsewhere."
74ALIASES += nativeimpl{4}="\section class_impl Implementations\n Native implementations are used for \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports; generic implementation is used elsewhere."
75ALIASES += onlyfor{1}="\section class_onlyfor Availability\n Only available for the \ref page_port_\1 port."
76ALIASES += onlyfor{2}="\section class_onlyfor Availability\n Only available for the \ref page_port_\1, \ref page_port_\2 ports."
77ALIASES += onlyfor{3}="\section class_onlyfor Availability\n Only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports."
78ALIASES += onlyfor{4}="\section class_onlyfor Availability\n Only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports."
469e56bf
FM		 79
80# creates appearance section: this should be used for all main GUI controls
bc192c07 81ALIASES += appearance{1}="\section class_appearance Appearance\n @htmlonly Screenshots for this widget: <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> @endhtmlonly"
048398c7 82
375c892e
FM		 83# IMPORTANT: the default \sa command does not generate a \section!
84ALIASES += seealso="\section class_sa See also\n"
85
86# IMPORTANT: the \headerfile command does not work everywhere we'd need it,
87# e.g. in the constants page we need to specify an header file
88# even if they're not inside a \class, \function or \struct command....
29d21088
FM		 89# and also inside a \class, we want to specify the header file only once
90# and not twice as the \headerfile command requires (and thus we use @wxheader)
375c892e 91ALIASES += header{1}="Include file:\n \verbatim #include <\1> @endverbatim"
29d21088 92ALIASES += wxheader{1}="\headerfile \1 wx/\1"
15b6757b
FM		 93
94# some formatting aliases
375c892e
FM		 95# NOTE: using <b> and <tt> tags is different from using \c \b because in the last case
96# \c gets applied to the first word following and \b to the second word following;
97# we want both bold and typetext attributes to be applied to the same word!
44fe9ffc
FM		 98ALIASES += true="<span class='literal'>true</span>"
99ALIASES += false="<span class='literal'>false</span>"
100ALIASES += NULL="<span class='literal'>NULL</span>"
101
102# NOTE: these are important as you can't write in the docs
103# just #ifdef since the # character is used by Doxygen
104# for explicit linking; use the following aliases instead!
105# However to avoid overwriting e.g. \if Doxygen command the _
106# character is postfixed
107ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
108ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
109ALIASES += if_="<span class='literal'>\#if</span>"
110ALIASES += endif_="<span class='literal'>\#endif</span>"
15b6757b 111
4514447c 112# table aliases for 2 and 3 column tables
877b5c30
BP		 113ALIASES += beginTable="<center><table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
114ALIASES += beginInvisibleTable="<center><table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
4514447c
FM		 115ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
116ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
117ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
118ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
119ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
120ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
121ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
122ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
123ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
124ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
125ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
126ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
127ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
128ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
129ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
130ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
131ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
375c892e 132ALIASES += endTable="</table></center>"
a3465294 133
4514447c
FM		 134# definition list aliases
135# a definition list currently is rendered as 2-column table but it may use as
136# well the <dl>, <dt> and <dd> HTML tags in future.
137# In any case a definition list differs from a table because of its semantic
138# nature and because it is always the association of a "title" with a "description"
139# (in contrast a table may have more than 2 columns of data)...
140ALIASES += beginDefList="<table class='doclist'>"
141ALIASES += itemdef{2}="<tr><td>\b \1</td> <td>\2</td></tr>"
142ALIASES += itemdef{3}="<tr><td>\b \1</td> <td>\2,\3</td></tr>"
143ALIASES += itemdef{4}="<tr><td>\b \1</td> <td>\2,\3,\4</td></tr>"
144ALIASES += itemdef{5}="<tr><td>\b \1</td> <td>\2,\3,\4,\5</td></tr>"
145ALIASES += itemdef{6}="<tr><td>\b \1</td> <td>\2,\3,\4,\5,\6</td></tr>"
146ALIASES += itemdef{7}="<tr><td>\b \1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
147ALIASES += itemdef{8}="<tr><td>\b \1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
148ALIASES += itemdef{9}="<tr><td>\b \1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
149ALIASES += itemdef{10}="<tr><td>\b \1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
150ALIASES += endDefList="</table>"
151
d54cf7ff
FM		 152# See ENABLED_SECTIONS configuration key for more info about these:
153ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL \n <b>wxPerl note</b>\n\n"
154ALIASES += endWxPerlOnly="\endif"
155ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL \n <b>wxPython note</b>\n\n"
156ALIASES += endWxPythonOnly="\endif"
a3465294 157
877b5c30
BP		 158# This is to get around a bug in Doxygen that prevents use of '{' or '}'
159# inside of any aliased command in parameters.
160ALIASES += leftCurly="{"
161ALIASES += rightCurly="}"
162
15b6757b
FM		 163
164#---------------------------------------------------------------------------
165# Build related configuration options
166#---------------------------------------------------------------------------
167EXTRACT_ALL = YES
168EXTRACT_PRIVATE = NO
169EXTRACT_STATIC = YES
170EXTRACT_LOCAL_CLASSES = YES
171EXTRACT_LOCAL_METHODS = NO
172EXTRACT_ANON_NSPACES = YES
23324ae1
FM		 173HIDE_UNDOC_MEMBERS = NO
174HIDE_UNDOC_CLASSES = NO
15b6757b
FM		 175HIDE_FRIEND_COMPOUNDS = NO
176HIDE_IN_BODY_DOCS = NO
177INTERNAL_DOCS = NO
178CASE_SENSE_NAMES = NO
179HIDE_SCOPE_NAMES = NO
180SHOW_INCLUDE_FILES = YES
181INLINE_INFO = YES
182SORT_MEMBER_DOCS = YES
23324ae1 183SORT_BRIEF_DOCS = NO # don't set it to YES! see http://bugzilla.gnome.org/show_bug.cgi?id=312655
15b6757b
FM		 184SORT_BY_SCOPE_NAME = NO
185GENERATE_TODOLIST = YES
186GENERATE_TESTLIST = YES
187GENERATE_BUGLIST = YES
188GENERATE_DEPRECATEDLIST= YES
d54cf7ff
FM		 189
190# can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
15b6757b 191ENABLED_SECTIONS =
d54cf7ff 192
15b6757b
FM		 193MAX_INITIALIZER_LINES = 30
194SHOW_USED_FILES = YES
23324ae1 195SHOW_DIRECTORIES = YES
15b6757b
FM		 196FILE_VERSION_FILTER =
197
198#---------------------------------------------------------------------------
199# configuration options related to warning and progress messages
200#---------------------------------------------------------------------------
201QUIET = NO
202WARNINGS = YES
23324ae1 203WARN_IF_UNDOCUMENTED = YES
15b6757b 204WARN_IF_DOC_ERROR = YES
23324ae1 205WARN_NO_PARAMDOC = YES
15b6757b 206WARN_FORMAT = "$file:$line: $text "
4411a6b6 207WARN_LOGFILE = doxygen.log
15b6757b
FM		 208
209#---------------------------------------------------------------------------
210# configuration options related to the input files
211#---------------------------------------------------------------------------
23324ae1 212INPUT = ./mainpages ./overviews ../../interface
15b6757b
FM		 213INPUT_ENCODING = UTF-8
214FILE_PATTERNS = *.h *.txt
215RECURSIVE = YES
216EXCLUDE =
217EXCLUDE_SYMLINKS = NO
218EXCLUDE_PATTERNS =
219EXCLUDE_SYMBOLS =
220EXAMPLE_PATH =
221EXAMPLE_PATTERNS = *
222EXAMPLE_RECURSIVE = YES
4411a6b6 223IMAGE_PATH = images
15b6757b
FM		 224INPUT_FILTER =
225FILTER_PATTERNS =
226FILTER_SOURCE_FILES = NO
227
228#---------------------------------------------------------------------------
229# configuration options related to source browsing
230#---------------------------------------------------------------------------
231SOURCE_BROWSER = NO
232INLINE_SOURCES = NO
233STRIP_CODE_COMMENTS = YES
234REFERENCED_BY_RELATION = NO
235REFERENCES_RELATION = NO
236REFERENCES_LINK_SOURCE = YES
237USE_HTAGS = NO
238VERBATIM_HEADERS = NO
239
240#---------------------------------------------------------------------------
241# configuration options related to the alphabetical class index
242#---------------------------------------------------------------------------
243ALPHABETICAL_INDEX = YES
244COLS_IN_ALPHA_INDEX = 5
245IGNORE_PREFIX = wx
246
247#---------------------------------------------------------------------------
248# configuration options related to the HTML output
249#---------------------------------------------------------------------------
15b6757b
FM		 250HTML_OUTPUT = html
251HTML_FILE_EXTENSION = .html
252HTML_HEADER = htmlheader.inc
253HTML_FOOTER = htmlfooter.inc
254HTML_STYLESHEET =
255HTML_ALIGN_MEMBERS = YES
15b6757b 256HTML_DYNAMIC_SECTIONS = NO
de87600c 257CHM_FILE = wx.chm
15b6757b
FM		 258GENERATE_CHI = NO
259BINARY_TOC = NO
260TOC_EXPAND = NO
261DISABLE_INDEX = NO
262ENUM_VALUES_PER_LINE = 4
263GENERATE_TREEVIEW = NO
264TREEVIEW_WIDTH = 250
265
266#---------------------------------------------------------------------------
267# configuration options related to the LaTeX output
268#---------------------------------------------------------------------------
15b6757b
FM		 269LATEX_OUTPUT = latex
270LATEX_CMD_NAME = latex
271MAKEINDEX_CMD_NAME = makeindex
272COMPACT_LATEX = NO
273PAPER_TYPE = a4wide
274EXTRA_PACKAGES =
275LATEX_HEADER =
276PDF_HYPERLINKS = NO
277USE_PDFLATEX = NO
278LATEX_BATCHMODE = NO
279LATEX_HIDE_INDICES = NO
280
281#---------------------------------------------------------------------------
282# configuration options related to the RTF output
283#---------------------------------------------------------------------------
15b6757b
FM		 284RTF_OUTPUT = rtf
285COMPACT_RTF = NO
286RTF_HYPERLINKS = NO
287RTF_STYLESHEET_FILE =
288RTF_EXTENSIONS_FILE =
289
290#---------------------------------------------------------------------------
291# configuration options related to the man page output
292#---------------------------------------------------------------------------
15b6757b
FM		 293MAN_OUTPUT = man
294MAN_EXTENSION = .3
295MAN_LINKS = NO
296
297#---------------------------------------------------------------------------
298# configuration options related to the XML output
299#---------------------------------------------------------------------------
15b6757b
FM		 300XML_OUTPUT = xml
301XML_SCHEMA =
302XML_DTD =
303XML_PROGRAMLISTING = YES
304
305#---------------------------------------------------------------------------
306# configuration options for the AutoGen Definitions output
307#---------------------------------------------------------------------------
de87600c 308
15b6757b
FM		 309
310#---------------------------------------------------------------------------
311# configuration options related to the Perl module output
312#---------------------------------------------------------------------------
313GENERATE_PERLMOD = NO
30738aae 314PERLMOD_LATEX = YES
15b6757b 315PERLMOD_PRETTY = YES
de87600c 316PERLMOD_MAKEVAR_PREFIX =
15b6757b
FM		 317
318#---------------------------------------------------------------------------
de87600c 319# Configuration options related to the preprocessor
15b6757b
FM		 320#---------------------------------------------------------------------------
321ENABLE_PREPROCESSING = YES
322MACRO_EXPANSION = NO
323EXPAND_ONLY_PREDEF = NO
324SEARCH_INCLUDES = YES
325INCLUDE_PATH =
326INCLUDE_FILE_PATTERNS =
327PREDEFINED =
328EXPAND_AS_DEFINED =
329SKIP_FUNCTION_MACROS = YES
330
331#---------------------------------------------------------------------------
332# Configuration::additions related to external references
333#---------------------------------------------------------------------------
334TAGFILES =
15b6757b
FM		 335ALLEXTERNALS = NO
336EXTERNAL_GROUPS = YES
337PERL_PATH = /usr/bin/perl
338
339#---------------------------------------------------------------------------
de87600c 340# Configuration options related to the dot tool
15b6757b
FM		 341#---------------------------------------------------------------------------
342CLASS_DIAGRAMS = YES
343MSCGEN_PATH =
344HIDE_UNDOC_RELATIONS = YES
345HAVE_DOT = YES
346CLASS_GRAPH = NO
347COLLABORATION_GRAPH = NO
348GROUP_GRAPHS = NO
349UML_LOOK = NO
350TEMPLATE_RELATIONS = NO
351INCLUDE_GRAPH = NO
352INCLUDED_BY_GRAPH = NO
353CALL_GRAPH = NO
354CALLER_GRAPH = NO
355GRAPHICAL_HIERARCHY = NO
356DIRECTORY_GRAPH = NO
357DOT_IMAGE_FORMAT = png
358DOT_PATH =
359DOTFILE_DIRS =
360DOT_GRAPH_MAX_NODES = 50
361MAX_DOT_GRAPH_DEPTH = 1000
362DOT_TRANSPARENT = NO
363DOT_MULTI_TARGETS = NO
364GENERATE_LEGEND = YES
365DOT_CLEANUP = YES
366
367#---------------------------------------------------------------------------
de87600c 368# Configuration::additions related to the search engine
15b6757b 369#---------------------------------------------------------------------------
de87600c 370SEARCHENGINE = NO
wxWidgets (Impactor)