doxy.config.in 99.6 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1
# Doxyfile 1.8.7
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
2
3

# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
5
#
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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
10
# The format is:
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 (\" \").
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
15
16
17
18
19

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

20
# This tag specifies the encoding used for all characters in the config file
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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
26
27
28

DOXYFILE_ENCODING      = UTF-8

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
34
35
36

PROJECT_NAME           = OpenMesh

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
40
41
42

PROJECT_NUMBER         =

43
# Using the PROJECT_BRIEF tag one can provide an optional one line description
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.
46
47
48

PROJECT_BRIEF          =

49
50
51
52
# With the PROJECT_LOGO tag one can specify an logo or 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.
53
54
55

PROJECT_LOGO           =

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
60
61
62

OUTPUT_DIRECTORY       = @CMAKE_BINARY_DIR@/Build/@ACG_PROJECT_DATADIR@/Doc

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius 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

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.
84
85
86
87
88
89
90
91
# 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.
92
# The default value is: English.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
93
94
95

OUTPUT_LANGUAGE        = English

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
100
101
102

BRIEF_MEMBER_DESC      = YES

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
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
107
# brief descriptions will be completely suppressed.
108
# The default value is: YES.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
109
110
111

REPEAT_BRIEF           = YES

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
120

121
ABBREVIATE_BRIEF       =
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
122

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

ALWAYS_DETAILED_SEC    = NO

130
131
132
# 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
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
133
# operators of the base classes will not be shown.
134
# The default value is: NO.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
135
136
137

INLINE_INHERITED_MEMB  = NO

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
142
143
144

FULL_PATH_NAMES        = YES

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
154

155
156
STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@ \
                         @CMAKE_SOURCE_DIR@/src
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
157

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
164

165
166
STRIP_FROM_INC_PATH    = @CMAKE_SOURCE_DIR@ \
                         @CMAKE_SOURCE_DIR@/src
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
167

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
172

173
SHORT_NAMES            = YES
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
174

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
181
182
183

JAVADOC_AUTOBRIEF      = YES

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
189
190
191

QT_AUTOBRIEF           = NO

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
201
202
203

MULTILINE_CPP_IS_BRIEF = NO

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
207
208
209

INHERIT_DOCS           = YES

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
214
215
216

SEPARATE_MEMBER_PAGES  = NO

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
220
221
222

TAB_SIZE               = 8

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
232

233
234
235
ALIASES                =

# This tag can be used to specify a number of word-keyword mappings (TCL only).
236
237
# 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.
238
239

TCL_SUBST              =
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
240

241
242
243
244
245
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
246
247
248

OPTIMIZE_OUTPUT_FOR_C  = NO

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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
254
255
256

OPTIMIZE_OUTPUT_JAVA   = NO

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

OPTIMIZE_FOR_FORTRAN   = NO

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

OPTIMIZE_OUTPUT_VHDL   = NO

269
# 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
# 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
272
273
# 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,
Jan Möbius's avatar
Jan Möbius committed
274
275
276
277
278
279
# 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.
280
281
282
283
284
#
# 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.
285
286
287

EXTENSION_MAPPING      =

288
289
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
290
# documentation. See http://daringfireball.net/projects/markdown/ for details.
291
292
293
294
# 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.
295
296
297

MARKDOWN_SUPPORT       = YES

Jan Möbius's avatar
Jan Möbius committed
298
299
300
301
# 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 by putting a % sign in front of the word
# or globally by setting AUTOLINK_SUPPORT to NO.
302
# The default value is: YES.
Jan Möbius's avatar
Jan Möbius committed
303
304
305

AUTOLINK_SUPPORT       = YES

306
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
307
308
309
310
# 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
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
311
# diagrams that involve STL classes more complete and accurate.
312
# The default value is: NO.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
313

Jan Möbius's avatar
Jan Möbius committed
314
BUILTIN_STL_SUPPORT    = YES
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
315

316
# If you use Microsoft's C++/CLI language, you should set this option to YES to
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
317
# enable parsing support.
318
# The default value is: NO.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
319
320
321

CPP_CLI_SUPPORT        = NO

322
323
324
325
326
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
327
328
329

SIP_SUPPORT            = NO

Jan Möbius's avatar
Jan Möbius committed
330
# For Microsoft's IDL there are propget and propput attributes to indicate
331
332
333
334
335
336
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
337
338
339

IDL_PROPERTY_SUPPORT   = YES

340
341
342
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
343
# all members of a group must be documented explicitly.
344
# The default value is: NO.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
345
346
347

DISTRIBUTE_GROUP_DOC   = YES

348
349
350
351
352
353
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
354
355
356

SUBGROUPING            = YES

357
358
359
360
361
362
363
364
# 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.
365
366
367

INLINE_GROUPED_CLASSES = NO

368
369
370
# 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,
Jan Möbius's avatar
Jan Möbius committed
371
# namespace, or group documentation), provided this scope is documented. If set
372
373
374
# 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.
375
376
377

INLINE_SIMPLE_STRUCTS  = NO

378
379
# 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
380
381
# 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,
382
383
# 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
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
384
# types are typedef'ed and only the typedef is referenced, never the tag name.
385
# The default value is: NO.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
386
387
388

TYPEDEF_HIDES_STRUCT   = NO

Jan Möbius's avatar
Jan Möbius committed
389
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
390
391
392
393
394
395
396
397
398
# 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.
399
400
401

LOOKUP_CACHE_SIZE      = 0

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
402
403
404
405
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

406
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
407
408
409
410
411
412
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
413
414
415

EXTRACT_ALL            = NO

416
417
418
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
419
420
421

EXTRACT_PRIVATE        = NO

Jan Möbius's avatar
Jan Möbius committed
422
423
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
# scope will be included in the documentation.
424
# The default value is: NO.
425
426
427

EXTRACT_PACKAGE        = NO

428
429
430
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
431
432
433

EXTRACT_STATIC         = NO

434
435
436
437
438
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
439
440
441

EXTRACT_LOCAL_CLASSES  = YES

442
443
444
445
446
# This flag is only useful for Objective-C code. When 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
447
448
449

EXTRACT_LOCAL_METHODS  = NO

450
451
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
452
453
454
455
# '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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
456
457
458

EXTRACT_ANON_NSPACES   = NO

459
460
461
462
463
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
464
465
466

HIDE_UNDOC_MEMBERS     = NO

467
468
469
470
471
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
472
473
474

HIDE_UNDOC_CLASSES     = NO

475
476
477
478
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
479
480
481

HIDE_FRIEND_COMPOUNDS  = NO

482
483
484
485
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
486
487
488

HIDE_IN_BODY_DOCS      = NO

489
490
491
492
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
493
494
495

INTERNAL_DOCS          = YES

496
497
# 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
498
499
# 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
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
500
# and Mac users are advised to set this option to NO.
501
# The default value is: system dependent.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
502
503
504

CASE_SENSE_NAMES       = YES

505
506
507
508
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
509
510
511

HIDE_SCOPE_NAMES       = NO

512
513
514
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
515
516
517

SHOW_INCLUDE_FILES     = YES

518
519
520
521
522
523
524
# 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

525
526
527
# 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.
528
529
530

FORCE_LOCAL_INCLUDES   = NO

531
532
533
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
534
535
536

INLINE_INFO            = YES

537
538
539
540
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
541
542
543

SORT_MEMBER_DOCS       = YES

544
545
# 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
546
547
# 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.
548
# The default value is: NO.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
549
550
551

SORT_BRIEF_DOCS        = NO

552
553
554
555
556
557
558
559
560
# 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.
561
562
563

SORT_MEMBERS_CTORS_1ST = NO

564
565
566
567
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
568
569
570

SORT_GROUP_NAMES       = NO

571
572
573
# 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.
574
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
575
576
577
# Note: This option applies only to the class list, not to the alphabetical
# list.
# The default value is: NO.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
578
579
580

SORT_BY_SCOPE_NAME     = NO

581
582
583
584
585
586
587
# 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.
588
589
590

STRICT_PROTO_MATCHING  = NO

591
592
593
594
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
595
596
597

GENERATE_TODOLIST      = YES

598
599
600
601
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
602
603
604

GENERATE_TESTLIST      = YES

605
606
607
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
608
609
610

GENERATE_BUGLIST       = YES

611
612
613
614
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
615
616
617

GENERATE_DEPRECATEDLIST= YES

618
619
620
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \endcond blocks.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
621

622
ENABLED_SECTIONS       = OPENMESH_INTERNAL_DOC
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
623

624
625
626
627
628
629
630
631
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
632
633
634

MAX_INITIALIZER_LINES  = 30

635
636
637
638
# 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 list
# will mention the files that were used to generate the documentation.
# The default value is: YES.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
639
640
641

SHOW_USED_FILES        = YES

642
643
644
645
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
646
647
648

SHOW_FILES             = YES

649
650
651
652
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
653
654
655

SHOW_NAMESPACES        = YES

656
657
658
# 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
659
660
661
662
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
663

664
FILE_VERSION_FILTER    =
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
665

666
667
# 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
668
# output files in an output format independent way. To create the layout file
669
670
671
672
673
674
675
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
676

677
678
LAYOUT_FILE            =

679
680
681
682
683
684
685
686
# 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. Do not use file names with spaces, bibtex cannot handle them. See
# also \cite for info how to create references.
687
688

CITE_BIB_FILES         =
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
689
690

#---------------------------------------------------------------------------
691
# Configuration options related to warning and progress messages
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
692
693
#---------------------------------------------------------------------------

694
695
696
697
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
698
699
700

QUIET                  = YES

701
# The WARNINGS tag can be used to turn on/off the warning messages that are
702
703
704
705
706
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
707
708
709

WARNINGS               = YES

710
711
712
713
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
714

Jan Möbius's avatar
Jan Möbius committed
715
WARN_IF_UNDOCUMENTED   = NO
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
716

717
718
719
720
721
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
722
723
724

WARN_IF_DOC_ERROR      = YES

725
726
727
728
729
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
730
731
732

WARN_NO_PARAMDOC       = NO

733
734
735
736
737
738
739
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
740
741
742

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

743
744
745
# 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).
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
746

747
WARN_LOGFILE           =
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
748
749

#---------------------------------------------------------------------------
750
# Configuration options related to the input files
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
751
752
#---------------------------------------------------------------------------

753
754
755
756
757
# 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.
# Note: If this tag is empty the current directory is searched.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
758
759
760

INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/..

761
# This tag can be used to specify the character encoding of the source files
762
763
764
765
766
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
767
768
769

INPUT_ENCODING         = UTF-8

770
# If the value of the INPUT tag contains directories, you can use the
771
772
773
774
775
776
777
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# *.h) to filter out the source-files in the directories. 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, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
# *.qsf, *.as and *.js.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
778
779
780
781
782

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

783
784
785
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
786
787
788

RECURSIVE              = YES

789
790
# 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
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
791
# subdirectory from a directory tree whose root is specified with the INPUT tag.
792
#
793
794
# Note that relative paths are relative to the directory from which doxygen is
# run.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
795
796

EXCLUDE                = @CMAKE_CURRENT_SOURCE_DIR@/Examples \
Jan Möbius's avatar
Jan Möbius committed
797
                         @CMAKE_CURRENT_SOURCE_DIR@/../src/OpenMesh/Tools/Test \
Jan Möbius's avatar
Jan Möbius committed
798
                         @CMAKE_CURRENT_SOURCE_DIR@/../src/OpenMesh/Apps/Unsupported \
799
                         @CMAKE_CURRENT_BINARY_DIR@
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
800

801
802
# 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
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
803
# from the input.
804
# The default value is: NO.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
805
806
807

EXCLUDE_SYMLINKS       = NO

808
809
# 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
810
811
812
813
# 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/*
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
814
815
816
817
818
819
820

EXCLUDE_PATTERNS       = .svn \
                         CVS \
                         Debian64 \
                         *.moc.cc \
                         footer.hh

821
822
823
824
# 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,
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
825
# AClass::ANamespace, ANamespace::*Test
826
827
828
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
829

830
EXCLUDE_SYMBOLS        =
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
831

832
833
834
# 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).
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
835
836
837
838

EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/Examples \
                         @CMAKE_CURRENT_SOURCE_DIR@/Tutorial

839
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
840
841
842
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
843
844

EXAMPLE_PATTERNS       = *.cc \
Jan Möbius's avatar
Jan Möbius committed
845
846
                         *.hh \
                         *.txt
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
847

848
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
849
850
851
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
852
853
854

EXAMPLE_RECURSIVE      = NO

855
856
857
# 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).
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
858
859
860

IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/images

861
862
# 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
863
864
865
866
867
868
869
870
871
# 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.
#
Jan Möbius's avatar
Jan Möbius committed
872
873
874
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
875

876
INPUT_FILTER           =
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
877

878
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
879
880
881
882
883
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
884

885
FILTER_PATTERNS        =
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
886

887
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
888
889
890
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
891
892
893

FILTER_SOURCE_FILES    = NO

894
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
895
896
897
898
# 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.
899
900
901

FILTER_SOURCE_PATTERNS =

902
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
Jan Möbius's avatar
Jan Möbius committed
903
904
# 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
905
# and want to reuse the introduction page also for the doxygen output.
Jan Möbius's avatar
Jan Möbius committed
906
907
908

USE_MDFILE_AS_MAINPAGE =

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
909
#---------------------------------------------------------------------------
910
# Configuration options related to source browsing
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
911
912
#---------------------------------------------------------------------------

913
914
915
916
917
918
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
919
920
921

SOURCE_BROWSER         = NO

922
923
924
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
925
926
927

INLINE_SOURCES         = NO

928
929
930
931
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
932
933
934

STRIP_CODE_COMMENTS    = YES

935
936
937
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
938
939
940

REFERENCED_BY_RELATION = NO

941
942
943
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
944
945
946

REFERENCES_RELATION    = NO

947
948
949
950
951
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
952
953
954

REFERENCES_LINK_SOURCE = YES

955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
984
985
986

USE_HTAGS              = NO

987
988
989
990
991
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
992
993
994
995

VERBATIM_HEADERS       = YES

#---------------------------------------------------------------------------
996
# Configuration options related to the alphabetical class index
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
997
998
#---------------------------------------------------------------------------

999
1000
1001
1002
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
1003
1004
1005

ALPHABETICAL_INDEX     = NO

1006
1007
1008
1009
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
1010
1011
1012

COLS_IN_ALPHA_INDEX    = 5

1013
1014
1015
1016
1017
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
1018

1019
IGNORE_PREFIX          =
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
1020
1021

#---------------------------------------------------------------------------
1022
# Configuration options related to the HTML output
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
1023
1024
#---------------------------------------------------------------------------

1025
1026
# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
# The default value is: YES.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
1027
1028
1029

GENERATE_HTML          = YES

1030
1031
1032
1033
1034
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
1035
1036
1037

HTML_OUTPUT            = html

1038
1039
1040
1041
# 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.
Jan Möbius's avatar
Dennis:  
Jan Möbius committed
1042
1043
1044

HTML_FILE_EXTENSION    = .html

1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
# 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.
1062
1063
1064

HTML_HEADER            =