]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/Doxyfile_inc
Fix discrepancy between different ways of measuring text extents under Mac.
[wxWidgets.git] / docs / doxygen / Doxyfile_inc
CommitLineData
15b6757b 1#############################################################################
be151c9a 2## Name: Doxyfile_inc
de87600c 3## Purpose: Main configuration file for the wxWidgets manual
4514447c 4## Author: Francesco Montorsi
15b6757b
FM
5## RCS-ID: $Id$
6## Licence: wxWindows license
7#############################################################################
8
9#---------------------------------------------------------------------------
10da75d0 10# Project Options
15b6757b
FM
11#---------------------------------------------------------------------------
12
13DOXYFILE_ENCODING = UTF-8
14PROJECT_NAME = wxWidgets
f3239c21 15PROJECT_NUMBER = 2.9.1
15b6757b
FM
16OUTPUT_DIRECTORY = out
17CREATE_SUBDIRS = NO
18OUTPUT_LANGUAGE = English
19BRIEF_MEMBER_DESC = YES
7a4370a3 20REPEAT_BRIEF = YES
15b6757b
FM
21ABBREVIATE_BRIEF =
22ALWAYS_DETAILED_SEC = YES
23INLINE_INHERITED_MEMB = NO
10da75d0
BP
24FULL_PATH_NAMES = YES
25STRIP_FROM_PATH = "$(WXWIDGETS)/"
26STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \
27 "$(WXWIDGETS)/interface/"
15b6757b 28SHORT_NAMES = NO
4e021c31 29JAVADOC_AUTOBRIEF = YES
15b6757b
FM
30QT_AUTOBRIEF = NO
31MULTILINE_CPP_IS_BRIEF = NO
15b6757b
FM
32INHERIT_DOCS = YES
33SEPARATE_MEMBER_PAGES = NO
34TAB_SIZE = 4
35OPTIMIZE_OUTPUT_FOR_C = NO
36OPTIMIZE_OUTPUT_JAVA = NO
0d0dc584
BP
37OPTIMIZE_FOR_FORTRAN = NO
38OPTIMIZE_OUTPUT_VHDL = NO
15b6757b
FM
39BUILTIN_STL_SUPPORT = NO
40CPP_CLI_SUPPORT = NO
0d0dc584
BP
41SIP_SUPPORT = NO
42IDL_PROPERTY_SUPPORT = NO
23324ae1 43DISTRIBUTE_GROUP_DOC = YES
15b6757b 44SUBGROUPING = YES
0d0dc584
BP
45TYPEDEF_HIDES_STRUCT = NO
46SYMBOL_CACHE_SIZE = 0
15b6757b 47
94802614
FM
48# This is the most important part of the wxWidgets Doxyfile; aliases allow
49# us to keep the headers readable and "implement" wxWidgets-specific commands:
50
15b6757b 51#---------------------------------------------------------------------------
94802614 52# Aliases - for use when documenting C++ classes
15b6757b
FM
53#---------------------------------------------------------------------------
54
3051a44a
FM
55# aliases to be used by classes which emit wxEvents (e.g. wxWindow, wxTextCtrl, etc):
56ALIASES = beginEventEmissionTable="\n<h2>Events emitted by this class</h2><p>Event macros for events emitted by this class:</p><div>"
57ALIASES += 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>"
58ALIASES += 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>"
59
60# aliases to be used in wxEvent-derived classes:
61ALIASES += 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>"
62ALIASES += 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>"
63
64# common event aliases:
8c6791e4
FM
65ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
66ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
67ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
68ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
69ALIASES += endEventTable="</div>\n"
15b6757b
FM
70
71# style aliases
0d0dc584 72ALIASES += beginStyleTable="\n<h2>Styles</h2><p>This class supports the following styles:</p><div>"
8c6791e4
FM
73ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
74ALIASES += endStyleTable="</div>\n"
15b6757b
FM
75
76# extra style aliases
0d0dc584 77ALIASES += beginExtraStyleTable="\n<hr><h2>Extra styles</h2><p>This class supports the following extra styles:</p><div>"
8c6791e4 78ALIASES += endExtraStyleTable="</div>\n"
469e56bf 79
09a728e1
FM
80# flag aliases
81ALIASES += beginFlagTable="<div>"
82ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
83ALIASES += endFlagTable="</div>\n"
84
94802614
FM
85# creates appearance section: this should be used for all main GUI controls
86ALIASES += appearance{1}="\htmlonly <br><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
ee49f540
FM
88# aliases for the creation of "named member groups"
89# USAGE: the first argument must not contain spaces and be a unique identifier
90# of the member group for the class being documented;
91# the second argument is the member group name and can contain spaces
92# See wxString as an usage example.
93# NOTE: no warnings are given for wrong member group names so be careful and check
94# the doxygen output to verify that there are no typos
95ALIASES += member_group_name{2}="<a name='\1'></a> \name \2"
96ALIASES += ref_member_group{2}="<a href='#\1' class='el'>\2</a>"
97
98
94802614
FM
99#---------------------------------------------------------------------------
100# Aliases - for use when documenting any C++ entity
101#---------------------------------------------------------------------------
102
e1ebc6f4 103# aliases for additional wx-specific infos
4cbfec15
FM
104ALIASES += 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>"
105ALIASES += 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>"
3c99e2fd 106ALIASES += 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>"
0d0dc584
BP
107ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
108ALIASES += 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>"
4f960cd1 109ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
e1ebc6f4
FM
110
111# native implementation infos:
f59be7c6
FM
112ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
113ALIASES += 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>"
114ALIASES += 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>"
115ALIASES += 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>"
e1ebc6f4
FM
116
117# onlyfor infos:
03d4f7b9
FM
118# NOTE: we need to be able to retrieve these infos also from the XML output, thus
119# we use the \xmlonly and \endxmlonly commands to include custom XML tags
120ALIASES += 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"
121ALIASES += 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"
122ALIASES += 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"
123ALIASES += 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"
048398c7 124
12f5e1e7
BP
125# Use this in grouped global functions, and macros since they
126# wouldn't otherwise indicate what header they are defined in.
e1ebc6f4
FM
127ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
128
15b6757b 129# some formatting aliases
44fe9ffc
FM
130ALIASES += true="<span class='literal'>true</span>"
131ALIASES += false="<span class='literal'>false</span>"
132ALIASES += NULL="<span class='literal'>NULL</span>"
8d740f72 133ALIASES += NUL="<span class='literal'>NUL</span>"
44fe9ffc
FM
134
135# NOTE: these are important as you can't write in the docs
136# just #ifdef since the # character is used by Doxygen
137# for explicit linking; use the following aliases instead!
138# However to avoid overwriting e.g. \if Doxygen command the _
139# character is postfixed
140ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
141ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
142ALIASES += if_="<span class='literal'>\#if</span>"
143ALIASES += endif_="<span class='literal'>\#endif</span>"
15b6757b 144
4514447c 145# table aliases for 2 and 3 column tables
a6d7c65b
VS
146ALIASES += beginTable="<table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
147ALIASES += beginInvisibleTable="<table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
4514447c
FM
148ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
149ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
150ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
151ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
152ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
153ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
154ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
155ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
156ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
157ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
158ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
159ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
160ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
161ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
162ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
163ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
164ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
a302d595 165ALIASES += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>"
a6d7c65b 166ALIASES += endTable="</table>"
a3465294 167
4514447c
FM
168# definition list aliases
169# a definition list currently is rendered as 2-column table but it may use as
170# well the <dl>, <dt> and <dd> HTML tags in future.
171# In any case a definition list differs from a table because of its semantic
172# nature and because it is always the association of a "title" with a "description"
173# (in contrast a table may have more than 2 columns of data)...
dc215c81 174ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
0aaf0255
FM
175ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
176ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
177ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
178ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
179ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
180ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
181ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
182ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
183ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
4514447c 184ALIASES += endDefList="</table>"
808b128e 185ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td> @image html gtk-\2.png\n</td><td>\3</td></tr>"
4514447c 186
94802614
FM
187#---------------------------------------------------------------------------
188# Aliases - for use when documenting wxPerl/wxPython-specific parts
189#---------------------------------------------------------------------------
190
d54cf7ff 191# See ENABLED_SECTIONS configuration key for more info about these:
f09b5681 192ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
d54cf7ff 193ALIASES += endWxPerlOnly="\endif"
f09b5681 194ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> "
d54cf7ff 195ALIASES += endWxPythonOnly="\endif"
a3465294 196
877b5c30
BP
197# This is to get around a bug in Doxygen that prevents use of '{' or '}'
198# inside of any aliased command in parameters.
199ALIASES += leftCurly="{"
200ALIASES += rightCurly="}"
201
94802614
FM
202#---------------------------------------------------------------------------
203# Aliases - for use when documenting samples
204#---------------------------------------------------------------------------
205
5d4cca7f
BP
206# For indicating the a directory containing a sample
207ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim"
94802614 208
57b2bba4 209# For refering to the corresponding sample in a class document or a overview
5d4cca7f
BP
210# Usually placed in the queue of @see
211ALIASES += sample{1}="\ref page_samples_\1"
94802614 212
57b2bba4
BP
213# For generating a general description for a sample
214# \1 could be a class or an overview or a descriptive sentence
5d4cca7f
BP
215# Shall be replaced by manual written description soon
216ALIASES += sampleabout{1}="This sample demonstrates \1."
94802614 217
5d4cca7f
BP
218# For indicating the necessary condition of a sample or a class
219# \1 is the wxUSE_XXX macro
220ALIASES += 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."
221ALIASES += 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."
222
15b6757b 223#---------------------------------------------------------------------------
10da75d0 224# Build Options
15b6757b 225#---------------------------------------------------------------------------
10da75d0 226
15b6757b
FM
227EXTRACT_ALL = YES
228EXTRACT_PRIVATE = NO
229EXTRACT_STATIC = YES
230EXTRACT_LOCAL_CLASSES = YES
231EXTRACT_LOCAL_METHODS = NO
232EXTRACT_ANON_NSPACES = YES
23324ae1
FM
233HIDE_UNDOC_MEMBERS = NO
234HIDE_UNDOC_CLASSES = NO
15b6757b
FM
235HIDE_FRIEND_COMPOUNDS = NO
236HIDE_IN_BODY_DOCS = NO
237INTERNAL_DOCS = NO
238CASE_SENSE_NAMES = NO
239HIDE_SCOPE_NAMES = NO
240SHOW_INCLUDE_FILES = YES
241INLINE_INFO = YES
242SORT_MEMBER_DOCS = YES
0d0dc584
BP
243SORT_BRIEF_DOCS = NO # Don't set to YES, it renders our named groups out of order.
244SORT_GROUP_NAMES = YES
15b6757b
FM
245SORT_BY_SCOPE_NAME = NO
246GENERATE_TODOLIST = YES
247GENERATE_TESTLIST = YES
248GENERATE_BUGLIST = YES
249GENERATE_DEPRECATEDLIST= YES
d54cf7ff
FM
250
251# can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
dc215c81 252ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL
d54cf7ff 253
15b6757b 254MAX_INITIALIZER_LINES = 30
10da75d0 255SHOW_USED_FILES = NO
23324ae1 256SHOW_DIRECTORIES = YES
0d0dc584
BP
257SHOW_FILES = YES
258SHOW_NAMESPACES = NO
6783cae4 259FILE_VERSION_FILTER =
0d0dc584 260LAYOUT_FILE = DoxygenLayout.xml
15b6757b
FM
261
262#---------------------------------------------------------------------------
10da75d0 263# Warning and Progress Message Options
15b6757b 264#---------------------------------------------------------------------------
10da75d0 265
f159c6b5 266QUIET = YES
15b6757b 267WARNINGS = YES
90a47090 268WARN_IF_UNDOCUMENTED = YES
15b6757b 269WARN_IF_DOC_ERROR = YES
23324ae1 270WARN_NO_PARAMDOC = YES
15b6757b 271WARN_FORMAT = "$file:$line: $text "
4411a6b6 272WARN_LOGFILE = doxygen.log
15b6757b
FM
273
274#---------------------------------------------------------------------------
10da75d0 275# Input File Options
15b6757b 276#---------------------------------------------------------------------------
10da75d0 277
c83e60aa 278INPUT = ./mainpages ./groups ./overviews ../../interface
15b6757b
FM
279INPUT_ENCODING = UTF-8
280FILE_PATTERNS = *.h *.txt
281RECURSIVE = YES
6783cae4 282EXCLUDE =
15b6757b 283EXCLUDE_SYMLINKS = NO
6783cae4
FM
284EXCLUDE_PATTERNS =
285EXCLUDE_SYMBOLS =
29f86fc1 286EXAMPLE_PATH = ../
15b6757b 287EXAMPLE_PATTERNS = *
29f86fc1 288EXAMPLE_RECURSIVE = NO
4411a6b6 289IMAGE_PATH = images
6783cae4
FM
290INPUT_FILTER =
291FILTER_PATTERNS =
15b6757b
FM
292FILTER_SOURCE_FILES = NO
293
294#---------------------------------------------------------------------------
10da75d0 295# Source Browsing Options
15b6757b 296#---------------------------------------------------------------------------
10da75d0 297
15b6757b
FM
298SOURCE_BROWSER = NO
299INLINE_SOURCES = NO
300STRIP_CODE_COMMENTS = YES
301REFERENCED_BY_RELATION = NO
302REFERENCES_RELATION = NO
303REFERENCES_LINK_SOURCE = YES
304USE_HTAGS = NO
305VERBATIM_HEADERS = NO
306
307#---------------------------------------------------------------------------
10da75d0 308# Alphabetical Class Index Options
15b6757b 309#---------------------------------------------------------------------------
10da75d0 310
15b6757b
FM
311ALPHABETICAL_INDEX = YES
312COLS_IN_ALPHA_INDEX = 5
313IGNORE_PREFIX = wx
314
315#---------------------------------------------------------------------------
316# configuration options related to the HTML output
317#---------------------------------------------------------------------------
2a6585b8 318GENERATE_HTML = NO # Only change in format output configs
15b6757b
FM
319HTML_OUTPUT = html
320HTML_FILE_EXTENSION = .html
321HTML_HEADER = htmlheader.inc
322HTML_FOOTER = htmlfooter.inc
6783cae4 323HTML_STYLESHEET =
15b6757b 324HTML_ALIGN_MEMBERS = YES
f159c6b5 325HTML_DYNAMIC_SECTIONS = YES
0d0dc584
BP
326GENERATE_DOCSET = NO # Only change in format output configs
327DOCSET_FEEDNAME = "wxWidgets"
328DOCSET_BUNDLE_ID = org.wxwidgets.doxygen
329GENERATE_HTMLHELP = NO # Only change in format output configs
2a6585b8
BP
330CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed
331HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
15b6757b
FM
332GENERATE_CHI = NO
333BINARY_TOC = NO
334TOC_EXPAND = NO
0d0dc584 335GENERATE_QHP = NO
3051a44a 336QCH_FILE =
0d0dc584
BP
337QHP_NAMESPACE = org.wxwidgets.doxygen
338QHP_VIRTUAL_FOLDER = doc
3051a44a 339QHG_LOCATION =
15b6757b 340DISABLE_INDEX = NO
bbc5b7f8 341ENUM_VALUES_PER_LINE = 1
0d0dc584 342GENERATE_TREEVIEW = NONE
15b6757b 343TREEVIEW_WIDTH = 250
0d0dc584 344FORMULA_FONTSIZE = 10
15b6757b
FM
345
346#---------------------------------------------------------------------------
10da75d0 347# LaTeX Output Options
15b6757b 348#---------------------------------------------------------------------------
10da75d0 349
2a6585b8 350GENERATE_LATEX = NO # Only change in format output configs
15b6757b
FM
351LATEX_OUTPUT = latex
352LATEX_CMD_NAME = latex
353MAKEINDEX_CMD_NAME = makeindex
354COMPACT_LATEX = NO
355PAPER_TYPE = a4wide
6783cae4 356EXTRA_PACKAGES =
d0894365 357LATEX_HEADER = latexdocstart.inc
f4eb5ee6
SC
358PDF_HYPERLINKS = YES
359USE_PDFLATEX = YES
360LATEX_BATCHMODE = YES
15b6757b
FM
361LATEX_HIDE_INDICES = NO
362
363#---------------------------------------------------------------------------
10da75d0 364# RTF Output Options
15b6757b 365#---------------------------------------------------------------------------
10da75d0 366
2a6585b8 367GENERATE_RTF = NO # Only change in format output configs
15b6757b
FM
368RTF_OUTPUT = rtf
369COMPACT_RTF = NO
370RTF_HYPERLINKS = NO
6783cae4
FM
371RTF_STYLESHEET_FILE =
372RTF_EXTENSIONS_FILE =
15b6757b
FM
373
374#---------------------------------------------------------------------------
10da75d0 375# Man Page Output Options
15b6757b 376#---------------------------------------------------------------------------
10da75d0 377
2a6585b8 378GENERATE_MAN = NO # Only change in format output configs
15b6757b
FM
379MAN_OUTPUT = man
380MAN_EXTENSION = .3
381MAN_LINKS = NO
382
383#---------------------------------------------------------------------------
10da75d0 384# XML Output Options
15b6757b 385#---------------------------------------------------------------------------
10da75d0 386
2a6585b8 387GENERATE_XML = NO # Only change in format output configs
15b6757b 388XML_OUTPUT = xml
6783cae4
FM
389XML_SCHEMA =
390XML_DTD =
09ad05fa 391XML_PROGRAMLISTING = NO
15b6757b
FM
392
393#---------------------------------------------------------------------------
10da75d0 394# AutoGen Definitions Output Options
15b6757b 395#---------------------------------------------------------------------------
10da75d0 396
2a6585b8 397GENERATE_AUTOGEN_DEF = NO # Only change in format output configs
15b6757b
FM
398
399#---------------------------------------------------------------------------
10da75d0 400# Perl Module Output Options
15b6757b 401#---------------------------------------------------------------------------
10da75d0 402
2a6585b8 403GENERATE_PERLMOD = NO # Only change in format output configs
30738aae 404PERLMOD_LATEX = YES
15b6757b 405PERLMOD_PRETTY = YES
de87600c 406PERLMOD_MAKEVAR_PREFIX =
15b6757b
FM
407
408#---------------------------------------------------------------------------
10da75d0 409# Preprocessor Options
15b6757b 410#---------------------------------------------------------------------------
10da75d0 411
15b6757b
FM
412ENABLE_PREPROCESSING = YES
413MACRO_EXPANSION = NO
414EXPAND_ONLY_PREDEF = NO
415SEARCH_INCLUDES = YES
6783cae4
FM
416INCLUDE_PATH =
417INCLUDE_FILE_PATTERNS =
418PREDEFINED =
419EXPAND_AS_DEFINED =
15b6757b
FM
420SKIP_FUNCTION_MACROS = YES
421
422#---------------------------------------------------------------------------
10da75d0 423# Additions Related to External References
15b6757b 424#---------------------------------------------------------------------------
10da75d0 425
6783cae4 426TAGFILES =
2a6585b8 427GENERATE_TAGFILE =
15b6757b
FM
428ALLEXTERNALS = NO
429EXTERNAL_GROUPS = YES
430PERL_PATH = /usr/bin/perl
431
432#---------------------------------------------------------------------------
10da75d0 433# dot Tool Options
15b6757b 434#---------------------------------------------------------------------------
10da75d0 435
15b6757b
FM
436CLASS_DIAGRAMS = YES
437MSCGEN_PATH =
438HIDE_UNDOC_RELATIONS = YES
439HAVE_DOT = YES
0d0dc584
BP
440DOT_FONTNAME = FreeSans
441DOT_FONTSIZE = 10
3051a44a 442DOT_FONTPATH =
0d0dc584 443CLASS_GRAPH = YES
15b6757b
FM
444COLLABORATION_GRAPH = NO
445GROUP_GRAPHS = NO
446UML_LOOK = NO
447TEMPLATE_RELATIONS = NO
448INCLUDE_GRAPH = NO
449INCLUDED_BY_GRAPH = NO
450CALL_GRAPH = NO
451CALLER_GRAPH = NO
452GRAPHICAL_HIERARCHY = NO
453DIRECTORY_GRAPH = NO
454DOT_IMAGE_FORMAT = png
6783cae4 455DOTFILE_DIRS =
15b6757b
FM
456DOT_GRAPH_MAX_NODES = 50
457MAX_DOT_GRAPH_DEPTH = 1000
458DOT_TRANSPARENT = NO
459DOT_MULTI_TARGETS = NO
460GENERATE_LEGEND = YES
461DOT_CLEANUP = YES
462
2d283194
FM
463# instead of setting a value for DOT_PATH it's easier and more portable to
464# put your dot utility in the PATH; if you are on a Unix system this is usually
465# done automatically; if you're on Windows you'll need to install GraphViz tools
466# and then manually add it to the PATH environment variable
467DOT_PATH =
468
15b6757b 469#---------------------------------------------------------------------------
10da75d0 470# Search Engine Options
15b6757b 471#---------------------------------------------------------------------------
10da75d0 472
2a6585b8
BP
473SEARCHENGINE = NO
474