doxy.config.in 105 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1
# Doxyfile 1.8.12
Mike Kremer's avatar
Mike Kremer committed
2
3
4
5

# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
#
Jan Möbius's avatar
Jan Möbius committed
6
7
8
9
# All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be ignored.
Mike Kremer's avatar
Mike Kremer committed
10
# The format is:
Jan Möbius's avatar
Jan Möbius committed
11
12
13
14
# TAG = value [value, ...]
# For lists, items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (\" \").
Mike Kremer's avatar
Mike Kremer committed
15
16
17
18
19
20

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------

# This tag specifies the encoding used for all characters in the config file
Jan Möbius's avatar
Jan Möbius committed
21
22
23
24
25
# that follow. The default is UTF-8 which is also the encoding used for all text
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
# for the list of possible encodings.
# The default value is: UTF-8.
Mike Kremer's avatar
Mike Kremer committed
26
27
28

DOXYFILE_ENCODING      = UTF-8

Jan Möbius's avatar
Jan Möbius committed
29
30
31
32
33
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.
Mike Kremer's avatar
Mike Kremer committed
34
35
36

PROJECT_NAME           = "OpenVolumeMesh"

Jan Möbius's avatar
Jan Möbius committed
37
38
39
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
Mike Kremer's avatar
Mike Kremer committed
40
41
42
43

PROJECT_NUMBER         =

# Using the PROJECT_BRIEF tag one can provide an optional one line description
Jan Möbius's avatar
Jan Möbius committed
44
45
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
Mike Kremer's avatar
Mike Kremer committed
46
47
48

PROJECT_BRIEF          =

Jan Möbius's avatar
Jan Möbius committed
49
50
51
52
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
Mike Kremer's avatar
Mike Kremer committed
53

54
PROJECT_LOGO           = @CMAKE_CURRENT_SOURCE_DIR@/html/logo_vci.png
Mike Kremer's avatar
Mike Kremer committed
55

Jan Möbius's avatar
Jan Möbius committed
56
57
58
59
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
Mike Kremer's avatar
Mike Kremer committed
60

61
OUTPUT_DIRECTORY       = @CMAKE_BINARY_DIR@/Build/@ACG_PROJECT_DATADIR@/Doc
Mike Kremer's avatar
Mike Kremer committed
62

Jan Möbius's avatar
Jan Möbius committed
63
64
65
66
67
68
69
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
# will distribute the generated files over these directories. Enabling this
# option can be useful when feeding doxygen a huge amount of source files, where
# putting all generated files in the same directory would otherwise causes
# performance problems for the file system.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
70
71
72

CREATE_SUBDIRS         = NO

Jan Möbius's avatar
Jan Möbius committed
73
74
75
76
77
78
79
80
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
# characters to appear in the names of generated files. If set to NO, non-ASCII
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
# U+3044.
# The default value is: NO.

ALLOW_UNICODE_NAMES    = NO

Mike Kremer's avatar
Mike Kremer committed
81
82
83
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
Jan Möbius's avatar
Jan Möbius committed
84
85
86
87
88
89
90
91
92
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.
Mike Kremer's avatar
Mike Kremer committed
93
94
95

OUTPUT_LANGUAGE        = English

Jan Möbius's avatar
Jan Möbius committed
96
97
98
99
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
100
101
102

BRIEF_MEMBER_DESC      = YES

Jan Möbius's avatar
Jan Möbius committed
103
104
105
106
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
# description of a member or function before the detailed description
#
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
Mike Kremer's avatar
Mike Kremer committed
107
# brief descriptions will be completely suppressed.
Jan Möbius's avatar
Jan Möbius committed
108
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
109
110
111

REPEAT_BRIEF           = YES

Jan Möbius's avatar
Jan Möbius committed
112
113
114
115
116
117
118
119
# This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found
# as the leading text of the brief description, will be stripped from the text
# and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of
# the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the.
Mike Kremer's avatar
Mike Kremer committed
120
121
122
123

ABBREVIATE_BRIEF       =

# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
Jan Möbius's avatar
Jan Möbius committed
124
# doxygen will generate a detailed section even if there is only a brief
Mike Kremer's avatar
Mike Kremer committed
125
# description.
Jan Möbius's avatar
Jan Möbius committed
126
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
127
128
129
130
131
132
133

ALWAYS_DETAILED_SEC    = NO

# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
Jan Möbius's avatar
Jan Möbius committed
134
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
135
136
137

INLINE_INHERITED_MEMB  = NO

Jan Möbius's avatar
Jan Möbius committed
138
139
140
141
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
# before files name in the file list and in the header files. If set to NO the
# shortest path that makes the file name unique will be used
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
142
143
144

FULL_PATH_NAMES        = YES

Jan Möbius's avatar
Jan Möbius committed
145
146
147
148
149
150
151
152
153
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
# part of the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the path to
# strip.
#
# Note that you can specify absolute paths here, but also relative paths, which
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
Mike Kremer's avatar
Mike Kremer committed
154
155
156
157

STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@ \
                         @CMAKE_SOURCE_DIR@/src

Jan Möbius's avatar
Jan Möbius committed
158
159
160
161
162
163
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
# header file to include in order to use a class. If left blank only the name of
# the header file containing the class definition is used. Otherwise one should
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.
Mike Kremer's avatar
Mike Kremer committed
164
165
166
167

STRIP_FROM_INC_PATH    = @CMAKE_SOURCE_DIR@ \
                         @CMAKE_SOURCE_DIR@/src

Jan Möbius's avatar
Jan Möbius committed
168
169
170
171
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
# support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
172
173
174

SHORT_NAMES            = NO

Jan Möbius's avatar
Jan Möbius committed
175
176
177
178
179
180
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# first line (until the first dot) of a Javadoc-style comment as the brief
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
# style comments (thus requiring an explicit @brief command for a brief
# description.)
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
181
182
183

JAVADOC_AUTOBRIEF      = NO

Jan Möbius's avatar
Jan Möbius committed
184
185
186
187
188
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# requiring an explicit \brief command for a brief description.)
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
189
190
191

QT_AUTOBRIEF           = NO

Jan Möbius's avatar
Jan Möbius committed
192
193
194
195
196
197
198
199
200
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
# a brief description. This used to be the default behavior. The new default is
# to treat a multi-line C++ comment block as a detailed description. Set this
# tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
201
202
203

MULTILINE_CPP_IS_BRIEF = NO

Jan Möbius's avatar
Jan Möbius committed
204
205
206
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
207
208
209

INHERIT_DOCS           = YES

Jan Möbius's avatar
Jan Möbius committed
210
211
212
213
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
# page for each member. If set to NO, the documentation of a member will be part
# of the file/class/namespace that contains it.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
214
215
216

