]> 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
speedup a little the parser by converting gccXML ID attributes to numbers, instead...
[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 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 = YES
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 = YES
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="\n<span class='events'>Events:</span>"
51ALIASES += event{1}="\li <span class='event'>\1</span>"
52ALIASES += event{2}="\li <span class='event'>\1, \2</span>"
53ALIASES += event{3}="\li <span class='event'>\1, \2, \3</span>"
54ALIASES += event{4}="\li <span class='event'>\1, \2, \3, \4</span>"
55ALIASES += endEventTable="\n"
56
57# style aliases
58ALIASES += beginStyleTable="\n<span class='styles'>Styles:</span>"
59ALIASES += style{1}="\li <span class='style'>\1</span>"
60ALIASES += endStyleTable="\n"
61
62# extra style aliases
63ALIASES += beginExtraStyleTable="<div><span class='styles'>Extra styles:</span>"
64ALIASES += endExtraStyleTable="</div>"
65
66# aliases for additional wx-specific infos
67ALIASES += 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>"
68ALIASES += 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>"
69ALIASES += library{1}="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
70ALIASES += nolibrary="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
71ALIASES += stdobjects="<span class='stdobj'>Predefined objects:</span>"
72
73# native implementation infos:
74ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
75ALIASES += 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>"
76ALIASES += 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>"
77ALIASES += 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>"
78
79# onlyfor infos:
80ALIASES += onlyfor{1}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1 port.</div>"
81ALIASES += onlyfor{2}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2 ports.</div>"
82ALIASES += 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>"
83ALIASES += 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>"
84
85# creates appearance section: this should be used for all main GUI controls
86ALIASES += appearance{1}="@htmlonly <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"
87
88# IMPORTANT: the \headerfile command does not work everywhere we'd need it,
89# e.g. in the constants page we need to specify an header file
90# even if they're not inside a \class, \function or \struct command:
91ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
92
93# IMPORTANT: inside a \class, we want to specify the header file only once
94# and not twice as the \headerfile command requires:
95ALIASES += wxheader{1}="\headerfile \1 wx/\1"
96
97# the following alias avoids to repeat lots of times the same statement:
98ALIASES += wxsince{1}="\since This function is new since wxWidgets version \1."
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'>"
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 \n <b>wxPerl note</b>\n\n"
157ALIASES += endWxPerlOnly="\endif"
158ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL \n <b>wxPython note</b>\n\n"
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
167#---------------------------------------------------------------------------
168# Build related configuration options
169#---------------------------------------------------------------------------
170EXTRACT_ALL = YES
171EXTRACT_PRIVATE = NO
172EXTRACT_STATIC = YES
173EXTRACT_LOCAL_CLASSES = YES
174EXTRACT_LOCAL_METHODS = NO
175EXTRACT_ANON_NSPACES = YES
176HIDE_UNDOC_MEMBERS = NO
177HIDE_UNDOC_CLASSES = NO
178HIDE_FRIEND_COMPOUNDS = NO
179HIDE_IN_BODY_DOCS = NO
180INTERNAL_DOCS = NO
181CASE_SENSE_NAMES = NO
182HIDE_SCOPE_NAMES = NO
183SHOW_INCLUDE_FILES = YES
184INLINE_INFO = YES
185SORT_MEMBER_DOCS = YES
186SORT_BRIEF_DOCS = NO # don't set it to YES! see http://bugzilla.gnome.org/show_bug.cgi?id=312655
187SORT_BY_SCOPE_NAME = NO
188GENERATE_TODOLIST = YES
189GENERATE_TESTLIST = YES
190GENERATE_BUGLIST = YES
191GENERATE_DEPRECATEDLIST= YES
192
193# can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
194ENABLED_SECTIONS =
195
196MAX_INITIALIZER_LINES = 30
197SHOW_USED_FILES = YES
198SHOW_DIRECTORIES = YES
199FILE_VERSION_FILTER =
200
201#---------------------------------------------------------------------------
202# configuration options related to warning and progress messages
203#---------------------------------------------------------------------------
204QUIET = YES
205WARNINGS = YES
206WARN_IF_UNDOCUMENTED = YES
207WARN_IF_DOC_ERROR = YES
208WARN_NO_PARAMDOC = YES
209WARN_FORMAT = "$file:$line: $text "
210WARN_LOGFILE = doxygen.log
211
212#---------------------------------------------------------------------------
213# configuration options related to the input files
214#---------------------------------------------------------------------------
215INPUT = ./mainpages ./groups ./overviews ../../interface
216INPUT_ENCODING = UTF-8
217FILE_PATTERNS = *.h *.txt
218RECURSIVE = YES
219EXCLUDE =
220EXCLUDE_SYMLINKS = NO
221EXCLUDE_PATTERNS =
222EXCLUDE_SYMBOLS =
223EXAMPLE_PATH =
224EXAMPLE_PATTERNS = *
225EXAMPLE_RECURSIVE = YES
226IMAGE_PATH = images
227INPUT_FILTER =
228FILTER_PATTERNS =
229FILTER_SOURCE_FILES = NO
230
231#---------------------------------------------------------------------------
232# configuration options related to source browsing
233#---------------------------------------------------------------------------
234SOURCE_BROWSER = NO
235INLINE_SOURCES = NO
236STRIP_CODE_COMMENTS = YES
237REFERENCED_BY_RELATION = NO
238REFERENCES_RELATION = NO
239REFERENCES_LINK_SOURCE = YES
240USE_HTAGS = NO
241VERBATIM_HEADERS = NO
242
243#---------------------------------------------------------------------------
244# configuration options related to the alphabetical class index
245#---------------------------------------------------------------------------
246ALPHABETICAL_INDEX = YES
247COLS_IN_ALPHA_INDEX = 5
248IGNORE_PREFIX = wx
249
250#---------------------------------------------------------------------------
251# configuration options related to the HTML output
252#---------------------------------------------------------------------------
253GENERATE_HTML = NO # Only change in format output configs
254HTML_OUTPUT = html
255HTML_FILE_EXTENSION = .html
256HTML_HEADER = htmlheader.inc
257HTML_FOOTER = htmlfooter.inc
258HTML_STYLESHEET =
259HTML_ALIGN_MEMBERS = YES
260GENERATE_HTMLHELP = NO # Only change in format output configs
261HTML_DYNAMIC_SECTIONS = YES
262CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed
263HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
264GENERATE_CHI = NO
265BINARY_TOC = NO
266TOC_EXPAND = NO
267DISABLE_INDEX = NO
268ENUM_VALUES_PER_LINE = 4
269GENERATE_TREEVIEW = NO
270TREEVIEW_WIDTH = 250
271
272#---------------------------------------------------------------------------
273# configuration options related to the LaTeX output
274#---------------------------------------------------------------------------
275GENERATE_LATEX = NO # Only change in format output configs
276LATEX_OUTPUT = latex
277LATEX_CMD_NAME = latex
278MAKEINDEX_CMD_NAME = makeindex
279COMPACT_LATEX = NO
280PAPER_TYPE = a4wide
281EXTRA_PACKAGES =
282LATEX_HEADER = latexdocstart.inc
283PDF_HYPERLINKS = YES
284USE_PDFLATEX = YES
285LATEX_BATCHMODE = YES
286LATEX_HIDE_INDICES = NO
287
288#---------------------------------------------------------------------------
289# configuration options related to the RTF output
290#---------------------------------------------------------------------------
291GENERATE_RTF = NO # Only change in format output configs
292RTF_OUTPUT = rtf
293COMPACT_RTF = NO
294RTF_HYPERLINKS = NO
295RTF_STYLESHEET_FILE =
296RTF_EXTENSIONS_FILE =
297
298#---------------------------------------------------------------------------
299# configuration options related to the man page output
300#---------------------------------------------------------------------------
301GENERATE_MAN = NO # Only change in format output configs
302MAN_OUTPUT = man
303MAN_EXTENSION = .3
304MAN_LINKS = NO
305
306#---------------------------------------------------------------------------
307# configuration options related to the XML output
308#---------------------------------------------------------------------------
309GENERATE_XML = NO # Only change in format output configs
310XML_OUTPUT = xml
311XML_SCHEMA =
312XML_DTD =
313XML_PROGRAMLISTING = YES
314
315#---------------------------------------------------------------------------
316# configuration options for the AutoGen Definitions output
317#---------------------------------------------------------------------------
318GENERATE_AUTOGEN_DEF = NO # Only change in format output configs
319
320#---------------------------------------------------------------------------
321# configuration options related to the Perl module output
322#---------------------------------------------------------------------------
323GENERATE_PERLMOD = NO # Only change in format output configs
324PERLMOD_LATEX = YES
325PERLMOD_PRETTY = YES
326PERLMOD_MAKEVAR_PREFIX =
327
328#---------------------------------------------------------------------------
329# Configuration options related to the preprocessor
330#---------------------------------------------------------------------------
331ENABLE_PREPROCESSING = YES
332MACRO_EXPANSION = NO
333EXPAND_ONLY_PREDEF = NO
334SEARCH_INCLUDES = YES
335INCLUDE_PATH =
336INCLUDE_FILE_PATTERNS =
337PREDEFINED =
338EXPAND_AS_DEFINED =
339SKIP_FUNCTION_MACROS = YES
340
341#---------------------------------------------------------------------------
342# Configuration::additions related to external references
343#---------------------------------------------------------------------------
344TAGFILES =
345GENERATE_TAGFILE =
346ALLEXTERNALS = NO
347EXTERNAL_GROUPS = YES
348PERL_PATH = /usr/bin/perl
349
350#---------------------------------------------------------------------------
351# Configuration options related to the dot tool
352#---------------------------------------------------------------------------
353CLASS_DIAGRAMS = YES
354MSCGEN_PATH =
355HIDE_UNDOC_RELATIONS = YES
356HAVE_DOT = YES
357CLASS_GRAPH = NO
358COLLABORATION_GRAPH = NO
359GROUP_GRAPHS = NO
360UML_LOOK = NO
361TEMPLATE_RELATIONS = NO
362INCLUDE_GRAPH = NO
363INCLUDED_BY_GRAPH = NO
364CALL_GRAPH = NO
365CALLER_GRAPH = NO
366GRAPHICAL_HIERARCHY = NO
367DIRECTORY_GRAPH = NO
368DOT_IMAGE_FORMAT = png
369DOT_PATH =
370DOTFILE_DIRS =
371DOT_GRAPH_MAX_NODES = 50
372MAX_DOT_GRAPH_DEPTH = 1000
373DOT_TRANSPARENT = NO
374DOT_MULTI_TARGETS = NO
375GENERATE_LEGEND = YES
376DOT_CLEANUP = YES
377
378#---------------------------------------------------------------------------
379# Configuration::additions related to the search engine
380#---------------------------------------------------------------------------
381SEARCHENGINE = NO
382
wxWidgets (Impactor)