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