SEPARATE_MEMBER_PAGES  = NO

Jan Möbius's avatar
Jan Möbius committed
217
218
219
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.
Mike Kremer's avatar
Mike Kremer committed
220
221
222

TAB_SIZE               = 8

Jan Möbius's avatar
Jan Möbius committed
223
224
225
226
227
228
229
230
231
# This tag can be used to specify a number of aliases that act as commands in
# the documentation. An alias has the form:
# name=value
# For example adding
# "sideeffect=@par Side Effects:\n"
# will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
Mike Kremer's avatar
Mike Kremer committed
232
233
234

ALIASES                =

Jan Möbius's avatar
Jan Möbius committed
235
236
237
238
239
240
241
242
243
244
245
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.

TCL_SUBST              =

# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
# members will be omitted, etc.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
246
247
248

OPTIMIZE_OUTPUT_FOR_C  = NO

Jan Möbius's avatar
Jan Möbius committed
249
250
251
252
253
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
# for that language. For instance, namespaces will be presented as packages,
# qualified scopes will look different, etc.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
254
255
256
257

OPTIMIZE_OUTPUT_JAVA   = NO

# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
Jan Möbius's avatar
Jan Möbius committed
258
259
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
260
261
262
263

OPTIMIZE_FOR_FORTRAN   = NO

# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
Jan Möbius's avatar
Jan Möbius committed
264
265
# sources. Doxygen will then generate output that is tailored for VHDL.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
266
267
268
269

OPTIMIZE_OUTPUT_VHDL   = NO

# Doxygen selects the parser to use depending on the extension of the files it
Jan Möbius's avatar
Jan Möbius committed
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
# Fortran. In the later case the parser tries to guess whether the code is fixed
# or free formatted code, this is the default for Fortran type files), VHDL. For
# instance to make doxygen treat .inc files as Fortran files (default is PHP),
# and .f files as C (default is Fortran), use: inc=Fortran f=C.
#
# Note: For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.
Mike Kremer's avatar
Mike Kremer committed
285
286
287

EXTENSION_MAPPING      =

Jan Möbius's avatar
Jan Möbius committed
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.

MARKDOWN_SUPPORT       = YES

# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
# to that level are automatically included in the table of contents, even if
# they do not have an id attribute.
# Note: This feature currently applies only to Markdown headings.
# Minimum value: 0, maximum value: 99, default value: 0.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.

TOC_INCLUDE_HEADINGS   = 0

# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by putting a % sign in front of the word or
# globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.

AUTOLINK_SUPPORT       = YES

Mike Kremer's avatar
Mike Kremer committed
315
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
Jan Möbius's avatar
Jan Möbius committed
316
317
318
319
# to include (a tag file for) the STL sources as input, then you should set this
# tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
# versus func(std::string) {}). This also make the inheritance and collaboration
Mike Kremer's avatar
Mike Kremer committed
320
# diagrams that involve STL classes more complete and accurate.
Jan Möbius's avatar
Jan Möbius committed
321
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
322
323
324
325
326

BUILTIN_STL_SUPPORT    = NO

# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
Jan Möbius's avatar
Jan Möbius committed
327
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
328
329
330

CPP_CLI_SUPPORT        = NO

Jan Möbius's avatar
Jan Möbius committed
331
332
333
334
335
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
# will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
336
337
338

SIP_SUPPORT            = NO

Jan Möbius's avatar
Jan Möbius committed
339
340
341
342
343
344
345
# For Microsoft's IDL there are propget and propput attributes to indicate
# getter and setter methods for a property. Setting this option to YES will make
# doxygen to replace the get and set methods by a property in the documentation.
# This will only work if the methods are indeed getting or setting a simple
# type. If this is not the case, or you want to show the methods anyway, you
# should set this option to NO.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
346
347
348
349

IDL_PROPERTY_SUPPORT   = YES

# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
Jan Möbius's avatar
Jan Möbius committed
350
# tag is set to YES then doxygen will reuse the documentation of the first
Mike Kremer's avatar
Mike Kremer committed
351
352
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
Jan Möbius's avatar
Jan Möbius committed
353
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
354
355
356

DISTRIBUTE_GROUP_DOC   = NO

Jan Möbius's avatar
Jan Möbius committed
357
358
359
360
361
362
363
364
365
366
367
368
369
# If one adds a struct or class to a group and this option is enabled, then also
# any nested class or struct is added to the same group. By default this option
# is disabled and one has to add nested compounds explicitly via \ingroup.
# The default value is: NO.

GROUP_NESTED_COMPOUNDS = NO

# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
# type (e.g. under the Public Functions section). Set it to NO to prevent
# subgrouping. Alternatively, this can be done per class using the
# \nosubgrouping command.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
370
371
372

SUBGROUPING            = YES

Jan Möbius's avatar
Jan Möbius committed
373
374
375
376
377
378
379
380
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# are shown inside the group in which they are included (e.g. using \ingroup)
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# and RTF).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
381
382
383

INLINE_GROUPED_CLASSES = NO

Jan Möbius's avatar
Jan Möbius committed
384
385
386
387
388
389
390
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
# the documentation of the scope in which they are defined (i.e. file,
# namespace, or group documentation), provided this scope is documented. If set
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
391
392
393

INLINE_SIMPLE_STRUCTS  = NO

Jan Möbius's avatar
Jan Möbius committed
394
395
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# enum is documented as struct, union, or enum with the name of the typedef. So
Mike Kremer's avatar
Mike Kremer committed
396
397
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
Jan Möbius's avatar
Jan Möbius committed
398
399
# namespace, or class. And the struct will be named TypeS. This can typically be
# useful for C code in case the coding convention dictates that all compound
Mike Kremer's avatar
Mike Kremer committed
400
# types are typedef'ed and only the typedef is referenced, never the tag name.
Jan Möbius's avatar
Jan Möbius committed
401
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
402
403
404

TYPEDEF_HIDES_STRUCT   = NO

Jan Möbius's avatar
Jan Möbius committed
405
406
407
408
409
410
411
412
413
414
415
416
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# cache is used to resolve symbols given their name and scope. Since this can be
# an expensive process and often the same symbol appears multiple times in the
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# doxygen will become slower. If the cache is too large, memory is wasted. The
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# symbols. At the end of a run doxygen will report the cache usage and suggest
# the optimal cache size from a speed point of view.
# Minimum value: 0, maximum value: 9, default value: 0.

LOOKUP_CACHE_SIZE      = 0
Mike Kremer's avatar
Mike Kremer committed
417
418
419
420
421

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

