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
# 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 = Crypto++
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.
33
OUTPUT_DIRECTORY = doc
35
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36
# 2 levels of 10 sub-directories under the output directory of each output
37
# format and will distribute the generated files over these directories.
38
# Enabling this option can be useful when feeding doxygen a huge amount of source
39
# files, where putting all generated files in the same directory would otherwise
40
# cause performance problems for the file system.
44
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
45
# documentation generated by doxygen is written. Doxygen will use this
46
# information to generate all constant output in the proper language.
47
# The default language is English, other supported languages are:
48
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
49
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
50
# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese,
51
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
53
OUTPUT_LANGUAGE = English
55
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
56
# include brief member descriptions after the members that are listed in
57
# the file and class documentation (similar to JavaDoc).
58
# Set to NO to disable this.
60
BRIEF_MEMBER_DESC = YES
62
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
63
# the brief description of a member or function before the detailed description.
64
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
65
# brief descriptions will be completely suppressed.
69
# This tag implements a quasi-intelligent brief description abbreviator
70
# that is used to form the text in various listings. Each string
71
# in this list, if found as the leading text of the brief description, will be
72
# stripped from the text and the result after processing the whole list, is used
73
# as the annotated text. Otherwise, the brief description is used as-is. If left
74
# blank, the following values are used ("$name" is automatically replaced with the
75
# name of the entity): "The $name class" "The $name widget" "The $name file"
76
# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
80
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
81
# Doxygen will generate a detailed section even if there is only a brief
84
ALWAYS_DETAILED_SEC = NO
86
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
87
# members of a class in the documentation of that class as if those members were
88
# ordinary class members. Constructors, destructors and assignment operators of
89
# the base classes will not be shown.
91
INLINE_INHERITED_MEMB = YES
93
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
94
# path before files name in the file list and in the header files. If set
95
# to NO the shortest path that makes the file name unique will be used.
99
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
100
# can be used to strip a user-defined part of the path. Stripping is
101
# only done if one of the specified strings matches the left-hand part of
102
# the path. The tag can be used to show relative paths in the file list.
103
# If left blank the directory from which doxygen is run is used as the
108
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
109
# the path mentioned in the documentation of a class, which tells
110
# the reader which header file to include in order to use a class.
111
# If left blank only the name of the header file containing the class
112
# definition is used. Otherwise one should specify the include paths that
113
# are normally passed to the compiler using the -I flag.
115
STRIP_FROM_INC_PATH =
117
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
118
# (but less readable) file names. This can be useful is your file systems
119
# doesn't support long names like on DOS, Mac, or CD-ROM.
123
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
124
# will interpret the first line (until the first dot) of a JavaDoc-style
125
# comment as the brief description. If set to NO, the JavaDoc
126
# comments will behave just like the Qt-style comments (thus requiring an
127
# explicit @brief command for a brief description.
129
JAVADOC_AUTOBRIEF = YES
131
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
132
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
133
# comments) as a brief description. This used to be the default behaviour.
134
# The new default is to treat a multi-line C++ comment block as a detailed
135
# description. Set this tag to YES if you prefer the old behaviour instead.
137
MULTILINE_CPP_IS_BRIEF = NO
139
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
140
# will output the detailed description near the top, like JavaDoc.
141
# If set to NO, the detailed description appears after the member
146
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
147
# member inherits the documentation from any documented member that it
152
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
153
# tag is set to YES, then doxygen will reuse the documentation of the first
154
# member in the group (if any) for the other members of the group. By default
155
# all members of a group must be documented explicitly.
157
DISTRIBUTE_GROUP_DOC = NO
159
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
160
# Doxygen uses this value to replace tabs by spaces in code fragments.
164
# This tag can be used to specify a number of aliases that acts
165
# as commands in the documentation. An alias has the form "name=value".
166
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
167
# put the command \sideeffect (or @sideeffect) in the documentation, which
168
# will result in a user-defined paragraph with heading "Side Effects:".
169
# You can put \n's in the value part of an alias to insert newlines.
173
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
174
# only. Doxygen will then generate output that is more tailored for C.
175
# For instance, some of the names that are used will be different. The list
176
# of all members will be omitted, etc.
178
OPTIMIZE_OUTPUT_FOR_C = NO
180
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
181
# only. Doxygen will then generate output that is more tailored for Java.
182
# For instance, namespaces will be presented as packages, qualified scopes
183
# will look different, etc.
185
OPTIMIZE_OUTPUT_JAVA = NO
187
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
188
# the same type (for instance a group of public functions) to be put as a
189
# subgroup of that type (e.g. under the Public Functions section). Set it to
190
# NO to prevent subgrouping. Alternatively, this can be done per class using
191
# the \nosubgrouping command.
195
#---------------------------------------------------------------------------
196
# Build related configuration options
197
#---------------------------------------------------------------------------
199
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
200
# documentation are documented, even if no documentation was available.
201
# Private class members and static file members will be hidden unless
202
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
206
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
207
# will be included in the documentation.
211
# If the EXTRACT_STATIC tag is set to YES all static members of a file
212
# will be included in the documentation.
216
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
217
# defined locally in source files will be included in the documentation.
218
# If set to NO only classes defined in header files are included.
220
EXTRACT_LOCAL_CLASSES = YES
222
# This flag is only useful for Objective-C code. When set to YES local
223
# methods, which are defined in the implementation section but not in
224
# the interface are included in the documentation.
225
# If set to NO (the default) only methods in the interface are included.
227
EXTRACT_LOCAL_METHODS = NO
229
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
230
# undocumented members of documented classes, files or namespaces.
231
# If set to NO (the default) these members will be included in the
232
# various overviews, but no documentation section is generated.
233
# This option has no effect if EXTRACT_ALL is enabled.
235
HIDE_UNDOC_MEMBERS = NO
237
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
238
# undocumented classes that are normally visible in the class hierarchy.
239
# If set to NO (the default) these classes will be included in the various
240
# overviews. This option has no effect if EXTRACT_ALL is enabled.
242
HIDE_UNDOC_CLASSES = NO
244
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
245
# friend (class|struct|union) declarations.
246
# If set to NO (the default) these declarations will be included in the
249
HIDE_FRIEND_COMPOUNDS = NO
251
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
252
# documentation blocks found inside the body of a function.
253
# If set to NO (the default) these blocks will be appended to the
254
# function's detailed documentation block.
256
HIDE_IN_BODY_DOCS = NO
258
# The INTERNAL_DOCS tag determines if documentation
259
# that is typed after a \internal command is included. If the tag is set
260
# to NO (the default) then the documentation will be excluded.
261
# Set it to YES to include the internal documentation.
265
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
266
# file names in lower-case letters. If set to YES upper-case letters are also
267
# allowed. This is useful if you have classes or files whose names only differ
268
# in case and if your file system supports case sensitive file names. Windows
269
# users are advised to set this option to NO.
271
CASE_SENSE_NAMES = NO
273
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
274
# will show members with their full class and namespace scopes in the
275
# documentation. If set to YES the scope will be hidden.
277
HIDE_SCOPE_NAMES = NO
279
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
280
# will put a list of the files that are included by a file in the documentation
283
SHOW_INCLUDE_FILES = YES
285
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
286
# is inserted in the documentation for inline members.
290
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
291
# will sort the (detailed) documentation of file and class members
292
# alphabetically by member name. If set to NO the members will appear in
295
SORT_MEMBER_DOCS = NO
297
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
298
# brief documentation of file, namespace and class members alphabetically
299
# by member name. If set to NO (the default) the members will appear in
304
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
305
# sorted by fully-qualified names, including namespaces. If set to
306
# NO (the default), the class list will be sorted only by class name,
307
# not including the namespace part.
308
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
309
# Note: This option applies only to the class list, not to the
312
SORT_BY_SCOPE_NAME = NO
314
# The GENERATE_TODOLIST tag can be used to enable (YES) or
315
# disable (NO) the todo list. This list is created by putting \todo
316
# commands in the documentation.
318
GENERATE_TODOLIST = YES
320
# The GENERATE_TESTLIST tag can be used to enable (YES) or
321
# disable (NO) the test list. This list is created by putting \test
322
# commands in the documentation.
324
GENERATE_TESTLIST = YES
326
# The GENERATE_BUGLIST tag can be used to enable (YES) or
327
# disable (NO) the bug list. This list is created by putting \bug
328
# commands in the documentation.
330
GENERATE_BUGLIST = YES
332
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
333
# disable (NO) the deprecated list. This list is created by putting
334
# \deprecated commands in the documentation.
336
GENERATE_DEPRECATEDLIST= YES
338
# The ENABLED_SECTIONS tag can be used to enable conditional
339
# documentation sections, marked by \if sectionname ... \endif.
343
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
344
# the initial value of a variable or define consists of for it to appear in
345
# the documentation. If the initializer consists of more lines than specified
346
# here it will be hidden. Use a value of 0 to hide initializers completely.
347
# The appearance of the initializer of individual variables and defines in the
348
# documentation can be controlled using \showinitializer or \hideinitializer
349
# command in the documentation regardless of this setting.
351
MAX_INITIALIZER_LINES = 30
353
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
354
# at the bottom of the documentation of classes and structs. If set to YES the
355
# list will mention the files that were used to generate the documentation.
357
SHOW_USED_FILES = YES
359
#---------------------------------------------------------------------------
360
# configuration options related to warning and progress messages
361
#---------------------------------------------------------------------------
363
# The QUIET tag can be used to turn on/off the messages that are generated
364
# by doxygen. Possible values are YES and NO. If left blank NO is used.
368
# The WARNINGS tag can be used to turn on/off the warning messages that are
369
# generated by doxygen. Possible values are YES and NO. If left blank
374
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
375
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
376
# automatically be disabled.
378
WARN_IF_UNDOCUMENTED = No
380
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
381
# potential errors in the documentation, such as not documenting some
382
# parameters in a documented function, or documenting parameters that
383
# don't exist or using markup commands wrongly.
385
WARN_IF_DOC_ERROR = YES
387
# The WARN_FORMAT tag determines the format of the warning messages that
388
# doxygen can produce. The string should contain the $file, $line, and $text
389
# tags, which will be replaced by the file and line number from which the
390
# warning originated and the warning text.
392
WARN_FORMAT = "$file:$line: $text"
394
# The WARN_LOGFILE tag can be used to specify a file to which warning
395
# and error messages should be written. If left blank the output is written
400
#---------------------------------------------------------------------------
401
# configuration options related to the input files
402
#---------------------------------------------------------------------------
404
# The INPUT tag can be used to specify the files and/or directories that contain
405
# documented source files. You may enter file names like "myfile.cpp" or
406
# directories like "/usr/src/myproject". Separate the files or directories
411
# If the value of the INPUT tag contains directories, you can use the
412
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
413
# and *.h) to filter out the source-files in the directories. If left
414
# blank the following patterns are tested:
415
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
416
# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
418
FILE_PATTERNS = *.h \
421
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
422
# should be searched for input files as well. Possible values are YES and NO.
423
# If left blank NO is used.
427
# The EXCLUDE tag can be used to specify files and/or directories that should
428
# excluded from the INPUT source files. This way you can easily exclude a
429
# subdirectory from a directory tree whose root is specified with the INPUT tag.
433
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
434
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
436
EXCLUDE_SYMLINKS = NO
438
# If the value of the INPUT tag contains directories, you can use the
439
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
440
# certain files from those directories.
444
# The EXAMPLE_PATH tag can be used to specify one or more files or
445
# directories that contain example code fragments that are included (see
446
# the \include command).
450
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
451
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
452
# and *.h) to filter out the source-files in the directories. If left
453
# blank all files are included.
457
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
458
# searched for input files to be used with the \include or \dontinclude
459
# commands irrespective of the value of the RECURSIVE tag.
460
# Possible values are YES and NO. If left blank NO is used.
462
EXAMPLE_RECURSIVE = NO
464
# The IMAGE_PATH tag can be used to specify one or more files or
465
# directories that contain image that are included in the documentation (see
466
# the \image command).
470
# The INPUT_FILTER tag can be used to specify a program that doxygen should
471
# invoke to filter for each input file. Doxygen will invoke the filter program
472
# by executing (via popen()) the command <filter> <input-file>, where <filter>
473
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
474
# input file. Doxygen will then use the output that the filter program writes
475
# to standard output.
479
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
480
# INPUT_FILTER) will be used to filter the input files when producing source
481
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
483
FILTER_SOURCE_FILES = NO
485
#---------------------------------------------------------------------------
486
# configuration options related to source browsing
487
#---------------------------------------------------------------------------
489
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
490
# be generated. Documented entities will be cross-referenced with these sources.
491
# Note: To get rid of all source code in the generated output, make sure also
492
# VERBATIM_HEADERS is set to NO.
496
# Setting the INLINE_SOURCES tag to YES will include the body
497
# of functions and classes directly in the documentation.
501
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
502
# doxygen to hide any special comment blocks from generated source code
503
# fragments. Normal C and C++ comments will always remain visible.
505
STRIP_CODE_COMMENTS = NO
507
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
508
# then for each documented function all documented
509
# functions referencing it will be listed.
511
REFERENCED_BY_RELATION = YES
513
# If the REFERENCES_RELATION tag is set to YES (the default)
514
# then for each documented function all documented entities
515
# called/used by that function will be listed.
517
REFERENCES_RELATION = YES
519
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
520
# will generate a verbatim copy of the header file for each class for
521
# which an include is specified. Set to NO to disable this.
523
VERBATIM_HEADERS = YES
525
#---------------------------------------------------------------------------
526
# configuration options related to the alphabetical class index
527
#---------------------------------------------------------------------------
529
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
530
# of all compounds will be generated. Enable this if the project
531
# contains a lot of classes, structs, unions or interfaces.
533
ALPHABETICAL_INDEX = YES
535
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
536
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
537
# in which this list will be split (can be a number in the range [1..20])
539
COLS_IN_ALPHA_INDEX = 3
541
# In case all classes in a project start with a common prefix, all
542
# classes will be put under the same header in the alphabetical index.
543
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
544
# should be ignored while generating the index headers.
548
#---------------------------------------------------------------------------
549
# configuration options related to the HTML output
550
#---------------------------------------------------------------------------
552
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
553
# generate HTML output.
557
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
558
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
559
# put in front of it. If left blank `html' will be used as the default path.
563
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
564
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
565
# doxygen will generate files with .html extension.
567
HTML_FILE_EXTENSION = .html
569
# The HTML_HEADER tag can be used to specify a personal HTML header for
570
# each generated HTML page. If it is left blank doxygen will generate a
575
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
576
# each generated HTML page. If it is left blank doxygen will generate a
581
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
582
# style sheet that is used by each HTML page. It can be used to
583
# fine-tune the look of the HTML output. If the tag is left blank doxygen
584
# will generate a default style sheet. Note that doxygen will try to copy
585
# the style sheet file to the HTML output directory, so don't put your own
586
# stylesheet in the HTML output directory as well, or it will be erased!
590
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
591
# files or namespaces will be aligned in HTML using tables. If set to
592
# NO a bullet list will be used.
594
HTML_ALIGN_MEMBERS = YES
596
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
597
# will be generated that can be used as input for tools like the
598
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
599
# of the generated HTML documentation.
601
GENERATE_HTMLHELP = YES
603
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
604
# be used to specify the file name of the resulting .chm file. You
605
# can add a path in front of the file if the result should not be
606
# written to the html output directory.
610
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
611
# be used to specify the location (absolute path including file name) of
612
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
613
# the HTML help compiler on the generated index.hhp.
617
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
618
# controls if a separate .chi index file is generated (YES) or that
619
# it should be included in the master .chm file (NO).
623
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
624
# controls whether a binary table of contents is generated (YES) or a
625
# normal table of contents (NO) in the .chm file.
629
# The TOC_EXPAND flag can be set to YES to add extra items for group members
630
# to the contents of the HTML help documentation and to the tree view.
634
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
635
# top of each HTML page. The value NO (the default) enables the index and
636
# the value YES disables it.
640
# This tag can be used to set the number of enum values (range [1..20])
641
# that doxygen will group on one line in the generated HTML documentation.
643
ENUM_VALUES_PER_LINE = 4
645
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
646
# generated containing a tree-like index structure (just like the one that
647
# is generated for HTML Help). For this to work a browser that supports
648
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
649
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
650
# probably better off using the HTML help feature.
652
GENERATE_TREEVIEW = NO
654
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
655
# used to set the initial width (in pixels) of the frame in which the tree
660
#---------------------------------------------------------------------------
661
# configuration options related to the LaTeX output
662
#---------------------------------------------------------------------------
664
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
665
# generate Latex output.
669
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
670
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
671
# put in front of it. If left blank `latex' will be used as the default path.
675
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
676
# invoked. If left blank `latex' will be used as the default command name.
678
LATEX_CMD_NAME = latex
680
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
681
# generate index for LaTeX. If left blank `makeindex' will be used as the
682
# default command name.
684
MAKEINDEX_CMD_NAME = makeindex
686
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
687
# LaTeX documents. This may be useful for small projects and may help to
688
# save some trees in general.
692
# The PAPER_TYPE tag can be used to set the paper type that is used
693
# by the printer. Possible values are: a4, a4wide, letter, legal and
694
# executive. If left blank a4wide will be used.
698
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
699
# packages that should be included in the LaTeX output.
703
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
704
# the generated latex document. The header should contain everything until
705
# the first chapter. If it is left blank doxygen will generate a
706
# standard header. Notice: only use this tag if you know what you are doing!
710
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
711
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
712
# contain links (just like the HTML output) instead of page references
713
# This makes the output suitable for online browsing using a pdf viewer.
717
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
718
# plain latex in the generated Makefile. Set this option to YES to get a
719
# higher quality PDF documentation.
723
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
724
# command to the generated LaTeX files. This will instruct LaTeX to keep
725
# running if errors occur, instead of asking the user for help.
726
# This option is also used when generating formulas in HTML.
730
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
731
# include the index chapters (such as File Index, Compound Index, etc.)
734
LATEX_HIDE_INDICES = NO
736
#---------------------------------------------------------------------------
737
# configuration options related to the RTF output
738
#---------------------------------------------------------------------------
740
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
741
# The RTF output is optimized for Word 97 and may not look very pretty with
742
# other RTF readers or editors.
746
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
747
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
748
# put in front of it. If left blank `rtf' will be used as the default path.
752
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
753
# RTF documents. This may be useful for small projects and may help to
754
# save some trees in general.
758
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
759
# will contain hyperlink fields. The RTF file will
760
# contain links (just like the HTML output) instead of page references.
761
# This makes the output suitable for online browsing using WORD or other
762
# programs which support those fields.
763
# Note: wordpad (write) and others do not support links.
767
# Load stylesheet definitions from file. Syntax is similar to doxygen's
768
# config file, i.e. a series of assignments. You only have to provide
769
# replacements, missing definitions are set to their default value.
771
RTF_STYLESHEET_FILE =
773
# Set optional variables used in the generation of an rtf document.
774
# Syntax is similar to doxygen's config file.
776
RTF_EXTENSIONS_FILE =
778
#---------------------------------------------------------------------------
779
# configuration options related to the man page output
780
#---------------------------------------------------------------------------
782
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
787
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
788
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
789
# put in front of it. If left blank `man' will be used as the default path.
793
# The MAN_EXTENSION tag determines the extension that is added to
794
# the generated man pages (default is the subroutine's section .3)
798
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
799
# then it will generate one additional man file for each entity
800
# documented in the real man page(s). These additional files
801
# only source the real man page, but without them the man command
802
# would be unable to find the correct page. The default is NO.
806
#---------------------------------------------------------------------------
807
# configuration options related to the XML output
808
#---------------------------------------------------------------------------
810
# If the GENERATE_XML tag is set to YES Doxygen will
811
# generate an XML file that captures the structure of
812
# the code including all documentation.
816
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
817
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
818
# put in front of it. If left blank `xml' will be used as the default path.
822
# The XML_SCHEMA tag can be used to specify an XML schema,
823
# which can be used by a validating XML parser to check the
824
# syntax of the XML files.
828
# The XML_DTD tag can be used to specify an XML DTD,
829
# which can be used by a validating XML parser to check the
830
# syntax of the XML files.
834
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
835
# dump the program listings (including syntax highlighting
836
# and cross-referencing information) to the XML output. Note that
837
# enabling this will significantly increase the size of the XML output.
839
XML_PROGRAMLISTING = YES
841
#---------------------------------------------------------------------------
842
# configuration options for the AutoGen Definitions output
843
#---------------------------------------------------------------------------
845
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
846
# generate an AutoGen Definitions (see autogen.sf.net) file
847
# that captures the structure of the code including all
848
# documentation. Note that this feature is still experimental
849
# and incomplete at the moment.
851
GENERATE_AUTOGEN_DEF = NO
853
#---------------------------------------------------------------------------
854
# configuration options related to the Perl module output
855
#---------------------------------------------------------------------------
857
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
858
# generate a Perl module file that captures the structure of
859
# the code including all documentation. Note that this
860
# feature is still experimental and incomplete at the
863
GENERATE_PERLMOD = NO
865
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
866
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
867
# to generate PDF and DVI output from the Perl module output.
871
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
872
# nicely formatted so it can be parsed by a human reader. This is useful
873
# if you want to understand what is going on. On the other hand, if this
874
# tag is set to NO the size of the Perl module output will be much smaller
875
# and Perl will parse it just the same.
879
# The names of the make variables in the generated doxyrules.make file
880
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
881
# This is useful so different doxyrules.make files included by the same
882
# Makefile don't overwrite each other's variables.
884
PERLMOD_MAKEVAR_PREFIX =
886
#---------------------------------------------------------------------------
887
# Configuration options related to the preprocessor
888
#---------------------------------------------------------------------------
890
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
891
# evaluate all C-preprocessor directives found in the sources and include
894
ENABLE_PREPROCESSING = YES
896
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
897
# names in the source code. If set to NO (the default) only conditional
898
# compilation will be performed. Macro expansion can be done in a controlled
899
# way by setting EXPAND_ONLY_PREDEF to YES.
901
MACRO_EXPANSION = YES
903
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
904
# then the macro expansion is limited to the macros specified with the
905
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
907
EXPAND_ONLY_PREDEF = NO
909
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
910
# in the INCLUDE_PATH (see below) will be search if a #include is found.
912
SEARCH_INCLUDES = YES
914
# The INCLUDE_PATH tag can be used to specify one or more directories that
915
# contain include files that are not input files but should be processed by
920
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
921
# patterns (like *.h and *.hpp) to filter out the header-files in the
922
# directories. If left blank, the patterns specified with FILE_PATTERNS will
925
INCLUDE_FILE_PATTERNS =
927
# The PREDEFINED tag can be used to specify one or more macro names that
928
# are defined before the preprocessor is started (similar to the -D option of
929
# gcc). The argument of the tag is a list of macros of the form: name
930
# or name=definition (no spaces). If the definition and the = are
931
# omitted =1 is assumed.
933
PREDEFINED = _WIN32 \
936
CRYPTOPP_DOXYGEN_PROCESSING
938
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
939
# this tag can be used to specify a list of macro names that should be expanded.
940
# The macro definition that is found in the sources will be used.
941
# Use the PREDEFINED tag if you want to use a different macro definition.
945
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
946
# doxygen's preprocessor will remove all function-like macros that are alone
947
# on a line, have an all uppercase name, and do not end with a semicolon. Such
948
# function macros are typically used for boiler-plate code, and will confuse the
949
# parser if not removed.
951
SKIP_FUNCTION_MACROS = YES
953
#---------------------------------------------------------------------------
954
# Configuration::additions related to external references
955
#---------------------------------------------------------------------------
957
# The TAGFILES option can be used to specify one or more tagfiles.
958
# Optionally an initial location of the external documentation
959
# can be added for each tagfile. The format of a tag file without
960
# this location is as follows:
961
# TAGFILES = file1 file2 ...
962
# Adding location for the tag files is done as follows:
963
# TAGFILES = file1=loc1 "file2 = loc2" ...
964
# where "loc1" and "loc2" can be relative or absolute paths or
965
# URLs. If a location is present for each tag, the installdox tool
966
# does not have to be run to correct the links.
967
# Note that each tag file must have a unique name
968
# (where the name does NOT include the path)
969
# If a tag file is not located in the directory in which doxygen
970
# is run, you must also specify the path to the tagfile here.
974
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
975
# a tag file that is based on the input files it reads.
979
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
980
# in the class index. If set to NO only the inherited external classes
985
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
986
# in the modules index. If set to NO, only the current project's groups will
989
EXTERNAL_GROUPS = YES
991
# The PERL_PATH should be the absolute path and name of the perl script
992
# interpreter (i.e. the result of `which perl').
994
PERL_PATH = /usr/bin/perl
996
#---------------------------------------------------------------------------
997
# Configuration options related to the dot tool
998
#---------------------------------------------------------------------------
1000
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1001
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1002
# super classes. Setting the tag to NO turns the diagrams off. Note that this
1003
# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1004
# recommended to install and use dot, since it yields more powerful graphs.
1006
CLASS_DIAGRAMS = YES
1008
# If set to YES, the inheritance and collaboration graphs will hide
1009
# inheritance and usage relations if the target is undocumented
1010
# or is not a class.
1012
HIDE_UNDOC_RELATIONS = YES
1014
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1015
# available from the path. This tool is part of Graphviz, a graph visualization
1016
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1017
# have no effect if this option is set to NO (the default)
1021
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1022
# will generate a graph for each documented class showing the direct and
1023
# indirect inheritance relations. Setting this tag to YES will force the
1024
# the CLASS_DIAGRAMS tag to NO.
1028
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1029
# will generate a graph for each documented class showing the direct and
1030
# indirect implementation dependencies (inheritance, containment, and
1031
# class references variables) of the class with other documented classes.
1033
COLLABORATION_GRAPH = YES
1035
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1036
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1041
# If set to YES, the inheritance and collaboration graphs will show the
1042
# relations between templates and their instances.
1044
TEMPLATE_RELATIONS = YES
1046
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1047
# tags are set to YES then doxygen will generate a graph for each documented
1048
# file showing the direct and indirect include dependencies of the file with
1049
# other documented files.
1053
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1054
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1055
# documented header file showing the documented files that directly or
1056
# indirectly include this file.
1058
INCLUDED_BY_GRAPH = YES
1060
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1061
# generate a call dependency graph for every global function or class method.
1062
# Note that enabling this option will significantly increase the time of a run.
1063
# So in most cases it will be better to enable call graphs for selected
1064
# functions only using the \callgraph command.
1068
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1069
# will graphical hierarchy of all classes instead of a textual one.
1071
GRAPHICAL_HIERARCHY = YES
1073
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1074
# generated by dot. Possible values are png, jpg, or gif
1075
# If left blank png will be used.
1077
DOT_IMAGE_FORMAT = png
1079
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1080
# found. If left blank, it is assumed the dot tool can be found on the path.
1084
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1085
# contain dot files that are included in the documentation (see the
1086
# \dotfile command).
1090
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1091
# generate a legend page explaining the meaning of the various boxes and
1092
# arrows in the dot generated graphs.
1094
GENERATE_LEGEND = YES
1096
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1097
# remove the intermediate dot files that are used to generate
1098
# the various graphs.
1102
#---------------------------------------------------------------------------
1103
# Configuration::additions related to the search engine
1104
#---------------------------------------------------------------------------
1106
# The SEARCHENGINE tag specifies whether or not a search engine should be
1107
# used. If set to NO the values of all tags below this one will be ignored.