source: pacpussensors/trunk/Vislab/lib3dv-1.2.0/doc/Doxyfile.in@ 141

Last change on this file since 141 was 136, checked in by ldecherf, 8 years ago

Doc

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