Jan Möbius's avatar
Jan Möbius committed
422
423
424
425
426
427
428
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
# documentation are documented, even if no documentation was available. Private
# class members and static file members will be hidden unless the
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
429
430
431

EXTRACT_ALL            = NO

Jan Möbius's avatar
Jan Möbius committed
432
433
434
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
435
436
437

EXTRACT_PRIVATE        = NO

Jan Möbius's avatar
Jan Möbius committed
438
439
440
441
442
443
444
445
446
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.

EXTRACT_PACKAGE        = NO

# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
# included in the documentation.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
447
448
449

EXTRACT_STATIC         = NO

Jan Möbius's avatar
Jan Möbius committed
450
451
452
453
454
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
# only classes defined in header files are included. Does not have any effect
# for Java sources.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
455
456
457

EXTRACT_LOCAL_CLASSES  = YES

Jan Möbius's avatar
Jan Möbius committed
458
459
460
461
462
# This flag is only useful for Objective-C code. If set to YES, local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO, only methods in the interface are
# included.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
463
464
465
466
467

EXTRACT_LOCAL_METHODS  = NO

# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
Jan Möbius's avatar
Jan Möbius committed
468
469
470
471
# 'anonymous_namespace{file}', where file will be replaced with the base name of
# the file that contains the anonymous namespace. By default anonymous namespace
# are hidden.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
472
473
474

EXTRACT_ANON_NSPACES   = NO

Jan Möbius's avatar
Jan Möbius committed
475
476
477
478
479
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
480
481
482

HIDE_UNDOC_MEMBERS     = NO

Jan Möbius's avatar
Jan Möbius committed
483
484
485
486
487
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
# to NO, these classes will be included in the various overviews. This option
# has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
488
489
490

HIDE_UNDOC_CLASSES     = NO

Jan Möbius's avatar
Jan Möbius committed
491
492
493
494
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# (class|struct|union) declarations. If set to NO, these declarations will be
# included in the documentation.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
495
496
497

HIDE_FRIEND_COMPOUNDS  = NO

Jan Möbius's avatar
Jan Möbius committed
498
499
500
501
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. If set to NO, these
# blocks will be appended to the function's detailed documentation block.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
502
503
504

HIDE_IN_BODY_DOCS      = NO

Jan Möbius's avatar
Jan Möbius committed
505
506
507
508
# The INTERNAL_DOCS tag determines if documentation that is typed after a
# \internal command is included. If the tag is set to NO then the documentation
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
509
510
511

INTERNAL_DOCS          = NO

Jan Möbius's avatar
Jan Möbius committed
512
513
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
# names in lower-case letters. If set to YES, upper-case letters are also
Mike Kremer's avatar
Mike Kremer committed
514
515
516
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
Jan Möbius's avatar
Jan Möbius committed
517
# The default value is: system dependent.
Mike Kremer's avatar
Mike Kremer committed
518
519
520

CASE_SENSE_NAMES       = YES

Jan Möbius's avatar
Jan Möbius committed
521
522
523
524
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
# their full class and namespace scopes in the documentation. If set to YES, the
# scope will be hidden.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
525
526
527

HIDE_SCOPE_NAMES       = NO

Jan Möbius's avatar
Jan Möbius committed
528
529
530
531
532
533
534
535
536
537
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
# append additional text to a page's title, such as Class Reference. If set to
# YES the compound reference will be hidden.
# The default value is: NO.

HIDE_COMPOUND_REFERENCE= NO

# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# the files that are included by a file in the documentation of that file.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
538
539
540

SHOW_INCLUDE_FILES     = YES

Jan Möbius's avatar
Jan Möbius committed
541
542
543
544
545
546
547
548
549
550
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
# which file to include in order to use the member.
# The default value is: NO.

SHOW_GROUPED_MEMB_INC  = NO

# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
# files with double quotes in the documentation rather than with sharp brackets.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
551
552
553

FORCE_LOCAL_INCLUDES   = NO

Jan Möbius's avatar
Jan Möbius committed
554
555
556
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# documentation for inline members.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
557
558
559

INLINE_INFO            = YES

Jan Möbius's avatar
Jan Möbius committed
560
561
562
563
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
# (detailed) documentation of file and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
564
565
566

SORT_MEMBER_DOCS       = YES

Jan Möbius's avatar
Jan Möbius committed
567
568
569
570
571
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order. Note that
# this will also influence the order of the classes in the class list.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
572
573
574

SORT_BRIEF_DOCS        = NO

Jan Möbius's avatar
Jan Möbius committed
575
576
577
578
579
580
581
582
583
# 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 constructors will appear in the
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# member documentation.
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
584
585
586

SORT_MEMBERS_CTORS_1ST = NO

Jan Möbius's avatar
Jan Möbius committed
587
588
589
590
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will
# appear in their defined order.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
591
592
593

SORT_GROUP_NAMES       = NO

Jan Möbius's avatar
Jan Möbius committed
594
595
596
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
# be sorted only by class name, not including the namespace part.
Mike Kremer's avatar
Mike Kremer committed
597
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Jan Möbius's avatar
Jan Möbius committed
598
599
600
# Note: This option applies only to the class list, not to the alphabetical
# list.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
601
602
603

SORT_BY_SCOPE_NAME     = NO

Jan Möbius's avatar
Jan Möbius committed
604
605
606
607
608
609
610
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# type resolution of all parameters of a function it will reject a match between
# the prototype and the implementation of a member function even if there is
# only one candidate or it is obvious which candidate to choose by doing a
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
# accept a match between prototype and implementation in such cases.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
611
612
613

STRICT_PROTO_MATCHING  = NO

Jan Möbius's avatar
Jan Möbius committed
614
615
616
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
# list. This list is created by putting \todo commands in the documentation.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
617
618
619

GENERATE_TODOLIST      = YES

Jan Möbius's avatar
Jan Möbius committed
620
621
622
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
# list. This list is created by putting \test commands in the documentation.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
623
624
625

GENERATE_TESTLIST      = YES

Jan Möbius's avatar
Jan Möbius committed
626
627
628
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
# list. This list is created by putting \bug commands in the documentation.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
629
630
631

GENERATE_BUGLIST       = YES

Jan Möbius's avatar
Jan Möbius committed
632
633
634
635
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
# the deprecated list. This list is created by putting \deprecated commands in
# the documentation.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
636
637
638

GENERATE_DEPRECATEDLIST= YES

Jan Möbius's avatar
Jan Möbius committed
639
640
641
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \endcond blocks.
Mike Kremer's avatar
Mike Kremer committed
642
643
644

ENABLED_SECTIONS       = OPENVOLUMEMESH_INTERNAL_DOC

