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