]> 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
added initial version of the Doxygen manual
[wxWidgets.git] / docs / doxygen / Doxyfile
... / ...
CommitLineData
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
50ALIASES = beginEventTable="\section events Events\n"
51ALIASES += event{1}="\li \b \1"
52ALIASES += event{2}="\li \b \1, \2"
53ALIASES += endEventTable="\n"
54
55# style aliases
56ALIASES += beginStyleTable="\section styles Styles\n"
57ALIASES += style{1}="\li \b \1"
58ALIASES += endStyleTable="\n"
59
60# extra style aliases
61ALIASES += beginExtraStyleTable="\section extrastyles Extra Styles\n"
62ALIASES += endExtraStyleTable="\n"
63
64# misc aliases
65ALIASES += library{1}="\section lib Library\n \b \1"
66ALIASES += seealso="\section sa See also\n" # the default \sa command does not generate a \section!
67ALIASES += stdobjects="\section stdobj Predefined objects\n \b"
68
69# some formatting aliases
70ALIASES += true="\b true"
71ALIASES += false="\b false"
72ALIASES += NULL="\b NULL"
73
74# NOTE: we could put aliases also for e.g. @wxDefaultSize, @wxDefaultPosition, @wxID_ANY, etc
75
76
77#---------------------------------------------------------------------------
78# Build related configuration options
79#---------------------------------------------------------------------------
80EXTRACT_ALL = YES
81EXTRACT_PRIVATE = NO
82EXTRACT_STATIC = YES
83EXTRACT_LOCAL_CLASSES = YES
84EXTRACT_LOCAL_METHODS = NO
85EXTRACT_ANON_NSPACES = YES
86HIDE_UNDOC_MEMBERS = YES
87HIDE_UNDOC_CLASSES = YES
88HIDE_FRIEND_COMPOUNDS = NO
89HIDE_IN_BODY_DOCS = NO
90INTERNAL_DOCS = NO
91CASE_SENSE_NAMES = NO
92HIDE_SCOPE_NAMES = NO
93SHOW_INCLUDE_FILES = YES
94INLINE_INFO = YES
95SORT_MEMBER_DOCS = YES
96SORT_BRIEF_DOCS = YES
97SORT_BY_SCOPE_NAME = NO
98GENERATE_TODOLIST = YES
99GENERATE_TESTLIST = YES
100GENERATE_BUGLIST = YES
101GENERATE_DEPRECATEDLIST= YES
102ENABLED_SECTIONS =
103MAX_INITIALIZER_LINES = 30
104SHOW_USED_FILES = YES
105SHOW_DIRECTORIES = NO
106FILE_VERSION_FILTER =
107
108#---------------------------------------------------------------------------
109# configuration options related to warning and progress messages
110#---------------------------------------------------------------------------
111QUIET = NO
112WARNINGS = YES
113WARN_IF_UNDOCUMENTED = NO
114WARN_IF_DOC_ERROR = YES
115WARN_NO_PARAMDOC = NO
116WARN_FORMAT = "$file:$line: $text "
117WARN_LOGFILE =
118
119#---------------------------------------------------------------------------
120# configuration options related to the input files
121#---------------------------------------------------------------------------
122INPUT = . ./overviews ../../include/interface
123INPUT_ENCODING = UTF-8
124FILE_PATTERNS = *.h *.txt
125RECURSIVE = YES
126EXCLUDE =
127EXCLUDE_SYMLINKS = NO
128EXCLUDE_PATTERNS =
129EXCLUDE_SYMBOLS =
130EXAMPLE_PATH =
131EXAMPLE_PATTERNS = *
132EXAMPLE_RECURSIVE = YES
133IMAGE_PATH = .
134INPUT_FILTER =
135FILTER_PATTERNS =
136FILTER_SOURCE_FILES = NO
137
138#---------------------------------------------------------------------------
139# configuration options related to source browsing
140#---------------------------------------------------------------------------
141SOURCE_BROWSER = NO
142INLINE_SOURCES = NO
143STRIP_CODE_COMMENTS = YES
144REFERENCED_BY_RELATION = NO
145REFERENCES_RELATION = NO
146REFERENCES_LINK_SOURCE = YES
147USE_HTAGS = NO
148VERBATIM_HEADERS = NO
149
150#---------------------------------------------------------------------------
151# configuration options related to the alphabetical class index
152#---------------------------------------------------------------------------
153ALPHABETICAL_INDEX = YES
154COLS_IN_ALPHA_INDEX = 5
155IGNORE_PREFIX = wx
156
157#---------------------------------------------------------------------------
158# configuration options related to the HTML output
159#---------------------------------------------------------------------------
160GENERATE_HTML = YES
161HTML_OUTPUT = html
162HTML_FILE_EXTENSION = .html
163HTML_HEADER = htmlheader.inc
164HTML_FOOTER = htmlfooter.inc
165HTML_STYLESHEET =
166HTML_ALIGN_MEMBERS = YES
167GENERATE_HTMLHELP = NO
168HTML_DYNAMIC_SECTIONS = NO
169CHM_FILE =
170HHC_LOCATION =
171GENERATE_CHI = NO
172BINARY_TOC = NO
173TOC_EXPAND = NO
174DISABLE_INDEX = NO
175ENUM_VALUES_PER_LINE = 4
176GENERATE_TREEVIEW = NO
177TREEVIEW_WIDTH = 250
178
179#---------------------------------------------------------------------------
180# configuration options related to the LaTeX output
181#---------------------------------------------------------------------------
182GENERATE_LATEX = NO
183LATEX_OUTPUT = latex
184LATEX_CMD_NAME = latex
185MAKEINDEX_CMD_NAME = makeindex
186COMPACT_LATEX = NO
187PAPER_TYPE = a4wide
188EXTRA_PACKAGES =
189LATEX_HEADER =
190PDF_HYPERLINKS = NO
191USE_PDFLATEX = NO
192LATEX_BATCHMODE = NO
193LATEX_HIDE_INDICES = NO
194
195#---------------------------------------------------------------------------
196# configuration options related to the RTF output
197#---------------------------------------------------------------------------
198GENERATE_RTF = NO
199RTF_OUTPUT = rtf
200COMPACT_RTF = NO
201RTF_HYPERLINKS = NO
202RTF_STYLESHEET_FILE =
203RTF_EXTENSIONS_FILE =
204
205#---------------------------------------------------------------------------
206# configuration options related to the man page output
207#---------------------------------------------------------------------------
208GENERATE_MAN = NO
209MAN_OUTPUT = man
210MAN_EXTENSION = .3
211MAN_LINKS = NO
212
213#---------------------------------------------------------------------------
214# configuration options related to the XML output
215#---------------------------------------------------------------------------
216GENERATE_XML = YES
217XML_OUTPUT = xml
218XML_SCHEMA =
219XML_DTD =
220XML_PROGRAMLISTING = YES
221
222#---------------------------------------------------------------------------
223# configuration options for the AutoGen Definitions output
224#---------------------------------------------------------------------------
225GENERATE_AUTOGEN_DEF = NO
226
227#---------------------------------------------------------------------------
228# configuration options related to the Perl module output
229#---------------------------------------------------------------------------
230GENERATE_PERLMOD = NO
231PERLMOD_LATEX = NO
232PERLMOD_PRETTY = YES
233PERLMOD_MAKEVAR_PREFIX =
234
235#---------------------------------------------------------------------------
236# Configuration options related to the preprocessor
237#---------------------------------------------------------------------------
238ENABLE_PREPROCESSING = YES
239MACRO_EXPANSION = NO
240EXPAND_ONLY_PREDEF = NO
241SEARCH_INCLUDES = YES
242INCLUDE_PATH =
243INCLUDE_FILE_PATTERNS =
244PREDEFINED =
245EXPAND_AS_DEFINED =
246SKIP_FUNCTION_MACROS = YES
247
248#---------------------------------------------------------------------------
249# Configuration::additions related to external references
250#---------------------------------------------------------------------------
251TAGFILES =
252GENERATE_TAGFILE =
253ALLEXTERNALS = NO
254EXTERNAL_GROUPS = YES
255PERL_PATH = /usr/bin/perl
256
257#---------------------------------------------------------------------------
258# Configuration options related to the dot tool
259#---------------------------------------------------------------------------
260CLASS_DIAGRAMS = YES
261MSCGEN_PATH =
262HIDE_UNDOC_RELATIONS = YES
263HAVE_DOT = YES
264CLASS_GRAPH = NO
265COLLABORATION_GRAPH = NO
266GROUP_GRAPHS = NO
267UML_LOOK = NO
268TEMPLATE_RELATIONS = NO
269INCLUDE_GRAPH = NO
270INCLUDED_BY_GRAPH = NO
271CALL_GRAPH = NO
272CALLER_GRAPH = NO
273GRAPHICAL_HIERARCHY = NO
274DIRECTORY_GRAPH = NO
275DOT_IMAGE_FORMAT = png
276DOT_PATH =
277DOTFILE_DIRS =
278DOT_GRAPH_MAX_NODES = 50
279MAX_DOT_GRAPH_DEPTH = 1000
280DOT_TRANSPARENT = NO
281DOT_MULTI_TARGETS = NO
282GENERATE_LEGEND = YES
283DOT_CLEANUP = YES
284
285#---------------------------------------------------------------------------
286# Configuration::additions related to the search engine
287#---------------------------------------------------------------------------
288SEARCHENGINE = YES
wxWidgets (Impactor)