Jan Möbius's avatar
Jan Möbius committed
645
646
647
648
649
650
651
652
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# initial value of a variable or macro / define can have for it to appear in the
# documentation. If the initializer consists of more lines than specified here
# it will be hidden. Use a value of 0 to hide initializers completely. The
# appearance of the value of individual variables and macros / defines can be
# controlled using \showinitializer or \hideinitializer command in the
# documentation regardless of this setting.
# Minimum value: 0, maximum value: 10000, default value: 30.
Mike Kremer's avatar
Mike Kremer committed
653
654
655

MAX_INITIALIZER_LINES  = 30

Jan Möbius's avatar
Jan Möbius committed
656
657
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
# the bottom of the documentation of classes and structs. If set to YES, the
Mike Kremer's avatar
Mike Kremer committed
658
# list will mention the files that were used to generate the documentation.
Jan Möbius's avatar
Jan Möbius committed
659
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
660
661
662

SHOW_USED_FILES        = YES

Jan Möbius's avatar
Jan Möbius committed
663
664
665
666
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
# will remove the Files entry from the Quick Index and from the Folder Tree View
# (if specified).
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
667
668
669

SHOW_FILES             = YES

Jan Möbius's avatar
Jan Möbius committed
670
671
672
673
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the
# Folder Tree View (if specified).
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
674
675
676
677
678
679

SHOW_NAMESPACES        = YES

# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
Jan Möbius's avatar
Jan Möbius committed
680
681
682
683
# popen()) the command command input-file, where command is the value of the
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# by doxygen. Whatever the program writes to standard output is used as the file
# version. For an example see the documentation.
Mike Kremer's avatar
Mike Kremer committed
684
685
686
687
688

FILE_VERSION_FILTER    =

# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
Jan Möbius's avatar
Jan Möbius committed
689
690
691
692
693
694
695
696
# output files in an output format independent way. To create the layout file
# that represents doxygen's defaults, run doxygen with the -l option. You can
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
# will be used as the name of the layout file.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
Mike Kremer's avatar
Mike Kremer committed
697
698
699

LAYOUT_FILE            =

Jan Möbius's avatar
Jan Möbius committed
700
701
702
703
704
705
706
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
# extension is automatically appended if omitted. This requires the bibtex tool
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
# For LaTeX the style of the bibliography can be controlled using
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. See also \cite for info how to create references.
Mike Kremer's avatar
Mike Kremer committed
707

Jan Möbius's avatar
Jan Möbius committed
708
CITE_BIB_FILES         =
Mike Kremer's avatar
Mike Kremer committed
709
710

#---------------------------------------------------------------------------
Jan Möbius's avatar
Jan Möbius committed
711
# Configuration options related to warning and progress messages
Mike Kremer's avatar
Mike Kremer committed
712
713
#---------------------------------------------------------------------------

Jan Möbius's avatar
Jan Möbius committed
714
715
716
717
# The QUIET tag can be used to turn on/off the messages that are generated to
# standard output by doxygen. If QUIET is set to YES this implies that the
# messages are off.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
718
719
720
721

QUIET                  = NO

# The WARNINGS tag can be used to turn on/off the warning messages that are
Jan Möbius's avatar
Jan Möbius committed
722
723
724
725
726
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
# this implies that the warnings are on.
#
# Tip: Turn warnings on while writing the documentation.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
727
728
729

WARNINGS               = YES

Jan Möbius's avatar
Jan Möbius committed
730
731
732
733
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
# will automatically be disabled.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
734

Mike Kremer's avatar
Mike Kremer committed
735
WARN_IF_UNDOCUMENTED   = NO
Mike Kremer's avatar
Mike Kremer committed
736

Jan Möbius's avatar
Jan Möbius committed
737
738
739
740
741
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
# in a documented function, or documenting parameters that don't exist or using
# markup commands wrongly.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
742
743
744

WARN_IF_DOC_ERROR      = YES

Jan Möbius's avatar
Jan Möbius committed
745
746
747
748
749
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# are documented, but have no documentation for their parameters or return
# value. If set to NO, doxygen will only warn about wrong or incomplete
# parameter documentation, but not about the absence of documentation.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
750
751
752

WARN_NO_PARAMDOC       = NO

Jan Möbius's avatar
Jan Möbius committed
753
754
755
756
757
758
759
760
761
762
763
764
765
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered.
# The default value is: NO.

WARN_AS_ERROR          = NO

# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
# will be replaced by the file and line number from which the warning originated
# and the warning text. Optionally the format may contain $version, which will
# be replaced by the version of the file (if it could be obtained via
# FILE_VERSION_FILTER)
# The default value is: $file:$line: $text.
Mike Kremer's avatar
Mike Kremer committed
766
767
768

WARN_FORMAT            = "$file:$line: $text"

Jan Möbius's avatar
Jan Möbius committed
769
770
771
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
# messages should be written. If left blank the output is written to standard
# error (stderr).
Mike Kremer's avatar
Mike Kremer committed
772
773
774
775

WARN_LOGFILE           =

#---------------------------------------------------------------------------
Jan Möbius's avatar
Jan Möbius committed
776
# Configuration options related to the input files
Mike Kremer's avatar
Mike Kremer committed
777
778
#---------------------------------------------------------------------------

Jan Möbius's avatar
Jan Möbius committed
779
780
781
782
783
# The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like myfile.cpp or
# directories like /usr/src/myproject. Separate the files or directories with
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
Mike Kremer's avatar
Mike Kremer committed
784
785
786
787

INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/..

# This tag can be used to specify the character encoding of the source files
Jan Möbius's avatar
Jan Möbius committed
788
789
790
791
792
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
# possible encodings.
# The default value is: UTF-8.
Mike Kremer's avatar
Mike Kremer committed
793
794
795
796

INPUT_ENCODING         = UTF-8

# If the value of the INPUT tag contains directories, you can use the
Jan Möbius's avatar
Jan Möbius committed
797
798
799
800
801
802
803
804
805
806
807
808
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# *.h) to filter out the source-files in the directories.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# read by doxygen.
#
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
Mike Kremer's avatar
Mike Kremer committed
809
810
811
812
813
814

FILE_PATTERNS          = *.cc \
                         *.hh \
                         *.docu \
                         *.doxy

Jan Möbius's avatar
Jan Möbius committed
815
816
817
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
818
819
820
821
822
823

RECURSIVE              = YES

# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
Jan Möbius's avatar
Jan Möbius committed
824
#
Mike Kremer's avatar
Mike Kremer committed
825
826
827
828
829
830
831
832
833
834
# Note that relative paths are relative to the directory from which doxygen is
# run.

