3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project
6
# All text after a hash (#) is considered a comment and will be ignored
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 (" ")
13
#---------------------------------------------------------------------------
14
# General configuration options
15
#---------------------------------------------------------------------------
17
HIDE_FRIEND_COMPOUNDS = yes
19
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
20
# by quotes) that should identify the project.
24
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
25
# This could be handy for archiving the generated documentation or
26
# if some version control system is used.
30
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
31
# base path where the generated documentation will be put.
32
# If a relative path is entered, it will be relative to the location
33
# where doxygen was started. If left blank the current directory will be used.
37
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
38
# documentation generated by doxygen is written. Doxygen will use this
39
# information to generate all constant output in the proper language.
40
# The default language is English, other supported languages are:
41
# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
42
# German, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
43
# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
45
OUTPUT_LANGUAGE = English
47
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
48
# documentation are documented, even if no documentation was available.
49
# Private class members and static file members will be hidden unless
50
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
54
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
55
# will be included in the documentation.
59
# If the EXTRACT_STATIC tag is set to YES all static members of a file
60
# will be included in the documentation.
64
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
65
# undocumented members of documented classes, files or namespaces.
66
# If set to NO (the default) these members will be included in the
67
# various overviews, but no documentation section is generated.
68
# This option has no effect if EXTRACT_ALL is enabled.
70
HIDE_UNDOC_MEMBERS = NO
72
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
73
# undocumented classes that are normally visible in the class hierarchy.
74
# If set to NO (the default) these class will be included in the various
75
# overviews. This option has no effect if EXTRACT_ALL is enabled.
77
HIDE_UNDOC_CLASSES = NO
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.
84
BRIEF_MEMBER_DESC = YES
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.
93
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
94
# Doxygen will generate a detailed section even if there is only a brief
97
ALWAYS_DETAILED_SEC = NO
99
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
100
# path before files name in the file list and in the header files. If set
101
# to NO the shortest path that makes the file name unique will be used.
105
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
106
# can be used to strip a user defined part of the path. Stripping is
107
# only done if one of the specified strings matches the left-hand part of
108
# the path. It is allowed to use relative paths in the argument list.
112
# The INTERNAL_DOCS tag determines if documentation
113
# that is typed after a \internal command is included. If the tag is set
114
# to NO (the default) then the documentation will be excluded.
115
# Set it to YES to include the internal documentation.
119
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
120
# doxygen to hide any special comment blocks from generated source code
121
# fragments. Normal C and C++ comments will always remain visible.
123
STRIP_CODE_COMMENTS = YES
125
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
126
# file names in lower case letters. If set to YES upper case letters are also
127
# allowed. This is useful if you have classes or files whose names only differ
128
# in case and if your file system supports case sensitive file names. Windows
129
# users are adviced to set this option to NO.
131
CASE_SENSE_NAMES = YES
133
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
134
# (but less readable) file names. This can be useful is your file systems
135
# doesn't support long names like on DOS, Mac, or CD-ROM.
139
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
140
# will show members with their full class and namespace scopes in the
141
# documentation. If set to YES the scope will be hidden.
143
HIDE_SCOPE_NAMES = NO
145
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
146
# will generate a verbatim copy of the header file for each class for
147
# which an include is specified. Set to NO to disable this.
149
VERBATIM_HEADERS = NO
151
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
152
# will put list of the files that are included by a file in the documentation
155
SHOW_INCLUDE_FILES = YES
157
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
158
# will interpret the first line (until the first dot) of a JavaDoc-style
159
# comment as the brief description. If set to NO, the JavaDoc
160
# comments will behave just like the Qt-style comments (thus requiring an
161
# explict @brief command for a brief description.
163
JAVADOC_AUTOBRIEF = NO
165
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
166
# member inherits the documentation from any documented member that it
171
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
172
# is inserted in the documentation for inline members.
176
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
177
# will sort the (detailed) documentation of file and class members
178
# alphabetically by member name. If set to NO the members will appear in
181
SORT_MEMBER_DOCS = YES
183
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
184
# tag is set to YES, then doxygen will reuse the documentation of the first
185
# member in the group (if any) for the other members of the group. By default
186
# all members of a group must be documented explicitly.
188
DISTRIBUTE_GROUP_DOC = NO
190
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
191
# Doxygen uses this value to replace tabs by spaces in code fragments.
195
# The GENERATE_TODOLIST tag can be used to enable (YES) or
196
# disable (NO) the todo list. This list is created by putting \todo
197
# commands in the documentation.
199
GENERATE_TODOLIST = YES
201
# The GENERATE_TESTLIST tag can be used to enable (YES) or
202
# disable (NO) the test list. This list is created by putting \test
203
# commands in the documentation.
205
GENERATE_TESTLIST = YES
207
# The GENERATE_BUGLIST tag can be used to enable (YES) or
208
# disable (NO) the bug list. This list is created by putting \bug
209
# commands in the documentation.
211
GENERATE_BUGLIST = YES
213
# This tag can be used to specify a number of aliases that acts
214
# as commands in the documentation. An alias has the form "name=value".
215
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
216
# put the command \sideeffect (or @sideeffect) in the documentation, which
217
# will result in a user defined paragraph with heading "Side Effects:".
218
# You can put \n's in the value part of an alias to insert newlines.
222
# The ENABLED_SECTIONS tag can be used to enable conditional
223
# documentation sections, marked by \if sectionname ... \endif.
227
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
228
# the initial value of a variable or define consist of for it to appear in
229
# the documentation. If the initializer consists of more lines than specified
230
# here it will be hidden. Use a value of 0 to hide initializers completely.
231
# The appearance of the initializer of individual variables and defines in the
232
# documentation can be controlled using \showinitializer or \hideinitializer
233
# command in the documentation regardless of this setting.
235
MAX_INITIALIZER_LINES = 30
237
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
238
# only. Doxygen will then generate output that is more tailored for C.
239
# For instance some of the names that are used will be different. The list
240
# of all members will be omitted, etc.
242
OPTIMIZE_OUTPUT_FOR_C = NO
244
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
245
# at the bottom of the documentation of classes and structs. If set to YES the
246
# list will mention the files that were used to generate the documentation.
250
#---------------------------------------------------------------------------
251
# configuration options related to warning and progress messages
252
#---------------------------------------------------------------------------
254
# The QUIET tag can be used to turn on/off the messages that are generated
255
# by doxygen. Possible values are YES and NO. If left blank NO is used.
259
# The WARNINGS tag can be used to turn on/off the warning messages that are
260
# generated by doxygen. Possible values are YES and NO. If left blank
265
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
266
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
267
# automatically be disabled.
269
WARN_IF_UNDOCUMENTED = YES
271
# The WARN_FORMAT tag determines the format of the warning messages that
272
# doxygen can produce. The string should contain the $file, $line, and $text
273
# tags, which will be replaced by the file and line number from which the
274
# warning originated and the warning text.
278
# The WARN_LOGFILE tag can be used to specify a file to which warning
279
# and error messages should be written. If left blank the output is written
284
#---------------------------------------------------------------------------
285
# configuration options related to the input files
286
#---------------------------------------------------------------------------
288
# The INPUT tag can be used to specify the files and/or directories that contain
289
# documented source files. You may enter file names like "myfile.cpp" or
290
# directories like "/usr/src/myproject". Separate the files or directories
295
# If the value of the INPUT tag contains directories, you can use the
296
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
297
# and *.h) to filter out the source-files in the directories. If left
298
# blank file matching one of the following patterns are included:
299
# *.c *.cc *.cxx *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
304
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
305
# should be searched for input files as well. Possible values are YES and NO.
306
# If left blank NO is used.
310
# The EXCLUDE tag can be used to specify files and/or directories that should
311
# excluded from the INPUT source files. This way you can easily exclude a
312
# subdirectory from a directory tree whose root is specified with the INPUT tag.
316
# If the value of the INPUT tag contains directories, you can use the
317
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
318
# certain files from those directories.
322
# The EXAMPLE_PATH tag can be used to specify one or more files or
323
# directories that contain example code fragments that are included (see
324
# the \include command).
328
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
329
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
330
# and *.h) to filter out the source-files in the directories. If left
331
# blank all files are included.
335
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
336
# searched for input files to be used with the \include or \dontinclude
337
# commands irrespective of the value of the RECURSIVE tag.
338
# Possible values are YES and NO. If left blank NO is used.
340
EXAMPLE_RECURSIVE = NO
342
# The IMAGE_PATH tag can be used to specify one or more files or
343
# directories that contain image that are included in the documentation (see
344
# the \image command).
348
# The INPUT_FILTER tag can be used to specify a program that doxygen should
349
# invoke to filter for each input file. Doxygen will invoke the filter program
350
# by executing (via popen()) the command <filter> <input-file>, where <filter>
351
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
352
# input file. Doxygen will then use the output that the filter program writes
353
# to standard output.
357
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
358
# INPUT_FILTER) will be used to filter the input files when producing source
361
FILTER_SOURCE_FILES = NO
363
#---------------------------------------------------------------------------
364
# configuration options related to source browsing
365
#---------------------------------------------------------------------------
367
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
368
# be generated. Documented entities will be cross-referenced with these sources.
372
# Setting the INLINE_SOURCES tag to YES will include the body
373
# of functions and classes directly in the documentation.
377
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
378
# then for each documented function all documented
379
# functions referencing it will be listed.
381
REFERENCED_BY_RELATION = YES
383
# If the REFERENCES_RELATION tag is set to YES (the default)
384
# then for each documented function all documented entities
385
# called/used by that function will be listed.
387
REFERENCES_RELATION = YES
389
#---------------------------------------------------------------------------
390
# configuration options related to the alphabetical class index
391
#---------------------------------------------------------------------------
393
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
394
# of all compounds will be generated. Enable this if the project
395
# contains a lot of classes, structs, unions or interfaces.
397
ALPHABETICAL_INDEX = NO
399
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
400
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
401
# in which this list will be split (can be a number in the range [1..20])
403
COLS_IN_ALPHA_INDEX = 5
405
# In case all classes in a project start with a common prefix, all
406
# classes will be put under the same header in the alphabetical index.
407
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
408
# should be ignored while generating the index headers.
412
#---------------------------------------------------------------------------
413
# configuration options related to the HTML output
414
#---------------------------------------------------------------------------
416
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
417
# generate HTML output.
421
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
422
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
423
# put in front of it. If left blank `html' will be used as the default path.
425
HTML_OUTPUT = ../.doxyout/mgmapi.html
427
# The HTML_HEADER tag can be used to specify a personal HTML header for
428
# each generated HTML page. If it is left blank doxygen will generate a
433
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
434
# each generated HTML page. If it is left blank doxygen will generate a
437
HTML_FOOTER = footer.html
439
# The HTML_STYLESHEET tag can be used to specify a user defined cascading
440
# style sheet that is used by each HTML page. It can be used to
441
# fine-tune the look of the HTML output. If the tag is left blank doxygen
442
# will generate a default style sheet
446
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
447
# files or namespaces will be aligned in HTML using tables. If set to
448
# NO a bullet list will be used.
450
HTML_ALIGN_MEMBERS = NO
452
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
453
# will be generated that can be used as input for tools like the
454
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
455
# of the generated HTML documentation.
457
GENERATE_HTMLHELP = NO
459
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
460
# controls if a separate .chi index file is generated (YES) or that
461
# it should be included in the master .chm file (NO).
465
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
466
# controls whether a binary table of contents is generated (YES) or a
467
# normal table of contents (NO) in the .chm file.
471
# The TOC_EXPAND flag can be set to YES to add extra items for group members
472
# to the contents of the Html help documentation and to the tree view.
476
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
477
# top of each HTML page. The value NO (the default) enables the index and
478
# the value YES disables it.
482
# This tag can be used to set the number of enum values (range [1..20])
483
# that doxygen will group on one line in the generated HTML documentation.
485
ENUM_VALUES_PER_LINE = 4
487
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
488
# generated containing a tree-like index structure (just like the one that
489
# is generated for HTML Help). For this to work a browser that supports
490
# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
491
# or Internet explorer 4.0+). Note that for large projects the tree generation
492
# can take a very long time. In such cases it is better to disable this feature.
493
# Windows users are probably better off using the HTML help feature.
495
GENERATE_TREEVIEW = NO
497
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
498
# used to set the initial width (in pixels) of the frame in which the tree
503
#---------------------------------------------------------------------------
504
# configuration options related to the LaTeX output
505
#---------------------------------------------------------------------------
507
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
508
# generate Latex output.
512
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
513
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
514
# put in front of it. If left blank `latex' will be used as the default path.
516
LATEX_OUTPUT = ../.doxyout/mgmapi.latex
518
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
519
# LaTeX documents. This may be useful for small projects and may help to
520
# save some trees in general.
524
# The PAPER_TYPE tag can be used to set the paper type that is used
525
# by the printer. Possible values are: a4, a4wide, letter, legal and
526
# executive. If left blank a4wide will be used.
530
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
531
# packages that should be included in the LaTeX output.
535
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
536
# the generated latex document. The header should contain everything until
537
# the first chapter. If it is left blank doxygen will generate a
538
# standard header. Notice: only use this tag if you know what you are doing!
540
LATEX_HEADER = ../doxygen/header.mgmapi.tex
542
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
543
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
544
# contain links (just like the HTML output) instead of page references
545
# This makes the output suitable for online browsing using a pdf viewer.
549
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
550
# plain latex in the generated Makefile. Set this option to YES to get a
551
# higher quality PDF documentation.
555
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
556
# command to the generated LaTeX files. This will instruct LaTeX to keep
557
# running if errors occur, instead of asking the user for help.
558
# This option is also used when generating formulas in HTML.
562
#---------------------------------------------------------------------------
563
# configuration options related to the RTF output
564
#---------------------------------------------------------------------------
566
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
567
# The RTF output is optimised for Word 97 and may not look very pretty with
568
# other RTF readers or editors.
572
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
573
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
574
# put in front of it. If left blank `rtf' will be used as the default path.
576
RTF_OUTPUT = ../mgmapi.rtf
578
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
579
# RTF documents. This may be useful for small projects and may help to
580
# save some trees in general.
584
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
585
# will contain hyperlink fields. The RTF file will
586
# contain links (just like the HTML output) instead of page references.
587
# This makes the output suitable for online browsing using WORD or other
588
# programs which support those fields.
589
# Note: wordpad (write) and others do not support links.
593
# Load stylesheet definitions from file. Syntax is similar to doxygen's
594
# config file, i.e. a series of assigments. You only have to provide
595
# replacements, missing definitions are set to their default value.
597
RTF_STYLESHEET_FILE =
599
# Set optional variables used in the generation of an rtf document.
600
# Syntax is similar to doxygen's config file.
602
RTF_EXTENSIONS_FILE =
604
#---------------------------------------------------------------------------
605
# configuration options related to the man page output
606
#---------------------------------------------------------------------------
608
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
613
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
614
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
615
# put in front of it. If left blank `man' will be used as the default path.
619
# The MAN_EXTENSION tag determines the extension that is added to
620
# the generated man pages (default is the subroutine's section .3)
624
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
625
# then it will generate one additional man file for each entity
626
# documented in the real man page(s). These additional files
627
# only source the real man page, but without them the man command
628
# would be unable to find the correct page. The default is NO.
632
#---------------------------------------------------------------------------
633
# configuration options related to the XML output
634
#---------------------------------------------------------------------------
636
# If the GENERATE_XML tag is set to YES Doxygen will
637
# generate an XML file that captures the structure of
638
# the code including all documentation. Note that this
639
# feature is still experimental and incomplete at the
644
#---------------------------------------------------------------------------
645
# Configuration options related to the preprocessor
646
#---------------------------------------------------------------------------
648
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
649
# evaluate all C-preprocessor directives found in the sources and include
652
ENABLE_PREPROCESSING = YES
654
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
655
# names in the source code. If set to NO (the default) only conditional
656
# compilation will be performed. Macro expansion can be done in a controlled
657
# way by setting EXPAND_ONLY_PREDEF to YES.
659
MACRO_EXPANSION = YES
661
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
662
# then the macro expansion is limited to the macros specified with the
663
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
665
EXPAND_ONLY_PREDEF = YES
667
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
668
# in the INCLUDE_PATH (see below) will be search if a #include is found.
670
SEARCH_INCLUDES = YES
672
# The INCLUDE_PATH tag can be used to specify one or more directories that
673
# contain include files that are not input files but should be processed by
678
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
679
# patterns (like *.h and *.hpp) to filter out the header-files in the
680
# directories. If left blank, the patterns specified with FILE_PATTERNS will
683
INCLUDE_FILE_PATTERNS =
685
# The PREDEFINED tag can be used to specify one or more macro names that
686
# are defined before the preprocessor is started (similar to the -D option of
687
# gcc). The argument of the tag is a list of macros of the form: name
688
# or name=definition (no spaces). If the definition and the = are
689
# omitted =1 is assumed.
691
PREDEFINED = DOXYGEN_FIX \
692
DOXYGEN_SHOULD_SKIP_DEPRECATED \
693
DOXYGEN_SHOULD_SKIP_INTERNAL \
696
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
697
# this tag can be used to specify a list of macro names that should be expanded.
698
# The macro definition that is found in the sources will be used.
699
# Use the PREDEFINED tag if you want to use a different macro definition.
703
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
704
# doxygen's preprocessor will remove all function-like macros that are alone
705
# on a line and do not end with a semicolon. Such function macros are typically
706
# used for boiler-plate code, and will confuse the parser if not removed.
708
SKIP_FUNCTION_MACROS = YES
710
#---------------------------------------------------------------------------
711
# Configuration::addtions related to external references
712
#---------------------------------------------------------------------------
714
# The TAGFILES tag can be used to specify one or more tagfiles.
718
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
719
# a tag file that is based on the input files it reads.
723
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
724
# in the class index. If set to NO only the inherited external classes
729
# The PERL_PATH should be the absolute path and name of the perl script
730
# interpreter (i.e. the result of `which perl').
734
#---------------------------------------------------------------------------
735
# Configuration options related to the dot tool
736
#---------------------------------------------------------------------------
738
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
739
# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
740
# super classes. Setting the tag to NO turns the diagrams off. Note that this
741
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
742
# recommended to install and use dot, since it yield more powerful graphs.
746
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
747
# available from the path. This tool is part of Graphviz, a graph visualization
748
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
749
# have no effect if this option is set to NO (the default)
753
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
754
# will generate a graph for each documented class showing the direct and
755
# indirect inheritance relations. Setting this tag to YES will force the
756
# the CLASS_DIAGRAMS tag to NO.
760
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
761
# will generate a graph for each documented class showing the direct and
762
# indirect implementation dependencies (inheritance, containment, and
763
# class references variables) of the class with other documented classes.
765
COLLABORATION_GRAPH = YES
767
# If set to YES, the inheritance and collaboration graphs will show the
768
# relations between templates and their instances.
770
TEMPLATE_RELATIONS = YES
772
# If set to YES, the inheritance and collaboration graphs will hide
773
# inheritance and usage relations if the target is undocumented
776
HIDE_UNDOC_RELATIONS = YES
778
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
779
# tags are set to YES then doxygen will generate a graph for each documented
780
# file showing the direct and indirect include dependencies of the file with
781
# other documented files.
785
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
786
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
787
# documented header file showing the documented files that directly or
788
# indirectly include this file.
790
INCLUDED_BY_GRAPH = YES
792
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
793
# will graphical hierarchy of all classes instead of a textual one.
795
GRAPHICAL_HIERARCHY = YES
797
# The tag DOT_PATH can be used to specify the path where the dot tool can be
798
# found. If left blank, it is assumed the dot tool can be found on the path.
802
# The DOTFILE_DIRS tag can be used to specify one or more directories that
803
# contain dot files that are included in the documentation (see the
808
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
809
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
810
# this value, doxygen will try to truncate the graph, so that it fits within
811
# the specified constraint. Beware that most browsers cannot cope with very
814
MAX_DOT_GRAPH_WIDTH = 1024
816
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
817
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
818
# this value, doxygen will try to truncate the graph, so that it fits within
819
# the specified constraint. Beware that most browsers cannot cope with very
822
MAX_DOT_GRAPH_HEIGHT = 1024
824
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
825
# generate a legend page explaining the meaning of the various boxes and
826
# arrows in the dot generated graphs.
828
GENERATE_LEGEND = YES
830
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
831
# remove the intermedate dot files that are used to generate
832
# the various graphs.
836
#---------------------------------------------------------------------------
837
# Configuration::addtions related to the search engine
838
#---------------------------------------------------------------------------
840
# The SEARCHENGINE tag specifies whether or not a search engine should be
841
# used. If set to NO the values of all tags below this one will be ignored.
845
# The CGI_NAME tag should be the name of the CGI script that
846
# starts the search engine (doxysearch) with the correct parameters.
847
# A script with this name will be generated by doxygen.
851
# The CGI_URL tag should be the absolute URL to the directory where the
852
# cgi binaries are located. See the documentation of your http daemon for
857
# The DOC_URL tag should be the absolute URL to the directory where the
858
# documentation is located. If left blank the absolute path to the
859
# documentation, with file:// prepended to it, will be used.
863
# The DOC_ABSPATH tag should be the absolute path to the directory where the
864
# documentation is located. If left blank the directory on the local machine
869
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
874
# The EXT_DOC_PATHS tag can be used to specify one or more paths to
875
# documentation generated for other projects. This allows doxysearch to search
876
# the documentation for these projects as well.
added
removed
ndb/docs/doxygen/Doxyfile.mgmapi
