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 = "The deal.II library"
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.
26
PROJECT_NUMBER = "Reference documentation for deal.II version @PACKAGE_VERSION@"
28
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29
# base path where the generated documentation will be put.
30
# If a relative path is entered, it will be relative to the location
31
# where doxygen was started. If left blank the current directory will be used.
35
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36
# 4096 sub-directories (in 2 levels) 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
39
# source files, where putting all generated files in the same directory would
40
# otherwise 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
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
49
# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
50
# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
51
# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
52
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
54
OUTPUT_LANGUAGE = English
56
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57
# include brief member descriptions after the members that are listed in
58
# the file and class documentation (similar to JavaDoc).
59
# Set to NO to disable this.
61
BRIEF_MEMBER_DESC = YES
63
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64
# the brief description of a member or function before the detailed description.
65
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66
# brief descriptions will be completely suppressed.
70
# This tag implements a quasi-intelligent brief description abbreviator
71
# that is used to form the text in various listings. Each string
72
# in this list, if found as the leading text of the brief description, will be
73
# stripped from the text and the result after processing the whole list, is
74
# used as the annotated text. Otherwise, the brief description is used as-is.
75
# If left blank, the following values are used ("$name" is automatically
76
# replaced with the name of the entity): "The $name class" "The $name widget"
77
# "The $name file" "is" "provides" "specifies" "contains"
78
# "represents" "a" "an" "the"
82
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
83
# Doxygen will generate a detailed section even if there is only a brief
86
ALWAYS_DETAILED_SEC = NO
88
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
89
# inherited members of a class in the documentation of that class as if those
90
# members were ordinary class members. Constructors, destructors and assignment
91
# operators of the base classes will not be shown.
93
INLINE_INHERITED_MEMB = NO
95
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
96
# path before files name in the file list and in the header files. If set
97
# to NO the shortest path that makes the file name unique will be used.
101
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
102
# can be used to strip a user-defined part of the path. Stripping is
103
# only done if one of the specified strings matches the left-hand part of
104
# the path. The tag can be used to show relative paths in the file list.
105
# If left blank the directory from which doxygen is run is used as the
108
STRIP_FROM_PATH = @prefix@
110
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
111
# the path mentioned in the documentation of a class, which tells
112
# the reader which header file to include in order to use a class.
113
# If left blank only the name of the header file containing the class
114
# definition is used. Otherwise one should specify the include paths that
115
# are normally passed to the compiler using the -I flag.
117
STRIP_FROM_INC_PATH =
119
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
120
# (but less readable) file names. This can be useful is your file systems
121
# doesn't support long names like on DOS, Mac, or CD-ROM.
125
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
126
# will interpret the first line (until the first dot) of a JavaDoc-style
127
# comment as the brief description. If set to NO, the JavaDoc
128
# comments will behave just like regular Qt-style comments
129
# (thus requiring an explicit @brief command for a brief description.)
131
JAVADOC_AUTOBRIEF = NO
133
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
134
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
135
# comments) as a brief description. This used to be the default behaviour.
136
# The new default is to treat a multi-line C++ comment block as a detailed
137
# description. Set this tag to YES if you prefer the old behaviour instead.
139
MULTILINE_CPP_IS_BRIEF = NO
141
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
142
# member inherits the documentation from any documented member that it
147
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
148
# a new page for each member. If set to NO, the documentation of a member will
149
# be part of the file/class/namespace that contains it.
151
SEPARATE_MEMBER_PAGES = NO
153
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
154
# Doxygen uses this value to replace tabs by spaces in code fragments.
158
# This tag can be used to specify a number of aliases that acts
159
# as commands in the documentation. An alias has the form "name=value".
160
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
161
# put the command \sideeffect (or @sideeffect) in the documentation, which
162
# will result in a user-defined paragraph with heading "Side Effects:".
163
# You can put \n's in the value part of an alias to insert newlines.
167
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
168
# sources only. Doxygen will then generate output that is more tailored for C.
169
# For instance, some of the names that are used will be different. The list
170
# of all members will be omitted, etc.
172
OPTIMIZE_OUTPUT_FOR_C = NO
174
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
175
# sources only. Doxygen will then generate output that is more tailored for Java.
176
# For instance, namespaces will be presented as packages, qualified scopes
177
# will look different, etc.
179
OPTIMIZE_OUTPUT_JAVA = NO
181
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
182
# include (a tag file for) the STL sources as input, then you should
183
# set this tag to YES in order to let doxygen match functions declarations and
184
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
185
# func(std::string) {}). This also make the inheritance and collaboration
186
# diagrams that involve STL classes more complete and accurate.
188
BUILTIN_STL_SUPPORT = NO
190
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
191
# tag is set to YES, then doxygen will reuse the documentation of the first
192
# member in the group (if any) for the other members of the group. By default
193
# all members of a group must be documented explicitly.
195
DISTRIBUTE_GROUP_DOC = NO
197
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
198
# the same type (for instance a group of public functions) to be put as a
199
# subgroup of that type (e.g. under the Public Functions section). Set it to
200
# NO to prevent subgrouping. Alternatively, this can be done per class using
201
# the \nosubgrouping command.
205
#---------------------------------------------------------------------------
206
# Build related configuration options
207
#---------------------------------------------------------------------------
209
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
210
# documentation are documented, even if no documentation was available.
211
# Private class members and static file members will be hidden unless
212
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
216
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
217
# will be included in the documentation.
219
EXTRACT_PRIVATE = YES
221
# If the EXTRACT_STATIC tag is set to YES all static members of a file
222
# will be included in the documentation.
226
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
227
# defined locally in source files will be included in the documentation.
228
# If set to NO only classes defined in header files are included.
230
EXTRACT_LOCAL_CLASSES = YES
232
# This flag is only useful for Objective-C code. When set to YES local
233
# methods, which are defined in the implementation section but not in
234
# the interface are included in the documentation.
235
# If set to NO (the default) only methods in the interface are included.
237
EXTRACT_LOCAL_METHODS = NO
239
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
240
# undocumented members of documented classes, files or namespaces.
241
# If set to NO (the default) these members will be included in the
242
# various overviews, but no documentation section is generated.
243
# This option has no effect if EXTRACT_ALL is enabled.
245
HIDE_UNDOC_MEMBERS = YES
247
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
248
# undocumented classes that are normally visible in the class hierarchy.
249
# If set to NO (the default) these classes will be included in the various
250
# overviews. This option has no effect if EXTRACT_ALL is enabled.
252
HIDE_UNDOC_CLASSES = YES
254
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
255
# friend (class|struct|union) declarations.
256
# If set to NO (the default) these declarations will be included in the
259
HIDE_FRIEND_COMPOUNDS = NO
261
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
262
# documentation blocks found inside the body of a function.
263
# If set to NO (the default) these blocks will be appended to the
264
# function's detailed documentation block.
266
HIDE_IN_BODY_DOCS = NO
268
# The INTERNAL_DOCS tag determines if documentation
269
# that is typed after a \internal command is included. If the tag is set
270
# to NO (the default) then the documentation will be excluded.
271
# Set it to YES to include the internal documentation.
275
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
276
# file names in lower-case letters. If set to YES upper-case letters are also
277
# allowed. This is useful if you have classes or files whose names only differ
278
# in case and if your file system supports case sensitive file names. Windows
279
# and Mac users are advised to set this option to NO.
281
CASE_SENSE_NAMES = YES
283
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
284
# will show members with their full class and namespace scopes in the
285
# documentation. If set to YES the scope will be hidden.
287
HIDE_SCOPE_NAMES = NO
289
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
290
# will put a list of the files that are included by a file in the documentation
293
SHOW_INCLUDE_FILES = NO
295
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
296
# is inserted in the documentation for inline members.
300
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
301
# will sort the (detailed) documentation of file and class members
302
# alphabetically by member name. If set to NO the members will appear in
305
SORT_MEMBER_DOCS = NO
307
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
308
# brief documentation of file, namespace and class members alphabetically
309
# by member name. If set to NO (the default) the members will appear in
314
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
315
# sorted by fully-qualified names, including namespaces. If set to
316
# NO (the default), the class list will be sorted only by class name,
317
# not including the namespace part.
318
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
319
# Note: This option applies only to the class list, not to the
322
SORT_BY_SCOPE_NAME = NO
324
# The GENERATE_TODOLIST tag can be used to enable (YES) or
325
# disable (NO) the todo list. This list is created by putting \todo
326
# commands in the documentation.
328
GENERATE_TODOLIST = YES
330
# The GENERATE_TESTLIST tag can be used to enable (YES) or
331
# disable (NO) the test list. This list is created by putting \test
332
# commands in the documentation.
334
GENERATE_TESTLIST = YES
336
# The GENERATE_BUGLIST tag can be used to enable (YES) or
337
# disable (NO) the bug list. This list is created by putting \bug
338
# commands in the documentation.
340
GENERATE_BUGLIST = YES
342
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
343
# disable (NO) the deprecated list. This list is created by putting
344
# \deprecated commands in the documentation.
346
GENERATE_DEPRECATEDLIST= YES
348
# The ENABLED_SECTIONS tag can be used to enable conditional
349
# documentation sections, marked by \if sectionname ... \endif.
351
ENABLED_SECTIONS = YES
353
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
354
# the initial value of a variable or define consists of for it to appear in
355
# the documentation. If the initializer consists of more lines than specified
356
# here it will be hidden. Use a value of 0 to hide initializers completely.
357
# The appearance of the initializer of individual variables and defines in the
358
# documentation can be controlled using \showinitializer or \hideinitializer
359
# command in the documentation regardless of this setting.
361
MAX_INITIALIZER_LINES = 30
363
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
364
# at the bottom of the documentation of classes and structs. If set to YES the
365
# list will mention the files that were used to generate the documentation.
367
SHOW_USED_FILES = YES
369
# If the sources in your project are distributed over multiple directories
370
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
371
# in the documentation. The default is NO.
373
SHOW_DIRECTORIES = NO
375
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
376
# doxygen should invoke to get the current version for each file (typically from the
377
# version control system). Doxygen will invoke the program by executing (via
378
# popen()) the command <command> <input-file>, where <command> is the value of
379
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
380
# provided by doxygen. Whatever the program writes to standard output
381
# is used as the file version. See the manual for examples.
383
FILE_VERSION_FILTER =
385
#---------------------------------------------------------------------------
386
# configuration options related to warning and progress messages
387
#---------------------------------------------------------------------------
389
# The QUIET tag can be used to turn on/off the messages that are generated
390
# by doxygen. Possible values are YES and NO. If left blank NO is used.
394
# The WARNINGS tag can be used to turn on/off the warning messages that are
395
# generated by doxygen. Possible values are YES and NO. If left blank
400
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
401
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
402
# automatically be disabled.
404
WARN_IF_UNDOCUMENTED = YES
406
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
407
# potential errors in the documentation, such as not documenting some
408
# parameters in a documented function, or documenting parameters that
409
# don't exist or using markup commands wrongly.
411
WARN_IF_DOC_ERROR = YES
413
# This WARN_NO_PARAMDOC option can be abled to get warnings for
414
# functions that are documented, but have no documentation for their parameters
415
# or return value. If set to NO (the default) doxygen will only warn about
416
# wrong or incomplete parameter documentation, but not about the absence of
419
WARN_NO_PARAMDOC = NO
421
# The WARN_FORMAT tag determines the format of the warning messages that
422
# doxygen can produce. The string should contain the $file, $line, and $text
423
# tags, which will be replaced by the file and line number from which the
424
# warning originated and the warning text. Optionally the format may contain
425
# $version, which will be replaced by the version of the file (if it could
426
# be obtained via FILE_VERSION_FILTER)
428
WARN_FORMAT = "$file:$line: $text "
430
# The WARN_LOGFILE tag can be used to specify a file to which warning
431
# and error messages should be written. If left blank the output is written
436
#---------------------------------------------------------------------------
437
# configuration options related to the input files
438
#---------------------------------------------------------------------------
440
# The INPUT tag can be used to specify the files and/or directories that contain
441
# documented source files. You may enter file names like "myfile.cpp" or
442
# directories like "/usr/src/myproject". Separate the files or directories
447
# If the value of the INPUT tag contains directories, you can use the
448
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
449
# and *.h) to filter out the source-files in the directories. If left
450
# blank the following patterns are tested:
451
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
452
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
456
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
457
# should be searched for input files as well. Possible values are YES and NO.
458
# If left blank NO is used.
462
# The EXCLUDE tag can be used to specify files and/or directories that should
463
# excluded from the INPUT source files. This way you can easily exclude a
464
# subdirectory from a directory tree whose root is specified with the INPUT tag.
468
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
469
# directories that are symbolic links (a Unix filesystem feature) are excluded
472
EXCLUDE_SYMLINKS = NO
474
# If the value of the INPUT tag contains directories, you can use the
475
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
476
# certain files from those directories. Note that the wildcards are matched
477
# against the file with absolute path, so to exclude all test directories
478
# for example use the pattern */test/*
480
EXCLUDE_PATTERNS = *.templates.h
482
# The EXAMPLE_PATH tag can be used to specify one or more files or
483
# directories that contain example code fragments that are included (see
484
# the \include command).
486
EXAMPLE_PATH = @prefix@/examples/doxygen
488
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
489
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
490
# and *.h) to filter out the source-files in the directories. If left
491
# blank all files are included.
495
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
496
# searched for input files to be used with the \include or \dontinclude
497
# commands irrespective of the value of the RECURSIVE tag.
498
# Possible values are YES and NO. If left blank NO is used.
500
EXAMPLE_RECURSIVE = NO
502
# The IMAGE_PATH tag can be used to specify one or more files or
503
# directories that contain image that are included in the documentation (see
504
# the \image command). This is overwritten in deal.dox
508
# The INPUT_FILTER tag can be used to specify a program that doxygen should
509
# invoke to filter for each input file. Doxygen will invoke the filter program
510
# by executing (via popen()) the command <filter> <input-file>, where <filter>
511
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
512
# input file. Doxygen will then use the output that the filter program writes
513
# to standard output. If FILTER_PATTERNS is specified, this tag will be
516
INPUT_FILTER = ./filter
518
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
519
# basis. Doxygen will compare the file name with each pattern and apply the
520
# filter if there is a match. The filters are a list of the form:
521
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
522
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
523
# is applied to all files.
527
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
528
# INPUT_FILTER) will be used to filter the input files when producing source
529
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
531
FILTER_SOURCE_FILES = YES
533
#---------------------------------------------------------------------------
534
# configuration options related to source browsing
535
#---------------------------------------------------------------------------
537
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
538
# be generated. Documented entities will be cross-referenced with these sources.
539
# Note: To get rid of all source code in the generated output, make sure also
540
# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
541
# then you must also enable this option. If you don't then doxygen will produce
542
# a warning and turn it on anyway
546
# Setting the INLINE_SOURCES tag to YES will include the body
547
# of functions and classes directly in the documentation.
551
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
552
# doxygen to hide any special comment blocks from generated source code
553
# fragments. Normal C and C++ comments will always remain visible.
555
STRIP_CODE_COMMENTS = YES
557
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
558
# then for each documented function all documented
559
# functions referencing it will be listed.
561
REFERENCED_BY_RELATION = YES
563
# If the REFERENCES_RELATION tag is set to YES (the default)
564
# then for each documented function all documented entities
565
# called/used by that function will be listed.
567
REFERENCES_RELATION = YES
569
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
570
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
571
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
572
# link to the source code. Otherwise they will link to the documentstion.
574
REFERENCES_LINK_SOURCE = YES
576
# If the USE_HTAGS tag is set to YES then the references to source code
577
# will point to the HTML generated by the htags(1) tool instead of doxygen
578
# built-in source browser. The htags tool is part of GNU's global source
579
# tagging system (see http://www.gnu.org/software/global/global.html). You
580
# will need version 4.8.6 or higher.
584
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
585
# will generate a verbatim copy of the header file for each class for
586
# which an include is specified. Set to NO to disable this.
588
VERBATIM_HEADERS = NO
590
#---------------------------------------------------------------------------
591
# configuration options related to the alphabetical class index
592
#---------------------------------------------------------------------------
594
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
595
# of all compounds will be generated. Enable this if the project
596
# contains a lot of classes, structs, unions or interfaces.
598
ALPHABETICAL_INDEX = YES
600
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
601
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
602
# in which this list will be split (can be a number in the range [1..20])
604
COLS_IN_ALPHA_INDEX = 3
606
# In case all classes in a project start with a common prefix, all
607
# classes will be put under the same header in the alphabetical index.
608
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
609
# should be ignored while generating the index headers.
613
#---------------------------------------------------------------------------
614
# configuration options related to the HTML output
615
#---------------------------------------------------------------------------
617
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
618
# generate HTML output.
622
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
623
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
624
# put in front of it. If left blank `html' will be used as the default path.
626
HTML_OUTPUT = deal.II
628
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
629
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
630
# doxygen will generate files with .html extension.
632
HTML_FILE_EXTENSION = .html
634
# The HTML_HEADER tag can be used to specify a personal HTML header for
635
# each generated HTML page. If it is left blank doxygen will generate a
638
HTML_HEADER = header.html
640
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
641
# each generated HTML page. If it is left blank doxygen will generate a
644
HTML_FOOTER = footer.html
646
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
647
# style sheet that is used by each HTML page. It can be used to
648
# fine-tune the look of the HTML output. If the tag is left blank doxygen
649
# will generate a default style sheet. Note that doxygen will try to copy
650
# the style sheet file to the HTML output directory, so don't put your own
651
# stylesheet in the HTML output directory as well, or it will be erased!
655
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
656
# files or namespaces will be aligned in HTML using tables. If set to
657
# NO a bullet list will be used.
659
HTML_ALIGN_MEMBERS = YES
661
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
662
# will be generated that can be used as input for tools like the
663
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
664
# of the generated HTML documentation.
666
GENERATE_HTMLHELP = NO
668
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
669
# be used to specify the file name of the resulting .chm file. You
670
# can add a path in front of the file if the result should not be
671
# written to the html output directory.
675
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
676
# be used to specify the location (absolute path including file name) of
677
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
678
# the HTML help compiler on the generated index.hhp.
682
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
683
# controls if a separate .chi index file is generated (YES) or that
684
# it should be included in the master .chm file (NO).
688
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
689
# controls whether a binary table of contents is generated (YES) or a
690
# normal table of contents (NO) in the .chm file.
694
# The TOC_EXPAND flag can be set to YES to add extra items for group members
695
# to the contents of the HTML help documentation and to the tree view.
699
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
700
# top of each HTML page. The value NO (the default) enables the index and
701
# the value YES disables it.
705
# This tag can be used to set the number of enum values (range [1..20])
706
# that doxygen will group on one line in the generated HTML documentation.
708
ENUM_VALUES_PER_LINE = 4
710
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
711
# generated containing a tree-like index structure (just like the one that
712
# is generated for HTML Help). For this to work a browser that supports
713
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
714
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
715
# probably better off using the HTML help feature.
717
GENERATE_TREEVIEW = NO
719
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
720
# used to set the initial width (in pixels) of the frame in which the tree
725
#---------------------------------------------------------------------------
726
# configuration options related to the LaTeX output
727
#---------------------------------------------------------------------------
729
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
730
# generate Latex output.
734
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
735
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
736
# put in front of it. If left blank `latex' will be used as the default path.
738
LATEX_OUTPUT = LaTeX/deal.II
740
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
741
# invoked. If left blank `latex' will be used as the default command name.
743
LATEX_CMD_NAME = latex
745
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
746
# generate index for LaTeX. If left blank `makeindex' will be used as the
747
# default command name.
749
MAKEINDEX_CMD_NAME = makeindex
751
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
752
# LaTeX documents. This may be useful for small projects and may help to
753
# save some trees in general.
757
# The PAPER_TYPE tag can be used to set the paper type that is used
758
# by the printer. Possible values are: a4, a4wide, letter, legal and
759
# executive. If left blank a4wide will be used.
763
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
764
# packages that should be included in the LaTeX output.
766
EXTRA_PACKAGES = amsmath amsfonts
768
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
769
# the generated latex document. The header should contain everything until
770
# the first chapter. If it is left blank doxygen will generate a
771
# standard header. Notice: only use this tag if you know what you are doing!
775
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
776
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
777
# contain links (just like the HTML output) instead of page references
778
# This makes the output suitable for online browsing using a pdf viewer.
782
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
783
# plain latex in the generated Makefile. Set this option to YES to get a
784
# higher quality PDF documentation.
788
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
789
# command to the generated LaTeX files. This will instruct LaTeX to keep
790
# running if errors occur, instead of asking the user for help.
791
# This option is also used when generating formulas in HTML.
793
LATEX_BATCHMODE = YES
795
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
796
# include the index chapters (such as File Index, Compound Index, etc.)
799
LATEX_HIDE_INDICES = NO
801
#---------------------------------------------------------------------------
802
# configuration options related to the RTF output
803
#---------------------------------------------------------------------------
805
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
806
# The RTF output is optimized for Word 97 and may not look very pretty with
807
# other RTF readers or editors.
811
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
812
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
813
# put in front of it. If left blank `rtf' will be used as the default path.
817
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
818
# RTF documents. This may be useful for small projects and may help to
819
# save some trees in general.
823
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
824
# will contain hyperlink fields. The RTF file will
825
# contain links (just like the HTML output) instead of page references.
826
# This makes the output suitable for online browsing using WORD or other
827
# programs which support those fields.
828
# Note: wordpad (write) and others do not support links.
832
# Load stylesheet definitions from file. Syntax is similar to doxygen's
833
# config file, i.e. a series of assignments. You only have to provide
834
# replacements, missing definitions are set to their default value.
836
RTF_STYLESHEET_FILE =
838
# Set optional variables used in the generation of an rtf document.
839
# Syntax is similar to doxygen's config file.
841
RTF_EXTENSIONS_FILE =
843
#---------------------------------------------------------------------------
844
# configuration options related to the man page output
845
#---------------------------------------------------------------------------
847
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
852
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
853
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
854
# put in front of it. If left blank `man' will be used as the default path.
858
# The MAN_EXTENSION tag determines the extension that is added to
859
# the generated man pages (default is the subroutine's section .3)
863
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
864
# then it will generate one additional man file for each entity
865
# documented in the real man page(s). These additional files
866
# only source the real man page, but without them the man command
867
# would be unable to find the correct page. The default is NO.
871
#---------------------------------------------------------------------------
872
# configuration options related to the XML output
873
#---------------------------------------------------------------------------
875
# If the GENERATE_XML tag is set to YES Doxygen will
876
# generate an XML file that captures the structure of
877
# the code including all documentation.
881
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
882
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
883
# put in front of it. If left blank `xml' will be used as the default path.
887
# The XML_SCHEMA tag can be used to specify an XML schema,
888
# which can be used by a validating XML parser to check the
889
# syntax of the XML files.
893
# The XML_DTD tag can be used to specify an XML DTD,
894
# which can be used by a validating XML parser to check the
895
# syntax of the XML files.
899
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
900
# dump the program listings (including syntax highlighting
901
# and cross-referencing information) to the XML output. Note that
902
# enabling this will significantly increase the size of the XML output.
904
XML_PROGRAMLISTING = YES
906
#---------------------------------------------------------------------------
907
# configuration options for the AutoGen Definitions output
908
#---------------------------------------------------------------------------
910
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
911
# generate an AutoGen Definitions (see autogen.sf.net) file
912
# that captures the structure of the code including all
913
# documentation. Note that this feature is still experimental
914
# and incomplete at the moment.
916
GENERATE_AUTOGEN_DEF = NO
918
#---------------------------------------------------------------------------
919
# configuration options related to the Perl module output
920
#---------------------------------------------------------------------------
922
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
923
# generate a Perl module file that captures the structure of
924
# the code including all documentation. Note that this
925
# feature is still experimental and incomplete at the
928
GENERATE_PERLMOD = NO
930
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
931
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
932
# to generate PDF and DVI output from the Perl module output.
936
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
937
# nicely formatted so it can be parsed by a human reader. This is useful
938
# if you want to understand what is going on. On the other hand, if this
939
# tag is set to NO the size of the Perl module output will be much smaller
940
# and Perl will parse it just the same.
944
# The names of the make variables in the generated doxyrules.make file
945
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
946
# This is useful so different doxyrules.make files included by the same
947
# Makefile don't overwrite each other's variables.
949
PERLMOD_MAKEVAR_PREFIX =
951
#---------------------------------------------------------------------------
952
# Configuration options related to the preprocessor
953
#---------------------------------------------------------------------------
955
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
956
# evaluate all C-preprocessor directives found in the sources and include
959
ENABLE_PREPROCESSING = YES
961
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
962
# names in the source code. If set to NO (the default) only conditional
963
# compilation will be performed. Macro expansion can be done in a controlled
964
# way by setting EXPAND_ONLY_PREDEF to YES.
966
MACRO_EXPANSION = YES
968
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
969
# then the macro expansion is limited to the macros specified with the
970
# PREDEFINED and EXPAND_AS_DEFINED tags.
972
EXPAND_ONLY_PREDEF = YES
974
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
975
# in the INCLUDE_PATH (see below) will be search if a #include is found.
977
SEARCH_INCLUDES = YES
979
# The INCLUDE_PATH tag can be used to specify one or more directories that
980
# contain include files that are not input files but should be processed by
983
INCLUDE_PATH = @prefix@/base/include \
984
@prefix@/lac/include \
985
@prefix@/deal.II/include
987
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
988
# patterns (like *.h and *.hpp) to filter out the header-files in the
989
# directories. If left blank, the patterns specified with FILE_PATTERNS will
992
INCLUDE_FILE_PATTERNS =
994
# The PREDEFINED tag can be used to specify one or more macro names that
995
# are defined before the preprocessor is started (similar to the -D option of
996
# gcc). The argument of the tag is a list of macros of the form: name
997
# or name=definition (no spaces). If the definition and the = are
998
# omitted =1 is assumed. To prevent a macro definition from being
999
# undefined via #undef or recursively expanded use the := operator
1000
# instead of the = operator.
1002
# [WB] Set MT flags so that the corresponding documentation will always be visible,
1003
# [WB] irrespective of whether MT is actually switched on or not.
1004
# [GK] Define a variable doxygen in order to mask out inline functions
1006
PREDEFINED = DOXYGEN=1 \
1008
DEAL_II_USE_PETSC=1 \
1009
DEAL_II_USE_SLEPC=1 \
1010
DEAL_II_USE_TRILINOS=1 \
1012
DEAL_II_USE_MT_POSIX=1
1014
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1015
# this tag can be used to specify a list of macro names that should be expanded.
1016
# The macro definition that is found in the sources will be used.
1017
# Use the PREDEFINED tag if you want to use a different macro definition.
1019
EXPAND_AS_DEFINED = DeclException0 \
1026
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1027
# doxygen's preprocessor will remove all function-like macros that are alone
1028
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1029
# function macros are typically used for boiler-plate code, and will confuse
1030
# the parser if not removed.
1032
SKIP_FUNCTION_MACROS = YES
1034
#---------------------------------------------------------------------------
1035
# Configuration::additions related to external references
1036
#---------------------------------------------------------------------------
1038
# The TAGFILES option can be used to specify one or more tagfiles.
1039
# Optionally an initial location of the external documentation
1040
# can be added for each tagfile. The format of a tag file without
1041
# this location is as follows:
1042
# TAGFILES = file1 file2 ...
1043
# Adding location for the tag files is done as follows:
1044
# TAGFILES = file1=loc1 "file2 = loc2" ...
1045
# where "loc1" and "loc2" can be relative or absolute paths or
1046
# URLs. If a location is present for each tag, the installdox tool
1047
# does not have to be run to correct the links.
1048
# Note that each tag file must have a unique name
1049
# (where the name does NOT include the path)
1050
# If a tag file is not located in the directory in which doxygen
1051
# is run, you must also specify the path to the tagfile here.
1055
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1056
# a tag file that is based on the input files it reads.
1058
GENERATE_TAGFILE = deal.tag
1060
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1061
# in the class index. If set to NO only the inherited external classes
1066
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1067
# in the modules index. If set to NO, only the current project's groups will
1070
EXTERNAL_GROUPS = YES
1072
# The PERL_PATH should be the absolute path and name of the perl script
1073
# interpreter (i.e. the result of `which perl').
1075
PERL_PATH = /usr/bin/perl
1077
#---------------------------------------------------------------------------
1078
# Configuration options related to the dot tool
1079
#---------------------------------------------------------------------------
1081
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1082
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1083
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1084
# this option is superseded by the HAVE_DOT option below. This is only a
1085
# fallback. It is recommended to install and use dot, since it yields more
1088
CLASS_DIAGRAMS = YES
1090
# If set to YES, the inheritance and collaboration graphs will hide
1091
# inheritance and usage relations if the target is undocumented
1092
# or is not a class.
1094
HIDE_UNDOC_RELATIONS = NO
1096
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1097
# available from the path. This tool is part of Graphviz, a graph visualization
1098
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1099
# have no effect if this option is set to NO (the default)
1101
HAVE_DOT = @DEAL_II_HAVE_DOT@
1103
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1104
# will generate a graph for each documented class showing the direct and
1105
# indirect inheritance relations. Setting this tag to YES will force the
1106
# the CLASS_DIAGRAMS tag to NO.
1110
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1111
# will generate a graph for each documented class showing the direct and
1112
# indirect implementation dependencies (inheritance, containment, and
1113
# class references variables) of the class with other documented classes.
1115
COLLABORATION_GRAPH = NO
1117
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1118
# will generate a graph for groups, showing the direct groups dependencies
1122
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1123
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1128
# If set to YES, the inheritance and collaboration graphs will show the
1129
# relations between templates and their instances.
1131
TEMPLATE_RELATIONS = NO
1133
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1134
# tags are set to YES then doxygen will generate a graph for each documented
1135
# file showing the direct and indirect include dependencies of the file with
1136
# other documented files.
1140
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1141
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1142
# documented header file showing the documented files that directly or
1143
# indirectly include this file.
1145
INCLUDED_BY_GRAPH = YES
1147
# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1148
# generate a call dependency graph for every global function or class method.
1149
# Note that enabling this option will significantly increase the time of a run.
1150
# So in most cases it will be better to enable call graphs for selected
1151
# functions only using the \callgraph command.
1155
# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1156
# generate a caller dependency graph for every global function or class method.
1157
# Note that enabling this option will significantly increase the time of a run.
1158
# So in most cases it will be better to enable caller graphs for selected
1159
# functions only using the \callergraph command.
1163
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1164
# will graphical hierarchy of all classes instead of a textual one.
1166
GRAPHICAL_HIERARCHY = NO
1168
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1169
# then doxygen will show the dependencies a directory has on other directories
1170
# in a graphical way. The dependency relations are determined by the #include
1171
# relations between the files in the directories.
1173
DIRECTORY_GRAPH = YES
1175
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1176
# generated by dot. Possible values are png, jpg, or gif
1177
# If left blank png will be used.
1179
DOT_IMAGE_FORMAT = png
1181
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1182
# found. If left blank, it is assumed the dot tool can be found in the path.
1186
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1187
# contain dot files that are included in the documentation (see the
1188
# \dotfile command).
1192
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1193
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1194
# from the root by following a path via at most 3 edges will be shown. Nodes
1195
# that lay further from the root node will be omitted. Note that setting this
1196
# option to 1 or 2 may greatly reduce the computation time needed for large
1197
# code bases. Also note that the size of a graph can be further restricted by
1198
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1200
MAX_DOT_GRAPH_DEPTH = 2
1202
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1203
# background. This is disabled by default, which results in a white background.
1204
# Warning: Depending on the platform used, enabling this option may lead to
1205
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1208
DOT_TRANSPARENT = NO
1210
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1211
# files in one run (i.e. multiple -o and -T options on the command line). This
1212
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1213
# support this, this feature is disabled by default.
1215
DOT_MULTI_TARGETS = NO
1217
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1218
# generate a legend page explaining the meaning of the various boxes and
1219
# arrows in the dot generated graphs.
1221
GENERATE_LEGEND = YES
1223
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1224
# remove the intermediate dot files that are used to generate
1225
# the various graphs.
1229
#---------------------------------------------------------------------------
1230
# Configuration::additions related to the search engine
1231
#---------------------------------------------------------------------------
1233
# The SEARCHENGINE tag specifies whether or not a search engine should be
1234
# used. If set to NO the values of all tags below this one will be ignored.
added
removed
.pc/srcdir.patch/doc/doxygen/options.dox.in