EXCLUDE                = @CMAKE_CURRENT_SOURCE_DIR@/../examples \
                         @CMAKE_CURRENT_SOURCE_DIR@/../src/Unittests \
                         @CMAKE_CURRENT_BINARY_DIR@

# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
Jan Möbius's avatar
Jan Möbius committed
835
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
836
837
838
839
840

EXCLUDE_SYMLINKS       = NO

# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
Jan Möbius's avatar
Jan Möbius committed
841
842
843
844
# certain files from those directories.
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
Mike Kremer's avatar
Mike Kremer committed
845

846
847
EXCLUDE_PATTERNS       = .git \
                         .svn \
Mike Kremer's avatar
Mike Kremer committed
848
849
850
851
852
853
854
                         *.moc.cc

# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
Jan Möbius's avatar
Jan Möbius committed
855
856
857
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
Mike Kremer's avatar
Mike Kremer committed
858
859
860

EXCLUDE_SYMBOLS        =

Jan Möbius's avatar
Jan Möbius committed
861
862
863
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include
# command).
Mike Kremer's avatar
Mike Kremer committed
864

865
866
EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/tutorials \
                         @CMAKE_CURRENT_SOURCE_DIR@/examples
Mike Kremer's avatar
Mike Kremer committed
867
868

# If the value of the EXAMPLE_PATH tag contains directories, you can use the
Jan Möbius's avatar
Jan Möbius committed
869
870
871
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all
# files are included.
Mike Kremer's avatar
Mike Kremer committed
872
873
874

EXAMPLE_PATTERNS       = *.cc \
                         *.hh \
875
876
                         *.txt \
                         *.ovm
Mike Kremer's avatar
Mike Kremer committed
877
878

# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
Jan Möbius's avatar
Jan Möbius committed
879
880
881
# searched for input files to be used with the \include or \dontinclude commands
# irrespective of the value of the RECURSIVE tag.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
882
883
884

EXAMPLE_RECURSIVE      = NO

Jan Möbius's avatar
Jan Möbius committed
885
886
887
# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the
# \image command).
Mike Kremer's avatar
Mike Kremer committed
888
889
890
891
892

IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/images

# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
Jan Möbius's avatar
Jan Möbius committed
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# by executing (via popen()) the command:
#
# <filter> <input-file>
#
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
# name of an input file. Doxygen will then use the output that the filter
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
# will be ignored.
#
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
Mike Kremer's avatar
Mike Kremer committed
909
910
911
912

INPUT_FILTER           =

# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
Jan Möbius's avatar
Jan Möbius committed
913
914
915
916
917
918
919
920
921
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form: pattern=filter
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# patterns match the file name, INPUT_FILTER is applied.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
Mike Kremer's avatar
Mike Kremer committed
922
923
924
925

FILTER_PATTERNS        =

# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
Jan Möbius's avatar
Jan Möbius committed
926
927
928
# INPUT_FILTER) will also be used to filter the input files that are used for
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
929
930
931
932

FILTER_SOURCE_FILES    = NO

# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
Jan Möbius's avatar
Jan Möbius committed
933
934
935
936
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
# it is also possible to disable source filtering for a specific pattern using
# *.ext= (so without naming a filter).
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
Mike Kremer's avatar
Mike Kremer committed
937
938
939

FILTER_SOURCE_PATTERNS =

Jan Möbius's avatar
Jan Möbius committed
940
941
942
943
944
945
946
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
# is part of the input, its contents will be placed on the main page
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE =

Mike Kremer's avatar
Mike Kremer committed
947
#---------------------------------------------------------------------------
Jan Möbius's avatar
Jan Möbius committed
948
# Configuration options related to source browsing
Mike Kremer's avatar
Mike Kremer committed
949
950
#---------------------------------------------------------------------------

Jan Möbius's avatar
Jan Möbius committed
951
952
953
954
955
956
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
# generated. Documented entities will be cross-referenced with these sources.
#
# Note: To get rid of all source code in the generated output, make sure that
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
957
958
959

SOURCE_BROWSER         = NO

Jan Möbius's avatar
Jan Möbius committed
960
961
962
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
963
964
965

INLINE_SOURCES         = NO

Jan Möbius's avatar
Jan Möbius committed
966
967
968
969
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# special comment blocks from generated source code fragments. Normal C, C++ and
# Fortran comments will always remain visible.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
970
971
972

STRIP_CODE_COMMENTS    = YES

Jan Möbius's avatar
Jan Möbius committed
973
974
975
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
# function all documented functions referencing it will be listed.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
976
977
978

REFERENCED_BY_RELATION = NO

Jan Möbius's avatar
Jan Möbius committed
979
980
981
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# The default value is: NO.
Mike Kremer's avatar
Mike Kremer committed
982
983
984

REFERENCES_RELATION    = NO

Jan Möbius's avatar
Jan Möbius committed
985
986
987
988
989
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
# link to the documentation.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
990
991
992

REFERENCES_LINK_SOURCE = YES

Jan Möbius's avatar
Jan Möbius committed
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
# source code will show a tooltip with additional information such as prototype,
# brief description and links to the definition and documentation. Since this
# will make the HTML file larger and loading of large files a bit slower, you
# can opt to disable this feature.
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.

SOURCE_TOOLTIPS        = YES

# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
# source browser. The htags tool is part of GNU's global source tagging system
# (see http://www.gnu.org/software/global/global.html). You will need version
# 4.8.6 or higher.
#
# To use it do the following:
# - Install the latest version of global
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
# - Make sure the INPUT points to the root of the source tree
# - Run doxygen as normal
#
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
# tools must be available from the command line (i.e. in the search path).
#
# The result: instead of the source browser generated by doxygen, the links to
# source code will now point to the output of htags.
# The default value is: NO.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1022
1023
1024

USE_HTAGS              = NO

Jan Möbius's avatar
Jan Möbius committed
1025
1026
1027
1028
1029
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
# verbatim copy of the header file for each class for which an include is
# specified. Set to NO to disable this.
# See also: Section \class.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
1030
1031
1032

VERBATIM_HEADERS       = YES

Jan Möbius's avatar
Jan Möbius committed
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
# cost of reduced performance. This can be particularly helpful with template
# rich C++ code for which doxygen's built-in parser lacks the necessary type
# information.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse-libclang=ON option for CMake.
# The default value is: NO.

CLANG_ASSISTED_PARSING = NO

# If clang assisted parsing is enabled you can provide the compiler with command
# line options that you would normally use when invoking the compiler. Note that
# the include paths will already be set by doxygen for the files and directories
# specified with INPUT and INCLUDE_PATH.
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.

CLANG_OPTIONS          =

