tdoxyfile - pism - [fork] customized build of PISM, the parallel ice sheet model (tillflux branch)
(HTM) git clone git://src.adamsgaard.dk/pism
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) LICENSE
---
tdoxyfile (56529B)
---
1 # Doxyfile 1.6.1
2
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
5 #
6 # All text after a hash (#) is considered a comment and will be ignored
7 # The format is:
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 (" ")
12
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
16
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23 DOXYFILE_ENCODING = UTF-8
24
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
27
28 PROJECT_NAME = "PISM, A Parallel Ice Sheet Model"
29
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
32 # if some version control system is used.
33
34 PROJECT_NUMBER = "${Pism_REVISION_TAG}"
35
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
40
41 OUTPUT_DIRECTORY = .
42
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
49
50 CREATE_SUBDIRS = NO
51
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 # documentation generated by doxygen is written. Doxygen will use this
54 # information to generate all constant output in the proper language.
55 # The default language is English, other supported languages are:
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
62
63 OUTPUT_LANGUAGE = English
64
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66 # include brief member descriptions after the members that are listed in
67 # the file and class documentation (similar to JavaDoc).
68 # Set to NO to disable this.
69
70 BRIEF_MEMBER_DESC = YES
71
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73 # the brief description of a member or function before the detailed description.
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75 # brief descriptions will be completely suppressed.
76
77 REPEAT_BRIEF = YES
78
79 # This tag implements a quasi-intelligent brief description abbreviator
80 # that is used to form the text in various listings. Each string
81 # in this list, if found as the leading text of the brief description, will be
82 # stripped from the text and the result after processing the whole list, is
83 # used as the annotated text. Otherwise, the brief description is used as-is.
84 # If left blank, the following values are used ("$name" is automatically
85 # replaced with the name of the entity): "The $name class" "The $name widget"
86 # "The $name file" "is" "provides" "specifies" "contains"
87 # "represents" "a" "an" "the"
88
89 ABBREVIATE_BRIEF = "The $name class " \
90 "The $name widget " \
91 "The $name file " \
92 is \
93 provides \
94 specifies \
95 contains \
96 represents \
97 a \
98 an \
99 the
100
101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102 # Doxygen will generate a detailed section even if there is only a brief
103 # description.
104
105 ALWAYS_DETAILED_SEC = NO
106
107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108 # inherited members of a class in the documentation of that class as if those
109 # members were ordinary class members. Constructors, destructors and assignment
110 # operators of the base classes will not be shown.
111
112 INLINE_INHERITED_MEMB = NO
113
114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115 # path before files name in the file list and in the header files. If set
116 # to NO the shortest path that makes the file name unique will be used.
117
118 FULL_PATH_NAMES = YES
119
120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121 # can be used to strip a user-defined part of the path. Stripping is
122 # only done if one of the specified strings matches the left-hand part of
123 # the path. The tag can be used to show relative paths in the file list.
124 # If left blank the directory from which doxygen is run is used as the
125 # path to strip.
126
127 STRIP_FROM_PATH = ${Pism_SOURCE_DIR}/
128
129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130 # the path mentioned in the documentation of a class, which tells
131 # the reader which header file to include in order to use a class.
132 # If left blank only the name of the header file containing the class
133 # definition is used. Otherwise one should specify the include paths that
134 # are normally passed to the compiler using the -I flag.
135
136 STRIP_FROM_INC_PATH =
137
138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139 # (but less readable) file names. This can be useful is your file systems
140 # doesn't support long names like on DOS, Mac, or CD-ROM.
141
142 SHORT_NAMES = NO
143
144 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
145 # will interpret the first line (until the first dot) of a JavaDoc-style
146 # comment as the brief description. If set to NO, the JavaDoc
147 # comments will behave just like regular Qt-style comments
148 # (thus requiring an explicit @brief command for a brief description.)
149
150 JAVADOC_AUTOBRIEF = NO
151
152 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
153 # interpret the first line (until the first dot) of a Qt-style
154 # comment as the brief description. If set to NO, the comments
155 # will behave just like regular Qt-style comments (thus requiring
156 # an explicit \brief command for a brief description.)
157
158 QT_AUTOBRIEF = NO
159
160 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
161 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
162 # comments) as a brief description. This used to be the default behaviour.
163 # The new default is to treat a multi-line C++ comment block as a detailed
164 # description. Set this tag to YES if you prefer the old behaviour instead.
165
166 MULTILINE_CPP_IS_BRIEF = NO
167
168 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
169 # member inherits the documentation from any documented member that it
170 # re-implements.
171
172 INHERIT_DOCS = YES
173
174 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175 # a new page for each member. If set to NO, the documentation of a member will
176 # be part of the file/class/namespace that contains it.
177
178 SEPARATE_MEMBER_PAGES = YES
179
180 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
181 # Doxygen uses this value to replace tabs by spaces in code fragments.
182
183 TAB_SIZE = 8
184
185 # This tag can be used to specify a number of aliases that acts
186 # as commands in the documentation. An alias has the form "name=value".
187 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
188 # put the command \sideeffect (or @sideeffect) in the documentation, which
189 # will result in a user-defined paragraph with heading "Side Effects:".
190 # You can put \n's in the value part of an alias to insert newlines.
191
192 ALIASES = delta=δ
193
194 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
195 # sources only. Doxygen will then generate output that is more tailored for C.
196 # For instance, some of the names that are used will be different. The list
197 # of all members will be omitted, etc.
198
199 OPTIMIZE_OUTPUT_FOR_C = NO
200
201 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
202 # sources only. Doxygen will then generate output that is more tailored for
203 # Java. For instance, namespaces will be presented as packages, qualified
204 # scopes will look different, etc.
205
206 OPTIMIZE_OUTPUT_JAVA = NO
207
208 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
209 # sources only. Doxygen will then generate output that is more tailored for
210 # Fortran.
211
212 OPTIMIZE_FOR_FORTRAN = NO
213
214 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
215 # sources. Doxygen will then generate output that is tailored for
216 # VHDL.
217
218 OPTIMIZE_OUTPUT_VHDL = NO
219
220 # Doxygen selects the parser to use depending on the extension of the files it parses.
221 # With this tag you can assign which parser to use for a given extension.
222 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
223 # The format is ext=language, where ext is a file extension, and language is one of
224 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
225 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
226 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
227 # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
228
229 EXTENSION_MAPPING =
230
231 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
232 # to include (a tag file for) the STL sources as input, then you should
233 # set this tag to YES in order to let doxygen match functions declarations and
234 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
235 # func(std::string) {}). This also make the inheritance and collaboration
236 # diagrams that involve STL classes more complete and accurate.
237
238 BUILTIN_STL_SUPPORT = YES
239
240 # If you use Microsoft's C++/CLI language, you should set this option to YES to
241 # enable parsing support.
242
243 CPP_CLI_SUPPORT = NO
244
245 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
246 # Doxygen will parse them like normal C++ but will assume all classes use public
247 # instead of private inheritance when no explicit protection keyword is present.
248
249 SIP_SUPPORT = NO
250
251 # For Microsoft's IDL there are propget and propput attributes to indicate getter
252 # and setter methods for a property. Setting this option to YES (the default)
253 # will make doxygen to replace the get and set methods by a property in the
254 # documentation. This will only work if the methods are indeed getting or
255 # setting a simple type. If this is not the case, or you want to show the
256 # methods anyway, you should set this option to NO.
257
258 IDL_PROPERTY_SUPPORT = YES
259
260 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
261 # tag is set to YES, then doxygen will reuse the documentation of the first
262 # member in the group (if any) for the other members of the group. By default
263 # all members of a group must be documented explicitly.
264
265 DISTRIBUTE_GROUP_DOC = NO
266
267 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
268 # the same type (for instance a group of public functions) to be put as a
269 # subgroup of that type (e.g. under the Public Functions section). Set it to
270 # NO to prevent subgrouping. Alternatively, this can be done per class using
271 # the \nosubgrouping command.
272
273 SUBGROUPING = YES
274
275 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
276 # is documented as struct, union, or enum with the name of the typedef. So
277 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
278 # with name TypeT. When disabled the typedef will appear as a member of a file,
279 # namespace, or class. And the struct will be named TypeS. This can typically
280 # be useful for C code in case the coding convention dictates that all compound
281 # types are typedef'ed and only the typedef is referenced, never the tag name.
282
283 TYPEDEF_HIDES_STRUCT = NO
284
285 #---------------------------------------------------------------------------
286 # Build related configuration options
287 #---------------------------------------------------------------------------
288
289 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
290 # documentation are documented, even if no documentation was available.
291 # Private class members and static file members will be hidden unless
292 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
293
294 EXTRACT_ALL = ${Pism_DOXYGEN_EXTRACT_ALL}
295
296 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
297 # will be included in the documentation.
298
299 EXTRACT_PRIVATE = YES
300
301 # If the EXTRACT_STATIC tag is set to YES all static members of a file
302 # will be included in the documentation.
303
304 EXTRACT_STATIC = YES
305
306 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
307 # defined locally in source files will be included in the documentation.
308 # If set to NO only classes defined in header files are included.
309
310 EXTRACT_LOCAL_CLASSES = YES
311
312 # This flag is only useful for Objective-C code. When set to YES local
313 # methods, which are defined in the implementation section but not in
314 # the interface are included in the documentation.
315 # If set to NO (the default) only methods in the interface are included.
316
317 EXTRACT_LOCAL_METHODS = NO
318
319 # If this flag is set to YES, the members of anonymous namespaces will be
320 # extracted and appear in the documentation as a namespace called
321 # 'anonymous_namespace{file}', where file will be replaced with the base
322 # name of the file that contains the anonymous namespace. By default
323 # anonymous namespace are hidden.
324
325 EXTRACT_ANON_NSPACES = NO
326
327 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
328 # undocumented members of documented classes, files or namespaces.
329 # If set to NO (the default) these members will be included in the
330 # various overviews, but no documentation section is generated.
331 # This option has no effect if EXTRACT_ALL is enabled.
332
333 HIDE_UNDOC_MEMBERS = NO
334
335 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
336 # undocumented classes that are normally visible in the class hierarchy.
337 # If set to NO (the default) these classes will be included in the various
338 # overviews. This option has no effect if EXTRACT_ALL is enabled.
339
340 HIDE_UNDOC_CLASSES = NO
341
342 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
343 # friend (class|struct|union) declarations.
344 # If set to NO (the default) these declarations will be included in the
345 # documentation.
346
347 HIDE_FRIEND_COMPOUNDS = NO
348
349 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
350 # documentation blocks found inside the body of a function.
351 # If set to NO (the default) these blocks will be appended to the
352 # function's detailed documentation block.
353
354 HIDE_IN_BODY_DOCS = NO
355
356 # The INTERNAL_DOCS tag determines if documentation
357 # that is typed after a \internal command is included. If the tag is set
358 # to NO (the default) then the documentation will be excluded.
359 # Set it to YES to include the internal documentation.
360
361 INTERNAL_DOCS = NO
362
363 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
364 # file names in lower-case letters. If set to YES upper-case letters are also
365 # allowed. This is useful if you have classes or files whose names only differ
366 # in case and if your file system supports case sensitive file names. Windows
367 # and Mac users are advised to set this option to NO.
368
369 CASE_SENSE_NAMES = YES
370
371 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
372 # will show members with their full class and namespace scopes in the
373 # documentation. If set to YES the scope will be hidden.
374
375 HIDE_SCOPE_NAMES = NO
376
377 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
378 # will put a list of the files that are included by a file in the documentation
379 # of that file.
380
381 SHOW_INCLUDE_FILES = YES
382
383 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
384 # is inserted in the documentation for inline members.
385
386 INLINE_INFO = YES
387
388 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
389 # will sort the (detailed) documentation of file and class members
390 # alphabetically by member name. If set to NO the members will appear in
391 # declaration order.
392
393 SORT_MEMBER_DOCS = YES
394
395 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
396 # brief documentation of file, namespace and class members alphabetically
397 # by member name. If set to NO (the default) the members will appear in
398 # declaration order.
399
400 SORT_BRIEF_DOCS = NO
401
402 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
403
404 SORT_MEMBERS_CTORS_1ST = NO
405
406 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
407 # hierarchy of group names into alphabetical order. If set to NO (the default)
408 # the group names will appear in their defined order.
409
410 SORT_GROUP_NAMES = NO
411
412 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
413 # sorted by fully-qualified names, including namespaces. If set to
414 # NO (the default), the class list will be sorted only by class name,
415 # not including the namespace part.
416 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
417 # Note: This option applies only to the class list, not to the
418 # alphabetical list.
419
420 SORT_BY_SCOPE_NAME = NO
421
422 # The GENERATE_TODOLIST tag can be used to enable (YES) or
423 # disable (NO) the todo list. This list is created by putting \todo
424 # commands in the documentation.
425
426 GENERATE_TODOLIST = YES
427
428 # The GENERATE_TESTLIST tag can be used to enable (YES) or
429 # disable (NO) the test list. This list is created by putting \test
430 # commands in the documentation.
431
432 GENERATE_TESTLIST = YES
433
434 # The GENERATE_BUGLIST tag can be used to enable (YES) or
435 # disable (NO) the bug list. This list is created by putting \bug
436 # commands in the documentation.
437
438 GENERATE_BUGLIST = YES
439
440 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
441 # disable (NO) the deprecated list. This list is created by putting
442 # \deprecated commands in the documentation.
443
444 GENERATE_DEPRECATEDLIST= YES
445
446 # The ENABLED_SECTIONS tag can be used to enable conditional
447 # documentation sections, marked by \if sectionname ... \endif.
448
449 ENABLED_SECTIONS = BROWSER
450
451 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
452 # the initial value of a variable or define consists of for it to appear in
453 # the documentation. If the initializer consists of more lines than specified
454 # here it will be hidden. Use a value of 0 to hide initializers completely.
455 # The appearance of the initializer of individual variables and defines in the
456 # documentation can be controlled using \showinitializer or \hideinitializer
457 # command in the documentation regardless of this setting.
458
459 MAX_INITIALIZER_LINES = 30
460
461 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
462 # at the bottom of the documentation of classes and structs. If set to YES the
463 # list will mention the files that were used to generate the documentation.
464
465 SHOW_USED_FILES = YES
466
467 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
468 # This will remove the Files entry from the Quick Index and from the
469 # Folder Tree View (if specified). The default is YES.
470
471 SHOW_FILES = YES
472
473 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
474 # Namespaces page.
475 # This will remove the Namespaces entry from the Quick Index
476 # and from the Folder Tree View (if specified). The default is YES.
477
478 SHOW_NAMESPACES = YES
479
480 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
481 # doxygen should invoke to get the current version for each file (typically from
482 # the version control system). Doxygen will invoke the program by executing (via
483 # popen()) the command <command> <input-file>, where <command> is the value of
484 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
485 # provided by doxygen. Whatever the program writes to standard output
486 # is used as the file version. See the manual for examples.
487
488 FILE_VERSION_FILTER =
489
490 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
491 # doxygen. The layout file controls the global structure of the generated output files
492 # in an output format independent way. The create the layout file that represents
493 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
494 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
495 # of the layout file.
496
497 LAYOUT_FILE =
498
499 #---------------------------------------------------------------------------
500 # configuration options related to warning and progress messages
501 #---------------------------------------------------------------------------
502
503 # The QUIET tag can be used to turn on/off the messages that are generated
504 # by doxygen. Possible values are YES and NO. If left blank NO is used.
505
506 QUIET = NO
507
508 # The WARNINGS tag can be used to turn on/off the warning messages that are
509 # generated by doxygen. Possible values are YES and NO. If left blank
510 # NO is used.
511
512 WARNINGS = YES
513
514 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
515 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
516 # automatically be disabled.
517
518 WARN_IF_UNDOCUMENTED = YES
519
520 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
521 # potential errors in the documentation, such as not documenting some
522 # parameters in a documented function, or documenting parameters that
523 # don't exist or using markup commands wrongly.
524
525 WARN_IF_DOC_ERROR = YES
526
527 # This WARN_NO_PARAMDOC option can be abled to get warnings for
528 # functions that are documented, but have no documentation for their parameters
529 # or return value. If set to NO (the default) doxygen will only warn about
530 # wrong or incomplete parameter documentation, but not about the absence of
531 # documentation.
532
533 WARN_NO_PARAMDOC = YES
534
535 # The WARN_FORMAT tag determines the format of the warning messages that
536 # doxygen can produce. The string should contain the $file, $line, and $text
537 # tags, which will be replaced by the file and line number from which the
538 # warning originated and the warning text. Optionally the format may contain
539 # $version, which will be replaced by the version of the file (if it could
540 # be obtained via FILE_VERSION_FILTER)
541
542 WARN_FORMAT = "$file:$line: $text "
543
544 # The WARN_LOGFILE tag can be used to specify a file to which warning
545 # and error messages should be written. If left blank the output is written
546 # to stderr.
547
548 WARN_LOGFILE =
549
550 #---------------------------------------------------------------------------
551 # configuration options related to the input files
552 #---------------------------------------------------------------------------
553
554 # The INPUT tag can be used to specify the files and/or directories that contain
555 # documented source files. You may enter file names like "myfile.cpp" or
556 # directories like "/usr/src/myproject". Separate the files or directories
557 # with spaces.
558
559 INPUT = mainpage.md references.md howto.md petsc.md \
560 ${Pism_SOURCE_DIR}/src/
561
562 USE_MDFILE_AS_MAINPAGE = mainpage.md
563
564 # This tag can be used to specify the character encoding of the source files
565 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
566 # also the default input encoding. Doxygen uses libiconv (or the iconv built
567 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
568 # the list of possible encodings.
569
570 INPUT_ENCODING = UTF-8
571
572 # If the value of the INPUT tag contains directories, you can use the
573 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
574 # and *.h) to filter out the source-files in the directories. If left
575 # blank the following patterns are tested:
576 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
577 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
578
579 FILE_PATTERNS = *.c \
580 *.cc \
581 *.h \
582 *.hh
583
584 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
585 # should be searched for input files as well. Possible values are YES and NO.
586 # If left blank NO is used.
587
588 RECURSIVE = YES
589
590 # The EXCLUDE tag can be used to specify files and/or directories that should
591 # excluded from the INPUT source files. This way you can easily exclude a
592 # subdirectory from a directory tree whose root is specified with the INPUT tag.
593
594 EXCLUDE = ${Pism_SOURCE_DIR}/src/earth/cubature.h \
595 ${Pism_SOURCE_DIR}/src/earth/cubature.c \
596 ${Pism_SOURCE_DIR}/src/calcalcs
597
598 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
599 # directories that are symbolic links (a Unix filesystem feature) are excluded
600 # from the input.
601
602 EXCLUDE_SYMLINKS = NO
603
604 # If the value of the INPUT tag contains directories, you can use the
605 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
606 # certain files from those directories. Note that the wildcards are matched
607 # against the file with absolute path, so to exclude all test directories
608 # for example use the pattern */test/*
609
610 EXCLUDE_PATTERNS =
611
612 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
613 # (namespaces, classes, functions, etc.) that should be excluded from the
614 # output. The symbol name can be a fully qualified name, a word, or if the
615 # wildcard * is used, a substring. Examples: ANamespace, AClass,
616 # AClass::ANamespace, ANamespace::*Test
617
618 EXCLUDE_SYMBOLS =
619
620 # The EXAMPLE_PATH tag can be used to specify one or more files or
621 # directories that contain example code fragments that are included (see
622 # the \include command).
623
624 EXAMPLE_PATH = .
625
626 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
627 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
628 # and *.h) to filter out the source-files in the directories. If left
629 # blank all files are included.
630
631 EXAMPLE_PATTERNS = *
632
633 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
634 # searched for input files to be used with the \include or \dontinclude
635 # commands irrespective of the value of the RECURSIVE tag.
636 # Possible values are YES and NO. If left blank NO is used.
637
638 EXAMPLE_RECURSIVE = NO
639
640 # The IMAGE_PATH tag can be used to specify one or more files or
641 # directories that contain image that are included in the documentation (see
642 # the \image command).
643
644 IMAGE_PATH =
645
646 # The INPUT_FILTER tag can be used to specify a program that doxygen should
647 # invoke to filter for each input file. Doxygen will invoke the filter program
648 # by executing (via popen()) the command <filter> <input-file>, where <filter>
649 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
650 # input file. Doxygen will then use the output that the filter program writes
651 # to standard output.
652 # If FILTER_PATTERNS is specified, this tag will be
653 # ignored.
654
655 INPUT_FILTER =
656
657 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
658 # basis.
659 # Doxygen will compare the file name with each pattern and apply the
660 # filter if there is a match.
661 # The filters are a list of the form:
662 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
663 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
664 # is applied to all files.
665
666 FILTER_PATTERNS =
667
668 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
669 # INPUT_FILTER) will be used to filter the input files when producing source
670 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
671
672 FILTER_SOURCE_FILES = NO
673
674 #---------------------------------------------------------------------------
675 # configuration options related to source browsing
676 #---------------------------------------------------------------------------
677
678 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
679 # be generated. Documented entities will be cross-referenced with these sources.
680 # Note: To get rid of all source code in the generated output, make sure also
681 # VERBATIM_HEADERS is set to NO.
682
683 SOURCE_BROWSER = YES
684
685 # Setting the INLINE_SOURCES tag to YES will include the body
686 # of functions and classes directly in the documentation.
687
688 INLINE_SOURCES = NO
689
690 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
691 # doxygen to hide any special comment blocks from generated source code
692 # fragments. Normal C and C++ comments will always remain visible.
693
694 STRIP_CODE_COMMENTS = NO
695
696 # If the REFERENCED_BY_RELATION tag is set to YES
697 # then for each documented function all documented
698 # functions referencing it will be listed.
699
700 REFERENCED_BY_RELATION = YES
701
702 # If the REFERENCES_RELATION tag is set to YES
703 # then for each documented function all documented entities
704 # called/used by that function will be listed.
705
706 REFERENCES_RELATION = YES
707
708 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
709 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
710 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
711 # link to the source code.
712 # Otherwise they will link to the documentation.
713
714 REFERENCES_LINK_SOURCE = YES
715
716 # If the USE_HTAGS tag is set to YES then the references to source code
717 # will point to the HTML generated by the htags(1) tool instead of doxygen
718 # built-in source browser. The htags tool is part of GNU's global source
719 # tagging system (see http://www.gnu.org/software/global/global.html). You
720 # will need version 4.8.6 or higher.
721
722 USE_HTAGS = NO
723
724 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
725 # will generate a verbatim copy of the header file for each class for
726 # which an include is specified. Set to NO to disable this.
727
728 VERBATIM_HEADERS = YES
729
730 #---------------------------------------------------------------------------
731 # configuration options related to the alphabetical class index
732 #---------------------------------------------------------------------------
733
734 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
735 # of all compounds will be generated. Enable this if the project
736 # contains a lot of classes, structs, unions or interfaces.
737
738 ALPHABETICAL_INDEX = YES
739
740 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
741 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
742 # in which this list will be split (can be a number in the range [1..20])
743
744 COLS_IN_ALPHA_INDEX = 5
745
746 # In case all classes in a project start with a common prefix, all
747 # classes will be put under the same header in the alphabetical index.
748 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
749 # should be ignored while generating the index headers.
750
751 IGNORE_PREFIX = PISM
752
753 #---------------------------------------------------------------------------
754 # configuration options related to the HTML output
755 #---------------------------------------------------------------------------
756
757 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
758 # generate HTML output.
759
760 GENERATE_HTML = YES
761
762 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
763 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
764 # put in front of it. If left blank `html' will be used as the default path.
765
766 HTML_OUTPUT = html/
767
768 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
769 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
770 # doxygen will generate files with .html extension.
771
772 HTML_FILE_EXTENSION = .html
773
774 # The HTML_HEADER tag can be used to specify a personal HTML header for
775 # each generated HTML page. If it is left blank doxygen will generate a
776 # standard header.
777
778 HTML_HEADER =
779
780 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
781 # each generated HTML page. If it is left blank doxygen will generate a
782 # standard footer.
783
784 HTML_FOOTER =
785
786 HTML_EXTRA_STYLESHEET = ${CMAKE_CURRENT_SOURCE_DIR}/browser.css
787
788 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
789 # documentation will contain sections that can be hidden and shown after the
790 # page has loaded. For this to work a browser that supports
791 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
792 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
793
794 HTML_DYNAMIC_SECTIONS = YES
795
796 # If the GENERATE_DOCSET tag is set to YES, additional index files
797 # will be generated that can be used as input for Apple's Xcode 3
798 # integrated development environment, introduced with OSX 10.5 (Leopard).
799 # To create a documentation set, doxygen will generate a Makefile in the
800 # HTML output directory. Running make will produce the docset in that
801 # directory and running "make install" will install the docset in
802 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
803 # it at startup.
804 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
805
806 GENERATE_DOCSET = NO
807
808 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
809 # feed. A documentation feed provides an umbrella under which multiple
810 # documentation sets from a single provider (such as a company or product suite)
811 # can be grouped.
812
813 DOCSET_FEEDNAME = "Doxygen generated docs"
814
815 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
816 # should uniquely identify the documentation set bundle. This should be a
817 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
818 # will append .docset to the name.
819
820 DOCSET_BUNDLE_ID = org.doxygen.Project
821
822 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
823 # will be generated that can be used as input for tools like the
824 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
825 # of the generated HTML documentation.
826
827 GENERATE_HTMLHELP = NO
828
829 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
830 # be used to specify the file name of the resulting .chm file. You
831 # can add a path in front of the file if the result should not be
832 # written to the html output directory.
833
834 CHM_FILE =
835
836 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
837 # be used to specify the location (absolute path including file name) of
838 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
839 # the HTML help compiler on the generated index.hhp.
840
841 HHC_LOCATION =
842
843 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
844 # controls if a separate .chi index file is generated (YES) or that
845 # it should be included in the master .chm file (NO).
846
847 GENERATE_CHI = NO
848
849 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
850 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
851 # content.
852
853 CHM_INDEX_ENCODING =
854
855 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
856 # controls whether a binary table of contents is generated (YES) or a
857 # normal table of contents (NO) in the .chm file.
858
859 BINARY_TOC = NO
860
861 # The TOC_EXPAND flag can be set to YES to add extra items for group members
862 # to the contents of the HTML help documentation and to the tree view.
863
864 TOC_EXPAND = NO
865
866 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
867 # are set, an additional index file will be generated that can be used as input for
868 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
869 # HTML documentation.
870
871 GENERATE_QHP = NO
872
873 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
874 # be used to specify the file name of the resulting .qch file.
875 # The path specified is relative to the HTML output folder.
876
877 QCH_FILE =
878
879 # The QHP_NAMESPACE tag specifies the namespace to use when generating
880 # Qt Help Project output. For more information please see
881 # http://doc.trolltech.com/qthelpproject.html#namespace
882
883 QHP_NAMESPACE =
884
885 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
886 # Qt Help Project output. For more information please see
887 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
888
889 QHP_VIRTUAL_FOLDER = doc
890
891 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
892 # For more information please see
893 # http://doc.trolltech.com/qthelpproject.html#custom-filters
894
895 QHP_CUST_FILTER_NAME =
896
897 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
898 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
899
900 QHP_CUST_FILTER_ATTRS =
901
902 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
903 # filter section matches.
904 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
905
906 QHP_SECT_FILTER_ATTRS =
907
908 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
909 # be used to specify the location of Qt's qhelpgenerator.
910 # If non-empty doxygen will try to run qhelpgenerator on the generated
911 # .qhp file.
912
913 QHG_LOCATION =
914
915 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
916 # top of each HTML page. The value NO (the default) enables the index and
917 # the value YES disables it.
918
919 DISABLE_INDEX = NO
920
921 # This tag can be used to set the number of enum values (range [1..20])
922 # that doxygen will group on one line in the generated HTML documentation.
923
924 ENUM_VALUES_PER_LINE = 4
925
926 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
927 # structure should be generated to display hierarchical information.
928 # If the tag value is set to YES, a side panel will be generated
929 # containing a tree-like index structure (just like the one that
930 # is generated for HTML Help). For this to work a browser that supports
931 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
932 # Windows users are probably better off using the HTML help feature.
933
934 GENERATE_TREEVIEW = NO
935
936 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
937 # used to set the initial width (in pixels) of the frame in which the tree
938 # is shown.
939
940 TREEVIEW_WIDTH = 250
941
942 # Use this tag to change the font size of Latex formulas included
943 # as images in the HTML documentation. The default is 10. Note that
944 # when you change the font size after a successful doxygen run you need
945 # to manually remove any form_*.png images from the HTML output directory
946 # to force them to be regenerated.
947
948 FORMULA_FONTSIZE = 14
949
950 # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
951 # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
952 # there is already a search function so this one should typically
953 # be disabled.
954
955 SEARCHENGINE = YES
956
957 #---------------------------------------------------------------------------
958 # configuration options related to the LaTeX output
959 #---------------------------------------------------------------------------
960
961 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
962 # generate Latex output.
963
964 GENERATE_LATEX = NO
965
966 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
967 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
968 # put in front of it. If left blank `latex' will be used as the default path.
969
970 LATEX_OUTPUT = latex
971
972 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
973 # invoked. If left blank `latex' will be used as the default command name.
974
975 LATEX_CMD_NAME = latex
976
977 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
978 # generate index for LaTeX. If left blank `makeindex' will be used as the
979 # default command name.
980
981 MAKEINDEX_CMD_NAME = makeindex
982
983 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
984 # LaTeX documents. This may be useful for small projects and may help to
985 # save some trees in general.
986
987 COMPACT_LATEX = NO
988
989 # The PAPER_TYPE tag can be used to set the paper type that is used
990 # by the printer. Possible values are: a4, a4wide, letter, legal and
991 # executive. If left blank a4wide will be used.
992
993 PAPER_TYPE = letter
994
995 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
996 # packages that should be included in the LaTeX output.
997
998 EXTRA_PACKAGES = amsmath \
999 txfonts \
1000 ${CMAKE_CURRENT_SOURCE_DIR}/pism
1001
1002 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1003 # the generated latex document. The header should contain everything until
1004 # the first chapter. If it is left blank doxygen will generate a
1005 # standard header. Notice: only use this tag if you know what you are doing!
1006
1007 LATEX_HEADER =
1008
1009 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1010 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1011 # contain links (just like the HTML output) instead of page references
1012 # This makes the output suitable for online browsing using a pdf viewer.
1013
1014 PDF_HYPERLINKS = YES
1015
1016 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1017 # plain latex in the generated Makefile. Set this option to YES to get a
1018 # higher quality PDF documentation.
1019
1020 USE_PDFLATEX = YES
1021
1022 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1023 # command to the generated LaTeX files. This will instruct LaTeX to keep
1024 # running if errors occur, instead of asking the user for help.
1025 # This option is also used when generating formulas in HTML.
1026
1027 LATEX_BATCHMODE = NO
1028
1029 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1030 # include the index chapters (such as File Index, Compound Index, etc.)
1031 # in the output.
1032
1033 LATEX_HIDE_INDICES = NO
1034
1035 # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
1036
1037 LATEX_SOURCE_CODE = NO
1038
1039 #---------------------------------------------------------------------------
1040 # Configuration options related to the preprocessor
1041 #---------------------------------------------------------------------------
1042
1043 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1044 # evaluate all C-preprocessor directives found in the sources and include
1045 # files.
1046
1047 ENABLE_PREPROCESSING = YES
1048
1049 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1050 # names in the source code. If set to NO (the default) only conditional
1051 # compilation will be performed. Macro expansion can be done in a controlled
1052 # way by setting EXPAND_ONLY_PREDEF to YES.
1053
1054 MACRO_EXPANSION = NO
1055
1056 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1057 # then the macro expansion is limited to the macros specified with the
1058 # PREDEFINED and EXPAND_AS_DEFINED tags.
1059
1060 EXPAND_ONLY_PREDEF = NO
1061
1062 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1063 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1064
1065 SEARCH_INCLUDES = YES
1066
1067 # The INCLUDE_PATH tag can be used to specify one or more directories that
1068 # contain include files that are not input files but should be processed by
1069 # the preprocessor.
1070
1071 INCLUDE_PATH =
1072
1073 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1074 # patterns (like *.h and *.hpp) to filter out the header-files in the
1075 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1076 # be used.
1077
1078 INCLUDE_FILE_PATTERNS =
1079
1080 # The PREDEFINED tag can be used to specify one or more macro names that
1081 # are defined before the preprocessor is started (similar to the -D option of
1082 # gcc). The argument of the tag is a list of macros of the form: name
1083 # or name=definition (no spaces). If the definition and the = are
1084 # omitted =1 is assumed. To prevent a macro definition from being
1085 # undefined via #undef or recursively expanded use the := operator
1086 # instead of the = operator.
1087
1088 PREDEFINED = Pism_DEBUG,Pism_USE_PROJ,Pism_USE_PARALLEL_NETCDF4,Pism_USE_PNETCDF
1089
1090 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1091 # this tag can be used to specify a list of macro names that should be expanded.
1092 # The macro definition that is found in the sources will be used.
1093 # Use the PREDEFINED tag if you want to use a different macro definition.
1094
1095 EXPAND_AS_DEFINED =
1096
1097 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1098 # doxygen's preprocessor will remove all function-like macros that are alone
1099 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1100 # function macros are typically used for boiler-plate code, and will confuse
1101 # the parser if not removed.
1102
1103 SKIP_FUNCTION_MACROS = YES
1104
1105 #---------------------------------------------------------------------------
1106 # Configuration::additions related to external references
1107 #---------------------------------------------------------------------------
1108
1109 # The TAGFILES option can be used to specify one or more tagfiles.
1110 # Optionally an initial location of the external documentation
1111 # can be added for each tagfile. The format of a tag file without
1112 # this location is as follows:
1113 #
1114 # TAGFILES = file1 file2 ...
1115 # Adding location for the tag files is done as follows:
1116 #
1117 # TAGFILES = file1=loc1 "file2 = loc2" ...
1118 # where "loc1" and "loc2" can be relative or absolute paths or
1119 # URLs. If a location is present for each tag, the installdox tool
1120 # does not have to be run to correct the links.
1121 # Note that each tag file must have a unique name
1122 # (where the name does NOT include the path)
1123 # If a tag file is not located in the directory in which doxygen
1124 # is run, you must also specify the path to the tagfile here.
1125
1126 TAGFILES =
1127
1128 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1129 # a tag file that is based on the input files it reads.
1130
1131 GENERATE_TAGFILE =
1132
1133 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1134 # in the class index. If set to NO only the inherited external classes
1135 # will be listed.
1136
1137 ALLEXTERNALS = NO
1138
1139 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1140 # in the modules index. If set to NO, only the current project's groups will
1141 # be listed.
1142
1143 EXTERNAL_GROUPS = YES
1144
1145 # The PERL_PATH should be the absolute path and name of the perl script
1146 # interpreter (i.e. the result of `which perl').
1147
1148 PERL_PATH = /usr/bin/perl
1149
1150 #---------------------------------------------------------------------------
1151 # Configuration options related to the dot tool
1152 #---------------------------------------------------------------------------
1153
1154 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1155 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1156 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1157 # this option is superseded by the HAVE_DOT option below. This is only a
1158 # fallback. It is recommended to install and use dot, since it yields more
1159 # powerful graphs.
1160
1161 CLASS_DIAGRAMS = YES
1162
1163 # You can define message sequence charts within doxygen comments using the \msc
1164 # command. Doxygen will then run the mscgen tool (see
1165 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1166 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1167 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1168 # default search path.
1169
1170 MSCGEN_PATH =
1171
1172 # If set to YES, the inheritance and collaboration graphs will hide
1173 # inheritance and usage relations if the target is undocumented
1174 # or is not a class.
1175
1176 HIDE_UNDOC_RELATIONS = NO
1177
1178 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1179 # available from the path. This tool is part of Graphviz, a graph visualization
1180 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1181 # have no effect if this option is set to NO (the default)
1182
1183 HAVE_DOT = YES
1184
1185 # By default doxygen will write a font called FreeSans.ttf to the output
1186 # directory and reference it in all dot files that doxygen generates. This
1187 # font does not include all possible unicode characters however, so when you need
1188 # these (or just want a differently looking font) you can specify the font name
1189 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1190 # which can be done by putting it in a standard location or by setting the
1191 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1192 # containing the font.
1193
1194 DOT_FONTNAME =
1195
1196 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1197 # The default size is 10pt.
1198
1199 DOT_FONTSIZE = 10
1200
1201 # By default doxygen will tell dot to use the output directory to look for the
1202 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1203 # different font using DOT_FONTNAME you can set the path where dot
1204 # can find it using this tag.
1205
1206 DOT_FONTPATH =
1207
1208 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1209 # will generate a graph for each documented class showing the direct and
1210 # indirect inheritance relations. Setting this tag to YES will force the
1211 # the CLASS_DIAGRAMS tag to NO.
1212
1213 CLASS_GRAPH = YES
1214
1215 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1216 # will generate a graph for each documented class showing the direct and
1217 # indirect implementation dependencies (inheritance, containment, and
1218 # class references variables) of the class with other documented classes.
1219
1220 COLLABORATION_GRAPH = NO
1221
1222 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1223 # will generate a graph for groups, showing the direct groups dependencies
1224
1225 GROUP_GRAPHS = YES
1226
1227 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1228 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1229 # Language.
1230
1231 UML_LOOK = NO
1232
1233 # If set to YES, the inheritance and collaboration graphs will show the
1234 # relations between templates and their instances.
1235
1236 TEMPLATE_RELATIONS = YES
1237
1238 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1239 # tags are set to YES then doxygen will generate a graph for each documented
1240 # file showing the direct and indirect include dependencies of the file with
1241 # other documented files.
1242
1243 INCLUDE_GRAPH = YES
1244
1245 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1246 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1247 # documented header file showing the documented files that directly or
1248 # indirectly include this file.
1249
1250 INCLUDED_BY_GRAPH = NO
1251
1252 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1253 # doxygen will generate a call dependency graph for every global function
1254 # or class method. Note that enabling this option will significantly increase
1255 # the time of a run. So in most cases it will be better to enable call graphs
1256 # for selected functions only using the \callgraph command.
1257
1258 CALL_GRAPH = NO
1259
1260 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1261 # doxygen will generate a caller dependency graph for every global function
1262 # or class method. Note that enabling this option will significantly increase
1263 # the time of a run. So in most cases it will be better to enable caller
1264 # graphs for selected functions only using the \callergraph command.
1265
1266 CALLER_GRAPH = NO
1267
1268 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1269 # will graphical hierarchy of all classes instead of a textual one.
1270
1271 GRAPHICAL_HIERARCHY = YES
1272
1273 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1274 # then doxygen will show the dependencies a directory has on other directories
1275 # in a graphical way. The dependency relations are determined by the #include
1276 # relations between the files in the directories.
1277
1278 DIRECTORY_GRAPH = NO
1279
1280 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1281 # generated by dot. Possible values are png, jpg, or gif
1282 # If left blank png will be used.
1283
1284 DOT_IMAGE_FORMAT = png
1285
1286 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1287 # found. If left blank, it is assumed the dot tool can be found in the path.
1288
1289 DOT_PATH =
1290
1291 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1292 # contain dot files that are included in the documentation (see the
1293 # \dotfile command).
1294
1295 DOTFILE_DIRS =
1296
1297 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1298 # nodes that will be shown in the graph. If the number of nodes in a graph
1299 # becomes larger than this value, doxygen will truncate the graph, which is
1300 # visualized by representing a node as a red box. Note that doxygen if the
1301 # number of direct children of the root node in a graph is already larger than
1302 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1303 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1304
1305 DOT_GRAPH_MAX_NODES = 100
1306
1307 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1308 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1309 # from the root by following a path via at most 3 edges will be shown. Nodes
1310 # that lay further from the root node will be omitted. Note that setting this
1311 # option to 1 or 2 may greatly reduce the computation time needed for large
1312 # code bases. Also note that the size of a graph can be further restricted by
1313 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1314
1315 MAX_DOT_GRAPH_DEPTH = 1000
1316
1317 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1318 # background. This is disabled by default, because dot on Windows does not
1319 # seem to support this out of the box. Warning: Depending on the platform used,
1320 # enabling this option may lead to badly anti-aliased labels on the edges of
1321 # a graph (i.e. they become hard to read).
1322
1323 DOT_TRANSPARENT = YES
1324
1325 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1326 # files in one run (i.e. multiple -o and -T options on the command line). This
1327 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1328 # support this, this feature is disabled by default.
1329
1330 DOT_MULTI_TARGETS = YES
1331
1332 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1333 # generate a legend page explaining the meaning of the various boxes and
1334 # arrows in the dot generated graphs.
1335
1336 GENERATE_LEGEND = YES
1337
1338 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1339 # remove the intermediate dot files that are used to generate
1340 # the various graphs.
1341
1342 DOT_CLEANUP = YES
1343