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