Mike Kremer's avatar
Mike Kremer committed
1052
#---------------------------------------------------------------------------
Jan Möbius's avatar
Jan Möbius committed
1053
# Configuration options related to the alphabetical class index
Mike Kremer's avatar
Mike Kremer committed
1054
1055
#---------------------------------------------------------------------------

Jan Möbius's avatar
Jan Möbius committed
1056
1057
1058
1059
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
# compounds will be generated. Enable this if the project contains a lot of
# classes, structs, unions or interfaces.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
1060
1061
1062

ALPHABETICAL_INDEX     = YES

Jan Möbius's avatar
Jan Möbius committed
1063
1064
1065
1066
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1067
1068
1069

COLS_IN_ALPHA_INDEX    = 5

Jan Möbius's avatar
Jan Möbius committed
1070
1071
1072
1073
1074
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# can be used to specify a prefix (or a list of prefixes) that should be ignored
# while generating the index headers.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1075
1076
1077
1078

IGNORE_PREFIX          =

#---------------------------------------------------------------------------
Jan Möbius's avatar
Jan Möbius committed
1079
# Configuration options related to the HTML output
Mike Kremer's avatar
Mike Kremer committed
1080
1081
#---------------------------------------------------------------------------

Jan Möbius's avatar
Jan Möbius committed
1082
1083
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
1084
1085
1086

GENERATE_HTML          = YES

Jan Möbius's avatar
Jan Möbius committed
1087
1088
1089
1090
1091
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1092
1093
1094

HTML_OUTPUT            = html

Jan Möbius's avatar
Jan Möbius committed
1095
1096
1097
1098
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
# The default value is: .html.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1099
1100
1101

HTML_FILE_EXTENSION    = .html

Jan Möbius's avatar
Jan Möbius committed
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
# each generated HTML page. If the tag is left blank doxygen will generate a
# standard header.
#
# To get valid HTML the header file that includes any scripts and style sheets
# that doxygen needs, which is dependent on the configuration options used (e.g.
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
# default header using
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
# YourConfigFile
# and then modify the file new_header.html. See also section "Doxygen usage"
# for information on how to generate the default header that doxygen normally
# uses.
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. For a description
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1119
1120
1121

HTML_HEADER            = @CMAKE_CURRENT_SOURCE_DIR@/html/acg_header.html

Jan Möbius's avatar
Jan Möbius committed
1122
1123
1124
1125
1126
1127
1128
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
# footer. See HTML_HEADER for more information on how to generate a default
# footer and what special commands can be used inside the footer. See also
# section "Doxygen usage" for information on how to generate the default footer
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1129
1130
1131

HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/html/acg_footer.html

Jan Möbius's avatar
Jan Möbius committed
1132
1133
1134
1135
1136
1137
1138
1139
1140
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
# the HTML output. If left blank doxygen will generate a default style sheet.
# See also section "Doxygen usage" for information on how to generate the style
# sheet that doxygen normally uses.
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1141
1142
1143

HTML_STYLESHEET        = @CMAKE_CURRENT_SOURCE_DIR@/html/style.css

Jan Möbius's avatar
Jan Möbius committed
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
# created by doxygen. Using this option one can overrule certain style aspects.
# This is preferred over using HTML_STYLESHEET since it does not replace the
# standard style sheet and is therefore more robust against future updates.
# Doxygen will copy the style sheet files to the output directory.
# Note: The order of the extra style sheet files is of importance (e.g. the last
# style sheet in the list overrules the setting of the previous ones in the
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_STYLESHEET  =

Mike Kremer's avatar
Mike Kremer committed
1157
1158
1159
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
Jan Möbius's avatar
Jan Möbius committed
1160
1161
1162
1163
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1164

1165
HTML_EXTRA_FILES       = @CMAKE_CURRENT_SOURCE_DIR@/html/logo_vci.png
Mike Kremer's avatar
Mike Kremer committed
1166

Jan Möbius's avatar
Jan Möbius committed
1167
1168
1169
1170
1171
1172
1173
1174
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the style sheet and background images according to
# this color. Hue is specified as an angle on a colorwheel, see
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# purple, and 360 is red again.
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1175
1176
1177

HTML_COLORSTYLE_HUE    = 220

Jan Möbius's avatar
Jan Möbius committed
1178
1179
1180
1181
1182
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
# value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1183
1184
1185

HTML_COLORSTYLE_SAT    = 100

Jan Möbius's avatar
Jan Möbius committed
1186
1187
1188
1189
1190
1191
1192
1193
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
# gradually make the output lighter, whereas values above 100 make the output
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
# change the gamma.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1194
1195
1196
1197

HTML_COLORSTYLE_GAMMA  = 80

# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
Jan Möbius's avatar
Jan Möbius committed
1198
1199
1200
1201
1202
# page will contain the date and time when the page was generated. Setting this
# to YES can help to show when doxygen was last run and thus if the
# documentation is up to date.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1203
1204
1205
1206
1207

HTML_TIMESTAMP         = YES

# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
Jan Möbius's avatar
Jan Möbius committed
1208
1209
1210
# page has loaded.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1211
1212
1213

HTML_DYNAMIC_SECTIONS  = NO

Jan Möbius's avatar
Jan Möbius committed
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
# and collapse entries dynamically later on. Doxygen will expand the tree to
# such a level that at most the specified number of entries are visible (unless
# a fully collapsed tree already exceeds this amount). So setting the number of
# entries 1 will produce a full collapsed tree by default. 0 is a special value
# representing an infinite number of entries and will result in a full expanded
# tree by default.
# Minimum value: 0, maximum value: 9999, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_INDEX_NUM_ENTRIES = 100

# If the GENERATE_DOCSET tag is set to YES, additional index files will be
# generated that can be used as input for Apple's Xcode 3 integrated development
# environment (see: http://developer.apple.com/tools/xcode/), introduced with
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
# Makefile in the HTML output directory. Running make will produce the docset in
# that directory and running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
Mike Kremer's avatar
Mike Kremer committed
1235
# for more information.
Jan Möbius's avatar
Jan Möbius committed
1236
1237
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1238
1239
1240

GENERATE_DOCSET        = NO

Jan Möbius's avatar
Jan Möbius committed
1241
1242
1243
1244
1245
# This tag determines the name of the docset feed. A documentation feed provides
# an umbrella under which multiple documentation sets from a single provider
# (such as a company or product suite) can be grouped.
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1246
1247
1248

DOCSET_FEEDNAME        = "Doxygen generated docs"

Jan Möbius's avatar
Jan Möbius committed
1249
1250
1251
1252
1253
# This tag specifies a string that should uniquely identify the documentation
# set bundle. This should be a reverse domain-name style string, e.g.
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1254
1255
1256

