source: xplra/doc/Doxyfile@ 82:e247e9f2fa15

Last change on this file since 82:e247e9f2fa15 was 67:1f08d2ceff1a, checked in by István Váradi <ivaradi@…>, 12 years ago

Started writing the overview documentation

File size: 74.7 KB
Line 
1# Doxyfile 1.8.1.2
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project.
5#
6# All text after a hash (#) is considered a comment and will be ignored.
7# The format is:
8# TAG = value [value, ...]
9# For lists items can also be appended using:
10# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ").
12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
16
17# This tag specifies the encoding used for all characters in the config file
18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING = UTF-8
24
25# The PROJECT_NAME tag is a single word (or sequence of words) that should
26# identify the project. Note that if you do not use Doxywizard you need
27# to put quotes around the project name if it contains spaces.
28
29PROJECT_NAME = "X-Plane Remote Access Plugin and Client Library"
30
31# The PROJECT_NUMBER tag can be used to enter a project or revision number.
32# This could be handy for archiving the generated documentation or
33# if some version control system is used.
34
35PROJECT_NUMBER =
36
37# Using the PROJECT_BRIEF tag one can provide an optional one line description
38# for a project that appears at the top of each page and should give viewer
39# a quick idea about the purpose of the project. Keep the description short.
40
41PROJECT_BRIEF =
42
43# With the PROJECT_LOGO tag one can specify an logo or icon that is
44# included in the documentation. The maximum height of the logo should not
45# exceed 55 pixels and the maximum width should not exceed 200 pixels.
46# Doxygen will copy the logo to the output directory.
47
48PROJECT_LOGO =
49
50# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51# base path where the generated documentation will be put.
52# If a relative path is entered, it will be relative to the location
53# where doxygen was started. If left blank the current directory will be used.
54
55OUTPUT_DIRECTORY =
56
57# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58# 4096 sub-directories (in 2 levels) under the output directory of each output
59# format and will distribute the generated files over these directories.
60# Enabling this option can be useful when feeding doxygen a huge amount of
61# source files, where putting all generated files in the same directory would
62# otherwise cause performance problems for the file system.
63
64CREATE_SUBDIRS = NO
65
66# The OUTPUT_LANGUAGE tag is used to specify the language in which all
67# documentation generated by doxygen is written. Doxygen will use this
68# information to generate all constant output in the proper language.
69# The default language is English, other supported languages are:
70# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76
77OUTPUT_LANGUAGE = English
78
79# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80# include brief member descriptions after the members that are listed in
81# the file and class documentation (similar to JavaDoc).
82# Set to NO to disable this.
83
84BRIEF_MEMBER_DESC = YES
85
86# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87# the brief description of a member or function before the detailed description.
88# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
89# brief descriptions will be completely suppressed.
90
91REPEAT_BRIEF = YES
92
93# This tag implements a quasi-intelligent brief description abbreviator
94# that is used to form the text in various listings. Each string
95# in this list, if found as the leading text of the brief description, will be
96# stripped from the text and the result after processing the whole list, is
97# used as the annotated text. Otherwise, the brief description is used as-is.
98# If left blank, the following values are used ("$name" is automatically
99# replaced with the name of the entity): "The $name class" "The $name widget"
100# "The $name file" "is" "provides" "specifies" "contains"
101# "represents" "a" "an" "the"
102
103ABBREVIATE_BRIEF =
104
105# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
106# Doxygen will generate a detailed section even if there is only a brief
107# description.
108
109ALWAYS_DETAILED_SEC = NO
110
111# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
112# inherited members of a class in the documentation of that class as if those
113# members were ordinary class members. Constructors, destructors and assignment
114# operators of the base classes will not be shown.
115
116INLINE_INHERITED_MEMB = NO
117
118# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
119# path before files name in the file list and in the header files. If set
120# to NO the shortest path that makes the file name unique will be used.
121
122FULL_PATH_NAMES = NO
123
124# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
125# can be used to strip a user-defined part of the path. Stripping is
126# only done if one of the specified strings matches the left-hand part of
127# the path. The tag can be used to show relative paths in the file list.
128# If left blank the directory from which doxygen is run is used as the
129# path to strip.
130
131STRIP_FROM_PATH =
132
133# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
134# the path mentioned in the documentation of a class, which tells
135# the reader which header file to include in order to use a class.
136# If left blank only the name of the header file containing the class
137# definition is used. Otherwise one should specify the include paths that
138# are normally passed to the compiler using the -I flag.
139
140STRIP_FROM_INC_PATH =
141
142# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
143# (but less readable) file names. This can be useful if your file system
144# doesn't support long names like on DOS, Mac, or CD-ROM.
145
146SHORT_NAMES = NO
147
148# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
149# will interpret the first line (until the first dot) of a JavaDoc-style
150# comment as the brief description. If set to NO, the JavaDoc
151# comments will behave just like regular Qt-style comments
152# (thus requiring an explicit @brief command for a brief description.)
153
154JAVADOC_AUTOBRIEF = NO
155
156# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
157# interpret the first line (until the first dot) of a Qt-style
158# comment as the brief description. If set to NO, the comments
159# will behave just like regular Qt-style comments (thus requiring
160# an explicit \brief command for a brief description.)
161
162QT_AUTOBRIEF = NO
163
164# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
165# treat a multi-line C++ special comment block (i.e. a block of //! or ///
166# comments) as a brief description. This used to be the default behaviour.
167# The new default is to treat a multi-line C++ comment block as a detailed
168# description. Set this tag to YES if you prefer the old behaviour instead.
169
170MULTILINE_CPP_IS_BRIEF = NO
171
172# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
173# member inherits the documentation from any documented member that it
174# re-implements.
175
176INHERIT_DOCS = YES
177
178# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
179# a new page for each member. If set to NO, the documentation of a member will
180# be part of the file/class/namespace that contains it.
181
182SEPARATE_MEMBER_PAGES = NO
183
184# The TAB_SIZE tag can be used to set the number of spaces in a tab.
185# Doxygen uses this value to replace tabs by spaces in code fragments.
186
187TAB_SIZE = 8
188
189# This tag can be used to specify a number of aliases that acts
190# as commands in the documentation. An alias has the form "name=value".
191# For example adding "sideeffect=\par Side Effects:\n" will allow you to
192# put the command \sideeffect (or @sideeffect) in the documentation, which
193# will result in a user-defined paragraph with heading "Side Effects:".
194# You can put \n's in the value part of an alias to insert newlines.
195
196ALIASES =
197
198# This tag can be used to specify a number of word-keyword mappings (TCL only).
199# A mapping has the form "name=value". For example adding
200# "class=itcl::class" will allow you to use the command class in the
201# itcl::class meaning.
202
203TCL_SUBST =
204
205# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
206# sources only. Doxygen will then generate output that is more tailored for C.
207# For instance, some of the names that are used will be different. The list
208# of all members will be omitted, etc.
209
210OPTIMIZE_OUTPUT_FOR_C = NO
211
212# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
213# sources only. Doxygen will then generate output that is more tailored for
214# Java. For instance, namespaces will be presented as packages, qualified
215# scopes will look different, etc.
216
217OPTIMIZE_OUTPUT_JAVA = NO
218
219# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
220# sources only. Doxygen will then generate output that is more tailored for
221# Fortran.
222
223OPTIMIZE_FOR_FORTRAN = NO
224
225# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
226# sources. Doxygen will then generate output that is tailored for
227# VHDL.
228
229OPTIMIZE_OUTPUT_VHDL = NO
230
231# Doxygen selects the parser to use depending on the extension of the files it
232# parses. With this tag you can assign which parser to use for a given extension.
233# Doxygen has a built-in mapping, but you can override or extend it using this
234# tag. The format is ext=language, where ext is a file extension, and language
235# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
236# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
237# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
238# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
239# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
240
241EXTENSION_MAPPING =
242
243# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
244# comments according to the Markdown format, which allows for more readable
245# documentation. See http://daringfireball.net/projects/markdown/ for details.
246# The output of markdown processing is further processed by doxygen, so you
247# can mix doxygen, HTML, and XML commands with Markdown formatting.
248# Disable only in case of backward compatibilities issues.
249
250MARKDOWN_SUPPORT = YES
251
252# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
253# to include (a tag file for) the STL sources as input, then you should
254# set this tag to YES in order to let doxygen match functions declarations and
255# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
256# func(std::string) {}). This also makes the inheritance and collaboration
257# diagrams that involve STL classes more complete and accurate.
258
259BUILTIN_STL_SUPPORT = NO
260
261# If you use Microsoft's C++/CLI language, you should set this option to YES to
262# enable parsing support.
263
264CPP_CLI_SUPPORT = NO
265
266# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
267# Doxygen will parse them like normal C++ but will assume all classes use public
268# instead of private inheritance when no explicit protection keyword is present.
269
270SIP_SUPPORT = NO
271
272# For Microsoft's IDL there are propget and propput attributes to indicate getter
273# and setter methods for a property. Setting this option to YES (the default)
274# will make doxygen replace the get and set methods by a property in the
275# documentation. This will only work if the methods are indeed getting or
276# setting a simple type. If this is not the case, or you want to show the
277# methods anyway, you should set this option to NO.
278
279IDL_PROPERTY_SUPPORT = YES
280
281# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
282# tag is set to YES, then doxygen will reuse the documentation of the first
283# member in the group (if any) for the other members of the group. By default
284# all members of a group must be documented explicitly.
285
286DISTRIBUTE_GROUP_DOC = NO
287
288# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
289# the same type (for instance a group of public functions) to be put as a
290# subgroup of that type (e.g. under the Public Functions section). Set it to
291# NO to prevent subgrouping. Alternatively, this can be done per class using
292# the \nosubgrouping command.
293
294SUBGROUPING = YES
295
296# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
297# unions are shown inside the group in which they are included (e.g. using
298# @ingroup) instead of on a separate page (for HTML and Man pages) or
299# section (for LaTeX and RTF).
300
301INLINE_GROUPED_CLASSES = NO
302
303# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
304# unions with only public data fields will be shown inline in the documentation
305# of the scope in which they are defined (i.e. file, namespace, or group
306# documentation), provided this scope is documented. If set to NO (the default),
307# structs, classes, and unions are shown on a separate page (for HTML and Man
308# pages) or section (for LaTeX and RTF).
309
310INLINE_SIMPLE_STRUCTS = NO
311
312# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
313# is documented as struct, union, or enum with the name of the typedef. So
314# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
315# with name TypeT. When disabled the typedef will appear as a member of a file,
316# namespace, or class. And the struct will be named TypeS. This can typically
317# be useful for C code in case the coding convention dictates that all compound
318# types are typedef'ed and only the typedef is referenced, never the tag name.
319
320TYPEDEF_HIDES_STRUCT = NO
321
322# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
323# determine which symbols to keep in memory and which to flush to disk.
324# When the cache is full, less often used symbols will be written to disk.
325# For small to medium size projects (<1000 input files) the default value is
326# probably good enough. For larger projects a too small cache size can cause
327# doxygen to be busy swapping symbols to and from disk most of the time
328# causing a significant performance penalty.
329# If the system has enough physical memory increasing the cache will improve the
330# performance by keeping more symbols in memory. Note that the value works on
331# a logarithmic scale so increasing the size by one will roughly double the
332# memory usage. The cache size is given by this formula:
333# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
334# corresponding to a cache size of 2^16 = 65536 symbols.
335
336SYMBOL_CACHE_SIZE = 0
337
338# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
339# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
340# their name and scope. Since this can be an expensive process and often the
341# same symbol appear multiple times in the code, doxygen keeps a cache of
342# pre-resolved symbols. If the cache is too small doxygen will become slower.
343# If the cache is too large, memory is wasted. The cache size is given by this
344# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
345# corresponding to a cache size of 2^16 = 65536 symbols.
346
347LOOKUP_CACHE_SIZE = 0
348
349#---------------------------------------------------------------------------
350# Build related configuration options
351#---------------------------------------------------------------------------
352
353# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
354# documentation are documented, even if no documentation was available.
355# Private class members and static file members will be hidden unless
356# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
357
358EXTRACT_ALL = NO
359
360# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
361# will be included in the documentation.
362
363EXTRACT_PRIVATE = YES
364
365# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.
366
367EXTRACT_PACKAGE = NO
368
369# If the EXTRACT_STATIC tag is set to YES all static members of a file
370# will be included in the documentation.
371
372EXTRACT_STATIC = NO
373
374# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
375# defined locally in source files will be included in the documentation.
376# If set to NO only classes defined in header files are included.
377
378EXTRACT_LOCAL_CLASSES = YES
379
380# This flag is only useful for Objective-C code. When set to YES local
381# methods, which are defined in the implementation section but not in
382# the interface are included in the documentation.
383# If set to NO (the default) only methods in the interface are included.
384
385EXTRACT_LOCAL_METHODS = NO
386
387# If this flag is set to YES, the members of anonymous namespaces will be
388# extracted and appear in the documentation as a namespace called
389# 'anonymous_namespace{file}', where file will be replaced with the base
390# name of the file that contains the anonymous namespace. By default
391# anonymous namespaces are hidden.
392
393EXTRACT_ANON_NSPACES = NO
394
395# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
396# undocumented members of documented classes, files or namespaces.
397# If set to NO (the default) these members will be included in the
398# various overviews, but no documentation section is generated.
399# This option has no effect if EXTRACT_ALL is enabled.
400
401HIDE_UNDOC_MEMBERS = NO
402
403# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
404# undocumented classes that are normally visible in the class hierarchy.
405# If set to NO (the default) these classes will be included in the various
406# overviews. This option has no effect if EXTRACT_ALL is enabled.
407
408HIDE_UNDOC_CLASSES = NO
409
410# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
411# friend (class|struct|union) declarations.
412# If set to NO (the default) these declarations will be included in the
413# documentation.
414
415HIDE_FRIEND_COMPOUNDS = NO
416
417# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
418# documentation blocks found inside the body of a function.
419# If set to NO (the default) these blocks will be appended to the
420# function's detailed documentation block.
421
422HIDE_IN_BODY_DOCS = NO
423
424# The INTERNAL_DOCS tag determines if documentation
425# that is typed after a \internal command is included. If the tag is set
426# to NO (the default) then the documentation will be excluded.
427# Set it to YES to include the internal documentation.
428
429INTERNAL_DOCS = NO
430
431# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
432# file names in lower-case letters. If set to YES upper-case letters are also
433# allowed. This is useful if you have classes or files whose names only differ
434# in case and if your file system supports case sensitive file names. Windows
435# and Mac users are advised to set this option to NO.
436
437CASE_SENSE_NAMES = YES
438
439# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
440# will show members with their full class and namespace scopes in the
441# documentation. If set to YES the scope will be hidden.
442
443HIDE_SCOPE_NAMES = NO
444
445# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
446# will put a list of the files that are included by a file in the documentation
447# of that file.
448
449SHOW_INCLUDE_FILES = YES
450
451# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
452# will list include files with double quotes in the documentation
453# rather than with sharp brackets.
454
455FORCE_LOCAL_INCLUDES = NO
456
457# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
458# is inserted in the documentation for inline members.
459
460INLINE_INFO = YES
461
462# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
463# will sort the (detailed) documentation of file and class members
464# alphabetically by member name. If set to NO the members will appear in
465# declaration order.
466
467SORT_MEMBER_DOCS = YES
468
469# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
470# brief documentation of file, namespace and class members alphabetically
471# by member name. If set to NO (the default) the members will appear in
472# declaration order.
473
474SORT_BRIEF_DOCS = NO
475
476# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
477# will sort the (brief and detailed) documentation of class members so that
478# constructors and destructors are listed first. If set to NO (the default)
479# the constructors will appear in the respective orders defined by
480# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
481# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
482# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
483
484SORT_MEMBERS_CTORS_1ST = NO
485
486# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
487# hierarchy of group names into alphabetical order. If set to NO (the default)
488# the group names will appear in their defined order.
489
490SORT_GROUP_NAMES = NO
491
492# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
493# sorted by fully-qualified names, including namespaces. If set to
494# NO (the default), the class list will be sorted only by class name,
495# not including the namespace part.
496# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
497# Note: This option applies only to the class list, not to the
498# alphabetical list.
499
500SORT_BY_SCOPE_NAME = NO
501
502# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
503# do proper type resolution of all parameters of a function it will reject a
504# match between the prototype and the implementation of a member function even
505# if there is only one candidate or it is obvious which candidate to choose
506# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
507# will still accept a match between prototype and implementation in such cases.
508
509STRICT_PROTO_MATCHING = NO
510
511# The GENERATE_TODOLIST tag can be used to enable (YES) or
512# disable (NO) the todo list. This list is created by putting \todo
513# commands in the documentation.
514
515GENERATE_TODOLIST = YES
516
517# The GENERATE_TESTLIST tag can be used to enable (YES) or
518# disable (NO) the test list. This list is created by putting \test
519# commands in the documentation.
520
521GENERATE_TESTLIST = YES
522
523# The GENERATE_BUGLIST tag can be used to enable (YES) or
524# disable (NO) the bug list. This list is created by putting \bug
525# commands in the documentation.
526
527GENERATE_BUGLIST = YES
528
529# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
530# disable (NO) the deprecated list. This list is created by putting
531# \deprecated commands in the documentation.
532
533GENERATE_DEPRECATEDLIST= YES
534
535# The ENABLED_SECTIONS tag can be used to enable conditional
536# documentation sections, marked by \if sectionname ... \endif.
537
538ENABLED_SECTIONS =
539
540# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
541# the initial value of a variable or macro consists of for it to appear in
542# the documentation. If the initializer consists of more lines than specified
543# here it will be hidden. Use a value of 0 to hide initializers completely.
544# The appearance of the initializer of individual variables and macros in the
545# documentation can be controlled using \showinitializer or \hideinitializer
546# command in the documentation regardless of this setting.
547
548MAX_INITIALIZER_LINES = 30
549
550# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
551# at the bottom of the documentation of classes and structs. If set to YES the
552# list will mention the files that were used to generate the documentation.
553
554SHOW_USED_FILES = YES
555
556# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
557# This will remove the Files entry from the Quick Index and from the
558# Folder Tree View (if specified). The default is YES.
559
560SHOW_FILES = YES
561
562# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
563# Namespaces page.
564# This will remove the Namespaces entry from the Quick Index
565# and from the Folder Tree View (if specified). The default is YES.
566
567SHOW_NAMESPACES = YES
568
569# The FILE_VERSION_FILTER tag can be used to specify a program or script that
570# doxygen should invoke to get the current version for each file (typically from
571# the version control system). Doxygen will invoke the program by executing (via
572# popen()) the command <command> <input-file>, where <command> is the value of
573# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
574# provided by doxygen. Whatever the program writes to standard output
575# is used as the file version. See the manual for examples.
576
577FILE_VERSION_FILTER =
578
579# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
580# by doxygen. The layout file controls the global structure of the generated
581# output files in an output format independent way. To create the layout file
582# that represents doxygen's defaults, run doxygen with the -l option.
583# You can optionally specify a file name after the option, if omitted
584# DoxygenLayout.xml will be used as the name of the layout file.
585
586LAYOUT_FILE =
587
588# The CITE_BIB_FILES tag can be used to specify one or more bib files
589# containing the references data. This must be a list of .bib files. The
590# .bib extension is automatically appended if omitted. Using this command
591# requires the bibtex tool to be installed. See also
592# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
593# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
594# feature you need bibtex and perl available in the search path.
595
596CITE_BIB_FILES =
597
598#---------------------------------------------------------------------------
599# configuration options related to warning and progress messages
600#---------------------------------------------------------------------------
601
602# The QUIET tag can be used to turn on/off the messages that are generated
603# by doxygen. Possible values are YES and NO. If left blank NO is used.
604
605QUIET = YES
606
607# The WARNINGS tag can be used to turn on/off the warning messages that are
608# generated by doxygen. Possible values are YES and NO. If left blank
609# NO is used.
610
611WARNINGS = YES
612
613# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
614# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
615# automatically be disabled.
616
617WARN_IF_UNDOCUMENTED = YES
618
619# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
620# potential errors in the documentation, such as not documenting some
621# parameters in a documented function, or documenting parameters that
622# don't exist or using markup commands wrongly.
623
624WARN_IF_DOC_ERROR = YES
625
626# The WARN_NO_PARAMDOC option can be enabled to get warnings for
627# functions that are documented, but have no documentation for their parameters
628# or return value. If set to NO (the default) doxygen will only warn about
629# wrong or incomplete parameter documentation, but not about the absence of
630# documentation.
631
632WARN_NO_PARAMDOC = NO
633
634# The WARN_FORMAT tag determines the format of the warning messages that
635# doxygen can produce. The string should contain the $file, $line, and $text
636# tags, which will be replaced by the file and line number from which the
637# warning originated and the warning text. Optionally the format may contain
638# $version, which will be replaced by the version of the file (if it could
639# be obtained via FILE_VERSION_FILTER)
640
641WARN_FORMAT = "$file:$line: $text"
642
643# The WARN_LOGFILE tag can be used to specify a file to which warning
644# and error messages should be written. If left blank the output is written
645# to stderr.
646
647WARN_LOGFILE =
648
649#---------------------------------------------------------------------------
650# configuration options related to the input files
651#---------------------------------------------------------------------------
652
653# The INPUT tag can be used to specify the files and/or directories that contain
654# documented source files. You may enter file names like "myfile.cpp" or
655# directories like "/usr/src/myproject". Separate the files or directories
656# with spaces.
657
658INPUT = overview.dox ../src/plugin/src/xplra \
659 ../src/client/c/hu/varadiistvan/xplra \
660 ../src/client/python
661
662# This tag can be used to specify the character encoding of the source files
663# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
664# also the default input encoding. Doxygen uses libiconv (or the iconv built
665# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
666# the list of possible encodings.
667
668INPUT_ENCODING = UTF-8
669
670# If the value of the INPUT tag contains directories, you can use the
671# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
672# and *.h) to filter out the source-files in the directories. If left
673# blank the following patterns are tested:
674# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
675# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
676# *.f90 *.f *.for *.vhd *.vhdl
677
678FILE_PATTERNS = *.h *.cc *.py
679
680# The RECURSIVE tag can be used to turn specify whether or not subdirectories
681# should be searched for input files as well. Possible values are YES and NO.
682# If left blank NO is used.
683
684RECURSIVE = NO
685
686# The EXCLUDE tag can be used to specify files and/or directories that should be
687# excluded from the INPUT source files. This way you can easily exclude a
688# subdirectory from a directory tree whose root is specified with the INPUT tag.
689# Note that relative paths are relative to the directory from which doxygen is
690# run.
691
692EXCLUDE =
693
694# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
695# directories that are symbolic links (a Unix file system feature) are excluded
696# from the input.
697
698EXCLUDE_SYMLINKS = NO
699
700# If the value of the INPUT tag contains directories, you can use the
701# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
702# certain files from those directories. Note that the wildcards are matched
703# against the file with absolute path, so to exclude all test directories
704# for example use the pattern */test/*
705
706EXCLUDE_PATTERNS =
707
708# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
709# (namespaces, classes, functions, etc.) that should be excluded from the
710# output. The symbol name can be a fully qualified name, a word, or if the
711# wildcard * is used, a substring. Examples: ANamespace, AClass,
712# AClass::ANamespace, ANamespace::*Test
713
714EXCLUDE_SYMBOLS =
715
716# The EXAMPLE_PATH tag can be used to specify one or more files or
717# directories that contain example code fragments that are included (see
718# the \include command).
719
720EXAMPLE_PATH =
721
722# If the value of the EXAMPLE_PATH tag contains directories, you can use the
723# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
724# and *.h) to filter out the source-files in the directories. If left
725# blank all files are included.
726
727EXAMPLE_PATTERNS =
728
729# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
730# searched for input files to be used with the \include or \dontinclude
731# commands irrespective of the value of the RECURSIVE tag.
732# Possible values are YES and NO. If left blank NO is used.
733
734EXAMPLE_RECURSIVE = NO
735
736# The IMAGE_PATH tag can be used to specify one or more files or
737# directories that contain image that are included in the documentation (see
738# the \image command).
739
740IMAGE_PATH =
741
742# The INPUT_FILTER tag can be used to specify a program that doxygen should
743# invoke to filter for each input file. Doxygen will invoke the filter program
744# by executing (via popen()) the command <filter> <input-file>, where <filter>
745# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
746# input file. Doxygen will then use the output that the filter program writes
747# to standard output.
748# If FILTER_PATTERNS is specified, this tag will be
749# ignored.
750
751INPUT_FILTER =
752
753# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
754# basis.
755# Doxygen will compare the file name with each pattern and apply the
756# filter if there is a match.
757# The filters are a list of the form:
758# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
759# info on how filters are used. If FILTER_PATTERNS is empty or if
760# non of the patterns match the file name, INPUT_FILTER is applied.
761
762FILTER_PATTERNS =
763
764# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
765# INPUT_FILTER) will be used to filter the input files when producing source
766# files to browse (i.e. when SOURCE_BROWSER is set to YES).
767
768FILTER_SOURCE_FILES = NO
769
770# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
771# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
772# and it is also possible to disable source filtering for a specific pattern
773# using *.ext= (so without naming a filter). This option only has effect when
774# FILTER_SOURCE_FILES is enabled.
775
776FILTER_SOURCE_PATTERNS =
777
778#---------------------------------------------------------------------------
779# configuration options related to source browsing
780#---------------------------------------------------------------------------
781
782# If the SOURCE_BROWSER tag is set to YES then a list of source files will
783# be generated. Documented entities will be cross-referenced with these sources.
784# Note: To get rid of all source code in the generated output, make sure also
785# VERBATIM_HEADERS is set to NO.
786
787SOURCE_BROWSER = YES
788
789# Setting the INLINE_SOURCES tag to YES will include the body
790# of functions and classes directly in the documentation.
791
792INLINE_SOURCES = NO
793
794# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
795# doxygen to hide any special comment blocks from generated source code
796# fragments. Normal C, C++ and Fortran comments will always remain visible.
797
798STRIP_CODE_COMMENTS = YES
799
800# If the REFERENCED_BY_RELATION tag is set to YES
801# then for each documented function all documented
802# functions referencing it will be listed.
803
804REFERENCED_BY_RELATION = NO
805
806# If the REFERENCES_RELATION tag is set to YES
807# then for each documented function all documented entities
808# called/used by that function will be listed.
809
810REFERENCES_RELATION = NO
811
812# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
813# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
814# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
815# link to the source code.
816# Otherwise they will link to the documentation.
817
818REFERENCES_LINK_SOURCE = YES
819
820# If the USE_HTAGS tag is set to YES then the references to source code
821# will point to the HTML generated by the htags(1) tool instead of doxygen
822# built-in source browser. The htags tool is part of GNU's global source
823# tagging system (see http://www.gnu.org/software/global/global.html). You
824# will need version 4.8.6 or higher.
825
826USE_HTAGS = NO
827
828# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
829# will generate a verbatim copy of the header file for each class for
830# which an include is specified. Set to NO to disable this.
831
832VERBATIM_HEADERS = YES
833
834#---------------------------------------------------------------------------
835# configuration options related to the alphabetical class index
836#---------------------------------------------------------------------------
837
838# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
839# of all compounds will be generated. Enable this if the project
840# contains a lot of classes, structs, unions or interfaces.
841
842ALPHABETICAL_INDEX = YES
843
844# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
845# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
846# in which this list will be split (can be a number in the range [1..20])
847
848COLS_IN_ALPHA_INDEX = 5
849
850# In case all classes in a project start with a common prefix, all
851# classes will be put under the same header in the alphabetical index.
852# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
853# should be ignored while generating the index headers.
854
855IGNORE_PREFIX =
856
857#---------------------------------------------------------------------------
858# configuration options related to the HTML output
859#---------------------------------------------------------------------------
860
861# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
862# generate HTML output.
863
864GENERATE_HTML = YES
865
866# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
867# If a relative path is entered the value of OUTPUT_DIRECTORY will be
868# put in front of it. If left blank `html' will be used as the default path.
869
870HTML_OUTPUT = html
871
872# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
873# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
874# doxygen will generate files with .html extension.
875
876HTML_FILE_EXTENSION = .html
877
878# The HTML_HEADER tag can be used to specify a personal HTML header for
879# each generated HTML page. If it is left blank doxygen will generate a
880# standard header. Note that when using a custom header you are responsible
881# for the proper inclusion of any scripts and style sheets that doxygen
882# needs, which is dependent on the configuration options used.
883# It is advised to generate a default header using "doxygen -w html
884# header.html footer.html stylesheet.css YourConfigFile" and then modify
885# that header. Note that the header is subject to change so you typically
886# have to redo this when upgrading to a newer version of doxygen or when
887# changing the value of configuration settings such as GENERATE_TREEVIEW!
888
889HTML_HEADER =
890
891# The HTML_FOOTER tag can be used to specify a personal HTML footer for
892# each generated HTML page. If it is left blank doxygen will generate a
893# standard footer.
894
895HTML_FOOTER =
896
897# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
898# style sheet that is used by each HTML page. It can be used to
899# fine-tune the look of the HTML output. If the tag is left blank doxygen
900# will generate a default style sheet. Note that doxygen will try to copy
901# the style sheet file to the HTML output directory, so don't put your own
902# style sheet in the HTML output directory as well, or it will be erased!
903
904HTML_STYLESHEET =
905
906# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
907# other source files which should be copied to the HTML output directory. Note
908# that these files will be copied to the base HTML output directory. Use the
909# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
910# files. In the HTML_STYLESHEET file, use the file name only. Also note that
911# the files will be copied as-is; there are no commands or markers available.
912
913HTML_EXTRA_FILES =
914
915# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
916# Doxygen will adjust the colors in the style sheet and background images
917# according to this color. Hue is specified as an angle on a colorwheel,
918# see http://en.wikipedia.org/wiki/Hue for more information.
919# For instance the value 0 represents red, 60 is yellow, 120 is green,
920# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
921# The allowed range is 0 to 359.
922
923HTML_COLORSTYLE_HUE = 220
924
925# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
926# the colors in the HTML output. For a value of 0 the output will use
927# grayscales only. A value of 255 will produce the most vivid colors.
928
929HTML_COLORSTYLE_SAT = 100
930
931# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
932# the luminance component of the colors in the HTML output. Values below
933# 100 gradually make the output lighter, whereas values above 100 make
934# the output darker. The value divided by 100 is the actual gamma applied,
935# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
936# and 100 does not change the gamma.
937
938HTML_COLORSTYLE_GAMMA = 80
939
940# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
941# page will contain the date and time when the page was generated. Setting
942# this to NO can help when comparing the output of multiple runs.
943
944HTML_TIMESTAMP = YES
945
946# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
947# documentation will contain sections that can be hidden and shown after the
948# page has loaded.
949
950HTML_DYNAMIC_SECTIONS = NO
951
952# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
953# entries shown in the various tree structured indices initially; the user
954# can expand and collapse entries dynamically later on. Doxygen will expand
955# the tree to such a level that at most the specified number of entries are
956# visible (unless a fully collapsed tree already exceeds this amount).
957# So setting the number of entries 1 will produce a full collapsed tree by
958# default. 0 is a special value representing an infinite number of entries
959# and will result in a full expanded tree by default.
960
961HTML_INDEX_NUM_ENTRIES = 100
962
963# If the GENERATE_DOCSET tag is set to YES, additional index files
964# will be generated that can be used as input for Apple's Xcode 3
965# integrated development environment, introduced with OSX 10.5 (Leopard).
966# To create a documentation set, doxygen will generate a Makefile in the
967# HTML output directory. Running make will produce the docset in that
968# directory and running "make install" will install the docset in
969# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
970# it at startup.
971# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
972# for more information.
973
974GENERATE_DOCSET = NO
975
976# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
977# feed. A documentation feed provides an umbrella under which multiple
978# documentation sets from a single provider (such as a company or product suite)
979# can be grouped.
980
981DOCSET_FEEDNAME = "Doxygen generated docs"
982
983# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
984# should uniquely identify the documentation set bundle. This should be a
985# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
986# will append .docset to the name.
987
988DOCSET_BUNDLE_ID = org.doxygen.Project
989
990# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
991# the documentation publisher. This should be a reverse domain-name style
992# string, e.g. com.mycompany.MyDocSet.documentation.
993
994DOCSET_PUBLISHER_ID = org.doxygen.Publisher
995
996# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
997
998DOCSET_PUBLISHER_NAME = Publisher
999
1000# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1001# will be generated that can be used as input for tools like the
1002# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1003# of the generated HTML documentation.
1004
1005GENERATE_HTMLHELP = NO
1006
1007# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1008# be used to specify the file name of the resulting .chm file. You
1009# can add a path in front of the file if the result should not be
1010# written to the html output directory.
1011
1012CHM_FILE =
1013
1014# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1015# be used to specify the location (absolute path including file name) of
1016# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1017# the HTML help compiler on the generated index.hhp.
1018
1019HHC_LOCATION =
1020
1021# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1022# controls if a separate .chi index file is generated (YES) or that
1023# it should be included in the master .chm file (NO).
1024
1025GENERATE_CHI = NO
1026
1027# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1028# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1029# content.
1030
1031CHM_INDEX_ENCODING =
1032
1033# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1034# controls whether a binary table of contents is generated (YES) or a
1035# normal table of contents (NO) in the .chm file.
1036
1037BINARY_TOC = NO
1038
1039# The TOC_EXPAND flag can be set to YES to add extra items for group members
1040# to the contents of the HTML help documentation and to the tree view.
1041
1042TOC_EXPAND = NO
1043
1044# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1045# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1046# that can be used as input for Qt's qhelpgenerator to generate a
1047# Qt Compressed Help (.qch) of the generated HTML documentation.
1048
1049GENERATE_QHP = NO
1050
1051# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1052# be used to specify the file name of the resulting .qch file.
1053# The path specified is relative to the HTML output folder.
1054
1055QCH_FILE =
1056
1057# The QHP_NAMESPACE tag specifies the namespace to use when generating
1058# Qt Help Project output. For more information please see
1059# http://doc.trolltech.com/qthelpproject.html#namespace
1060
1061QHP_NAMESPACE = org.doxygen.Project
1062
1063# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1064# Qt Help Project output. For more information please see
1065# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1066
1067QHP_VIRTUAL_FOLDER = doc
1068
1069# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1070# add. For more information please see
1071# http://doc.trolltech.com/qthelpproject.html#custom-filters
1072
1073QHP_CUST_FILTER_NAME =
1074
1075# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1076# custom filter to add. For more information please see
1077# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1078# Qt Help Project / Custom Filters</a>.
1079
1080QHP_CUST_FILTER_ATTRS =
1081
1082# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1083# project's
1084# filter section matches.
1085# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1086# Qt Help Project / Filter Attributes</a>.
1087
1088QHP_SECT_FILTER_ATTRS =
1089
1090# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1091# be used to specify the location of Qt's qhelpgenerator.
1092# If non-empty doxygen will try to run qhelpgenerator on the generated
1093# .qhp file.
1094
1095QHG_LOCATION =
1096
1097# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1098# will be generated, which together with the HTML files, form an Eclipse help
1099# plugin. To install this plugin and make it available under the help contents
1100# menu in Eclipse, the contents of the directory containing the HTML and XML
1101# files needs to be copied into the plugins directory of eclipse. The name of
1102# the directory within the plugins directory should be the same as
1103# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1104# the help appears.
1105
1106GENERATE_ECLIPSEHELP = NO
1107
1108# A unique identifier for the eclipse help plugin. When installing the plugin
1109# the directory name containing the HTML and XML files should also have
1110# this name.
1111
1112ECLIPSE_DOC_ID = org.doxygen.Project
1113
1114# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1115# at top of each HTML page. The value NO (the default) enables the index and
1116# the value YES disables it. Since the tabs have the same information as the
1117# navigation tree you can set this option to NO if you already set
1118# GENERATE_TREEVIEW to YES.
1119
1120DISABLE_INDEX = NO
1121
1122# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1123# structure should be generated to display hierarchical information.
1124# If the tag value is set to YES, a side panel will be generated
1125# containing a tree-like index structure (just like the one that
1126# is generated for HTML Help). For this to work a browser that supports
1127# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1128# Windows users are probably better off using the HTML help feature.
1129# Since the tree basically has the same information as the tab index you
1130# could consider to set DISABLE_INDEX to NO when enabling this option.
1131
1132GENERATE_TREEVIEW = NO
1133
1134# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1135# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1136# documentation. Note that a value of 0 will completely suppress the enum
1137# values from appearing in the overview section.
1138
1139ENUM_VALUES_PER_LINE = 4
1140
1141# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1142# used to set the initial width (in pixels) of the frame in which the tree
1143# is shown.
1144
1145TREEVIEW_WIDTH = 250
1146
1147# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1148# links to external symbols imported via tag files in a separate window.
1149
1150EXT_LINKS_IN_WINDOW = NO
1151
1152# Use this tag to change the font size of Latex formulas included
1153# as images in the HTML documentation. The default is 10. Note that
1154# when you change the font size after a successful doxygen run you need
1155# to manually remove any form_*.png images from the HTML output directory
1156# to force them to be regenerated.
1157
1158FORMULA_FONTSIZE = 10
1159
1160# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1161# generated for formulas are transparent PNGs. Transparent PNGs are
1162# not supported properly for IE 6.0, but are supported on all modern browsers.
1163# Note that when changing this option you need to delete any form_*.png files
1164# in the HTML output before the changes have effect.
1165
1166FORMULA_TRANSPARENT = YES
1167
1168# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1169# (see http://www.mathjax.org) which uses client side Javascript for the
1170# rendering instead of using prerendered bitmaps. Use this if you do not
1171# have LaTeX installed or if you want to formulas look prettier in the HTML
1172# output. When enabled you may also need to install MathJax separately and
1173# configure the path to it using the MATHJAX_RELPATH option.
1174
1175USE_MATHJAX = NO
1176
1177# When MathJax is enabled you need to specify the location relative to the
1178# HTML output directory using the MATHJAX_RELPATH option. The destination
1179# directory should contain the MathJax.js script. For instance, if the mathjax
1180# directory is located at the same level as the HTML output directory, then
1181# MATHJAX_RELPATH should be ../mathjax. The default value points to
1182# the MathJax Content Delivery Network so you can quickly see the result without
1183# installing MathJax.
1184# However, it is strongly recommended to install a local
1185# copy of MathJax from http://www.mathjax.org before deployment.
1186
1187MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1188
1189# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1190# names that should be enabled during MathJax rendering.
1191
1192MATHJAX_EXTENSIONS =
1193
1194# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1195# for the HTML output. The underlying search engine uses javascript
1196# and DHTML and should work on any modern browser. Note that when using
1197# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1198# (GENERATE_DOCSET) there is already a search function so this one should
1199# typically be disabled. For large projects the javascript based search engine
1200# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1201
1202SEARCHENGINE = YES
1203
1204# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1205# implemented using a PHP enabled web server instead of at the web client
1206# using Javascript. Doxygen will generate the search PHP script and index
1207# file to put on the web server. The advantage of the server
1208# based approach is that it scales better to large projects and allows
1209# full text search. The disadvantages are that it is more difficult to setup
1210# and does not have live searching capabilities.
1211
1212SERVER_BASED_SEARCH = NO
1213
1214#---------------------------------------------------------------------------
1215# configuration options related to the LaTeX output
1216#---------------------------------------------------------------------------
1217
1218# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1219# generate Latex output.
1220
1221GENERATE_LATEX = NO
1222
1223# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1224# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1225# put in front of it. If left blank `latex' will be used as the default path.
1226
1227LATEX_OUTPUT = latex
1228
1229# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1230# invoked. If left blank `latex' will be used as the default command name.
1231# Note that when enabling USE_PDFLATEX this option is only used for
1232# generating bitmaps for formulas in the HTML output, but not in the
1233# Makefile that is written to the output directory.
1234
1235LATEX_CMD_NAME = latex
1236
1237# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1238# generate index for LaTeX. If left blank `makeindex' will be used as the
1239# default command name.
1240
1241MAKEINDEX_CMD_NAME = makeindex
1242
1243# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1244# LaTeX documents. This may be useful for small projects and may help to
1245# save some trees in general.
1246
1247COMPACT_LATEX = NO
1248
1249# The PAPER_TYPE tag can be used to set the paper type that is used
1250# by the printer. Possible values are: a4, letter, legal and
1251# executive. If left blank a4wide will be used.
1252
1253PAPER_TYPE = a4
1254
1255# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1256# packages that should be included in the LaTeX output.
1257
1258EXTRA_PACKAGES =
1259
1260# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1261# the generated latex document. The header should contain everything until
1262# the first chapter. If it is left blank doxygen will generate a
1263# standard header. Notice: only use this tag if you know what you are doing!
1264
1265LATEX_HEADER =
1266
1267# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1268# the generated latex document. The footer should contain everything after
1269# the last chapter. If it is left blank doxygen will generate a
1270# standard footer. Notice: only use this tag if you know what you are doing!
1271
1272LATEX_FOOTER =
1273
1274# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1275# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1276# contain links (just like the HTML output) instead of page references
1277# This makes the output suitable for online browsing using a pdf viewer.
1278
1279PDF_HYPERLINKS = YES
1280
1281# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1282# plain latex in the generated Makefile. Set this option to YES to get a
1283# higher quality PDF documentation.
1284
1285USE_PDFLATEX = YES
1286
1287# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1288# command to the generated LaTeX files. This will instruct LaTeX to keep
1289# running if errors occur, instead of asking the user for help.
1290# This option is also used when generating formulas in HTML.
1291
1292LATEX_BATCHMODE = NO
1293
1294# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1295# include the index chapters (such as File Index, Compound Index, etc.)
1296# in the output.
1297
1298LATEX_HIDE_INDICES = NO
1299
1300# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1301# source code with syntax highlighting in the LaTeX output.
1302# Note that which sources are shown also depends on other settings
1303# such as SOURCE_BROWSER.
1304
1305LATEX_SOURCE_CODE = NO
1306
1307# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1308# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1309# http://en.wikipedia.org/wiki/BibTeX for more info.
1310
1311LATEX_BIB_STYLE = plain
1312
1313#---------------------------------------------------------------------------
1314# configuration options related to the RTF output
1315#---------------------------------------------------------------------------
1316
1317# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1318# The RTF output is optimized for Word 97 and may not look very pretty with
1319# other RTF readers or editors.
1320
1321GENERATE_RTF = NO
1322
1323# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1324# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1325# put in front of it. If left blank `rtf' will be used as the default path.
1326
1327RTF_OUTPUT = rtf
1328
1329# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1330# RTF documents. This may be useful for small projects and may help to
1331# save some trees in general.
1332
1333COMPACT_RTF = NO
1334
1335# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1336# will contain hyperlink fields. The RTF file will
1337# contain links (just like the HTML output) instead of page references.
1338# This makes the output suitable for online browsing using WORD or other
1339# programs which support those fields.
1340# Note: wordpad (write) and others do not support links.
1341
1342RTF_HYPERLINKS = NO
1343
1344# Load style sheet definitions from file. Syntax is similar to doxygen's
1345# config file, i.e. a series of assignments. You only have to provide
1346# replacements, missing definitions are set to their default value.
1347
1348RTF_STYLESHEET_FILE =
1349
1350# Set optional variables used in the generation of an rtf document.
1351# Syntax is similar to doxygen's config file.
1352
1353RTF_EXTENSIONS_FILE =
1354
1355#---------------------------------------------------------------------------
1356# configuration options related to the man page output
1357#---------------------------------------------------------------------------
1358
1359# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1360# generate man pages
1361
1362GENERATE_MAN = NO
1363
1364# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1365# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1366# put in front of it. If left blank `man' will be used as the default path.
1367
1368MAN_OUTPUT = man
1369
1370# The MAN_EXTENSION tag determines the extension that is added to
1371# the generated man pages (default is the subroutine's section .3)
1372
1373MAN_EXTENSION = .3
1374
1375# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1376# then it will generate one additional man file for each entity
1377# documented in the real man page(s). These additional files
1378# only source the real man page, but without them the man command
1379# would be unable to find the correct page. The default is NO.
1380
1381MAN_LINKS = NO
1382
1383#---------------------------------------------------------------------------
1384# configuration options related to the XML output
1385#---------------------------------------------------------------------------
1386
1387# If the GENERATE_XML tag is set to YES Doxygen will
1388# generate an XML file that captures the structure of
1389# the code including all documentation.
1390
1391GENERATE_XML = NO
1392
1393# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1394# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1395# put in front of it. If left blank `xml' will be used as the default path.
1396
1397XML_OUTPUT = xml
1398
1399# The XML_SCHEMA tag can be used to specify an XML schema,
1400# which can be used by a validating XML parser to check the
1401# syntax of the XML files.
1402
1403XML_SCHEMA =
1404
1405# The XML_DTD tag can be used to specify an XML DTD,
1406# which can be used by a validating XML parser to check the
1407# syntax of the XML files.
1408
1409XML_DTD =
1410
1411# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1412# dump the program listings (including syntax highlighting
1413# and cross-referencing information) to the XML output. Note that
1414# enabling this will significantly increase the size of the XML output.
1415
1416XML_PROGRAMLISTING = YES
1417
1418#---------------------------------------------------------------------------
1419# configuration options for the AutoGen Definitions output
1420#---------------------------------------------------------------------------
1421
1422# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1423# generate an AutoGen Definitions (see autogen.sf.net) file
1424# that captures the structure of the code including all
1425# documentation. Note that this feature is still experimental
1426# and incomplete at the moment.
1427
1428GENERATE_AUTOGEN_DEF = NO
1429
1430#---------------------------------------------------------------------------
1431# configuration options related to the Perl module output
1432#---------------------------------------------------------------------------
1433
1434# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1435# generate a Perl module file that captures the structure of
1436# the code including all documentation. Note that this
1437# feature is still experimental and incomplete at the
1438# moment.
1439
1440GENERATE_PERLMOD = NO
1441
1442# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1443# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1444# to generate PDF and DVI output from the Perl module output.
1445
1446PERLMOD_LATEX = NO
1447
1448# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1449# nicely formatted so it can be parsed by a human reader.
1450# This is useful
1451# if you want to understand what is going on.
1452# On the other hand, if this
1453# tag is set to NO the size of the Perl module output will be much smaller
1454# and Perl will parse it just the same.
1455
1456PERLMOD_PRETTY = YES
1457
1458# The names of the make variables in the generated doxyrules.make file
1459# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1460# This is useful so different doxyrules.make files included by the same
1461# Makefile don't overwrite each other's variables.
1462
1463PERLMOD_MAKEVAR_PREFIX =
1464
1465#---------------------------------------------------------------------------
1466# Configuration options related to the preprocessor
1467#---------------------------------------------------------------------------
1468
1469# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1470# evaluate all C-preprocessor directives found in the sources and include
1471# files.
1472
1473ENABLE_PREPROCESSING = YES
1474
1475# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1476# names in the source code. If set to NO (the default) only conditional
1477# compilation will be performed. Macro expansion can be done in a controlled
1478# way by setting EXPAND_ONLY_PREDEF to YES.
1479
1480MACRO_EXPANSION = NO
1481
1482# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1483# then the macro expansion is limited to the macros specified with the
1484# PREDEFINED and EXPAND_AS_DEFINED tags.
1485
1486EXPAND_ONLY_PREDEF = NO
1487
1488# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1489# pointed to by INCLUDE_PATH will be searched when a #include is found.
1490
1491SEARCH_INCLUDES = YES
1492
1493# The INCLUDE_PATH tag can be used to specify one or more directories that
1494# contain include files that are not input files but should be processed by
1495# the preprocessor.
1496
1497INCLUDE_PATH =
1498
1499# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1500# patterns (like *.h and *.hpp) to filter out the header-files in the
1501# directories. If left blank, the patterns specified with FILE_PATTERNS will
1502# be used.
1503
1504INCLUDE_FILE_PATTERNS =
1505
1506# The PREDEFINED tag can be used to specify one or more macro names that
1507# are defined before the preprocessor is started (similar to the -D option of
1508# gcc). The argument of the tag is a list of macros of the form: name
1509# or name=definition (no spaces). If the definition and the = are
1510# omitted =1 is assumed. To prevent a macro definition from being
1511# undefined via #undef or recursively expanded use the := operator
1512# instead of the = operator.
1513
1514PREDEFINED =
1515
1516# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1517# this tag can be used to specify a list of macro names that should be expanded.
1518# The macro definition that is found in the sources will be used.
1519# Use the PREDEFINED tag if you want to use a different macro definition that
1520# overrules the definition found in the source code.
1521
1522EXPAND_AS_DEFINED =
1523
1524# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1525# doxygen's preprocessor will remove all references to function-like macros
1526# that are alone on a line, have an all uppercase name, and do not end with a
1527# semicolon, because these will confuse the parser if not removed.
1528
1529SKIP_FUNCTION_MACROS = YES
1530
1531#---------------------------------------------------------------------------
1532# Configuration::additions related to external references
1533#---------------------------------------------------------------------------
1534
1535# The TAGFILES option can be used to specify one or more tagfiles. For each
1536# tag file the location of the external documentation should be added. The
1537# format of a tag file without this location is as follows:
1538#
1539# TAGFILES = file1 file2 ...
1540# Adding location for the tag files is done as follows:
1541#
1542# TAGFILES = file1=loc1 "file2 = loc2" ...
1543# where "loc1" and "loc2" can be relative or absolute paths
1544# or URLs. Note that each tag file must have a unique name (where the name does
1545# NOT include the path). If a tag file is not located in the directory in which
1546# doxygen is run, you must also specify the path to the tagfile here.
1547
1548TAGFILES =
1549
1550# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1551# a tag file that is based on the input files it reads.
1552
1553GENERATE_TAGFILE =
1554
1555# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1556# in the class index. If set to NO only the inherited external classes
1557# will be listed.
1558
1559ALLEXTERNALS = NO
1560
1561# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1562# in the modules index. If set to NO, only the current project's groups will
1563# be listed.
1564
1565EXTERNAL_GROUPS = YES
1566
1567# The PERL_PATH should be the absolute path and name of the perl script
1568# interpreter (i.e. the result of `which perl').
1569
1570PERL_PATH = /usr/bin/perl
1571
1572#---------------------------------------------------------------------------
1573# Configuration options related to the dot tool
1574#---------------------------------------------------------------------------
1575
1576# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1577# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1578# or super classes. Setting the tag to NO turns the diagrams off. Note that
1579# this option also works with HAVE_DOT disabled, but it is recommended to
1580# install and use dot, since it yields more powerful graphs.
1581
1582CLASS_DIAGRAMS = YES
1583
1584# You can define message sequence charts within doxygen comments using the \msc
1585# command. Doxygen will then run the mscgen tool (see
1586# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1587# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1588# the mscgen tool resides. If left empty the tool is assumed to be found in the
1589# default search path.
1590
1591MSCGEN_PATH =
1592
1593# If set to YES, the inheritance and collaboration graphs will hide
1594# inheritance and usage relations if the target is undocumented
1595# or is not a class.
1596
1597HIDE_UNDOC_RELATIONS = YES
1598
1599# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1600# available from the path. This tool is part of Graphviz, a graph visualization
1601# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1602# have no effect if this option is set to NO (the default)
1603
1604HAVE_DOT = NO
1605
1606# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1607# allowed to run in parallel. When set to 0 (the default) doxygen will
1608# base this on the number of processors available in the system. You can set it
1609# explicitly to a value larger than 0 to get control over the balance
1610# between CPU load and processing speed.
1611
1612DOT_NUM_THREADS = 0
1613
1614# By default doxygen will use the Helvetica font for all dot files that
1615# doxygen generates. When you want a differently looking font you can specify
1616# the font name using DOT_FONTNAME. You need to make sure dot is able to find
1617# the font, which can be done by putting it in a standard location or by setting
1618# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1619# directory containing the font.
1620
1621DOT_FONTNAME = Helvetica
1622
1623# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1624# The default size is 10pt.
1625
1626DOT_FONTSIZE = 10
1627
1628# By default doxygen will tell dot to use the Helvetica font.
1629# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1630# set the path where dot can find it.
1631
1632DOT_FONTPATH =
1633
1634# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1635# will generate a graph for each documented class showing the direct and
1636# indirect inheritance relations. Setting this tag to YES will force the
1637# CLASS_DIAGRAMS tag to NO.
1638
1639CLASS_GRAPH = YES
1640
1641# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1642# will generate a graph for each documented class showing the direct and
1643# indirect implementation dependencies (inheritance, containment, and
1644# class references variables) of the class with other documented classes.
1645
1646COLLABORATION_GRAPH = YES
1647
1648# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1649# will generate a graph for groups, showing the direct groups dependencies
1650
1651GROUP_GRAPHS = YES
1652
1653# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1654# collaboration diagrams in a style similar to the OMG's Unified Modeling
1655# Language.
1656
1657UML_LOOK = NO
1658
1659# If the UML_LOOK tag is enabled, the fields and methods are shown inside
1660# the class node. If there are many fields or methods and many nodes the
1661# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1662# threshold limits the number of items for each type to make the size more
1663# managable. Set this to 0 for no limit. Note that the threshold may be
1664# exceeded by 50% before the limit is enforced.
1665
1666UML_LIMIT_NUM_FIELDS = 10
1667
1668# If set to YES, the inheritance and collaboration graphs will show the
1669# relations between templates and their instances.
1670
1671TEMPLATE_RELATIONS = NO
1672
1673# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1674# tags are set to YES then doxygen will generate a graph for each documented
1675# file showing the direct and indirect include dependencies of the file with
1676# other documented files.
1677
1678INCLUDE_GRAPH = YES
1679
1680# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1681# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1682# documented header file showing the documented files that directly or
1683# indirectly include this file.
1684
1685INCLUDED_BY_GRAPH = YES
1686
1687# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1688# doxygen will generate a call dependency graph for every global function
1689# or class method. Note that enabling this option will significantly increase
1690# the time of a run. So in most cases it will be better to enable call graphs
1691# for selected functions only using the \callgraph command.
1692
1693CALL_GRAPH = NO
1694
1695# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1696# doxygen will generate a caller dependency graph for every global function
1697# or class method. Note that enabling this option will significantly increase
1698# the time of a run. So in most cases it will be better to enable caller
1699# graphs for selected functions only using the \callergraph command.
1700
1701CALLER_GRAPH = NO
1702
1703# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1704# will generate a graphical hierarchy of all classes instead of a textual one.
1705
1706GRAPHICAL_HIERARCHY = YES
1707
1708# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
1709# then doxygen will show the dependencies a directory has on other directories
1710# in a graphical way. The dependency relations are determined by the #include
1711# relations between the files in the directories.
1712
1713DIRECTORY_GRAPH = YES
1714
1715# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1716# generated by dot. Possible values are svg, png, jpg, or gif.
1717# If left blank png will be used. If you choose svg you need to set
1718# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1719# visible in IE 9+ (other browsers do not have this requirement).
1720
1721DOT_IMAGE_FORMAT = png
1722
1723# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1724# enable generation of interactive SVG images that allow zooming and panning.
1725# Note that this requires a modern browser other than Internet Explorer.
1726# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1727# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1728# visible. Older versions of IE do not have SVG support.
1729
1730INTERACTIVE_SVG = NO
1731
1732# The tag DOT_PATH can be used to specify the path where the dot tool can be
1733# found. If left blank, it is assumed the dot tool can be found in the path.
1734
1735DOT_PATH =
1736
1737# The DOTFILE_DIRS tag can be used to specify one or more directories that
1738# contain dot files that are included in the documentation (see the
1739# \dotfile command).
1740
1741DOTFILE_DIRS =
1742
1743# The MSCFILE_DIRS tag can be used to specify one or more directories that
1744# contain msc files that are included in the documentation (see the
1745# \mscfile command).
1746
1747MSCFILE_DIRS =
1748
1749# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1750# nodes that will be shown in the graph. If the number of nodes in a graph
1751# becomes larger than this value, doxygen will truncate the graph, which is
1752# visualized by representing a node as a red box. Note that doxygen if the
1753# number of direct children of the root node in a graph is already larger than
1754# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1755# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1756
1757DOT_GRAPH_MAX_NODES = 50
1758
1759# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1760# graphs generated by dot. A depth value of 3 means that only nodes reachable
1761# from the root by following a path via at most 3 edges will be shown. Nodes
1762# that lay further from the root node will be omitted. Note that setting this
1763# option to 1 or 2 may greatly reduce the computation time needed for large
1764# code bases. Also note that the size of a graph can be further restricted by
1765# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1766
1767MAX_DOT_GRAPH_DEPTH = 0
1768
1769# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1770# background. This is disabled by default, because dot on Windows does not
1771# seem to support this out of the box. Warning: Depending on the platform used,
1772# enabling this option may lead to badly anti-aliased labels on the edges of
1773# a graph (i.e. they become hard to read).
1774
1775DOT_TRANSPARENT = NO
1776
1777# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1778# files in one run (i.e. multiple -o and -T options on the command line). This
1779# makes dot run faster, but since only newer versions of dot (>1.8.10)
1780# support this, this feature is disabled by default.
1781
1782DOT_MULTI_TARGETS = YES
1783
1784# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1785# generate a legend page explaining the meaning of the various boxes and
1786# arrows in the dot generated graphs.
1787
1788GENERATE_LEGEND = YES
1789
1790# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1791# remove the intermediate dot files that are used to generate
1792# the various graphs.
1793
1794DOT_CLEANUP = YES
Note: See TracBrowser for help on using the repository browser.