]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/Doxyfile_inc
Consider wxOSX the port name, and have wxOSX/Carbon and wxOSX/Cocoa as variations...
[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
15PROJECT_NUMBER = 2.9.0
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
88#---------------------------------------------------------------------------
89# Aliases - for use when documenting any C++ entity
90#---------------------------------------------------------------------------
91
e1ebc6f4 92# aliases for additional wx-specific infos
4cbfec15
FM
93ALIASES += 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>"
94ALIASES += 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 95ALIASES += 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
96ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
97ALIASES += 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 98ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
e1ebc6f4
FM
99
100# native implementation infos:
f59be7c6
FM
101ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
102ALIASES += 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>"
103ALIASES += 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>"
104ALIASES += 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
105
106# onlyfor infos:
03d4f7b9
FM
107# NOTE: we need to be able to retrieve these infos also from the XML output, thus
108# we use the \xmlonly and \endxmlonly commands to include custom XML tags
109ALIASES += 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"
110ALIASES += 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"
111ALIASES += 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"
112ALIASES += 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 113
12f5e1e7
BP
114# Use this in grouped global functions, and macros since they
115# wouldn't otherwise indicate what header they are defined in.
e1ebc6f4
FM
116ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
117
15b6757b 118# some formatting aliases
44fe9ffc
FM
119ALIASES += true="<span class='literal'>true</span>"
120ALIASES += false="<span class='literal'>false</span>"
121ALIASES += NULL="<span class='literal'>NULL</span>"
8d740f72 122ALIASES += NUL="<span class='literal'>NUL</span>"
44fe9ffc
FM
123
124# NOTE: these are important as you can't write in the docs
125# just #ifdef since the # character is used by Doxygen
126# for explicit linking; use the following aliases instead!
127# However to avoid overwriting e.g. \if Doxygen command the _
128# character is postfixed
129ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
130ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
131ALIASES += if_="<span class='literal'>\#if</span>"
132ALIASES += endif_="<span class='literal'>\#endif</span>"
15b6757b 133
4514447c 134# table aliases for 2 and 3 column tables
a6d7c65b
VS
135ALIASES += beginTable="<table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
136ALIASES += beginInvisibleTable="<table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
4514447c
FM
137ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
138ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
139ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
140ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
141ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
142ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
143ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
144ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
145ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
146ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
147ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
148ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
149ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
150ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
151ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
152ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
153ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
a302d595 154ALIASES += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>"
a6d7c65b 155ALIASES += endTable="</table>"
a3465294 156
4514447c
FM
157# definition list aliases
158# a definition list currently is rendered as 2-column table but it may use as
159# well the <dl>, <dt> and <dd> HTML tags in future.
160# In any case a definition list differs from a table because of its semantic
161# nature and because it is always the association of a "title" with a "description"
162# (in contrast a table may have more than 2 columns of data)...
dc215c81 163ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
0aaf0255
FM
164ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
165ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
166ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
167ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
168ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
169ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
170ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
171ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
172ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
4514447c 173ALIASES += endDefList="</table>"
808b128e 174ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td> @image html gtk-\2.png\n</td><td>\3</td></tr>"
4514447c 175
94802614
FM
176#---------------------------------------------------------------------------
177# Aliases - for use when documenting wxPerl/wxPython-specific parts
178#---------------------------------------------------------------------------
179
d54cf7ff 180# See ENABLED_SECTIONS configuration key for more info about these:
f09b5681 181ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
d54cf7ff 182ALIASES += endWxPerlOnly="\endif"
f09b5681 183ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> "
d54cf7ff 184ALIASES += endWxPythonOnly="\endif"
a3465294 185
877b5c30
BP
186# This is to get around a bug in Doxygen that prevents use of '{' or '}'
187# inside of any aliased command in parameters.
188ALIASES += leftCurly="{"
189ALIASES += rightCurly="}"
190
94802614
FM
191#---------------------------------------------------------------------------
192# Aliases - for use when documenting samples
193#---------------------------------------------------------------------------
194
5d4cca7f
BP
195# For indicating the a directory containing a sample
196ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim"
94802614 197
57b2bba4 198# For refering to the corresponding sample in a class document or a overview
5d4cca7f
BP
199# Usually placed in the queue of @see
200ALIASES += sample{1}="\ref page_samples_\1"
94802614 201
57b2bba4
BP
202# For generating a general description for a sample
203# \1 could be a class or an overview or a descriptive sentence
5d4cca7f
BP
204# Shall be replaced by manual written description soon
205ALIASES += sampleabout{1}="This sample demonstrates \1."
94802614 206
5d4cca7f
BP
207# For indicating the necessary condition of a sample or a class
208# \1 is the wxUSE_XXX macro
209ALIASES += 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."
210ALIASES += 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."
211
15b6757b 212#---------------------------------------------------------------------------
10da75d0 213# Build Options
15b6757b 214#---------------------------------------------------------------------------
10da75d0 215
15b6757b
FM
216EXTRACT_ALL = YES
217EXTRACT_PRIVATE = NO
218EXTRACT_STATIC = YES
219EXTRACT_LOCAL_CLASSES = YES
220EXTRACT_LOCAL_METHODS = NO
221EXTRACT_ANON_NSPACES = YES
23324ae1
FM
222HIDE_UNDOC_MEMBERS = NO
223HIDE_UNDOC_CLASSES = NO
15b6757b
FM
224HIDE_FRIEND_COMPOUNDS = NO
225HIDE_IN_BODY_DOCS = NO
226INTERNAL_DOCS = NO
227CASE_SENSE_NAMES = NO
228HIDE_SCOPE_NAMES = NO
229SHOW_INCLUDE_FILES = YES
230INLINE_INFO = YES
231SORT_MEMBER_DOCS = YES
0d0dc584
BP
232SORT_BRIEF_DOCS = NO # Don't set to YES, it renders our named groups out of order.
233SORT_GROUP_NAMES = YES
15b6757b
FM
234SORT_BY_SCOPE_NAME = NO
235GENERATE_TODOLIST = YES
236GENERATE_TESTLIST = YES
237GENERATE_BUGLIST = YES
238GENERATE_DEPRECATEDLIST= YES
d54cf7ff
FM
239
240# can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
dc215c81 241ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL
d54cf7ff 242
15b6757b 243MAX_INITIALIZER_LINES = 30
10da75d0 244SHOW_USED_FILES = NO
23324ae1 245SHOW_DIRECTORIES = YES
0d0dc584
BP
246SHOW_FILES = YES
247SHOW_NAMESPACES = NO
6783cae4 248FILE_VERSION_FILTER =
0d0dc584 249LAYOUT_FILE = DoxygenLayout.xml
15b6757b
FM
250
251#---------------------------------------------------------------------------
10da75d0 252# Warning and Progress Message Options
15b6757b 253#---------------------------------------------------------------------------
10da75d0 254
f159c6b5 255QUIET = YES
15b6757b 256WARNINGS = YES
90a47090 257WARN_IF_UNDOCUMENTED = YES
15b6757b 258WARN_IF_DOC_ERROR = YES
23324ae1 259WARN_NO_PARAMDOC = YES
15b6757b 260WARN_FORMAT = "$file:$line: $text "
4411a6b6 261WARN_LOGFILE = doxygen.log
15b6757b
FM
262
263#---------------------------------------------------------------------------
10da75d0 264# Input File Options
15b6757b 265#---------------------------------------------------------------------------
10da75d0 266
c83e60aa 267INPUT = ./mainpages ./groups ./overviews ../../interface
15b6757b
FM
268INPUT_ENCODING = UTF-8
269FILE_PATTERNS = *.h *.txt
270RECURSIVE = YES
6783cae4 271EXCLUDE =
15b6757b 272EXCLUDE_SYMLINKS = NO
6783cae4
FM
273EXCLUDE_PATTERNS =
274EXCLUDE_SYMBOLS =
29f86fc1 275EXAMPLE_PATH = ../
15b6757b 276EXAMPLE_PATTERNS = *
29f86fc1 277EXAMPLE_RECURSIVE = NO
4411a6b6 278IMAGE_PATH = images
6783cae4
FM
279INPUT_FILTER =
280FILTER_PATTERNS =
15b6757b
FM
281FILTER_SOURCE_FILES = NO
282
283#---------------------------------------------------------------------------
10da75d0 284# Source Browsing Options
15b6757b 285#---------------------------------------------------------------------------
10da75d0 286
15b6757b
FM
287SOURCE_BROWSER = NO
288INLINE_SOURCES = NO
289STRIP_CODE_COMMENTS = YES
290REFERENCED_BY_RELATION = NO
291REFERENCES_RELATION = NO
292REFERENCES_LINK_SOURCE = YES
293USE_HTAGS = NO
294VERBATIM_HEADERS = NO
295
296#---------------------------------------------------------------------------
10da75d0 297# Alphabetical Class Index Options
15b6757b 298#---------------------------------------------------------------------------
10da75d0 299
15b6757b
FM
300ALPHABETICAL_INDEX = YES
301COLS_IN_ALPHA_INDEX = 5
302IGNORE_PREFIX = wx
303
304#---------------------------------------------------------------------------
305# configuration options related to the HTML output
306#---------------------------------------------------------------------------
2a6585b8 307GENERATE_HTML = NO # Only change in format output configs
15b6757b
FM
308HTML_OUTPUT = html
309HTML_FILE_EXTENSION = .html
310HTML_HEADER = htmlheader.inc
311HTML_FOOTER = htmlfooter.inc
6783cae4 312HTML_STYLESHEET =
15b6757b 313HTML_ALIGN_MEMBERS = YES
f159c6b5 314HTML_DYNAMIC_SECTIONS = YES
0d0dc584
BP
315GENERATE_DOCSET = NO # Only change in format output configs
316DOCSET_FEEDNAME = "wxWidgets"
317DOCSET_BUNDLE_ID = org.wxwidgets.doxygen
318GENERATE_HTMLHELP = NO # Only change in format output configs
2a6585b8
BP
319CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed
320HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
15b6757b
FM
321GENERATE_CHI = NO
322BINARY_TOC = NO
323TOC_EXPAND = NO
0d0dc584 324GENERATE_QHP = NO
3051a44a 325QCH_FILE =
0d0dc584
BP
326QHP_NAMESPACE = org.wxwidgets.doxygen
327QHP_VIRTUAL_FOLDER = doc
3051a44a 328QHG_LOCATION =
15b6757b 329DISABLE_INDEX = NO
bbc5b7f8 330ENUM_VALUES_PER_LINE = 1
0d0dc584 331GENERATE_TREEVIEW = NONE
15b6757b 332TREEVIEW_WIDTH = 250
0d0dc584 333FORMULA_FONTSIZE = 10
15b6757b
FM
334
335#---------------------------------------------------------------------------
10da75d0 336# LaTeX Output Options
15b6757b 337#---------------------------------------------------------------------------
10da75d0 338
2a6585b8 339GENERATE_LATEX = NO # Only change in format output configs
15b6757b
FM
340LATEX_OUTPUT = latex
341LATEX_CMD_NAME = latex
342MAKEINDEX_CMD_NAME = makeindex
343COMPACT_LATEX = NO
344PAPER_TYPE = a4wide
6783cae4 345EXTRA_PACKAGES =
d0894365 346LATEX_HEADER = latexdocstart.inc
f4eb5ee6
SC
347PDF_HYPERLINKS = YES
348USE_PDFLATEX = YES
349LATEX_BATCHMODE = YES
15b6757b
FM
350LATEX_HIDE_INDICES = NO
351
352#---------------------------------------------------------------------------
10da75d0 353# RTF Output Options
15b6757b 354#---------------------------------------------------------------------------
10da75d0 355
2a6585b8 356GENERATE_RTF = NO # Only change in format output configs
15b6757b
FM
357RTF_OUTPUT = rtf
358COMPACT_RTF = NO
359RTF_HYPERLINKS = NO
6783cae4
FM
360RTF_STYLESHEET_FILE =
361RTF_EXTENSIONS_FILE =
15b6757b
FM
362
363#---------------------------------------------------------------------------
10da75d0 364# Man Page Output Options
15b6757b 365#---------------------------------------------------------------------------
10da75d0 366
2a6585b8 367GENERATE_MAN = NO # Only change in format output configs
15b6757b
FM
368MAN_OUTPUT = man
369MAN_EXTENSION = .3
370MAN_LINKS = NO
371
372#---------------------------------------------------------------------------
10da75d0 373# XML Output Options
15b6757b 374#---------------------------------------------------------------------------
10da75d0 375
2a6585b8 376GENERATE_XML = NO # Only change in format output configs
15b6757b 377XML_OUTPUT = xml
6783cae4
FM
378XML_SCHEMA =
379XML_DTD =
09ad05fa 380XML_PROGRAMLISTING = NO
15b6757b
FM
381
382#---------------------------------------------------------------------------
10da75d0 383# AutoGen Definitions Output Options
15b6757b 384#---------------------------------------------------------------------------
10da75d0 385
2a6585b8 386GENERATE_AUTOGEN_DEF = NO # Only change in format output configs
15b6757b
FM
387
388#---------------------------------------------------------------------------
10da75d0 389# Perl Module Output Options
15b6757b 390#---------------------------------------------------------------------------
10da75d0 391
2a6585b8 392GENERATE_PERLMOD = NO # Only change in format output configs
30738aae 393PERLMOD_LATEX = YES
15b6757b 394PERLMOD_PRETTY = YES
de87600c 395PERLMOD_MAKEVAR_PREFIX =
15b6757b
FM
396
397#---------------------------------------------------------------------------
10da75d0 398# Preprocessor Options
15b6757b 399#---------------------------------------------------------------------------
10da75d0 400
15b6757b
FM
401ENABLE_PREPROCESSING = YES
402MACRO_EXPANSION = NO
403EXPAND_ONLY_PREDEF = NO
404SEARCH_INCLUDES = YES
6783cae4
FM
405INCLUDE_PATH =
406INCLUDE_FILE_PATTERNS =
407PREDEFINED =
408EXPAND_AS_DEFINED =
15b6757b
FM
409SKIP_FUNCTION_MACROS = YES
410
411#---------------------------------------------------------------------------
10da75d0 412# Additions Related to External References
15b6757b 413#---------------------------------------------------------------------------
10da75d0 414
6783cae4 415TAGFILES =
2a6585b8 416GENERATE_TAGFILE =
15b6757b
FM
417ALLEXTERNALS = NO
418EXTERNAL_GROUPS = YES
419PERL_PATH = /usr/bin/perl
420
421#---------------------------------------------------------------------------
10da75d0 422# dot Tool Options
15b6757b 423#---------------------------------------------------------------------------
10da75d0 424
15b6757b
FM
425CLASS_DIAGRAMS = YES
426MSCGEN_PATH =
427HIDE_UNDOC_RELATIONS = YES
428HAVE_DOT = YES
0d0dc584
BP
429DOT_FONTNAME = FreeSans
430DOT_FONTSIZE = 10
3051a44a 431DOT_FONTPATH =
0d0dc584 432CLASS_GRAPH = YES
15b6757b
FM
433COLLABORATION_GRAPH = NO
434GROUP_GRAPHS = NO
435UML_LOOK = NO
436TEMPLATE_RELATIONS = NO
437INCLUDE_GRAPH = NO
438INCLUDED_BY_GRAPH = NO
439CALL_GRAPH = NO
440CALLER_GRAPH = NO
441GRAPHICAL_HIERARCHY = NO
442DIRECTORY_GRAPH = NO
443DOT_IMAGE_FORMAT = png
6783cae4
FM
444DOT_PATH =
445DOTFILE_DIRS =
15b6757b
FM
446DOT_GRAPH_MAX_NODES = 50
447MAX_DOT_GRAPH_DEPTH = 1000
448DOT_TRANSPARENT = NO
449DOT_MULTI_TARGETS = NO
450GENERATE_LEGEND = YES
451DOT_CLEANUP = YES
452
453#---------------------------------------------------------------------------
10da75d0 454# Search Engine Options
15b6757b 455#---------------------------------------------------------------------------
10da75d0 456
2a6585b8
BP
457SEARCHENGINE = NO
458