DOCSET_BUNDLE_ID       = org.doxygen.Project

Jan Möbius's avatar
Jan Möbius committed
1257
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
Mike Kremer's avatar
Mike Kremer committed
1258
1259
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
Jan Möbius's avatar
Jan Möbius committed
1260
1261
# The default value is: org.doxygen.Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1262
1263
1264

DOCSET_PUBLISHER_ID    = org.doxygen.Publisher

Jan Möbius's avatar
Jan Möbius committed
1265
1266
1267
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
# The default value is: Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1268

Jan Möbius's avatar
Jan Möbius committed
1269
DOCSET_PUBLISHER_NAME  = AachenComputerGraphicsGroup
Mike Kremer's avatar
Mike Kremer committed
1270

Jan Möbius's avatar
Jan Möbius committed
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
# files are now used as the Windows 98 help format, and will replace the old
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
# HTML files also contain an index, a table of contents, and you can search for
# words in the documentation. The HTML workshop also contains a viewer for
# compressed HTML files.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1286
1287
1288

GENERATE_HTMLHELP      = NO

Jan Möbius's avatar
Jan Möbius committed
1289
1290
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
# file. You can add a path in front of the file if the result should not be
Mike Kremer's avatar
Mike Kremer committed
1291
# written to the html output directory.
Jan Möbius's avatar
Jan Möbius committed
1292
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1293
1294
1295

CHM_FILE               =

Jan Möbius's avatar
Jan Möbius committed
1296
1297
1298
1299
1300
# The HHC_LOCATION tag can be used to specify the location (absolute path
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
# doxygen will try to run the HTML help compiler on the generated index.hhp.
# The file has to be specified with full path.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1301
1302
1303

HHC_LOCATION           =

Jan Möbius's avatar
Jan Möbius committed
1304
1305
1306
1307
# The GENERATE_CHI flag controls if a separate .chi index file is generated
# (YES) or that it should be included in the master .chm file (NO).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1308
1309
1310

GENERATE_CHI           = NO

Jan Möbius's avatar
Jan Möbius committed
1311
1312
1313
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
# and project file content.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1314
1315
1316

CHM_INDEX_ENCODING     =

Jan Möbius's avatar
Jan Möbius committed
1317
1318
1319
1320
1321
# The BINARY_TOC flag controls whether a binary table of contents is generated
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
# enables the Previous and Next buttons.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1322
1323
1324

BINARY_TOC             = NO

Jan Möbius's avatar
Jan Möbius committed
1325
1326
1327
1328
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
# the table of contents of the HTML help documentation and to the tree view.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1329
1330
1331
1332

TOC_EXPAND             = NO

# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
Jan Möbius's avatar
Jan Möbius committed
1333
1334
1335
1336
1337
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
# (.qch) of the generated HTML documentation.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1338
1339
1340

GENERATE_QHP           = NO

Jan Möbius's avatar
Jan Möbius committed
1341
1342
1343
1344
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
# the file name of the resulting .qch file. The path specified is relative to
# the HTML output folder.
# This tag requires that the tag GENERATE_QHP is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1345
1346
1347

QCH_FILE               =

Jan Möbius's avatar
Jan Möbius committed
1348
1349
1350
1351
1352
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Project output. For more information please see Qt Help Project / Namespace
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1353
1354
1355

QHP_NAMESPACE          = org.doxygen.Project

Jan Möbius's avatar
Jan Möbius committed
1356
1357
1358
1359
1360
1361
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
# Help Project output. For more information please see Qt Help Project / Virtual
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
# folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1362
1363
1364

QHP_VIRTUAL_FOLDER     = doc

Jan Möbius's avatar
Jan Möbius committed
1365
1366
1367
1368
1369
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1370
1371
1372

QHP_CUST_FILTER_NAME   =

Jan Möbius's avatar
Jan Möbius committed
1373
1374
1375
1376
1377
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1378
1379
1380
1381

QHP_CUST_FILTER_ATTRS  =

# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
Jan Möbius's avatar
Jan Möbius committed
1382
1383
1384
# project's filter section matches. Qt Help Project / Filter Attributes (see:
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
# This tag requires that the tag GENERATE_QHP is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1385
1386
1387

QHP_SECT_FILTER_ATTRS  =

Jan Möbius's avatar
Jan Möbius committed
1388
1389
1390
1391
# The QHG_LOCATION tag can be used to specify the location of Qt's
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
# generated .qhp file.
# This tag requires that the tag GENERATE_QHP is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1392
1393
1394

QHG_LOCATION           =

Jan Möbius's avatar
Jan Möbius committed
1395
1396
1397
1398
1399
1400
1401
1402
1403
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
# generated, together with the HTML files, they form an Eclipse help plugin. To
# install this plugin and make it available under the help contents menu in
# Eclipse, the contents of the directory containing the HTML and XML files needs
# to be copied into the plugins directory of eclipse. The name of the directory
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
# After copying Eclipse needs to be restarted before the help appears.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1404
1405
1406

GENERATE_ECLIPSEHELP   = NO

Jan Möbius's avatar
Jan Möbius committed
1407
1408
1409
1410
1411
# A unique identifier for the Eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have this
# name. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1412
1413
1414

ECLIPSE_DOC_ID         = org.doxygen.Project

Jan Möbius's avatar
Jan Möbius committed
1415
1416
1417
1418
1419
1420
1421
1422
# If you want full control over the layout of the generated HTML pages it might
# be necessary to disable the index and replace it with your own. The
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
# of each HTML page. A value of NO enables the index and the value YES disables
# it. Since the tabs in the index contain the same information as the navigation
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1423
1424
1425
1426

DISABLE_INDEX          = NO

# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
Jan Möbius's avatar
Jan Möbius committed
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
# structure should be generated to display hierarchical information. If the tag
# value is set to YES, a side panel will be generated containing a tree-like
# index structure (just like the one that is generated for HTML Help). For this
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
# (i.e. any modern browser). Windows users are probably better off using the
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
# further fine-tune the look of the index. As an example, the default style
# sheet generated by doxygen has an example that shows how to put an image at
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# the same information as the tab index, you could consider setting
# DISABLE_INDEX to YES when enabling this option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1440
1441
1442

GENERATE_TREEVIEW      = YES

Jan Möbius's avatar
Jan Möbius committed
1443
1444
1445
1446
1447
1448
1449
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
#
# Note that a value of 0 will completely suppress the enum values from appearing
# in the overview section.
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1450
1451
1452

ENUM_VALUES_PER_LINE   = 4

Jan Möbius's avatar
Jan Möbius committed
1453
1454
1455
1456
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
# to set the initial width (in pixels) of the frame in which the tree is shown.
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1457
1458
1459

