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