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