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
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18
# by quotes) that should identify the project.
20
PROJECT_NAME = NetIDMgr
22
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23
# This could be handy for archiving the generated documentation or
24
# if some version control system is used.
28
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29
# base path where the generated documentation will be put.
30
# If a relative path is entered, it will be relative to the location
31
# where doxygen was started. If left blank the current directory will be used.
35
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36
# documentation generated by doxygen is written. Doxygen will use this
37
# information to generate all constant output in the proper language.
38
# The default language is English, other supported languages are:
39
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41
# (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
42
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
44
OUTPUT_LANGUAGE = English
46
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
47
# documentation are documented, even if no documentation was available.
48
# Private class members and static file members will be hidden unless
49
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
53
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
54
# will be included in the documentation.
58
# If the EXTRACT_STATIC tag is set to YES all static members of a file
59
# will be included in the documentation.
63
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
64
# defined locally in source files will be included in the documentation.
65
# If set to NO only classes defined in header files are included.
67
EXTRACT_LOCAL_CLASSES = YES
69
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
70
# undocumented members of documented classes, files or namespaces.
71
# If set to NO (the default) these members will be included in the
72
# various overviews, but no documentation section is generated.
73
# This option has no effect if EXTRACT_ALL is enabled.
75
HIDE_UNDOC_MEMBERS = NO
77
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
78
# undocumented classes that are normally visible in the class hierarchy.
79
# If set to NO (the default) these class will be included in the various
80
# overviews. This option has no effect if EXTRACT_ALL is enabled.
82
HIDE_UNDOC_CLASSES = NO
84
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
85
# friend (class|struct|union) declarations.
86
# If set to NO (the default) these declarations will be included in the
89
HIDE_FRIEND_COMPOUNDS = NO
91
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
92
# include brief member descriptions after the members that are listed in
93
# the file and class documentation (similar to JavaDoc).
94
# Set to NO to disable this.
96
BRIEF_MEMBER_DESC = YES
98
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will
99
# prepend the brief description of a member or function before the
100
# detailed description. Note: if both HIDE_UNDOC_MEMBERS and
101
# BRIEF_MEMBER_DESC are set to NO, the brief descriptions will be
102
# completely suppressed.
106
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
107
# Doxygen will generate a detailed section even if there is only a brief
110
ALWAYS_DETAILED_SEC = NO
112
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show
113
# all inherited members of a class in the documentation of that class
114
# as if those members were ordinary class members. Constructors,
115
# destructors and assignment operators of the base classes will not be
118
INLINE_INHERITED_MEMB = NO
120
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
121
# path before files name in the file list and in the header files. If set
122
# to NO the shortest path that makes the file name unique will be used.
126
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
127
# can be used to strip a user defined part of the path. Stripping is
128
# only done if one of the specified strings matches the left-hand part of
129
# the path. It is allowed to use relative paths in the argument list.
133
# The INTERNAL_DOCS tag determines if documentation
134
# that is typed after a \internal command is included. If the tag is set
135
# to NO (the default) then the documentation will be excluded.
136
# Set it to YES to include the internal documentation.
140
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
141
# doxygen to hide any special comment blocks from generated source code
142
# fragments. Normal C and C++ comments will always remain visible.
144
STRIP_CODE_COMMENTS = YES
146
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
147
# file names in lower case letters. If set to YES upper case letters are also
148
# allowed. This is useful if you have classes or files whose names only differ
149
# in case and if your file system supports case sensitive file names. Windows
150
# users are adviced to set this option to NO.
152
CASE_SENSE_NAMES = YES
154
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
155
# (but less readable) file names. This can be useful is your file systems
156
# doesn't support long names like on DOS, Mac, or CD-ROM.
160
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
161
# will show members with their full class and namespace scopes in the
162
# documentation. If set to YES the scope will be hidden.
164
HIDE_SCOPE_NAMES = NO
166
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
167
# will generate a verbatim copy of the header file for each class for
168
# which an include is specified. Set to NO to disable this.
170
VERBATIM_HEADERS = NO
172
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
173
# will put list of the files that are included by a file in the documentation
176
SHOW_INCLUDE_FILES = YES
178
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
179
# will interpret the first line (until the first dot) of a JavaDoc-style
180
# comment as the brief description. If set to NO, the JavaDoc
181
# comments will behave just like the Qt-style comments (thus requiring an
182
# explict @brief command for a brief description.
184
JAVADOC_AUTOBRIEF = NO
186
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
187
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
188
# comments) as a brief description. This used to be the default behaviour.
189
# The new default is to treat a multi-line C++ comment block as a detailed
190
# description. Set this tag to YES if you prefer the old behaviour instead.
192
MULTILINE_CPP_IS_BRIEF = NO
194
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
195
# will output the detailed description near the top, like JavaDoc.
196
# If set to NO, the detailed description appears after the member
201
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
202
# member inherits the documentation from any documented member that it
207
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
208
# is inserted in the documentation for inline members.
212
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
213
# will sort the (detailed) documentation of file and class members
214
# alphabetically by member name. If set to NO the members will appear in
217
SORT_MEMBER_DOCS = YES
219
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
220
# tag is set to YES, then doxygen will reuse the documentation of the first
221
# member in the group (if any) for the other members of the group. By default
222
# all members of a group must be documented explicitly.
224
DISTRIBUTE_GROUP_DOC = NO
226
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
227
# Doxygen uses this value to replace tabs by spaces in code fragments.
231
# The GENERATE_TODOLIST tag can be used to enable (YES) or
232
# disable (NO) the todo list. This list is created by putting \todo
233
# commands in the documentation.
235
GENERATE_TODOLIST = YES
237
# The GENERATE_TESTLIST tag can be used to enable (YES) or
238
# disable (NO) the test list. This list is created by putting \test
239
# commands in the documentation.
241
GENERATE_TESTLIST = YES
243
# The GENERATE_BUGLIST tag can be used to enable (YES) or
244
# disable (NO) the bug list. This list is created by putting \bug
245
# commands in the documentation.
247
GENERATE_BUGLIST = YES
249
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
250
# disable (NO) the deprecated list. This list is created by putting \deprecated commands in the documentation.
252
GENERATE_DEPRECATEDLIST= YES
254
# This tag can be used to specify a number of aliases that acts
255
# as commands in the documentation. An alias has the form "name=value".
256
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
257
# put the command \sideeffect (or @sideeffect) in the documentation, which
258
# will result in a user defined paragraph with heading "Side Effects:".
259
# You can put \n's in the value part of an alias to insert newlines.
263
# The ENABLED_SECTIONS tag can be used to enable conditional
264
# documentation sections, marked by \if sectionname ... \endif.
268
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
269
# the initial value of a variable or define consist of for it to appear in
270
# the documentation. If the initializer consists of more lines than specified
271
# here it will be hidden. Use a value of 0 to hide initializers completely.
272
# The appearance of the initializer of individual variables and defines in the
273
# documentation can be controlled using \showinitializer or \hideinitializer
274
# command in the documentation regardless of this setting.
276
MAX_INITIALIZER_LINES = 30
278
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
279
# only. Doxygen will then generate output that is more tailored for C.
280
# For instance some of the names that are used will be different. The list
281
# of all members will be omitted, etc.
283
OPTIMIZE_OUTPUT_FOR_C = YES
285
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
286
# only. Doxygen will then generate output that is more tailored for Java.
287
# For instance namespaces will be presented as packages, qualified scopes
288
# will look different, etc.
290
OPTIMIZE_OUTPUT_JAVA = NO
292
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
293
# at the bottom of the documentation of classes and structs. If set to YES the
294
# list will mention the files that were used to generate the documentation.
296
SHOW_USED_FILES = YES
298
SHOW_DIRECTORIES = NO
300
#---------------------------------------------------------------------------
301
# configuration options related to warning and progress messages
302
#---------------------------------------------------------------------------
304
# The QUIET tag can be used to turn on/off the messages that are generated
305
# by doxygen. Possible values are YES and NO. If left blank NO is used.
309
# The WARNINGS tag can be used to turn on/off the warning messages that are
310
# generated by doxygen. Possible values are YES and NO. If left blank
315
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
316
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
317
# automatically be disabled.
319
WARN_IF_UNDOCUMENTED = YES
321
# The WARN_FORMAT tag determines the format of the warning messages that
322
# doxygen can produce. The string should contain the $file, $line, and $text
323
# tags, which will be replaced by the file and line number from which the
324
# warning originated and the warning text.
326
WARN_FORMAT = "$file:$line: $text"
328
# The WARN_LOGFILE tag can be used to specify a file to which warning
329
# and error messages should be written. If left blank the output is written
334
#---------------------------------------------------------------------------
335
# configuration options related to the input files
336
#---------------------------------------------------------------------------
338
# The INPUT tag can be used to specify the files and/or directories that contain
339
# documented source files. You may enter file names like "myfile.cpp" or
340
# directories like "/usr/src/myproject". Separate the files or directories
345
# If the value of the INPUT tag contains directories, you can use the
346
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
347
# and *.h) to filter out the source-files in the directories. If left
348
# blank the following patterns are tested:
349
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
354
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
355
# should be searched for input files as well. Possible values are YES and NO.
356
# If left blank NO is used.
360
# The EXCLUDE tag can be used to specify files and/or directories that should
361
# excluded from the INPUT source files. This way you can easily exclude a
362
# subdirectory from a directory tree whose root is specified with the INPUT tag.
366
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
367
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
369
EXCLUDE_SYMLINKS = NO
371
# If the value of the INPUT tag contains directories, you can use the
372
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
373
# certain files from those directories.
377
# The EXAMPLE_PATH tag can be used to specify one or more files or
378
# directories that contain example code fragments that are included (see
379
# the \include command).
383
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
384
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
385
# and *.h) to filter out the source-files in the directories. If left
386
# blank all files are included.
390
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
391
# searched for input files to be used with the \include or \dontinclude
392
# commands irrespective of the value of the RECURSIVE tag.
393
# Possible values are YES and NO. If left blank NO is used.
395
EXAMPLE_RECURSIVE = NO
397
# The IMAGE_PATH tag can be used to specify one or more files or
398
# directories that contain image that are included in the documentation (see
399
# the \image command).
403
# The INPUT_FILTER tag can be used to specify a program that doxygen should
404
# invoke to filter for each input file. Doxygen will invoke the filter program
405
# by executing (via popen()) the command <filter> <input-file>, where <filter>
406
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
407
# input file. Doxygen will then use the output that the filter program writes
408
# to standard output.
412
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
413
# INPUT_FILTER) will be used to filter the input files when producing source
414
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
416
FILTER_SOURCE_FILES = NO
418
#---------------------------------------------------------------------------
419
# configuration options related to source browsing
420
#---------------------------------------------------------------------------
422
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
423
# be generated. Documented entities will be cross-referenced with these sources.
427
# Setting the INLINE_SOURCES tag to YES will include the body
428
# of functions and classes directly in the documentation.
432
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
433
# then for each documented function all documented
434
# functions referencing it will be listed.
436
REFERENCED_BY_RELATION = YES
438
# If the REFERENCES_RELATION tag is set to YES (the default)
439
# then for each documented function all documented entities
440
# called/used by that function will be listed.
442
REFERENCES_RELATION = YES
444
#---------------------------------------------------------------------------
445
# configuration options related to the alphabetical class index
446
#---------------------------------------------------------------------------
448
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
449
# of all compounds will be generated. Enable this if the project
450
# contains a lot of classes, structs, unions or interfaces.
452
ALPHABETICAL_INDEX = YES
454
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
455
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
456
# in which this list will be split (can be a number in the range [1..20])
458
COLS_IN_ALPHA_INDEX = 5
460
# In case all classes in a project start with a common prefix, all
461
# classes will be put under the same header in the alphabetical index.
462
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
463
# should be ignored while generating the index headers.
467
#---------------------------------------------------------------------------
468
# configuration options related to the HTML output
469
#---------------------------------------------------------------------------
471
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
472
# generate HTML output.
476
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
477
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
478
# put in front of it. If left blank `html' will be used as the default path.
482
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
483
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
484
# doxygen will generate files with .html extension.
486
HTML_FILE_EXTENSION = .html
488
# The HTML_HEADER tag can be used to specify a personal HTML header for
489
# each generated HTML page. If it is left blank doxygen will generate a
492
HTML_HEADER = header.html
494
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
495
# each generated HTML page. If it is left blank doxygen will generate a
498
HTML_FOOTER = footer.html
500
# The HTML_STYLESHEET tag can be used to specify a user defined cascading
501
# style sheet that is used by each HTML page. It can be used to
502
# fine-tune the look of the HTML output. If the tag is left blank doxygen
503
# will generate a default style sheet
505
HTML_STYLESHEET = stylesheet.css
507
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
508
# files or namespaces will be aligned in HTML using tables. If set to
509
# NO a bullet list will be used.
511
HTML_ALIGN_MEMBERS = YES
513
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
514
# will be generated that can be used as input for tools like the
515
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
516
# of the generated HTML documentation.
518
GENERATE_HTMLHELP = YES
520
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
521
# be used to specify the file name of the resulting .chm file. You
522
# can add a path in front of the file if the result should not be
523
# written to the html output dir.
527
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
528
# be used to specify the location (absolute path including file name) of
529
# the HTML help compiler (hhc.exe). If non empty doxygen will try to run
530
# the html help compiler on the generated index.hhp.
534
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
535
# controls if a separate .chi index file is generated (YES) or that
536
# it should be included in the master .chm file (NO).
540
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
541
# controls whether a binary table of contents is generated (YES) or a
542
# normal table of contents (NO) in the .chm file.
546
# The TOC_EXPAND flag can be set to YES to add extra items for group members
547
# to the contents of the Html help documentation and to the tree view.
551
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
552
# top of each HTML page. The value NO (the default) enables the index and
553
# the value YES disables it.
557
# This tag can be used to set the number of enum values (range [1..20])
558
# that doxygen will group on one line in the generated HTML documentation.
560
ENUM_VALUES_PER_LINE = 4
562
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
563
# generated containing a tree-like index structure (just like the one
564
# that is generated for HTML Help). For this to work a browser that
565
# supports JavaScript and frames is required (for instance Mozilla,
566
# Netscape 4.0+, or Internet explorer 4.0+). Note that for large
567
# projects the tree generation can take a very long time. In such
568
# cases it is better to disable this feature. Windows users are
569
# probably better off using the HTML help feature.
571
GENERATE_TREEVIEW = NO
573
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
574
# used to set the initial width (in pixels) of the frame in which the tree
579
#---------------------------------------------------------------------------
580
# configuration options related to the LaTeX output
581
#---------------------------------------------------------------------------
583
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
584
# generate Latex output.
588
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
589
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
590
# put in front of it. If left blank `latex' will be used as the default path.
594
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
596
LATEX_CMD_NAME = latex
598
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
599
# generate index for LaTeX. If left blank `makeindex' will be used as the
600
# default command name.
602
MAKEINDEX_CMD_NAME = makeindex
604
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
605
# LaTeX documents. This may be useful for small projects and may help to
606
# save some trees in general.
610
# The PAPER_TYPE tag can be used to set the paper type that is used
611
# by the printer. Possible values are: a4, a4wide, letter, legal and
612
# executive. If left blank a4wide will be used.
616
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
617
# packages that should be included in the LaTeX output.
621
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
622
# the generated latex document. The header should contain everything until
623
# the first chapter. If it is left blank doxygen will generate a
624
# standard header. Notice: only use this tag if you know what you are doing!
628
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
629
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
630
# contain links (just like the HTML output) instead of page references
631
# This makes the output suitable for online browsing using a pdf viewer.
635
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
636
# plain latex in the generated Makefile. Set this option to YES to get a
637
# higher quality PDF documentation.
641
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
642
# command to the generated LaTeX files. This will instruct LaTeX to keep
643
# running if errors occur, instead of asking the user for help.
644
# This option is also used when generating formulas in HTML.
648
#---------------------------------------------------------------------------
649
# configuration options related to the RTF output
650
#---------------------------------------------------------------------------
652
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
653
# The RTF output is optimised for Word 97 and may not look very pretty with
654
# other RTF readers or editors.
658
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
659
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
660
# put in front of it. If left blank `rtf' will be used as the default path.
664
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
665
# RTF documents. This may be useful for small projects and may help to
666
# save some trees in general.
670
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
671
# will contain hyperlink fields. The RTF file will
672
# contain links (just like the HTML output) instead of page references.
673
# This makes the output suitable for online browsing using WORD or other
674
# programs which support those fields.
675
# Note: wordpad (write) and others do not support links.
679
# Load stylesheet definitions from file. Syntax is similar to doxygen's
680
# config file, i.e. a series of assigments. You only have to provide
681
# replacements, missing definitions are set to their default value.
683
RTF_STYLESHEET_FILE =
685
# Set optional variables used in the generation of an rtf document.
686
# Syntax is similar to doxygen's config file.
688
RTF_EXTENSIONS_FILE =
690
#---------------------------------------------------------------------------
691
# configuration options related to the man page output
692
#---------------------------------------------------------------------------
694
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
699
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
700
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
701
# put in front of it. If left blank `man' will be used as the default path.
705
# The MAN_EXTENSION tag determines the extension that is added to
706
# the generated man pages (default is the subroutine's section .3)
710
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
711
# then it will generate one additional man file for each entity
712
# documented in the real man page(s). These additional files
713
# only source the real man page, but without them the man command
714
# would be unable to find the correct page. The default is NO.
718
#---------------------------------------------------------------------------
719
# configuration options related to the XML output
720
#---------------------------------------------------------------------------
722
# If the GENERATE_XML tag is set to YES Doxygen will
723
# generate an XML file that captures the structure of
724
# the code including all documentation. Note that this
725
# feature is still experimental and incomplete at the
730
# The XML_SCHEMA tag can be used to specify an XML schema,
731
# which can be used by a validating XML parser to check the
732
# syntax of the XML files.
736
# The XML_DTD tag can be used to specify an XML DTD,
737
# which can be used by a validating XML parser to check the
738
# syntax of the XML files.
742
#---------------------------------------------------------------------------
743
# configuration options for the AutoGen Definitions output
744
#---------------------------------------------------------------------------
746
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
747
# generate an AutoGen Definitions (see autogen.sf.net) file
748
# that captures the structure of the code including all
749
# documentation. Note that this feature is still experimental
750
# and incomplete at the moment.
752
GENERATE_AUTOGEN_DEF = NO
754
#---------------------------------------------------------------------------
755
# Configuration options related to the preprocessor
756
#---------------------------------------------------------------------------
758
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
759
# evaluate all C-preprocessor directives found in the sources and include
762
ENABLE_PREPROCESSING = YES
764
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
765
# names in the source code. If set to NO (the default) only conditional
766
# compilation will be performed. Macro expansion can be done in a controlled
767
# way by setting EXPAND_ONLY_PREDEF to YES.
771
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
772
# then the macro expansion is limited to the macros specified with the
773
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
775
EXPAND_ONLY_PREDEF = NO
777
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
778
# in the INCLUDE_PATH (see below) will be search if a #include is found.
780
SEARCH_INCLUDES = YES
782
# The INCLUDE_PATH tag can be used to specify one or more directories that
783
# contain include files that are not input files but should be processed by
788
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
789
# patterns (like *.h and *.hpp) to filter out the header-files in the
790
# directories. If left blank, the patterns specified with FILE_PATTERNS will
793
INCLUDE_FILE_PATTERNS =
795
# The PREDEFINED tag can be used to specify one or more macro names that
796
# are defined before the preprocessor is started (similar to the -D option of
797
# gcc). The argument of the tag is a list of macros of the form: name
798
# or name=definition (no spaces). If the definition and the = are
799
# omitted =1 is assumed.
801
PREDEFINED = _WIN32 \
805
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
806
# this tag can be used to specify a list of macro names that should be expanded.
807
# The macro definition that is found in the sources will be used.
808
# Use the PREDEFINED tag if you want to use a different macro definition.
812
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
813
# doxygen's preprocessor will remove all function-like macros that are
814
# alone on a line, have an all uppercase name, and do not end with a
815
# semicolon. Such function macros are typically used for boiler-plate
816
# code, and will confuse the parser if not removed.
818
SKIP_FUNCTION_MACROS = YES
820
#---------------------------------------------------------------------------
821
# Configuration::addtions related to external references
822
#---------------------------------------------------------------------------
824
# The TAGFILES tag can be used to specify one or more tagfiles.
828
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
829
# a tag file that is based on the input files it reads.
833
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
834
# in the class index. If set to NO only the inherited external classes
839
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
840
# in the modules index. If set to NO, only the current project's groups will
843
EXTERNAL_GROUPS = YES
845
# The PERL_PATH should be the absolute path and name of the perl script
846
# interpreter (i.e. the result of `which perl').
848
PERL_PATH = /usr/bin/perl
850
#---------------------------------------------------------------------------
851
# Configuration options related to the dot tool
852
#---------------------------------------------------------------------------
854
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
855
# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
856
# super classes. Setting the tag to NO turns the diagrams off. Note that this
857
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
858
# recommended to install and use dot, since it yield more powerful graphs.
862
# If set to YES, the inheritance and collaboration graphs will hide
863
# inheritance and usage relations if the target is undocumented
866
HIDE_UNDOC_RELATIONS = YES
868
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
869
# available from the path. This tool is part of Graphviz, a graph visualization
870
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
871
# have no effect if this option is set to NO (the default)
875
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
876
# will generate a graph for each documented class showing the direct and
877
# indirect inheritance relations. Setting this tag to YES will force the
878
# the CLASS_DIAGRAMS tag to NO.
882
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
883
# will generate a graph for each documented class showing the direct and
884
# indirect implementation dependencies (inheritance, containment, and
885
# class references variables) of the class with other documented classes.
887
COLLABORATION_GRAPH = YES
889
# If set to YES, the inheritance and collaboration graphs will show the
890
# relations between templates and their instances.
892
TEMPLATE_RELATIONS = YES
894
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
895
# tags are set to YES then doxygen will generate a graph for each documented
896
# file showing the direct and indirect include dependencies of the file with
897
# other documented files.
901
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
902
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
903
# documented header file showing the documented files that directly or
904
# indirectly include this file.
906
INCLUDED_BY_GRAPH = YES
908
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
909
# will graphical hierarchy of all classes instead of a textual one.
911
GRAPHICAL_HIERARCHY = YES
913
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
914
# generated by dot. Possible values are png, jpg, or gif
915
# If left blank png will be used.
917
DOT_IMAGE_FORMAT = png
919
# The tag DOT_PATH can be used to specify the path where the dot tool can be
920
# found. If left blank, it is assumed the dot tool can be found on the path.
924
# The DOTFILE_DIRS tag can be used to specify one or more directories that
925
# contain dot files that are included in the documentation (see the
930
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
931
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
932
# this value, doxygen will try to truncate the graph, so that it fits within
933
# the specified constraint. Beware that most browsers cannot cope with very
936
MAX_DOT_GRAPH_WIDTH = 1024
938
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
939
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
940
# this value, doxygen will try to truncate the graph, so that it fits within
941
# the specified constraint. Beware that most browsers cannot cope with very
944
MAX_DOT_GRAPH_HEIGHT = 1024
946
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
947
# generate a legend page explaining the meaning of the various boxes and
948
# arrows in the dot generated graphs.
950
GENERATE_LEGEND = YES
952
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
953
# remove the intermedate dot files that are used to generate
954
# the various graphs.
958
#---------------------------------------------------------------------------
959
# Configuration::addtions related to the search engine
960
#---------------------------------------------------------------------------
962
# The SEARCHENGINE tag specifies whether or not a search engine should be
963
# used. If set to NO the values of all tags below this one will be ignored.
967
# The CGI_NAME tag should be the name of the CGI script that
968
# starts the search engine (doxysearch) with the correct parameters.
969
# A script with this name will be generated by doxygen.
971
CGI_NAME = search.cgi
973
# The CGI_URL tag should be the absolute URL to the directory where the
974
# cgi binaries are located. See the documentation of your http daemon for
979
# The DOC_URL tag should be the absolute URL to the directory where the
980
# documentation is located. If left blank the absolute path to the
981
# documentation, with file:// prepended to it, will be used.
985
# The DOC_ABSPATH tag should be the absolute path to the directory where the
986
# documentation is located. If left blank the directory on the local machine
991
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
994
BIN_ABSPATH = /usr/local/bin/
996
# The EXT_DOC_PATHS tag can be used to specify one or more paths to
997
# documentation generated for other projects. This allows doxysearch to search
998
# the documentation for these projects as well.
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
# Project related configuration options
15
#---------------------------------------------------------------------------
17
# This tag specifies the encoding used for all characters in the config file that
18
# follow. The default is UTF-8 which is also the encoding used for all text before
19
# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
20
# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
23
DOXYFILE_ENCODING = UTF-8
25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26
# by quotes) that should identify the project.
28
PROJECT_NAME = "Network Identity Manager"
30
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31
# This could be handy for archiving the generated documentation or
32
# if some version control system is used.
36
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37
# base path where the generated documentation will be put.
38
# If a relative path is entered, it will be relative to the location
39
# where doxygen was started. If left blank the current directory will be used.
43
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44
# 4096 sub-directories (in 2 levels) under the output directory of each output
45
# format and will distribute the generated files over these directories.
46
# Enabling this option can be useful when feeding doxygen a huge amount of
47
# source files, where putting all generated files in the same directory would
48
# otherwise cause performance problems for the file system.
52
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53
# documentation generated by doxygen is written. Doxygen will use this
54
# information to generate all constant output in the proper language.
55
# The default language is English, other supported languages are:
56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57
# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
58
# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
59
# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
60
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
62
OUTPUT_LANGUAGE = English
64
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
65
# include brief member descriptions after the members that are listed in
66
# the file and class documentation (similar to JavaDoc).
67
# Set to NO to disable this.
69
BRIEF_MEMBER_DESC = YES
71
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
72
# the brief description of a member or function before the detailed description.
73
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
74
# brief descriptions will be completely suppressed.
78
# This tag implements a quasi-intelligent brief description abbreviator
79
# that is used to form the text in various listings. Each string
80
# in this list, if found as the leading text of the brief description, will be
81
# stripped from the text and the result after processing the whole list, is
82
# used as the annotated text. Otherwise, the brief description is used as-is.
83
# If left blank, the following values are used ("$name" is automatically
84
# replaced with the name of the entity): "The $name class" "The $name widget"
85
# "The $name file" "is" "provides" "specifies" "contains"
86
# "represents" "a" "an" "the"
90
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
91
# Doxygen will generate a detailed section even if there is only a brief
94
ALWAYS_DETAILED_SEC = NO
96
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
97
# inherited members of a class in the documentation of that class as if those
98
# members were ordinary class members. Constructors, destructors and assignment
99
# operators of the base classes will not be shown.
101
INLINE_INHERITED_MEMB = NO
103
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
104
# path before files name in the file list and in the header files. If set
105
# to NO the shortest path that makes the file name unique will be used.
109
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
110
# can be used to strip a user-defined part of the path. Stripping is
111
# only done if one of the specified strings matches the left-hand part of
112
# the path. The tag can be used to show relative paths in the file list.
113
# If left blank the directory from which doxygen is run is used as the
118
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
119
# the path mentioned in the documentation of a class, which tells
120
# the reader which header file to include in order to use a class.
121
# If left blank only the name of the header file containing the class
122
# definition is used. Otherwise one should specify the include paths that
123
# are normally passed to the compiler using the -I flag.
125
STRIP_FROM_INC_PATH =
127
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
128
# (but less readable) file names. This can be useful is your file systems
129
# doesn't support long names like on DOS, Mac, or CD-ROM.
133
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
134
# will interpret the first line (until the first dot) of a JavaDoc-style
135
# comment as the brief description. If set to NO, the JavaDoc
136
# comments will behave just like the Qt-style comments (thus requiring an
137
# explicit @brief command for a brief description.
139
JAVADOC_AUTOBRIEF = NO
141
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
142
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
143
# comments) as a brief description. This used to be the default behaviour.
144
# The new default is to treat a multi-line C++ comment block as a detailed
145
# description. Set this tag to YES if you prefer the old behaviour instead.
147
MULTILINE_CPP_IS_BRIEF = NO
149
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
150
# will output the detailed description near the top, like JavaDoc.
151
# If set to NO, the detailed description appears after the member
156
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
157
# member inherits the documentation from any documented member that it
162
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
163
# a new page for each member. If set to NO, the documentation of a member will
164
# be part of the file/class/namespace that contains it.
166
SEPARATE_MEMBER_PAGES = NO
168
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
169
# Doxygen uses this value to replace tabs by spaces in code fragments.
173
# This tag can be used to specify a number of aliases that acts
174
# as commands in the documentation. An alias has the form "name=value".
175
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
176
# put the command \sideeffect (or @sideeffect) in the documentation, which
177
# will result in a user-defined paragraph with heading "Side Effects:".
178
# You can put \n's in the value part of an alias to insert newlines.
182
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
183
# sources only. Doxygen will then generate output that is more tailored for C.
184
# For instance, some of the names that are used will be different. The list
185
# of all members will be omitted, etc.
187
OPTIMIZE_OUTPUT_FOR_C = YES
189
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
190
# sources only. Doxygen will then generate output that is more tailored for Java.
191
# For instance, namespaces will be presented as packages, qualified scopes
192
# will look different, etc.
194
OPTIMIZE_OUTPUT_JAVA = NO
196
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
197
# include (a tag file for) the STL sources as input, then you should
198
# set this tag to YES in order to let doxygen match functions declarations and
199
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
200
# func(std::string) {}). This also make the inheritance and collaboration
201
# diagrams that involve STL classes more complete and accurate.
203
BUILTIN_STL_SUPPORT = NO
205
# If you use Microsoft's C++/CLI language, you should set this option to YES to
206
# enable parsing support.
210
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
211
# tag is set to YES, then doxygen will reuse the documentation of the first
212
# member in the group (if any) for the other members of the group. By default
213
# all members of a group must be documented explicitly.
215
DISTRIBUTE_GROUP_DOC = NO
217
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
218
# the same type (for instance a group of public functions) to be put as a
219
# subgroup of that type (e.g. under the Public Functions section). Set it to
220
# NO to prevent subgrouping. Alternatively, this can be done per class using
221
# the \nosubgrouping command.
225
#---------------------------------------------------------------------------
226
# Build related configuration options
227
#---------------------------------------------------------------------------
229
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
230
# documentation are documented, even if no documentation was available.
231
# Private class members and static file members will be hidden unless
232
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
236
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
237
# will be included in the documentation.
241
# If the EXTRACT_STATIC tag is set to YES all static members of a file
242
# will be included in the documentation.
246
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
247
# defined locally in source files will be included in the documentation.
248
# If set to NO only classes defined in header files are included.
250
EXTRACT_LOCAL_CLASSES = YES
252
# This flag is only useful for Objective-C code. When set to YES local
253
# methods, which are defined in the implementation section but not in
254
# the interface are included in the documentation.
255
# If set to NO (the default) only methods in the interface are included.
257
EXTRACT_LOCAL_METHODS = NO
259
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
260
# undocumented members of documented classes, files or namespaces.
261
# If set to NO (the default) these members will be included in the
262
# various overviews, but no documentation section is generated.
263
# This option has no effect if EXTRACT_ALL is enabled.
265
HIDE_UNDOC_MEMBERS = NO
267
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
268
# undocumented classes that are normally visible in the class hierarchy.
269
# If set to NO (the default) these classes will be included in the various
270
# overviews. This option has no effect if EXTRACT_ALL is enabled.
272
HIDE_UNDOC_CLASSES = NO
274
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
275
# friend (class|struct|union) declarations.
276
# If set to NO (the default) these declarations will be included in the
279
HIDE_FRIEND_COMPOUNDS = NO
281
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
282
# documentation blocks found inside the body of a function.
283
# If set to NO (the default) these blocks will be appended to the
284
# function's detailed documentation block.
286
HIDE_IN_BODY_DOCS = NO
288
# The INTERNAL_DOCS tag determines if documentation
289
# that is typed after a \internal command is included. If the tag is set
290
# to NO (the default) then the documentation will be excluded.
291
# Set it to YES to include the internal documentation.
295
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
296
# file names in lower-case letters. If set to YES upper-case letters are also
297
# allowed. This is useful if you have classes or files whose names only differ
298
# in case and if your file system supports case sensitive file names. Windows
299
# and Mac users are advised to set this option to NO.
301
CASE_SENSE_NAMES = YES
303
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
304
# will show members with their full class and namespace scopes in the
305
# documentation. If set to YES the scope will be hidden.
307
HIDE_SCOPE_NAMES = NO
309
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
310
# will put a list of the files that are included by a file in the documentation
313
SHOW_INCLUDE_FILES = YES
315
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
316
# is inserted in the documentation for inline members.
320
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
321
# will sort the (detailed) documentation of file and class members
322
# alphabetically by member name. If set to NO the members will appear in
325
SORT_MEMBER_DOCS = YES
327
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
328
# brief documentation of file, namespace and class members alphabetically
329
# by member name. If set to NO (the default) the members will appear in
334
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
335
# sorted by fully-qualified names, including namespaces. If set to
336
# NO (the default), the class list will be sorted only by class name,
337
# not including the namespace part.
338
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
339
# Note: This option applies only to the class list, not to the
342
SORT_BY_SCOPE_NAME = NO
344
# The GENERATE_TODOLIST tag can be used to enable (YES) or
345
# disable (NO) the todo list. This list is created by putting \todo
346
# commands in the documentation.
348
GENERATE_TODOLIST = YES
350
# The GENERATE_TESTLIST tag can be used to enable (YES) or
351
# disable (NO) the test list. This list is created by putting \test
352
# commands in the documentation.
354
GENERATE_TESTLIST = YES
356
# The GENERATE_BUGLIST tag can be used to enable (YES) or
357
# disable (NO) the bug list. This list is created by putting \bug
358
# commands in the documentation.
360
GENERATE_BUGLIST = YES
362
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
363
# disable (NO) the deprecated list. This list is created by putting
364
# \deprecated commands in the documentation.
366
GENERATE_DEPRECATEDLIST= YES
368
# The ENABLED_SECTIONS tag can be used to enable conditional
369
# documentation sections, marked by \if sectionname ... \endif.
373
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
374
# the initial value of a variable or define consists of for it to appear in
375
# the documentation. If the initializer consists of more lines than specified
376
# here it will be hidden. Use a value of 0 to hide initializers completely.
377
# The appearance of the initializer of individual variables and defines in the
378
# documentation can be controlled using \showinitializer or \hideinitializer
379
# command in the documentation regardless of this setting.
381
MAX_INITIALIZER_LINES = 30
383
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
384
# at the bottom of the documentation of classes and structs. If set to YES the
385
# list will mention the files that were used to generate the documentation.
387
SHOW_USED_FILES = YES
389
# If the sources in your project are distributed over multiple directories
390
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
391
# in the documentation. The default is NO.
393
SHOW_DIRECTORIES = NO
395
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
396
# doxygen should invoke to get the current version for each file (typically from the
397
# version control system). Doxygen will invoke the program by executing (via
398
# popen()) the command <command> <input-file>, where <command> is the value of
399
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
400
# provided by doxygen. Whatever the program writes to standard output
401
# is used as the file version. See the manual for examples.
403
FILE_VERSION_FILTER =
405
#---------------------------------------------------------------------------
406
# configuration options related to warning and progress messages
407
#---------------------------------------------------------------------------
409
# The QUIET tag can be used to turn on/off the messages that are generated
410
# by doxygen. Possible values are YES and NO. If left blank NO is used.
414
# The WARNINGS tag can be used to turn on/off the warning messages that are
415
# generated by doxygen. Possible values are YES and NO. If left blank
420
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
421
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
422
# automatically be disabled.
424
WARN_IF_UNDOCUMENTED = YES
426
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
427
# potential errors in the documentation, such as not documenting some
428
# parameters in a documented function, or documenting parameters that
429
# don't exist or using markup commands wrongly.
431
WARN_IF_DOC_ERROR = YES
433
# This WARN_NO_PARAMDOC option can be abled to get warnings for
434
# functions that are documented, but have no documentation for their parameters
435
# or return value. If set to NO (the default) doxygen will only warn about
436
# wrong or incomplete parameter documentation, but not about the absence of
439
WARN_NO_PARAMDOC = NO
441
# The WARN_FORMAT tag determines the format of the warning messages that
442
# doxygen can produce. The string should contain the $file, $line, and $text
443
# tags, which will be replaced by the file and line number from which the
444
# warning originated and the warning text. Optionally the format may contain
445
# $version, which will be replaced by the version of the file (if it could
446
# be obtained via FILE_VERSION_FILTER)
448
WARN_FORMAT = "$file:$line: $text"
450
# The WARN_LOGFILE tag can be used to specify a file to which warning
451
# and error messages should be written. If left blank the output is written
456
#---------------------------------------------------------------------------
457
# configuration options related to the input files
458
#---------------------------------------------------------------------------
460
# The INPUT tag can be used to specify the files and/or directories that contain
461
# documented source files. You may enter file names like "myfile.cpp" or
462
# directories like "/usr/src/myproject". Separate the files or directories
467
# This tag can be used to specify the character encoding of the source files that
468
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
469
# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
470
# See http://www.gnu.org/software/libiconv for the list of possible encodings.
472
INPUT_ENCODING = UTF-8
474
# If the value of the INPUT tag contains directories, you can use the
475
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
476
# and *.h) to filter out the source-files in the directories. If left
477
# blank the following patterns are tested:
478
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
479
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
483
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
484
# should be searched for input files as well. Possible values are YES and NO.
485
# If left blank NO is used.
489
# The EXCLUDE tag can be used to specify files and/or directories that should
490
# excluded from the INPUT source files. This way you can easily exclude a
491
# subdirectory from a directory tree whose root is specified with the INPUT tag.
495
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
496
# directories that are symbolic links (a Unix filesystem feature) are excluded
499
EXCLUDE_SYMLINKS = NO
501
# If the value of the INPUT tag contains directories, you can use the
502
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
503
# certain files from those directories. Note that the wildcards are matched
504
# against the file with absolute path, so to exclude all test directories
505
# for example use the pattern */test/*
509
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
510
# (namespaces, classes, functions, etc.) that should be excluded from the output.
511
# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
512
# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
516
# The EXAMPLE_PATH tag can be used to specify one or more files or
517
# directories that contain example code fragments that are included (see
518
# the \include command).
522
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
523
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
524
# and *.h) to filter out the source-files in the directories. If left
525
# blank all files are included.
529
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
530
# searched for input files to be used with the \include or \dontinclude
531
# commands irrespective of the value of the RECURSIVE tag.
532
# Possible values are YES and NO. If left blank NO is used.
534
EXAMPLE_RECURSIVE = NO
536
# The IMAGE_PATH tag can be used to specify one or more files or
537
# directories that contain image that are included in the documentation (see
538
# the \image command).
542
# The INPUT_FILTER tag can be used to specify a program that doxygen should
543
# invoke to filter for each input file. Doxygen will invoke the filter program
544
# by executing (via popen()) the command <filter> <input-file>, where <filter>
545
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
546
# input file. Doxygen will then use the output that the filter program writes
547
# to standard output. If FILTER_PATTERNS is specified, this tag will be
552
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
553
# basis. Doxygen will compare the file name with each pattern and apply the
554
# filter if there is a match. The filters are a list of the form:
555
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
556
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
557
# is applied to all files.
561
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
562
# INPUT_FILTER) will be used to filter the input files when producing source
563
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
565
FILTER_SOURCE_FILES = NO
567
#---------------------------------------------------------------------------
568
# configuration options related to source browsing
569
#---------------------------------------------------------------------------
571
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
572
# be generated. Documented entities will be cross-referenced with these sources.
573
# Note: To get rid of all source code in the generated output, make sure also
574
# VERBATIM_HEADERS is set to NO.
578
# Setting the INLINE_SOURCES tag to YES will include the body
579
# of functions and classes directly in the documentation.
583
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
584
# doxygen to hide any special comment blocks from generated source code
585
# fragments. Normal C and C++ comments will always remain visible.
587
STRIP_CODE_COMMENTS = YES
589
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
590
# then for each documented function all documented
591
# functions referencing it will be listed.
593
REFERENCED_BY_RELATION = YES
595
# If the REFERENCES_RELATION tag is set to YES (the default)
596
# then for each documented function all documented entities
597
# called/used by that function will be listed.
599
REFERENCES_RELATION = YES
601
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
602
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
603
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
604
# link to the source code. Otherwise they will link to the documentstion.
606
REFERENCES_LINK_SOURCE = YES
608
# If the USE_HTAGS tag is set to YES then the references to source code
609
# will point to the HTML generated by the htags(1) tool instead of doxygen
610
# built-in source browser. The htags tool is part of GNU's global source
611
# tagging system (see http://www.gnu.org/software/global/global.html). You
612
# will need version 4.8.6 or higher.
616
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
617
# will generate a verbatim copy of the header file for each class for
618
# which an include is specified. Set to NO to disable this.
620
VERBATIM_HEADERS = NO
622
#---------------------------------------------------------------------------
623
# configuration options related to the alphabetical class index
624
#---------------------------------------------------------------------------
626
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
627
# of all compounds will be generated. Enable this if the project
628
# contains a lot of classes, structs, unions or interfaces.
630
ALPHABETICAL_INDEX = YES
632
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
633
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
634
# in which this list will be split (can be a number in the range [1..20])
636
COLS_IN_ALPHA_INDEX = 5
638
# In case all classes in a project start with a common prefix, all
639
# classes will be put under the same header in the alphabetical index.
640
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
641
# should be ignored while generating the index headers.
645
#---------------------------------------------------------------------------
646
# configuration options related to the HTML output
647
#---------------------------------------------------------------------------
649
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
650
# generate HTML output.
654
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
655
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
656
# put in front of it. If left blank `html' will be used as the default path.
660
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
661
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
662
# doxygen will generate files with .html extension.
664
HTML_FILE_EXTENSION = .html
666
# The HTML_HEADER tag can be used to specify a personal HTML header for
667
# each generated HTML page. If it is left blank doxygen will generate a
670
HTML_HEADER = header.html
672
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
673
# each generated HTML page. If it is left blank doxygen will generate a
676
HTML_FOOTER = footer.html
678
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
679
# style sheet that is used by each HTML page. It can be used to
680
# fine-tune the look of the HTML output. If the tag is left blank doxygen
681
# will generate a default style sheet. Note that doxygen will try to copy
682
# the style sheet file to the HTML output directory, so don't put your own
683
# stylesheet in the HTML output directory as well, or it will be erased!
685
HTML_STYLESHEET = stylesheet.css
687
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
688
# files or namespaces will be aligned in HTML using tables. If set to
689
# NO a bullet list will be used.
691
HTML_ALIGN_MEMBERS = YES
693
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
694
# will be generated that can be used as input for tools like the
695
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
696
# of the generated HTML documentation.
698
GENERATE_HTMLHELP = YES
700
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
701
# be used to specify the file name of the resulting .chm file. You
702
# can add a path in front of the file if the result should not be
703
# written to the html output directory.
707
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
708
# be used to specify the location (absolute path including file name) of
709
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
710
# the HTML help compiler on the generated index.hhp.
714
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
715
# controls if a separate .chi index file is generated (YES) or that
716
# it should be included in the master .chm file (NO).
720
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
721
# controls whether a binary table of contents is generated (YES) or a
722
# normal table of contents (NO) in the .chm file.
726
# The TOC_EXPAND flag can be set to YES to add extra items for group members
727
# to the contents of the HTML help documentation and to the tree view.
731
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
732
# top of each HTML page. The value NO (the default) enables the index and
733
# the value YES disables it.
737
# This tag can be used to set the number of enum values (range [1..20])
738
# that doxygen will group on one line in the generated HTML documentation.
740
ENUM_VALUES_PER_LINE = 4
742
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
743
# generated containing a tree-like index structure (just like the one that
744
# is generated for HTML Help). For this to work a browser that supports
745
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
746
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
747
# probably better off using the HTML help feature.
749
GENERATE_TREEVIEW = YES
751
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
752
# used to set the initial width (in pixels) of the frame in which the tree
757
#---------------------------------------------------------------------------
758
# configuration options related to the LaTeX output
759
#---------------------------------------------------------------------------
761
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
762
# generate Latex output.
766
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
767
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
768
# put in front of it. If left blank `latex' will be used as the default path.
772
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
773
# invoked. If left blank `latex' will be used as the default command name.
775
LATEX_CMD_NAME = latex
777
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
778
# generate index for LaTeX. If left blank `makeindex' will be used as the
779
# default command name.
781
MAKEINDEX_CMD_NAME = makeindex
783
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
784
# LaTeX documents. This may be useful for small projects and may help to
785
# save some trees in general.
789
# The PAPER_TYPE tag can be used to set the paper type that is used
790
# by the printer. Possible values are: a4, a4wide, letter, legal and
791
# executive. If left blank a4wide will be used.
795
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
796
# packages that should be included in the LaTeX output.
800
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
801
# the generated latex document. The header should contain everything until
802
# the first chapter. If it is left blank doxygen will generate a
803
# standard header. Notice: only use this tag if you know what you are doing!
807
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
808
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
809
# contain links (just like the HTML output) instead of page references
810
# This makes the output suitable for online browsing using a pdf viewer.
814
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
815
# plain latex in the generated Makefile. Set this option to YES to get a
816
# higher quality PDF documentation.
820
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
821
# command to the generated LaTeX files. This will instruct LaTeX to keep
822
# running if errors occur, instead of asking the user for help.
823
# This option is also used when generating formulas in HTML.
827
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
828
# include the index chapters (such as File Index, Compound Index, etc.)
831
LATEX_HIDE_INDICES = NO
833
#---------------------------------------------------------------------------
834
# configuration options related to the RTF output
835
#---------------------------------------------------------------------------
837
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
838
# The RTF output is optimized for Word 97 and may not look very pretty with
839
# other RTF readers or editors.
843
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
844
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
845
# put in front of it. If left blank `rtf' will be used as the default path.
849
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
850
# RTF documents. This may be useful for small projects and may help to
851
# save some trees in general.
855
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
856
# will contain hyperlink fields. The RTF file will
857
# contain links (just like the HTML output) instead of page references.
858
# This makes the output suitable for online browsing using WORD or other
859
# programs which support those fields.
860
# Note: wordpad (write) and others do not support links.
864
# Load stylesheet definitions from file. Syntax is similar to doxygen's
865
# config file, i.e. a series of assignments. You only have to provide
866
# replacements, missing definitions are set to their default value.
868
RTF_STYLESHEET_FILE =
870
# Set optional variables used in the generation of an rtf document.
871
# Syntax is similar to doxygen's config file.
873
RTF_EXTENSIONS_FILE =
875
#---------------------------------------------------------------------------
876
# configuration options related to the man page output
877
#---------------------------------------------------------------------------
879
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
884
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
885
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
886
# put in front of it. If left blank `man' will be used as the default path.
890
# The MAN_EXTENSION tag determines the extension that is added to
891
# the generated man pages (default is the subroutine's section .3)
895
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
896
# then it will generate one additional man file for each entity
897
# documented in the real man page(s). These additional files
898
# only source the real man page, but without them the man command
899
# would be unable to find the correct page. The default is NO.
903
#---------------------------------------------------------------------------
904
# configuration options related to the XML output
905
#---------------------------------------------------------------------------
907
# If the GENERATE_XML tag is set to YES Doxygen will
908
# generate an XML file that captures the structure of
909
# the code including all documentation.
913
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
914
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
915
# put in front of it. If left blank `xml' will be used as the default path.
919
# The XML_SCHEMA tag can be used to specify an XML schema,
920
# which can be used by a validating XML parser to check the
921
# syntax of the XML files.
925
# The XML_DTD tag can be used to specify an XML DTD,
926
# which can be used by a validating XML parser to check the
927
# syntax of the XML files.
931
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
932
# dump the program listings (including syntax highlighting
933
# and cross-referencing information) to the XML output. Note that
934
# enabling this will significantly increase the size of the XML output.
936
XML_PROGRAMLISTING = YES
938
#---------------------------------------------------------------------------
939
# configuration options for the AutoGen Definitions output
940
#---------------------------------------------------------------------------
942
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
943
# generate an AutoGen Definitions (see autogen.sf.net) file
944
# that captures the structure of the code including all
945
# documentation. Note that this feature is still experimental
946
# and incomplete at the moment.
948
GENERATE_AUTOGEN_DEF = NO
950
#---------------------------------------------------------------------------
951
# configuration options related to the Perl module output
952
#---------------------------------------------------------------------------
954
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
955
# generate a Perl module file that captures the structure of
956
# the code including all documentation. Note that this
957
# feature is still experimental and incomplete at the
960
GENERATE_PERLMOD = NO
962
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
963
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
964
# to generate PDF and DVI output from the Perl module output.
968
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
969
# nicely formatted so it can be parsed by a human reader. This is useful
970
# if you want to understand what is going on. On the other hand, if this
971
# tag is set to NO the size of the Perl module output will be much smaller
972
# and Perl will parse it just the same.
976
# The names of the make variables in the generated doxyrules.make file
977
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
978
# This is useful so different doxyrules.make files included by the same
979
# Makefile don't overwrite each other's variables.
981
PERLMOD_MAKEVAR_PREFIX =
983
#---------------------------------------------------------------------------
984
# Configuration options related to the preprocessor
985
#---------------------------------------------------------------------------
987
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
988
# evaluate all C-preprocessor directives found in the sources and include
991
ENABLE_PREPROCESSING = YES
993
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
994
# names in the source code. If set to NO (the default) only conditional
995
# compilation will be performed. Macro expansion can be done in a controlled
996
# way by setting EXPAND_ONLY_PREDEF to YES.
1000
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1001
# then the macro expansion is limited to the macros specified with the
1002
# PREDEFINED and EXPAND_AS_DEFINED tags.
1004
EXPAND_ONLY_PREDEF = NO
1006
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1007
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1009
SEARCH_INCLUDES = YES
1011
# The INCLUDE_PATH tag can be used to specify one or more directories that
1012
# contain include files that are not input files but should be processed by
1017
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1018
# patterns (like *.h and *.hpp) to filter out the header-files in the
1019
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1022
INCLUDE_FILE_PATTERNS =
1024
# The PREDEFINED tag can be used to specify one or more macro names that
1025
# are defined before the preprocessor is started (similar to the -D option of
1026
# gcc). The argument of the tag is a list of macros of the form: name
1027
# or name=definition (no spaces). If the definition and the = are
1028
# omitted =1 is assumed. To prevent a macro definition from being
1029
# undefined via #undef or recursively expanded use the := operator
1030
# instead of the = operator.
1032
PREDEFINED = _WIN32 \
1036
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1037
# this tag can be used to specify a list of macro names that should be expanded.
1038
# The macro definition that is found in the sources will be used.
1039
# Use the PREDEFINED tag if you want to use a different macro definition.
1043
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1044
# doxygen's preprocessor will remove all function-like macros that are alone
1045
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1046
# function macros are typically used for boiler-plate code, and will confuse
1047
# the parser if not removed.
1049
SKIP_FUNCTION_MACROS = YES
1051
#---------------------------------------------------------------------------
1052
# Configuration::additions related to external references
1053
#---------------------------------------------------------------------------
1055
# The TAGFILES option can be used to specify one or more tagfiles.
1056
# Optionally an initial location of the external documentation
1057
# can be added for each tagfile. The format of a tag file without
1058
# this location is as follows:
1059
# TAGFILES = file1 file2 ...
1060
# Adding location for the tag files is done as follows:
1061
# TAGFILES = file1=loc1 "file2 = loc2" ...
1062
# where "loc1" and "loc2" can be relative or absolute paths or
1063
# URLs. If a location is present for each tag, the installdox tool
1064
# does not have to be run to correct the links.
1065
# Note that each tag file must have a unique name
1066
# (where the name does NOT include the path)
1067
# If a tag file is not located in the directory in which doxygen
1068
# is run, you must also specify the path to the tagfile here.
1072
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1073
# a tag file that is based on the input files it reads.
1077
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1078
# in the class index. If set to NO only the inherited external classes
1083
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1084
# in the modules index. If set to NO, only the current project's groups will
1087
EXTERNAL_GROUPS = YES
1089
# The PERL_PATH should be the absolute path and name of the perl script
1090
# interpreter (i.e. the result of `which perl').
1092
PERL_PATH = /usr/bin/perl
1094
#---------------------------------------------------------------------------
1095
# Configuration options related to the dot tool
1096
#---------------------------------------------------------------------------
1098
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1099
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1100
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1101
# this option is superseded by the HAVE_DOT option below. This is only a
1102
# fallback. It is recommended to install and use dot, since it yields more
1105
CLASS_DIAGRAMS = YES
1107
# You can define message sequence charts within doxygen comments using the \msc
1108
# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1109
# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1110
# specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1111
# be found in the default search path.
1115
# If set to YES, the inheritance and collaboration graphs will hide
1116
# inheritance and usage relations if the target is undocumented
1117
# or is not a class.
1119
HIDE_UNDOC_RELATIONS = YES
1121
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1122
# available from the path. This tool is part of Graphviz, a graph visualization
1123
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1124
# have no effect if this option is set to NO (the default)
1128
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1129
# will generate a graph for each documented class showing the direct and
1130
# indirect inheritance relations. Setting this tag to YES will force the
1131
# the CLASS_DIAGRAMS tag to NO.
1135
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1136
# will generate a graph for each documented class showing the direct and
1137
# indirect implementation dependencies (inheritance, containment, and
1138
# class references variables) of the class with other documented classes.
1140
COLLABORATION_GRAPH = YES
1142
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1143
# will generate a graph for groups, showing the direct groups dependencies
1147
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1148
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1153
# If set to YES, the inheritance and collaboration graphs will show the
1154
# relations between templates and their instances.
1156
TEMPLATE_RELATIONS = YES
1158
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1159
# tags are set to YES then doxygen will generate a graph for each documented
1160
# file showing the direct and indirect include dependencies of the file with
1161
# other documented files.
1165
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1166
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1167
# documented header file showing the documented files that directly or
1168
# indirectly include this file.
1170
INCLUDED_BY_GRAPH = YES
1172
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1173
# generate a call dependency graph for every global function or class method.
1174
# Note that enabling this option will significantly increase the time of a run.
1175
# So in most cases it will be better to enable call graphs for selected
1176
# functions only using the \callgraph command.
1180
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1181
# generate a caller dependency graph for every global function or class method.
1182
# Note that enabling this option will significantly increase the time of a run.
1183
# So in most cases it will be better to enable caller graphs for selected
1184
# functions only using the \callergraph command.
1188
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1189
# will graphical hierarchy of all classes instead of a textual one.
1191
GRAPHICAL_HIERARCHY = YES
1193
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1194
# then doxygen will show the dependencies a directory has on other directories
1195
# in a graphical way. The dependency relations are determined by the #include
1196
# relations between the files in the directories.
1198
DIRECTORY_GRAPH = YES
1200
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1201
# generated by dot. Possible values are png, jpg, or gif
1202
# If left blank png will be used.
1204
DOT_IMAGE_FORMAT = png
1206
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1207
# found. If left blank, it is assumed the dot tool can be found in the path.
1211
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1212
# contain dot files that are included in the documentation (see the
1213
# \dotfile command).
1217
# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1218
# nodes that will be shown in the graph. If the number of nodes in a graph
1219
# becomes larger than this value, doxygen will truncate the graph, which is
1220
# visualized by representing a node as a red box. Note that doxygen will always
1221
# show the root nodes and its direct children regardless of this setting.
1223
DOT_GRAPH_MAX_NODES = 50
1225
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1226
# background. This is disabled by default, which results in a white background.
1227
# Warning: Depending on the platform used, enabling this option may lead to
1228
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1231
DOT_TRANSPARENT = NO
1233
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1234
# files in one run (i.e. multiple -o and -T options on the command line). This
1235
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1236
# support this, this feature is disabled by default.
1238
DOT_MULTI_TARGETS = NO
1240
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1241
# generate a legend page explaining the meaning of the various boxes and
1242
# arrows in the dot generated graphs.
1244
GENERATE_LEGEND = YES
1246
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1247
# remove the intermediate dot files that are used to generate
1248
# the various graphs.
1252
#---------------------------------------------------------------------------
1253
# Configuration::additions related to the search engine
1254
#---------------------------------------------------------------------------
1256
# The SEARCHENGINE tag specifies whether or not a search engine should be
1257
# used. If set to NO the values of all tags below this one will be ignored.
added
removed
src/windows/identity/doc/doxyfile.cfg
