]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/Doxyfile
added wxWidgets samples
[wxWidgets.git] / docs / doxygen / Doxyfile
CommitLineData
15b6757b
FM
1#############################################################################
2## Name: Doxyfile
3## Purpose: Doxygen configuration file for wxWidgets manual
4## Author: wxWidgets team
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
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
64# misc aliases
375c892e
FM
65ALIASES += library{1}="\section class_lib Library\n \ref \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"
15b6757b
FM
76
77# some formatting aliases
375c892e
FM
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>"
15b6757b 84
a3465294 85# these are useful for creation of tables
375c892e
FM
86ALIASES += beginTable="<center><table class='doctable'>"
87ALIASES += beginInvisibleTable="<center><table class='doctable' border='0'>"
88ALIASES += row{2}="<tr><td>\1</td> <td>\2</td></tr>"
89ALIASES += row{3}="<tr><td>\1</td> <td>\2 \3</td></tr>"
90ALIASES += row{4}="<tr><td>\1</td> <td>\2 \3 \4</td></tr>"
91ALIASES += endTable="</table></center>"
a3465294 92
375c892e
FM
93# NOTE: we could put aliases also for e.g. @wxDefaultSize, @wxDefaultPosition, @wxID_ANY,
94# @wxEmptyString, @wxNullIcon, etc etc
15b6757b 95
a3465294
FM
96# NOTE: these are important as you can't write in the docs
97# just #ifdef since the # character is used by Doxygen
98# for explicit linking; use the following aliases instead!
375c892e
FM
99ALIASES += ifdef="<b><tt>\#ifdef</tt></b>"
100ALIASES += ifndef="<b><tt>\#ifndef</tt></b>"
101ALIASES += if="<b><tt>\#if</tt></b>" # NOTE: this overrides the Doxygen \if command
102ALIASES += endif="<b><tt>\#endif</tt></b>"
a3465294 103
15b6757b
FM
104
105#---------------------------------------------------------------------------
106# Build related configuration options
107#---------------------------------------------------------------------------
108EXTRACT_ALL = YES
109EXTRACT_PRIVATE = NO
110EXTRACT_STATIC = YES
111EXTRACT_LOCAL_CLASSES = YES
112EXTRACT_LOCAL_METHODS = NO
113EXTRACT_ANON_NSPACES = YES
114HIDE_UNDOC_MEMBERS = YES
115HIDE_UNDOC_CLASSES = YES
116HIDE_FRIEND_COMPOUNDS = NO
117HIDE_IN_BODY_DOCS = NO
118INTERNAL_DOCS = NO
119CASE_SENSE_NAMES = NO
120HIDE_SCOPE_NAMES = NO
121SHOW_INCLUDE_FILES = YES
122INLINE_INFO = YES
123SORT_MEMBER_DOCS = YES
124SORT_BRIEF_DOCS = YES
125SORT_BY_SCOPE_NAME = NO
126GENERATE_TODOLIST = YES
127GENERATE_TESTLIST = YES
128GENERATE_BUGLIST = YES
129GENERATE_DEPRECATEDLIST= YES
130ENABLED_SECTIONS =
131MAX_INITIALIZER_LINES = 30
132SHOW_USED_FILES = YES
133SHOW_DIRECTORIES = NO
134FILE_VERSION_FILTER =
135
136#---------------------------------------------------------------------------
137# configuration options related to warning and progress messages
138#---------------------------------------------------------------------------
139QUIET = NO
140WARNINGS = YES
141WARN_IF_UNDOCUMENTED = NO
142WARN_IF_DOC_ERROR = YES
143WARN_NO_PARAMDOC = NO
144WARN_FORMAT = "$file:$line: $text "
4411a6b6 145WARN_LOGFILE = doxygen.log
15b6757b
FM
146
147#---------------------------------------------------------------------------
148# configuration options related to the input files
149#---------------------------------------------------------------------------
a3465294 150INPUT = . ./overviews ../../interface
15b6757b
FM
151INPUT_ENCODING = UTF-8
152FILE_PATTERNS = *.h *.txt
153RECURSIVE = YES
154EXCLUDE =
155EXCLUDE_SYMLINKS = NO
156EXCLUDE_PATTERNS =
157EXCLUDE_SYMBOLS =
158EXAMPLE_PATH =
159EXAMPLE_PATTERNS = *
160EXAMPLE_RECURSIVE = YES
4411a6b6 161IMAGE_PATH = images
15b6757b
FM
162INPUT_FILTER =
163FILTER_PATTERNS =
164FILTER_SOURCE_FILES = NO
165
166#---------------------------------------------------------------------------
167# configuration options related to source browsing
168#---------------------------------------------------------------------------
169SOURCE_BROWSER = NO
170INLINE_SOURCES = NO
171STRIP_CODE_COMMENTS = YES
172REFERENCED_BY_RELATION = NO
173REFERENCES_RELATION = NO
174REFERENCES_LINK_SOURCE = YES
175USE_HTAGS = NO
176VERBATIM_HEADERS = NO
177
178#---------------------------------------------------------------------------
179# configuration options related to the alphabetical class index
180#---------------------------------------------------------------------------
181ALPHABETICAL_INDEX = YES
182COLS_IN_ALPHA_INDEX = 5
183IGNORE_PREFIX = wx
184
185#---------------------------------------------------------------------------
186# configuration options related to the HTML output
187#---------------------------------------------------------------------------
188GENERATE_HTML = YES
189HTML_OUTPUT = html
190HTML_FILE_EXTENSION = .html
191HTML_HEADER = htmlheader.inc
192HTML_FOOTER = htmlfooter.inc
193HTML_STYLESHEET =
194HTML_ALIGN_MEMBERS = YES
195GENERATE_HTMLHELP = NO
196HTML_DYNAMIC_SECTIONS = NO
197CHM_FILE =
198HHC_LOCATION =
199GENERATE_CHI = NO
200BINARY_TOC = NO
201TOC_EXPAND = NO
202DISABLE_INDEX = NO
203ENUM_VALUES_PER_LINE = 4
204GENERATE_TREEVIEW = NO
205TREEVIEW_WIDTH = 250
206
207#---------------------------------------------------------------------------
208# configuration options related to the LaTeX output
209#---------------------------------------------------------------------------
210GENERATE_LATEX = NO
211LATEX_OUTPUT = latex
212LATEX_CMD_NAME = latex
213MAKEINDEX_CMD_NAME = makeindex
214COMPACT_LATEX = NO
215PAPER_TYPE = a4wide
216EXTRA_PACKAGES =
217LATEX_HEADER =
218PDF_HYPERLINKS = NO
219USE_PDFLATEX = NO
220LATEX_BATCHMODE = NO
221LATEX_HIDE_INDICES = NO
222
223#---------------------------------------------------------------------------
224# configuration options related to the RTF output
225#---------------------------------------------------------------------------
226GENERATE_RTF = NO
227RTF_OUTPUT = rtf
228COMPACT_RTF = NO
229RTF_HYPERLINKS = NO
230RTF_STYLESHEET_FILE =
231RTF_EXTENSIONS_FILE =
232
233#---------------------------------------------------------------------------
234# configuration options related to the man page output
235#---------------------------------------------------------------------------
236GENERATE_MAN = NO
237MAN_OUTPUT = man
238MAN_EXTENSION = .3
239MAN_LINKS = NO
240
241#---------------------------------------------------------------------------
242# configuration options related to the XML output
243#---------------------------------------------------------------------------
a3465294 244GENERATE_XML = NO
15b6757b
FM
245XML_OUTPUT = xml
246XML_SCHEMA =
247XML_DTD =
248XML_PROGRAMLISTING = YES
249
250#---------------------------------------------------------------------------
251# configuration options for the AutoGen Definitions output
252#---------------------------------------------------------------------------
253GENERATE_AUTOGEN_DEF = NO
254
255#---------------------------------------------------------------------------
256# configuration options related to the Perl module output
257#---------------------------------------------------------------------------
258GENERATE_PERLMOD = NO
259PERLMOD_LATEX = NO
260PERLMOD_PRETTY = YES
261PERLMOD_MAKEVAR_PREFIX =
262
263#---------------------------------------------------------------------------
264# Configuration options related to the preprocessor
265#---------------------------------------------------------------------------
266ENABLE_PREPROCESSING = YES
267MACRO_EXPANSION = NO
268EXPAND_ONLY_PREDEF = NO
269SEARCH_INCLUDES = YES
270INCLUDE_PATH =
271INCLUDE_FILE_PATTERNS =
272PREDEFINED =
273EXPAND_AS_DEFINED =
274SKIP_FUNCTION_MACROS = YES
275
276#---------------------------------------------------------------------------
277# Configuration::additions related to external references
278#---------------------------------------------------------------------------
279TAGFILES =
280GENERATE_TAGFILE =
281ALLEXTERNALS = NO
282EXTERNAL_GROUPS = YES
283PERL_PATH = /usr/bin/perl
284
285#---------------------------------------------------------------------------
286# Configuration options related to the dot tool
287#---------------------------------------------------------------------------
288CLASS_DIAGRAMS = YES
289MSCGEN_PATH =
290HIDE_UNDOC_RELATIONS = YES
291HAVE_DOT = YES
292CLASS_GRAPH = NO
293COLLABORATION_GRAPH = NO
294GROUP_GRAPHS = NO
295UML_LOOK = NO
296TEMPLATE_RELATIONS = NO
297INCLUDE_GRAPH = NO
298INCLUDED_BY_GRAPH = NO
299CALL_GRAPH = NO
300CALLER_GRAPH = NO
301GRAPHICAL_HIERARCHY = NO
302DIRECTORY_GRAPH = NO
303DOT_IMAGE_FORMAT = png
304DOT_PATH =
305DOTFILE_DIRS =
306DOT_GRAPH_MAX_NODES = 50
307MAX_DOT_GRAPH_DEPTH = 1000
308DOT_TRANSPARENT = NO
309DOT_MULTI_TARGETS = NO
310GENERATE_LEGEND = YES
311DOT_CLEANUP = YES
312
313#---------------------------------------------------------------------------
314# Configuration::additions related to the search engine
315#---------------------------------------------------------------------------
316SEARCHENGINE = YES