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
18
# that follow. The default is UTF-8 which is also the encoding used for all
19
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20
# iconv built into libc) for the transcoding. See
21
# http://www.gnu.org/software/libiconv for the list of possible encodings.
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 = Kerberos_doxygen
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.
34
PROJECT_NUMBER = 1.9_0.1
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.
41
OUTPUT_DIRECTORY = ../out
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, Esperanto, Farsi, Finnish, French, German,
58
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
63
OUTPUT_LANGUAGE = English
65
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66
# include brief member descriptions after the members that are listed in
67
# the file and class documentation (similar to JavaDoc).
68
# Set to NO to disable this.
70
BRIEF_MEMBER_DESC = YES
72
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73
# the brief description of a member or function before the detailed description.
74
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75
# brief descriptions will be completely suppressed.
79
# This tag implements a quasi-intelligent brief description abbreviator
80
# that is used to form the text in various listings. Each string
81
# in this list, if found as the leading text of the brief description, will be
82
# stripped from the text and the result after processing the whole list, is
83
# used as the annotated text. Otherwise, the brief description is used as-is.
84
# If left blank, the following values are used ("$name" is automatically
85
# replaced with the name of the entity): "The $name class" "The $name widget"
86
# "The $name file" "is" "provides" "specifies" "contains"
87
# "represents" "a" "an" "the"
89
ABBREVIATE_BRIEF = "The $name class" \
101
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102
# Doxygen will generate a detailed section even if there is only a brief
105
ALWAYS_DETAILED_SEC = NO
107
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108
# inherited members of a class in the documentation of that class as if those
109
# members were ordinary class members. Constructors, destructors and assignment
110
# operators of the base classes will not be shown.
112
INLINE_INHERITED_MEMB = NO
114
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115
# path before files name in the file list and in the header files. If set
116
# to NO the shortest path that makes the file name unique will be used.
118
FULL_PATH_NAMES = YES
120
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121
# can be used to strip a user-defined part of the path. Stripping is
122
# only done if one of the specified strings matches the left-hand part of
123
# the path. The tag can be used to show relative paths in the file list.
124
# If left blank the directory from which doxygen is run is used as the
129
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130
# the path mentioned in the documentation of a class, which tells
131
# the reader which header file to include in order to use a class.
132
# If left blank only the name of the header file containing the class
133
# definition is used. Otherwise one should specify the include paths that
134
# are normally passed to the compiler using the -I flag.
136
STRIP_FROM_INC_PATH =
138
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139
# (but less readable) file names. This can be useful if your file system
140
# doesn't support long names like on DOS, Mac, or CD-ROM.
144
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
145
# will interpret the first line (until the first dot) of a JavaDoc-style
146
# comment as the brief description. If set to NO, the JavaDoc
147
# comments will behave just like regular Qt-style comments
148
# (thus requiring an explicit @brief command for a brief description.)
150
JAVADOC_AUTOBRIEF = YES
152
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
153
# interpret the first line (until the first dot) of a Qt-style
154
# comment as the brief description. If set to NO, the comments
155
# will behave just like regular Qt-style comments (thus requiring
156
# an explicit \brief command for a brief description.)
160
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
161
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
162
# comments) as a brief description. This used to be the default behaviour.
163
# The new default is to treat a multi-line C++ comment block as a detailed
164
# description. Set this tag to YES if you prefer the old behaviour instead.
166
MULTILINE_CPP_IS_BRIEF = NO
168
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
169
# member inherits the documentation from any documented member that it
174
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175
# a new page for each member. If set to NO, the documentation of a member will
176
# be part of the file/class/namespace that contains it.
178
SEPARATE_MEMBER_PAGES = NO
180
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
181
# Doxygen uses this value to replace tabs by spaces in code fragments.
185
# This tag can be used to specify a number of aliases that acts
186
# as commands in the documentation. An alias has the form "name=value".
187
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
188
# put the command \sideeffect (or @sideeffect) in the documentation, which
189
# will result in a user-defined paragraph with heading "Side Effects:".
190
# You can put \n's in the value part of an alias to insert newlines.
194
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
195
# sources only. Doxygen will then generate output that is more tailored for C.
196
# For instance, some of the names that are used will be different. The list
197
# of all members will be omitted, etc.
199
OPTIMIZE_OUTPUT_FOR_C = YES
201
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
202
# sources only. Doxygen will then generate output that is more tailored for
203
# Java. For instance, namespaces will be presented as packages, qualified
204
# scopes will look different, etc.
206
OPTIMIZE_OUTPUT_JAVA = NO
208
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
209
# sources only. Doxygen will then generate output that is more tailored for
212
OPTIMIZE_FOR_FORTRAN = NO
214
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
215
# sources. Doxygen will then generate output that is tailored for
218
OPTIMIZE_OUTPUT_VHDL = NO
220
# Doxygen selects the parser to use depending on the extension of the files it
221
# parses. With this tag you can assign which parser to use for a given extension.
222
# Doxygen has a built-in mapping, but you can override or extend it using this
223
# tag. The format is ext=language, where ext is a file extension, and language
224
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
225
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
226
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
227
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
228
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
232
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
233
# to include (a tag file for) the STL sources as input, then you should
234
# set this tag to YES in order to let doxygen match functions declarations and
235
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
236
# func(std::string) {}). This also makes the inheritance and collaboration
237
# diagrams that involve STL classes more complete and accurate.
239
BUILTIN_STL_SUPPORT = NO
241
# If you use Microsoft's C++/CLI language, you should set this option to YES to
242
# enable parsing support.
246
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
247
# Doxygen will parse them like normal C++ but will assume all classes use public
248
# instead of private inheritance when no explicit protection keyword is present.
252
# For Microsoft's IDL there are propget and propput attributes to indicate getter
253
# and setter methods for a property. Setting this option to YES (the default)
254
# will make doxygen replace the get and set methods by a property in the
255
# documentation. This will only work if the methods are indeed getting or
256
# setting a simple type. If this is not the case, or you want to show the
257
# methods anyway, you should set this option to NO.
259
IDL_PROPERTY_SUPPORT = YES
261
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
262
# tag is set to YES, then doxygen will reuse the documentation of the first
263
# member in the group (if any) for the other members of the group. By default
264
# all members of a group must be documented explicitly.
266
DISTRIBUTE_GROUP_DOC = NO
268
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
269
# the same type (for instance a group of public functions) to be put as a
270
# subgroup of that type (e.g. under the Public Functions section). Set it to
271
# NO to prevent subgrouping. Alternatively, this can be done per class using
272
# the \nosubgrouping command.
276
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
277
# is documented as struct, union, or enum with the name of the typedef. So
278
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
279
# with name TypeT. When disabled the typedef will appear as a member of a file,
280
# namespace, or class. And the struct will be named TypeS. This can typically
281
# be useful for C code in case the coding convention dictates that all compound
282
# types are typedef'ed and only the typedef is referenced, never the tag name.
284
TYPEDEF_HIDES_STRUCT = NO
286
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
287
# determine which symbols to keep in memory and which to flush to disk.
288
# When the cache is full, less often used symbols will be written to disk.
289
# For small to medium size projects (<1000 input files) the default value is
290
# probably good enough. For larger projects a too small cache size can cause
291
# doxygen to be busy swapping symbols to and from disk most of the time
292
# causing a significant performance penality.
293
# If the system has enough physical memory increasing the cache will improve the
294
# performance by keeping more symbols in memory. Note that the value works on
295
# a logarithmic scale so increasing the size by one will roughly double the
296
# memory usage. The cache size is given by this formula:
297
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
298
# corresponding to a cache size of 2^16 = 65536 symbols
300
SYMBOL_CACHE_SIZE = 0
302
#---------------------------------------------------------------------------
303
# Build related configuration options
304
#---------------------------------------------------------------------------
306
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
307
# documentation are documented, even if no documentation was available.
308
# Private class members and static file members will be hidden unless
309
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
313
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
314
# will be included in the documentation.
318
# If the EXTRACT_STATIC tag is set to YES all static members of a file
319
# will be included in the documentation.
323
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
324
# defined locally in source files will be included in the documentation.
325
# If set to NO only classes defined in header files are included.
327
EXTRACT_LOCAL_CLASSES = YES
329
# This flag is only useful for Objective-C code. When set to YES local
330
# methods, which are defined in the implementation section but not in
331
# the interface are included in the documentation.
332
# If set to NO (the default) only methods in the interface are included.
334
EXTRACT_LOCAL_METHODS = NO
336
# If this flag is set to YES, the members of anonymous namespaces will be
337
# extracted and appear in the documentation as a namespace called
338
# 'anonymous_namespace{file}', where file will be replaced with the base
339
# name of the file that contains the anonymous namespace. By default
340
# anonymous namespaces are hidden.
342
EXTRACT_ANON_NSPACES = NO
344
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
345
# undocumented members of documented classes, files or namespaces.
346
# If set to NO (the default) these members will be included in the
347
# various overviews, but no documentation section is generated.
348
# This option has no effect if EXTRACT_ALL is enabled.
350
HIDE_UNDOC_MEMBERS = NO
352
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
353
# undocumented classes that are normally visible in the class hierarchy.
354
# If set to NO (the default) these classes will be included in the various
355
# overviews. This option has no effect if EXTRACT_ALL is enabled.
357
HIDE_UNDOC_CLASSES = NO
359
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
360
# friend (class|struct|union) declarations.
361
# If set to NO (the default) these declarations will be included in the
364
HIDE_FRIEND_COMPOUNDS = NO
366
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
367
# documentation blocks found inside the body of a function.
368
# If set to NO (the default) these blocks will be appended to the
369
# function's detailed documentation block.
371
HIDE_IN_BODY_DOCS = NO
373
# The INTERNAL_DOCS tag determines if documentation
374
# that is typed after a \internal command is included. If the tag is set
375
# to NO (the default) then the documentation will be excluded.
376
# Set it to YES to include the internal documentation.
380
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
381
# file names in lower-case letters. If set to YES upper-case letters are also
382
# allowed. This is useful if you have classes or files whose names only differ
383
# in case and if your file system supports case sensitive file names. Windows
384
# and Mac users are advised to set this option to NO.
386
CASE_SENSE_NAMES = NO
388
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
389
# will show members with their full class and namespace scopes in the
390
# documentation. If set to YES the scope will be hidden.
392
HIDE_SCOPE_NAMES = YES
394
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
395
# will put a list of the files that are included by a file in the documentation
398
SHOW_INCLUDE_FILES = YES
400
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
401
# will list include files with double quotes in the documentation
402
# rather than with sharp brackets.
404
FORCE_LOCAL_INCLUDES = NO
406
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
407
# is inserted in the documentation for inline members.
411
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
412
# will sort the (detailed) documentation of file and class members
413
# alphabetically by member name. If set to NO the members will appear in
416
SORT_MEMBER_DOCS = YES
418
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
419
# brief documentation of file, namespace and class members alphabetically
420
# by member name. If set to NO (the default) the members will appear in
425
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
426
# will sort the (brief and detailed) documentation of class members so that
427
# constructors and destructors are listed first. If set to NO (the default)
428
# the constructors will appear in the respective orders defined by
429
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
430
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
431
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
433
SORT_MEMBERS_CTORS_1ST = NO
435
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
436
# hierarchy of group names into alphabetical order. If set to NO (the default)
437
# the group names will appear in their defined order.
439
SORT_GROUP_NAMES = NO
441
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
442
# sorted by fully-qualified names, including namespaces. If set to
443
# NO (the default), the class list will be sorted only by class name,
444
# not including the namespace part.
445
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
446
# Note: This option applies only to the class list, not to the
449
SORT_BY_SCOPE_NAME = NO
451
# The GENERATE_TODOLIST tag can be used to enable (YES) or
452
# disable (NO) the todo list. This list is created by putting \todo
453
# commands in the documentation.
455
GENERATE_TODOLIST = YES
457
# The GENERATE_TESTLIST tag can be used to enable (YES) or
458
# disable (NO) the test list. This list is created by putting \test
459
# commands in the documentation.
461
GENERATE_TESTLIST = YES
463
# The GENERATE_BUGLIST tag can be used to enable (YES) or
464
# disable (NO) the bug list. This list is created by putting \bug
465
# commands in the documentation.
467
GENERATE_BUGLIST = YES
469
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
470
# disable (NO) the deprecated list. This list is created by putting
471
# \deprecated commands in the documentation.
473
GENERATE_DEPRECATEDLIST= YES
475
# The ENABLED_SECTIONS tag can be used to enable conditional
476
# documentation sections, marked by \if sectionname ... \endif.
480
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
481
# the initial value of a variable or macro consists of for it to appear in
482
# the documentation. If the initializer consists of more lines than specified
483
# here it will be hidden. Use a value of 0 to hide initializers completely.
484
# The appearance of the initializer of individual variables and macros in the
485
# documentation can be controlled using \showinitializer or \hideinitializer
486
# command in the documentation regardless of this setting.
488
MAX_INITIALIZER_LINES = 30
490
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
491
# at the bottom of the documentation of classes and structs. If set to YES the
492
# list will mention the files that were used to generate the documentation.
494
SHOW_USED_FILES = YES
496
# If the sources in your project are distributed over multiple directories
497
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
498
# in the documentation. The default is NO.
500
SHOW_DIRECTORIES = NO
502
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
503
# This will remove the Files entry from the Quick Index and from the
504
# Folder Tree View (if specified). The default is YES.
508
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
509
# Namespaces page. This will remove the Namespaces entry from the Quick Index
510
# and from the Folder Tree View (if specified). The default is YES.
512
SHOW_NAMESPACES = YES
514
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
515
# doxygen should invoke to get the current version for each file (typically from
516
# the version control system). Doxygen will invoke the program by executing (via
517
# popen()) the command <command> <input-file>, where <command> is the value of
518
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
519
# provided by doxygen. Whatever the program writes to standard output
520
# is used as the file version. See the manual for examples.
522
FILE_VERSION_FILTER =
524
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
525
# by doxygen. The layout file controls the global structure of the generated
526
# output files in an output format independent way. The create the layout file
527
# that represents doxygen's defaults, run doxygen with the -l option.
528
# You can optionally specify a file name after the option, if omitted
529
# DoxygenLayout.xml will be used as the name of the layout file.
533
#---------------------------------------------------------------------------
534
# configuration options related to warning and progress messages
535
#---------------------------------------------------------------------------
537
# The QUIET tag can be used to turn on/off the messages that are generated
538
# by doxygen. Possible values are YES and NO. If left blank NO is used.
542
# The WARNINGS tag can be used to turn on/off the warning messages that are
543
# generated by doxygen. Possible values are YES and NO. If left blank
548
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
549
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
550
# automatically be disabled.
552
WARN_IF_UNDOCUMENTED = YES
554
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
555
# potential errors in the documentation, such as not documenting some
556
# parameters in a documented function, or documenting parameters that
557
# don't exist or using markup commands wrongly.
559
WARN_IF_DOC_ERROR = YES
561
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
562
# functions that are documented, but have no documentation for their parameters
563
# or return value. If set to NO (the default) doxygen will only warn about
564
# wrong or incomplete parameter documentation, but not about the absence of
567
WARN_NO_PARAMDOC = NO
569
# The WARN_FORMAT tag determines the format of the warning messages that
570
# doxygen can produce. The string should contain the $file, $line, and $text
571
# tags, which will be replaced by the file and line number from which the
572
# warning originated and the warning text. Optionally the format may contain
573
# $version, which will be replaced by the version of the file (if it could
574
# be obtained via FILE_VERSION_FILTER)
576
WARN_FORMAT = "$file:$line: $text"
578
# The WARN_LOGFILE tag can be used to specify a file to which warning
579
# and error messages should be written. If left blank the output is written
584
#---------------------------------------------------------------------------
585
# configuration options related to the input files
586
#---------------------------------------------------------------------------
588
# The INPUT tag can be used to specify the files and/or directories that contain
589
# documented source files. You may enter file names like "myfile.cpp" or
590
# directories like "/usr/src/myproject". Separate the files or directories
593
INPUT = . ../doc/doxy_examples/
595
# This tag can be used to specify the character encoding of the source files
596
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
597
# also the default input encoding. Doxygen uses libiconv (or the iconv built
598
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
599
# the list of possible encodings.
601
INPUT_ENCODING = UTF-8
603
# If the value of the INPUT tag contains directories, you can use the
604
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
605
# and *.h) to filter out the source-files in the directories. If left
606
# blank the following patterns are tested:
607
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
608
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
609
# *.f90 *.f *.vhd *.vhdl
611
FILE_PATTERNS = *.c \
615
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
616
# should be searched for input files as well. Possible values are YES and NO.
617
# If left blank NO is used.
621
# The EXCLUDE tag can be used to specify files and/or directories that should
622
# excluded from the INPUT source files. This way you can easily exclude a
623
# subdirectory from a directory tree whose root is specified with the INPUT tag.
625
EXCLUDE = appl windows tests lib/crypto/crypto_tests \
626
lib/crypto/openssl lib/crypto/nss plugins
628
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
629
# directories that are symbolic links (a Unix filesystem feature) are excluded
632
EXCLUDE_SYMLINKS = YES
634
# If the value of the INPUT tag contains directories, you can use the
635
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
636
# certain files from those directories. Note that the wildcards are matched
637
# against the file with absolute path, so to exclude all test directories
638
# for example use the pattern */test/*
642
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
643
# (namespaces, classes, functions, etc.) that should be excluded from the
644
# output. The symbol name can be a fully qualified name, a word, or if the
645
# wildcard * is used, a substring. Examples: ANamespace, AClass,
646
# AClass::ANamespace, ANamespace::*Test
650
# The EXAMPLE_PATH tag can be used to specify one or more files or
651
# directories that contain example code fragments that are included (see
652
# the \include command).
654
EXAMPLE_PATH = ../doc/doxy_examples
656
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
657
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
658
# and *.h) to filter out the source-files in the directories. If left
659
# blank all files are included.
663
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
664
# searched for input files to be used with the \include or \dontinclude
665
# commands irrespective of the value of the RECURSIVE tag.
666
# Possible values are YES and NO. If left blank NO is used.
668
EXAMPLE_RECURSIVE = NO
670
# The IMAGE_PATH tag can be used to specify one or more files or
671
# directories that contain image that are included in the documentation (see
672
# the \image command).
676
# The INPUT_FILTER tag can be used to specify a program that doxygen should
677
# invoke to filter for each input file. Doxygen will invoke the filter program
678
# by executing (via popen()) the command <filter> <input-file>, where <filter>
679
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
680
# input file. Doxygen will then use the output that the filter program writes
681
# to standard output. If FILTER_PATTERNS is specified, this tag will be
686
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
687
# basis. Doxygen will compare the file name with each pattern and apply the
688
# filter if there is a match. The filters are a list of the form:
689
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
690
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
691
# is applied to all files.
695
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
696
# INPUT_FILTER) will be used to filter the input files when producing source
697
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
699
FILTER_SOURCE_FILES = NO
701
#---------------------------------------------------------------------------
702
# configuration options related to source browsing
703
#---------------------------------------------------------------------------
705
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
706
# be generated. Documented entities will be cross-referenced with these sources.
707
# Note: To get rid of all source code in the generated output, make sure also
708
# VERBATIM_HEADERS is set to NO.
712
# Setting the INLINE_SOURCES tag to YES will include the body
713
# of functions and classes directly in the documentation.
717
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
718
# doxygen to hide any special comment blocks from generated source code
719
# fragments. Normal C and C++ comments will always remain visible.
721
STRIP_CODE_COMMENTS = YES
723
# If the REFERENCED_BY_RELATION tag is set to YES
724
# then for each documented function all documented
725
# functions referencing it will be listed.
727
REFERENCED_BY_RELATION = NO
729
# If the REFERENCES_RELATION tag is set to YES
730
# then for each documented function all documented entities
731
# called/used by that function will be listed.
733
REFERENCES_RELATION = NO
735
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
736
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
737
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
738
# link to the source code. Otherwise they will link to the documentation.
740
REFERENCES_LINK_SOURCE = YES
742
# If the USE_HTAGS tag is set to YES then the references to source code
743
# will point to the HTML generated by the htags(1) tool instead of doxygen
744
# built-in source browser. The htags tool is part of GNU's global source
745
# tagging system (see http://www.gnu.org/software/global/global.html). You
746
# will need version 4.8.6 or higher.
750
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
751
# will generate a verbatim copy of the header file for each class for
752
# which an include is specified. Set to NO to disable this.
754
VERBATIM_HEADERS = YES
756
#---------------------------------------------------------------------------
757
# configuration options related to the alphabetical class index
758
#---------------------------------------------------------------------------
760
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
761
# of all compounds will be generated. Enable this if the project
762
# contains a lot of classes, structs, unions or interfaces.
764
ALPHABETICAL_INDEX = YES
766
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
767
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
768
# in which this list will be split (can be a number in the range [1..20])
770
COLS_IN_ALPHA_INDEX = 5
772
# In case all classes in a project start with a common prefix, all
773
# classes will be put under the same header in the alphabetical index.
774
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
775
# should be ignored while generating the index headers.
779
#---------------------------------------------------------------------------
780
# configuration options related to the HTML output
781
#---------------------------------------------------------------------------
783
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
784
# generate HTML output.
788
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
789
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
790
# put in front of it. If left blank `html' will be used as the default path.
794
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
795
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
796
# doxygen will generate files with .html extension.
798
HTML_FILE_EXTENSION = .html
800
# The HTML_HEADER tag can be used to specify a personal HTML header for
801
# each generated HTML page. If it is left blank doxygen will generate a
806
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
807
# each generated HTML page. If it is left blank doxygen will generate a
812
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
813
# style sheet that is used by each HTML page. It can be used to
814
# fine-tune the look of the HTML output. If the tag is left blank doxygen
815
# will generate a default style sheet. Note that doxygen will try to copy
816
# the style sheet file to the HTML output directory, so don't put your own
817
# stylesheet in the HTML output directory as well, or it will be erased!
821
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
822
# Doxygen will adjust the colors in the stylesheet and background images
823
# according to this color. Hue is specified as an angle on a colorwheel,
824
# see http://en.wikipedia.org/wiki/Hue for more information.
825
# For instance the value 0 represents red, 60 is yellow, 120 is green,
826
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
827
# The allowed range is 0 to 359.
829
HTML_COLORSTYLE_HUE = 220
831
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
832
# the colors in the HTML output. For a value of 0 the output will use
833
# grayscales only. A value of 255 will produce the most vivid colors.
835
HTML_COLORSTYLE_SAT = 100
837
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
838
# the luminance component of the colors in the HTML output. Values below
839
# 100 gradually make the output lighter, whereas values above 100 make
840
# the output darker. The value divided by 100 is the actual gamma applied,
841
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
842
# and 100 does not change the gamma.
844
HTML_COLORSTYLE_GAMMA = 80
846
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
847
# page will contain the date and time when the page was generated. Setting
848
# this to NO can help when comparing the output of multiple runs.
852
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
853
# files or namespaces will be aligned in HTML using tables. If set to
854
# NO a bullet list will be used.
856
HTML_ALIGN_MEMBERS = YES
858
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
859
# documentation will contain sections that can be hidden and shown after the
860
# page has loaded. For this to work a browser that supports
861
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
862
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
864
HTML_DYNAMIC_SECTIONS = NO
866
# If the GENERATE_DOCSET tag is set to YES, additional index files
867
# will be generated that can be used as input for Apple's Xcode 3
868
# integrated development environment, introduced with OSX 10.5 (Leopard).
869
# To create a documentation set, doxygen will generate a Makefile in the
870
# HTML output directory. Running make will produce the docset in that
871
# directory and running "make install" will install the docset in
872
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
874
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
875
# for more information.
879
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
880
# feed. A documentation feed provides an umbrella under which multiple
881
# documentation sets from a single provider (such as a company or product suite)
884
DOCSET_FEEDNAME = "Doxygen generated docs"
886
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
887
# should uniquely identify the documentation set bundle. This should be a
888
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
889
# will append .docset to the name.
891
DOCSET_BUNDLE_ID = org.doxygen.Project
893
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
894
# the documentation publisher. This should be a reverse domain-name style
895
# string, e.g. com.mycompany.MyDocSet.documentation.
897
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
899
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
901
DOCSET_PUBLISHER_NAME = Publisher
903
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
904
# will be generated that can be used as input for tools like the
905
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
906
# of the generated HTML documentation.
908
GENERATE_HTMLHELP = NO
910
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
911
# be used to specify the file name of the resulting .chm file. You
912
# can add a path in front of the file if the result should not be
913
# written to the html output directory.
917
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
918
# be used to specify the location (absolute path including file name) of
919
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
920
# the HTML help compiler on the generated index.hhp.
924
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
925
# controls if a separate .chi index file is generated (YES) or that
926
# it should be included in the master .chm file (NO).
930
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
931
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
936
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
937
# controls whether a binary table of contents is generated (YES) or a
938
# normal table of contents (NO) in the .chm file.
942
# The TOC_EXPAND flag can be set to YES to add extra items for group members
943
# to the contents of the HTML help documentation and to the tree view.
947
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
948
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
949
# that can be used as input for Qt's qhelpgenerator to generate a
950
# Qt Compressed Help (.qch) of the generated HTML documentation.
954
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
955
# be used to specify the file name of the resulting .qch file.
956
# The path specified is relative to the HTML output folder.
960
# The QHP_NAMESPACE tag specifies the namespace to use when generating
961
# Qt Help Project output. For more information please see
962
# http://doc.trolltech.com/qthelpproject.html#namespace
964
QHP_NAMESPACE = org.doxygen.Project
966
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
967
# Qt Help Project output. For more information please see
968
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
970
QHP_VIRTUAL_FOLDER = doc
972
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
973
# add. For more information please see
974
# http://doc.trolltech.com/qthelpproject.html#custom-filters
976
QHP_CUST_FILTER_NAME =
978
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
979
# custom filter to add. For more information please see
980
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
981
# Qt Help Project / Custom Filters</a>.
983
QHP_CUST_FILTER_ATTRS =
985
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
987
# filter section matches.
988
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
989
# Qt Help Project / Filter Attributes</a>.
991
QHP_SECT_FILTER_ATTRS =
993
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
994
# be used to specify the location of Qt's qhelpgenerator.
995
# If non-empty doxygen will try to run qhelpgenerator on the generated
1000
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1001
# will be generated, which together with the HTML files, form an Eclipse help
1002
# plugin. To install this plugin and make it available under the help contents
1003
# menu in Eclipse, the contents of the directory containing the HTML and XML
1004
# files needs to be copied into the plugins directory of eclipse. The name of
1005
# the directory within the plugins directory should be the same as
1006
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1009
GENERATE_ECLIPSEHELP = NO
1011
# A unique identifier for the eclipse help plugin. When installing the plugin
1012
# the directory name containing the HTML and XML files should also have
1015
ECLIPSE_DOC_ID = org.doxygen.Project
1017
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1018
# top of each HTML page. The value NO (the default) enables the index and
1019
# the value YES disables it.
1023
# This tag can be used to set the number of enum values (range [0,1..20])
1024
# that doxygen will group on one line in the generated HTML documentation.
1025
# Note that a value of 0 will completely suppress the enum values from
1026
# appearing in the overview section.
1028
ENUM_VALUES_PER_LINE = 4
1030
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1031
# structure should be generated to display hierarchical information.
1032
# If the tag value is set to YES, a side panel will be generated
1033
# containing a tree-like index structure (just like the one that
1034
# is generated for HTML Help). For this to work a browser that supports
1035
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1036
# Windows users are probably better off using the HTML help feature.
1038
GENERATE_TREEVIEW = NO
1040
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1041
# and Class Hierarchy pages using a tree view instead of an ordered list.
1043
USE_INLINE_TREES = NO
1045
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1046
# used to set the initial width (in pixels) of the frame in which the tree
1049
TREEVIEW_WIDTH = 250
1051
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1052
# links to external symbols imported via tag files in a separate window.
1054
EXT_LINKS_IN_WINDOW = NO
1056
# Use this tag to change the font size of Latex formulas included
1057
# as images in the HTML documentation. The default is 10. Note that
1058
# when you change the font size after a successful doxygen run you need
1059
# to manually remove any form_*.png images from the HTML output directory
1060
# to force them to be regenerated.
1062
FORMULA_FONTSIZE = 10
1064
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1065
# generated for formulas are transparent PNGs. Transparent PNGs are
1066
# not supported properly for IE 6.0, but are supported on all modern browsers.
1067
# Note that when changing this option you need to delete any form_*.png files
1068
# in the HTML output before the changes have effect.
1070
FORMULA_TRANSPARENT = YES
1072
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1073
# (see http://www.mathjax.org) which uses client side Javascript for the
1074
# rendering instead of using prerendered bitmaps. Use this if you do not
1075
# have LaTeX installed or if you want to formulas look prettier in the HTML
1076
# output. When enabled you also need to install MathJax separately and
1077
# configure the path to it using the MATHJAX_RELPATH option.
1081
# When MathJax is enabled you need to specify the location relative to the
1082
# HTML output directory using the MATHJAX_RELPATH option. The destination
1083
# directory should contain the MathJax.js script. For instance, if the mathjax
1084
# directory is located at the same level as the HTML output directory, then
1085
# MATHJAX_RELPATH should be ../mathjax. The default value points to the
1086
# mathjax.org site, so you can quickly see the result without installing
1087
# MathJax, but it is strongly recommended to install a local copy of MathJax
1088
# before deployment.
1090
MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1092
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1093
# for the HTML output. The underlying search engine uses javascript
1094
# and DHTML and should work on any modern browser. Note that when using
1095
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1096
# (GENERATE_DOCSET) there is already a search function so this one should
1097
# typically be disabled. For large projects the javascript based search engine
1098
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1102
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1103
# implemented using a PHP enabled web server instead of at the web client
1104
# using Javascript. Doxygen will generate the search PHP script and index
1105
# file to put on the web server. The advantage of the server
1106
# based approach is that it scales better to large projects and allows
1107
# full text search. The disadvantages are that it is more difficult to setup
1108
# and does not have live searching capabilities.
1110
SERVER_BASED_SEARCH = NO
1112
#---------------------------------------------------------------------------
1113
# configuration options related to the LaTeX output
1114
#---------------------------------------------------------------------------
1116
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1117
# generate Latex output.
1121
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1122
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1123
# put in front of it. If left blank `latex' will be used as the default path.
1125
LATEX_OUTPUT = latex
1127
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1128
# invoked. If left blank `latex' will be used as the default command name.
1129
# Note that when enabling USE_PDFLATEX this option is only used for
1130
# generating bitmaps for formulas in the HTML output, but not in the
1131
# Makefile that is written to the output directory.
1133
LATEX_CMD_NAME = latex
1135
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1136
# generate index for LaTeX. If left blank `makeindex' will be used as the
1137
# default command name.
1139
MAKEINDEX_CMD_NAME = makeindex
1141
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1142
# LaTeX documents. This may be useful for small projects and may help to
1143
# save some trees in general.
1147
# The PAPER_TYPE tag can be used to set the paper type that is used
1148
# by the printer. Possible values are: a4, letter, legal and
1149
# executive. If left blank a4wide will be used.
1153
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1154
# packages that should be included in the LaTeX output.
1158
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1159
# the generated latex document. The header should contain everything until
1160
# the first chapter. If it is left blank doxygen will generate a
1161
# standard header. Notice: only use this tag if you know what you are doing!
1165
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1166
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1167
# contain links (just like the HTML output) instead of page references
1168
# This makes the output suitable for online browsing using a pdf viewer.
1170
PDF_HYPERLINKS = YES
1172
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1173
# plain latex in the generated Makefile. Set this option to YES to get a
1174
# higher quality PDF documentation.
1178
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1179
# command to the generated LaTeX files. This will instruct LaTeX to keep
1180
# running if errors occur, instead of asking the user for help.
1181
# This option is also used when generating formulas in HTML.
1183
LATEX_BATCHMODE = NO
1185
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1186
# include the index chapters (such as File Index, Compound Index, etc.)
1189
LATEX_HIDE_INDICES = NO
1191
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1192
# source code with syntax highlighting in the LaTeX output.
1193
# Note that which sources are shown also depends on other settings
1194
# such as SOURCE_BROWSER.
1196
LATEX_SOURCE_CODE = NO
1198
#---------------------------------------------------------------------------
1199
# configuration options related to the RTF output
1200
#---------------------------------------------------------------------------
1202
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1203
# The RTF output is optimized for Word 97 and may not look very pretty with
1204
# other RTF readers or editors.
1208
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1209
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1210
# put in front of it. If left blank `rtf' will be used as the default path.
1214
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1215
# RTF documents. This may be useful for small projects and may help to
1216
# save some trees in general.
1220
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1221
# will contain hyperlink fields. The RTF file will
1222
# contain links (just like the HTML output) instead of page references.
1223
# This makes the output suitable for online browsing using WORD or other
1224
# programs which support those fields.
1225
# Note: wordpad (write) and others do not support links.
1229
# Load stylesheet definitions from file. Syntax is similar to doxygen's
1230
# config file, i.e. a series of assignments. You only have to provide
1231
# replacements, missing definitions are set to their default value.
1233
RTF_STYLESHEET_FILE =
1235
# Set optional variables used in the generation of an rtf document.
1236
# Syntax is similar to doxygen's config file.
1238
RTF_EXTENSIONS_FILE =
1240
#---------------------------------------------------------------------------
1241
# configuration options related to the man page output
1242
#---------------------------------------------------------------------------
1244
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1245
# generate man pages
1249
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1250
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1251
# put in front of it. If left blank `man' will be used as the default path.
1255
# The MAN_EXTENSION tag determines the extension that is added to
1256
# the generated man pages (default is the subroutine's section .3)
1260
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1261
# then it will generate one additional man file for each entity
1262
# documented in the real man page(s). These additional files
1263
# only source the real man page, but without them the man command
1264
# would be unable to find the correct page. The default is NO.
1268
#---------------------------------------------------------------------------
1269
# configuration options related to the XML output
1270
#---------------------------------------------------------------------------
1272
# If the GENERATE_XML tag is set to YES Doxygen will
1273
# generate an XML file that captures the structure of
1274
# the code including all documentation.
1278
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1279
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1280
# put in front of it. If left blank `xml' will be used as the default path.
1284
# The XML_SCHEMA tag can be used to specify an XML schema,
1285
# which can be used by a validating XML parser to check the
1286
# syntax of the XML files.
1290
# The XML_DTD tag can be used to specify an XML DTD,
1291
# which can be used by a validating XML parser to check the
1292
# syntax of the XML files.
1296
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1297
# dump the program listings (including syntax highlighting
1298
# and cross-referencing information) to the XML output. Note that
1299
# enabling this will significantly increase the size of the XML output.
1301
XML_PROGRAMLISTING = YES
1303
#---------------------------------------------------------------------------
1304
# configuration options for the AutoGen Definitions output
1305
#---------------------------------------------------------------------------
1307
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1308
# generate an AutoGen Definitions (see autogen.sf.net) file
1309
# that captures the structure of the code including all
1310
# documentation. Note that this feature is still experimental
1311
# and incomplete at the moment.
1313
GENERATE_AUTOGEN_DEF = NO
1315
#---------------------------------------------------------------------------
1316
# configuration options related to the Perl module output
1317
#---------------------------------------------------------------------------
1319
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1320
# generate a Perl module file that captures the structure of
1321
# the code including all documentation. Note that this
1322
# feature is still experimental and incomplete at the
1325
GENERATE_PERLMOD = NO
1327
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1328
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1329
# to generate PDF and DVI output from the Perl module output.
1333
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1334
# nicely formatted so it can be parsed by a human reader. This is useful
1335
# if you want to understand what is going on. On the other hand, if this
1336
# tag is set to NO the size of the Perl module output will be much smaller
1337
# and Perl will parse it just the same.
1339
PERLMOD_PRETTY = YES
1341
# The names of the make variables in the generated doxyrules.make file
1342
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1343
# This is useful so different doxyrules.make files included by the same
1344
# Makefile don't overwrite each other's variables.
1346
PERLMOD_MAKEVAR_PREFIX =
1348
#---------------------------------------------------------------------------
1349
# Configuration options related to the preprocessor
1350
#---------------------------------------------------------------------------
1352
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1353
# evaluate all C-preprocessor directives found in the sources and include
1356
ENABLE_PREPROCESSING = YES
1358
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1359
# names in the source code. If set to NO (the default) only conditional
1360
# compilation will be performed. Macro expansion can be done in a controlled
1361
# way by setting EXPAND_ONLY_PREDEF to YES.
1363
MACRO_EXPANSION = NO
1365
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1366
# then the macro expansion is limited to the macros specified with the
1367
# PREDEFINED and EXPAND_AS_DEFINED tags.
1369
EXPAND_ONLY_PREDEF = NO
1371
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1372
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1374
SEARCH_INCLUDES = YES
1376
# The INCLUDE_PATH tag can be used to specify one or more directories that
1377
# contain include files that are not input files but should be processed by
1382
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1383
# patterns (like *.h and *.hpp) to filter out the header-files in the
1384
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1387
INCLUDE_FILE_PATTERNS =
1389
# The PREDEFINED tag can be used to specify one or more macro names that
1390
# are defined before the preprocessor is started (similar to the -D option of
1391
# gcc). The argument of the tag is a list of macros of the form: name
1392
# or name=definition (no spaces). If the definition and the = are
1393
# omitted =1 is assumed. To prevent a macro definition from being
1394
# undefined via #undef or recursively expanded use the := operator
1395
# instead of the = operator.
1397
PREDEFINED = KRB5_DEPRECATED KRB5_OLD_CRYPTO
1399
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1400
# this tag can be used to specify a list of macro names that should be expanded.
1401
# The macro definition that is found in the sources will be used.
1402
# Use the PREDEFINED tag if you want to use a different macro definition.
1406
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1407
# doxygen's preprocessor will remove all function-like macros that are alone
1408
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1409
# function macros are typically used for boiler-plate code, and will confuse
1410
# the parser if not removed.
1412
SKIP_FUNCTION_MACROS = YES
1414
#---------------------------------------------------------------------------
1415
# Configuration::additions related to external references
1416
#---------------------------------------------------------------------------
1418
# The TAGFILES option can be used to specify one or more tagfiles.
1419
# Optionally an initial location of the external documentation
1420
# can be added for each tagfile. The format of a tag file without
1421
# this location is as follows:
1422
# TAGFILES = file1 file2 ...
1423
# Adding location for the tag files is done as follows:
1424
# TAGFILES = file1=loc1 "file2 = loc2" ...
1425
# where "loc1" and "loc2" can be relative or absolute paths or
1426
# URLs. If a location is present for each tag, the installdox tool
1427
# does not have to be run to correct the links.
1428
# Note that each tag file must have a unique name
1429
# (where the name does NOT include the path)
1430
# If a tag file is not located in the directory in which doxygen
1431
# is run, you must also specify the path to the tagfile here.
1435
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1436
# a tag file that is based on the input files it reads.
1438
# GENERATE_TAGFILE = krb5doxy.tag
1440
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1441
# in the class index. If set to NO only the inherited external classes
1446
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1447
# in the modules index. If set to NO, only the current project's groups will
1450
EXTERNAL_GROUPS = YES
1452
# The PERL_PATH should be the absolute path and name of the perl script
1453
# interpreter (i.e. the result of `which perl').
1455
PERL_PATH = /usr/bin/perl
1457
#---------------------------------------------------------------------------
1458
# Configuration options related to the dot tool
1459
#---------------------------------------------------------------------------
1461
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1462
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1463
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1464
# this option also works with HAVE_DOT disabled, but it is recommended to
1465
# install and use dot, since it yields more powerful graphs.
1469
# You can define message sequence charts within doxygen comments using the \msc
1470
# command. Doxygen will then run the mscgen tool (see
1471
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1472
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1473
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1474
# default search path.
1478
# If set to YES, the inheritance and collaboration graphs will hide
1479
# inheritance and usage relations if the target is undocumented
1480
# or is not a class.
1482
HIDE_UNDOC_RELATIONS = YES
1484
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1485
# available from the path. This tool is part of Graphviz, a graph visualization
1486
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1487
# have no effect if this option is set to NO (the default)
1491
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1492
# allowed to run in parallel. When set to 0 (the default) doxygen will
1493
# base this on the number of processors available in the system. You can set it
1494
# explicitly to a value larger than 0 to get control over the balance
1495
# between CPU load and processing speed.
1499
# By default doxygen will write a font called FreeSans.ttf to the output
1500
# directory and reference it in all dot files that doxygen generates. This
1501
# font does not include all possible unicode characters however, so when you need
1502
# these (or just want a differently looking font) you can specify the font name
1503
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1504
# which can be done by putting it in a standard location or by setting the
1505
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1506
# containing the font.
1508
DOT_FONTNAME = FreeSans.ttf
1510
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1511
# The default size is 10pt.
1515
# By default doxygen will tell dot to use the output directory to look for the
1516
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1517
# different font using DOT_FONTNAME you can set the path where dot
1518
# can find it using this tag.
1522
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1523
# will generate a graph for each documented class showing the direct and
1524
# indirect inheritance relations. Setting this tag to YES will force the
1525
# the CLASS_DIAGRAMS tag to NO.
1529
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1530
# will generate a graph for each documented class showing the direct and
1531
# indirect implementation dependencies (inheritance, containment, and
1532
# class references variables) of the class with other documented classes.
1534
COLLABORATION_GRAPH = YES
1536
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1537
# will generate a graph for groups, showing the direct groups dependencies
1541
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1542
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1547
# If set to YES, the inheritance and collaboration graphs will show the
1548
# relations between templates and their instances.
1550
TEMPLATE_RELATIONS = NO
1552
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1553
# tags are set to YES then doxygen will generate a graph for each documented
1554
# file showing the direct and indirect include dependencies of the file with
1555
# other documented files.
1559
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1560
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1561
# documented header file showing the documented files that directly or
1562
# indirectly include this file.
1564
INCLUDED_BY_GRAPH = YES
1566
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1567
# doxygen will generate a call dependency graph for every global function
1568
# or class method. Note that enabling this option will significantly increase
1569
# the time of a run. So in most cases it will be better to enable call graphs
1570
# for selected functions only using the \callgraph command.
1574
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1575
# doxygen will generate a caller dependency graph for every global function
1576
# or class method. Note that enabling this option will significantly increase
1577
# the time of a run. So in most cases it will be better to enable caller
1578
# graphs for selected functions only using the \callergraph command.
1582
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1583
# will generate a graphical hierarchy of all classes instead of a textual one.
1585
GRAPHICAL_HIERARCHY = YES
1587
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1588
# then doxygen will show the dependencies a directory has on other directories
1589
# in a graphical way. The dependency relations are determined by the #include
1590
# relations between the files in the directories.
1592
DIRECTORY_GRAPH = YES
1594
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1595
# generated by dot. Possible values are png, jpg, or gif.
1596
# If left blank png will be used.
1598
DOT_IMAGE_FORMAT = png
1600
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1601
# found. If left blank, it is assumed the dot tool can be found in the path.
1603
DOT_PATH = /usr/local/graphviz-2.14/bin
1605
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1606
# contain dot files that are included in the documentation (see the
1607
# \dotfile command).
1611
# The MSCFILE_DIRS tag can be used to specify one or more directories that
1612
# contain msc files that are included in the documentation (see the
1613
# \mscfile command).
1617
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1618
# nodes that will be shown in the graph. If the number of nodes in a graph
1619
# becomes larger than this value, doxygen will truncate the graph, which is
1620
# visualized by representing a node as a red box. Note that doxygen if the
1621
# number of direct children of the root node in a graph is already larger than
1622
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1623
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1625
DOT_GRAPH_MAX_NODES = 50
1627
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1628
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1629
# from the root by following a path via at most 3 edges will be shown. Nodes
1630
# that lay further from the root node will be omitted. Note that setting this
1631
# option to 1 or 2 may greatly reduce the computation time needed for large
1632
# code bases. Also note that the size of a graph can be further restricted by
1633
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1635
MAX_DOT_GRAPH_DEPTH = 0
1637
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1638
# background. This is disabled by default, because dot on Windows does not
1639
# seem to support this out of the box. Warning: Depending on the platform used,
1640
# enabling this option may lead to badly anti-aliased labels on the edges of
1641
# a graph (i.e. they become hard to read).
1643
DOT_TRANSPARENT = NO
1645
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1646
# files in one run (i.e. multiple -o and -T options on the command line). This
1647
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1648
# support this, this feature is disabled by default.
1650
DOT_MULTI_TARGETS = NO
1652
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1653
# generate a legend page explaining the meaning of the various boxes and
1654
# arrows in the dot generated graphs.
1656
GENERATE_LEGEND = YES
1658
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1659
# remove the intermediate dot files that are used to generate
1660
# the various graphs.
added
removed
src/Doxyfile