TREEVIEW_WIDTH         = 250

Jan Möbius's avatar
Jan Möbius committed
1460
1461
1462
1463
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1464
1465
1466

EXT_LINKS_IN_WINDOW    = NO

Jan Möbius's avatar
Jan Möbius committed
1467
1468
1469
1470
1471
1472
# Use this tag to change the font size of LaTeX formulas included as images in
# the HTML documentation. When you change the font size after a successful
# doxygen run you need to manually remove any form_*.png images from the HTML
# output directory to force them to be regenerated.
# Minimum value: 8, maximum value: 50, default value: 10.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1473
1474
1475
1476

FORMULA_FONTSIZE       = 10

# Use the FORMULA_TRANPARENT tag to determine whether or not the images
Jan Möbius's avatar
Jan Möbius committed
1477
1478
1479
1480
1481
1482
1483
# generated for formulas are transparent PNGs. Transparent PNGs are not
# supported properly for IE 6.0, but are supported on all modern browsers.
#
# Note that when changing this option you need to delete any form_*.png files in
# the HTML output directory before the changes have effect.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1484
1485
1486

FORMULA_TRANSPARENT    = YES

Jan Möbius's avatar
Jan Möbius committed
1487
1488
1489
1490
1491
1492
1493
1494
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# http://www.mathjax.org) which uses client side Javascript for the rendering
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
# installed or if you want to formulas look prettier in the HTML output. When
# enabled you may also need to install MathJax separately and configure the path
# to it using the MATHJAX_RELPATH option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1495
1496
1497

USE_MATHJAX            = NO

Jan Möbius's avatar
Jan Möbius committed
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
# http://docs.mathjax.org/en/latest/output.html) for more details.
# Possible values are: HTML-CSS (which is slower, but has the best
# compatibility), NativeMML (i.e. MathML) and SVG.
# The default value is: HTML-CSS.
# This tag requires that the tag USE_MATHJAX is set to YES.

MATHJAX_FORMAT         = HTML-CSS

# When MathJax is enabled you need to specify the location relative to the HTML
# output directory using the MATHJAX_RELPATH option. The destination directory
# should contain the MathJax.js script. For instance, if the mathjax directory
# is located at the same level as the HTML output directory, then
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
# Content Delivery Network so you can quickly see the result without installing
# MathJax. However, it is strongly recommended to install a local copy of
# MathJax from http://www.mathjax.org before deployment.
# The default value is: http://cdn.mathjax.org/mathjax/latest.
# This tag requires that the tag USE_MATHJAX is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1518
1519
1520

MATHJAX_RELPATH        = http://www.mathjax.org/mathjax

Jan Möbius's avatar
Jan Möbius committed
1521
1522
1523
1524
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
# This tag requires that the tag USE_MATHJAX is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1525
1526
1527

MATHJAX_EXTENSIONS     =

Jan Möbius's avatar
Jan Möbius committed
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# of code that will be used on startup of the MathJax code. See the MathJax site
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
# example see the documentation.
# This tag requires that the tag USE_MATHJAX is set to YES.

MATHJAX_CODEFILE       =

# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
# the HTML output. The underlying search engine uses javascript and DHTML and
# should work on any modern browser. Note that when using HTML help
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
# there is already a search function so this one should typically be disabled.
# For large projects the javascript based search engine can be slow, then
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
# search using the keyboard; to jump to the search box use <access key> + S
# (what the <access key> is depends on the OS and browser, but it is typically
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
# key> to jump into the search results window, the results can be navigated
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
# the search. The filter options can be selected when the cursor is inside the
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
# to select a filter and <Enter> or <escape> to activate or cancel the filter
# option.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1554
1555
1556
1557

SEARCHENGINE           = YES

# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
Jan Möbius's avatar
Jan Möbius committed
1558
1559
1560
1561
1562
1563
1564
1565
# implemented using a web server instead of a web client using Javascript. There
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
# setting. When disabled, doxygen will generate a PHP script for searching and
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
# and searching needs to be provided by external tools. See the section
# "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1566
1567
1568

SERVER_BASED_SEARCH    = NO

Jan Möbius's avatar
Jan Möbius committed
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
# script for searching. Instead the search results are written to an XML file
# which needs to be processed by an external indexer. Doxygen will invoke an
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
# search results.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.

EXTERNAL_SEARCH        = NO

# The SEARCHENGINE_URL should point to a search engine hosted by a web server
# which will return the search results when EXTERNAL_SEARCH is enabled.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/). See the section "External Indexing and
# Searching" for details.
# This tag requires that the tag SEARCHENGINE is set to YES.

SEARCHENGINE_URL       =

# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
# search data is written to a file for indexing by an external tool. With the
# SEARCHDATA_FILE tag the name of this file can be specified.
# The default file is: searchdata.xml.
# This tag requires that the tag SEARCHENGINE is set to YES.

SEARCHDATA_FILE        = searchdata.xml

# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
# projects and redirect the results back to the right project.
# This tag requires that the tag SEARCHENGINE is set to YES.

EXTERNAL_SEARCH_ID     =

# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
# projects other than the one defined by this configuration file, but that are
# all added to the same external search index. Each project needs to have a
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
# to a relative location where the documentation can be found. The format is:
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
# This tag requires that the tag SEARCHENGINE is set to YES.

EXTRA_SEARCH_MAPPINGS  =

Mike Kremer's avatar
Mike Kremer committed
1622
#---------------------------------------------------------------------------
Jan Möbius's avatar
Jan Möbius committed
1623
# Configuration options related to the LaTeX output
Mike Kremer's avatar
Mike Kremer committed
1624
1625
#---------------------------------------------------------------------------

Jan Möbius's avatar
Jan Möbius committed
1626
1627
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
Mike Kremer's avatar
Mike Kremer committed
1628
1629
1630

GENERATE_LATEX         = YES

Jan Möbius's avatar
Jan Möbius committed
1631
1632
1633
1634
1635
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1636
1637
1638
1639

LATEX_OUTPUT           = latex

# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
Jan Möbius's avatar
Jan Möbius committed
1640
1641
1642
1643
1644
1645
1646
# invoked.
#
# Note that when enabling USE_PDFLATEX this option is only used for generating
# bitmaps for formulas in the HTML output, but not in the Makefile that is
# written to the output directory.
# The default file is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
Mike Kremer's avatar
Mike Kremer committed
1647
1648
1649

LATEX_CMD_NAME         = latex

Jan Möbius's avatar
Jan Möbius committed
1650
1651
1652
1653
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
# index for LaTeX.
# The default file is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
Mike Kremer's avatar
Mike Kremer committed