]> 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
Use library-specific description in their version resources for MSW DLLs.
[wxWidgets.git] / docs / doxygen / Doxyfile
... / ...
CommitLineData
1# Doxyfile 1.8.2
2
3#---------------------------------------------------------------------------
4# Project Options
5#---------------------------------------------------------------------------
6
7DOXYFILE_ENCODING = UTF-8
8PROJECT_NAME = wxWidgets
9PROJECT_NUMBER = 2.9.5
10PROJECT_BRIEF =
11PROJECT_LOGO = logo.png
12OUTPUT_DIRECTORY = out
13CREATE_SUBDIRS = NO
14OUTPUT_LANGUAGE = English
15BRIEF_MEMBER_DESC = YES
16REPEAT_BRIEF = YES
17ABBREVIATE_BRIEF =
18ALWAYS_DETAILED_SEC = YES # Default: NO
19INLINE_INHERITED_MEMB = NO
20FULL_PATH_NAMES = YES
21STRIP_FROM_PATH = "$(WXWIDGETS)/"
22STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \
23 "$(WXWIDGETS)/interface/"
24SHORT_NAMES = NO
25JAVADOC_AUTOBRIEF = YES # Default: NO
26QT_AUTOBRIEF = NO
27MULTILINE_CPP_IS_BRIEF = NO
28INHERIT_DOCS = YES
29SEPARATE_MEMBER_PAGES = NO
30TAB_SIZE = 4
31TCL_SUBST =
32OPTIMIZE_OUTPUT_FOR_C = NO
33OPTIMIZE_OUTPUT_JAVA = NO
34OPTIMIZE_FOR_FORTRAN = NO
35OPTIMIZE_OUTPUT_VHDL = NO
36EXTENSION_MAPPING =
37MARKDOWN_SUPPORT = YES
38AUTOLINK_SUPPORT = YES
39BUILTIN_STL_SUPPORT = NO
40CPP_CLI_SUPPORT = NO
41SIP_SUPPORT = NO
42IDL_PROPERTY_SUPPORT = NO # Default: YES
43DISTRIBUTE_GROUP_DOC = YES # Default: NO
44SUBGROUPING = YES
45INLINE_GROUPED_CLASSES = NO # TODO: Examine this setting.
46INLINE_SIMPLE_STRUCTS = NO # TODO: Examine this setting.
47TYPEDEF_HIDES_STRUCT = NO
48SYMBOL_CACHE_SIZE = 0
49LOOKUP_CACHE_SIZE = 0
50
51
52#---------------------------------------------------------------------------
53# Aliases
54#---------------------------------------------------------------------------
55
56# This is the most important part of the wxWidgets Doxyfile. Aliases allow
57# us to keep the headers readable and "implement" wxWidgets-specific commands.
58
59# Aliases for documenting C++ classes
60#---------------------------------------------------------------------------
61
62# aliases to be used by classes which emit wxEvents (e.g. wxWindow, wxTextCtrl, etc):
63ALIASES = beginEventEmissionTable="\n<h2>Events emitted by this class</h2><p>Event macros for events emitted by this class:</p><div>"
64ALIASES += beginEventEmissionTable{1}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros for events emitted by this class:<div>"
65ALIASES += beginEventEmissionTable{2}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros for events emitted by this class:<div>"
66
67# aliases to be used in wxEvent-derived classes:
68ALIASES += beginEventTable{1}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros:<div>"
69ALIASES += beginEventTable{2}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros:<div>"
70
71# common event aliases:
72ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
73ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
74ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
75ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
76ALIASES += endEventTable="</div>\n"
77
78# style aliases
79ALIASES += beginStyleTable="\n<h2>Styles</h2><p>This class supports the following styles:</p><div>"
80ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
81ALIASES += endStyleTable="</div>\n"
82
83# extra style aliases
84ALIASES += beginExtraStyleTable="\n<hr><h2>Extra Styles</h2><p>This class supports the following extra styles:</p><div>"
85ALIASES += endExtraStyleTable="</div>\n"
86
87# flag aliases
88ALIASES += beginFlagTable="<div>"
89ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
90ALIASES += endFlagTable="</div>\n"
91
92# creates appearance section: this should be used for all main GUI controls
93# that look different in different ports. genericAppearance can be used for the
94# controls that always look the same.
95ALIASES += appearance{1}="\htmlonly<div class="appearance"><span class='appearance'>Appearance:</span><table><tr><td>\endhtmlonly\n\image html appear-\1-msw.png \"wxMSW Appearance\"\n\htmlonly</td><td>\endhtmlonly\n\image html appear-\1-gtk.png \"wxGTK Appearance\"\n\htmlonly</td><td>\endhtmlonly\n\image html appear-\1-mac.png \"wxOSX Appearance\"\n\htmlonly</td></tr></table></div>\endhtmlonly"
96ALIASES += genericAppearance{1}="\htmlonly<div class="appearance"><span class='appearance'>Appearance:</span><table class='appearance'><tr><td>\endhtmlonly\n\image html generic/\1 \"Generic Appearance\"\n\htmlonly</td></tr></table></div>\endhtmlonly"
97
98# aliases for the creation of "named member groups"
99# USAGE: the first argument must not contain spaces and be a unique identifier
100# of the member group for the class being documented;
101# the second argument is the member group name and can contain spaces
102# See wxString as an usage example.
103# NOTE: no warnings are given for wrong member group names so be careful and check
104# the doxygen output to verify that there are no typos
105ALIASES += member_group_name{2}="<a name='\1'></a> \name \2"
106ALIASES += ref_member_group{2}="<a href='#\1' class='el'>\2</a>"
107
108# Aliases for documenting any C++ entity
109#---------------------------------------------------------------------------
110
111# aliases for additional wx-specific infos
112ALIASES += 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>"
113ALIASES += 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>"
114ALIASES += category{3}="\ingroup group_class_\1 group_class_\2 group_class_\3 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2, \ref group_class_\3</span></div>"
115ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
116ALIASES += nolibrary="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
117ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
118
119# native implementation infos:
120ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
121ALIASES += 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>"
122ALIASES += 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>"
123ALIASES += 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>"
124
125# onlyfor infos:
126# NOTE: we need to be able to retrieve these infos also from the XML output, thus
127# we use the \xmlonly and \endxmlonly commands to include custom XML tags
128ALIASES += onlyfor{1}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1 port.</div> \xmlonly <onlyfor>\1</onlyfor> \endxmlonly"
129ALIASES += onlyfor{2}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2 ports.</div> \xmlonly <onlyfor>\1,\2</onlyfor> \endxmlonly"
130ALIASES += 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> \xmlonly <onlyfor>\1,\2,\3</onlyfor> \endxmlonly"
131ALIASES += 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> \xmlonly <onlyfor>\1,\2,\3,\4</onlyfor> \endxmlonly"
132
133# Use this in grouped global functions, and macros since they
134# wouldn't otherwise indicate what header they are defined in.
135ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
136
137# some formatting aliases
138ALIASES += true="<span class='literal'>true</span>"
139ALIASES += false="<span class='literal'>false</span>"
140ALIASES += NULL="<span class='literal'>NULL</span>"
141ALIASES += NUL="<span class='literal'>NUL</span>"
142
143# NOTE: these are important as you can't write in the docs
144# just #ifdef since the # character is used by Doxygen
145# for explicit linking; use the following aliases instead!
146# However to avoid overwriting e.g. \if Doxygen command the _
147# character is postfixed
148ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
149ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
150ALIASES += if_="<span class='literal'>\#if</span>"
151ALIASES += endif_="<span class='literal'>\#endif</span>"
152
153# table aliases for 2 and 3 column tables
154ALIASES += beginTable="<table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
155ALIASES += beginInvisibleTable="<table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
156ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
157ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
158ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
159ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
160ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
161ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
162ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
163ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
164ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
165ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
166ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
167ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
168ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
169ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
170ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
171ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
172ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
173ALIASES += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>"
174ALIASES += endTable="</table>"
175
176# definition list aliases
177# a definition list currently is rendered as 2-column table but it may use as
178# well the <dl>, <dt> and <dd> HTML tags in future.
179# In any case a definition list differs from a table because of its semantic
180# nature and because it is always the association of a "title" with a "description"
181# (in contrast a table may have more than 2 columns of data)...
182ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
183ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
184ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
185ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
186ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
187ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
188ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
189ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
190ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
191ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
192ALIASES += endDefList="</table>"
193ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td> @image html gtk-\2.png\n</td><td>\3</td></tr>"
194
195# Aliases for documenting wxPerl/wxPython-specific parts
196#---------------------------------------------------------------------------
197
198# See ENABLED_SECTIONS configuration key for more info about these:
199ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
200ALIASES += endWxPerlOnly="\endif"
201
202# This is to get around a bug in Doxygen that prevents use of '{' or '}'
203# inside of any aliased command in parameters.
204ALIASES += leftCurly="{"
205ALIASES += rightCurly="}"
206
207# Aliases for documenting samples
208#---------------------------------------------------------------------------
209
210# For indicating a sample location
211ALIASES += sampledir{1}="@e Location: @c samples/\1 subdirectory of your wxWidgets installation or http://svn.wxwidgets.org/viewvc/wx/wxWidgets/trunk/samples/\1"
212
213# For refering to the corresponding sample in a class document or a overview
214# Usually placed in the queue of @see
215ALIASES += sample{1}="\ref page_samples_\1"
216
217# For generating a general description for a sample
218# \1 could be a class or an overview or a descriptive sentence
219# Shall be replaced by manual written description soon
220ALIASES += sampleabout{1}="This sample demonstrates \1."
221
222# For indicating the necessary condition of a sample or a class
223# \1 is the wxUSE_XXX macro
224ALIASES += buildwith{1}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info."
225ALIASES += buildwith{2}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> and <tt>\2</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info."
226
227
228#---------------------------------------------------------------------------
229# Build Options
230#---------------------------------------------------------------------------
231
232EXTRACT_ALL = YES # Default: NO
233EXTRACT_PRIVATE = NO
234EXTRACT_PACKAGE = NO
235EXTRACT_STATIC = YES # Default: NO
236EXTRACT_LOCAL_CLASSES = YES
237EXTRACT_LOCAL_METHODS = NO
238EXTRACT_ANON_NSPACES = YES # TODO: Default: NO
239HIDE_UNDOC_MEMBERS = NO
240HIDE_UNDOC_CLASSES = NO
241HIDE_FRIEND_COMPOUNDS = NO
242HIDE_IN_BODY_DOCS = NO
243INTERNAL_DOCS = NO
244CASE_SENSE_NAMES = NO # Default: YES
245HIDE_SCOPE_NAMES = NO
246SHOW_INCLUDE_FILES = YES
247FORCE_LOCAL_INCLUDES = NO
248INLINE_INFO = YES
249SORT_MEMBER_DOCS = YES
250SORT_BRIEF_DOCS = NO # Don't set to YES, it renders our named groups out of order.
251SORT_MEMBERS_CTORS_1ST = NO # Default: NO
252SORT_GROUP_NAMES = YES # Default: NO
253SORT_BY_SCOPE_NAME = NO
254STRICT_PROTO_MATCHING = NO
255GENERATE_TODOLIST = YES
256GENERATE_TESTLIST = YES
257GENERATE_BUGLIST = YES
258GENERATE_DEPRECATEDLIST= YES
259
260# can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
261ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL
262
263MAX_INITIALIZER_LINES = 30
264SHOW_USED_FILES = NO # Default: YES
265SHOW_FILES = YES
266SHOW_NAMESPACES = NO # TODO: Default: YES
267FILE_VERSION_FILTER =
268LAYOUT_FILE = DoxygenLayout.xml
269CITE_BIB_FILES =
270
271
272#---------------------------------------------------------------------------
273# Warning and Progress Message Options
274#---------------------------------------------------------------------------
275
276QUIET = YES # Default: NO
277WARNINGS = YES
278WARN_IF_UNDOCUMENTED = YES
279WARN_IF_DOC_ERROR = YES
280WARN_NO_PARAMDOC = YES # Default: NO
281WARN_FORMAT = "$file:$line: $text"
282WARN_LOGFILE = doxygen.log
283
284
285#---------------------------------------------------------------------------
286# Input File Options
287#---------------------------------------------------------------------------
288
289INPUT = mainpages groups overviews ../../interface
290INPUT_ENCODING = UTF-8
291FILE_PATTERNS = *.h
292RECURSIVE = YES # Default: NO
293EXCLUDE =
294EXCLUDE_SYMLINKS = NO
295EXCLUDE_PATTERNS =
296EXCLUDE_SYMBOLS =
297EXAMPLE_PATH = ../
298EXAMPLE_PATTERNS = *
299EXAMPLE_RECURSIVE = NO
300IMAGE_PATH = images
301INPUT_FILTER =
302FILTER_PATTERNS =
303FILTER_SOURCE_FILES = NO
304FILTER_SOURCE_PATTERNS =
305
306
307#---------------------------------------------------------------------------
308# Source Browsing Options
309#---------------------------------------------------------------------------
310
311SOURCE_BROWSER = NO
312INLINE_SOURCES = NO
313STRIP_CODE_COMMENTS = YES
314REFERENCED_BY_RELATION = NO
315REFERENCES_RELATION = NO
316REFERENCES_LINK_SOURCE = YES
317USE_HTAGS = NO
318VERBATIM_HEADERS = NO # Default: YES
319
320
321#---------------------------------------------------------------------------
322# Alphabetical Class Index Options
323#---------------------------------------------------------------------------
324
325ALPHABETICAL_INDEX = YES
326COLS_IN_ALPHA_INDEX = 5
327IGNORE_PREFIX = wx
328
329
330#---------------------------------------------------------------------------
331# HTML Output Options
332#---------------------------------------------------------------------------
333
334GENERATE_HTML = $(GENERATE_HTML)
335HTML_OUTPUT = html
336HTML_FILE_EXTENSION = .html
337HTML_HEADER = custom_header.html
338HTML_FOOTER = custom_footer.html
339HTML_STYLESHEET =
340HTML_EXTRA_STYLESHEET = extra_stylesheet.css
341HTML_EXTRA_FILES = wxwidgets.js
342HTML_COLORSTYLE_HUE = 220 # Default: 220
343HTML_COLORSTYLE_SAT = 255 # Default: 100
344HTML_COLORSTYLE_GAMMA = 100 # Default: 80
345HTML_TIMESTAMP = YES
346HTML_DYNAMIC_SECTIONS = YES # Default: NO
347HTML_INDEX_NUM_ENTRIES = 100
348DISABLE_INDEX = NO
349ENUM_VALUES_PER_LINE = 1 # Default: 4
350GENERATE_TREEVIEW = NO
351TREEVIEW_WIDTH = 250
352EXT_LINKS_IN_WINDOW = YES # Default: NO
353FORMULA_FONTSIZE = 10
354FORMULA_TRANSPARENT = YES
355USE_MATHJAX = NO
356MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
357MATHJAX_EXTENSIONS =
358SEARCHENGINE = $(SEARCHENGINE)
359SERVER_BASED_SEARCH = $(SERVER_BASED_SEARCH)
360
361
362#---------------------------------------------------------------------------
363# Docset Output Options
364#---------------------------------------------------------------------------
365
366GENERATE_DOCSET = $(GENERATE_DOCSET)
367DOCSET_FEEDNAME = "wxWidgets 2.9"
368DOCSET_BUNDLE_ID = org.wxwidgets.doxygen.wx29
369DOCSET_PUBLISHER_ID = org.wxwidgets.doxygen
370DOCSET_PUBLISHER_NAME = wxWidgets Team
371
372
373#---------------------------------------------------------------------------
374# CHM Output Options
375#---------------------------------------------------------------------------
376
377GENERATE_HTMLHELP = $(GENERATE_HTMLHELP)
378CHM_FILE = ..\wx.chm # Windows style separator is required.
379HHC_LOCATION = hhc.exe
380GENERATE_CHI = NO
381CHM_INDEX_ENCODING =
382BINARY_TOC = NO
383TOC_EXPAND = NO
384
385
386#---------------------------------------------------------------------------
387# QHP Output Options
388#---------------------------------------------------------------------------
389
390GENERATE_QHP = $(GENERATE_QHP)
391QCH_FILE =
392QHP_NAMESPACE = org.wxwidgets.doxygen
393QHP_VIRTUAL_FOLDER = doc
394QHP_CUST_FILTER_NAME =
395QHP_CUST_FILTER_ATTRS =
396QHP_SECT_FILTER_ATTRS =
397QHG_LOCATION =
398
399
400#---------------------------------------------------------------------------
401# Eclipse Output Options
402#---------------------------------------------------------------------------
403
404GENERATE_ECLIPSEHELP = NO
405ECLIPSE_DOC_ID = org.wxwidgets.doxygen
406
407
408#---------------------------------------------------------------------------
409# LaTeX Output Options
410#---------------------------------------------------------------------------
411
412GENERATE_LATEX = $(GENERATE_LATEX)
413LATEX_OUTPUT = latex
414LATEX_CMD_NAME = latex
415MAKEINDEX_CMD_NAME = makeindex
416COMPACT_LATEX = NO
417PAPER_TYPE = a4wide
418EXTRA_PACKAGES =
419LATEX_HEADER = latexdocstart.inc
420LATEX_FOOTER =
421PDF_HYPERLINKS = YES
422USE_PDFLATEX = YES
423LATEX_BATCHMODE = YES # Default: NO
424LATEX_HIDE_INDICES = NO
425LATEX_SOURCE_CODE = NO
426LATEX_BIB_STYLE = plain
427
428
429#---------------------------------------------------------------------------
430# RTF Output Options
431#---------------------------------------------------------------------------
432
433GENERATE_RTF = NO
434RTF_OUTPUT = rtf
435COMPACT_RTF = NO
436RTF_HYPERLINKS = NO
437RTF_STYLESHEET_FILE =
438RTF_EXTENSIONS_FILE =
439
440
441#---------------------------------------------------------------------------
442# Man Page Output Options
443#---------------------------------------------------------------------------
444
445GENERATE_MAN = NO
446MAN_OUTPUT = man
447MAN_EXTENSION = .3
448MAN_LINKS = NO
449
450
451#---------------------------------------------------------------------------
452# XML Output Options
453#---------------------------------------------------------------------------
454
455GENERATE_XML = $(GENERATE_XML)
456XML_OUTPUT = xml
457XML_SCHEMA =
458XML_DTD =
459XML_PROGRAMLISTING = NO # Default: YES
460
461
462#---------------------------------------------------------------------------
463# AutoGen Definitions Output Options
464#---------------------------------------------------------------------------
465
466GENERATE_AUTOGEN_DEF = NO
467
468
469#---------------------------------------------------------------------------
470# Perl Module Output Options
471#---------------------------------------------------------------------------
472
473GENERATE_PERLMOD = NO
474PERLMOD_LATEX = YES # Default: NO
475PERLMOD_PRETTY = YES
476PERLMOD_MAKEVAR_PREFIX =
477
478
479#---------------------------------------------------------------------------
480# Preprocessor Options
481#---------------------------------------------------------------------------
482
483ENABLE_PREPROCESSING = YES
484MACRO_EXPANSION = NO
485EXPAND_ONLY_PREDEF = NO
486SEARCH_INCLUDES = YES
487INCLUDE_PATH =
488INCLUDE_FILE_PATTERNS =
489PREDEFINED = wxUSE_BASE wxUSE_GUI
490EXPAND_AS_DEFINED =
491SKIP_FUNCTION_MACROS = YES
492
493
494#---------------------------------------------------------------------------
495# Additions Related to External References
496#---------------------------------------------------------------------------
497
498TAGFILES =
499GENERATE_TAGFILE =
500ALLEXTERNALS = NO
501EXTERNAL_GROUPS = YES
502PERL_PATH = /usr/bin/perl
503
504
505#---------------------------------------------------------------------------
506# dot Tool Options
507#---------------------------------------------------------------------------
508
509CLASS_DIAGRAMS = YES
510MSCGEN_PATH =
511HIDE_UNDOC_RELATIONS = YES
512HAVE_DOT = YES # Default: NO
513DOT_NUM_THREADS = 0
514DOT_FONTNAME = FreeSans # Default: Helvetica
515DOT_FONTSIZE = 10
516DOT_FONTPATH =
517CLASS_GRAPH = YES
518COLLABORATION_GRAPH = NO # Default: YES
519GROUP_GRAPHS = NO # Default: YES
520UML_LOOK = NO
521UML_LIMIT_NUM_FIELDS = 10
522TEMPLATE_RELATIONS = NO
523INCLUDE_GRAPH = NO # Default: YES
524INCLUDED_BY_GRAPH = NO # Default: YES
525CALL_GRAPH = NO
526CALLER_GRAPH = NO
527GRAPHICAL_HIERARCHY = NO # TODO: Default: YES
528DIRECTORY_GRAPH = NO # Default: YES
529DOT_IMAGE_FORMAT = png
530INTERACTIVE_SVG = NO
531DOTFILE_DIRS =
532MSCFILE_DIRS =
533DOT_GRAPH_MAX_NODES = 50
534MAX_DOT_GRAPH_DEPTH = 1000 # Default: 0
535DOT_TRANSPARENT = NO
536DOT_MULTI_TARGETS = NO
537GENERATE_LEGEND = YES
538DOT_CLEANUP = YES
539
540# Instead of setting a value for DOT_PATH it's easier and more portable to
541# put your dot utility in the PATH. On Windows you'll need to install GraphViz
542# tools, and then manually add it to the PATH environment variable.
543DOT_PATH =
wxWidgets (Impactor)