Project

General

Profile

0001-Issue-6334-Build-Doxygen-docs-for-cetlib.patch

Ben Morgan, 02/05/2016 02:12 PM

View differences:

CMakeLists.txt
57 57
add_subdirectory( test )             # test code
58 58
add_subdirectory( ups )              # ups files
59 59

  
60
#-----------------------------------------------------------------------
61
# Documentation
62
#
63
find_package(Doxygen 1.8)
64
if(DOXYGEN_FOUND)
65
  set(DOXYGEN_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/Doxygen")
66
  configure_file(Doxyfile.in Doxyfile @ONLY)
67
  add_custom_command(
68
    OUTPUT "${DOXYGEN_OUTPUT_DIR}/html/index.html"
69
    COMMAND "${DOXYGEN_EXECUTABLE}" "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile"
70
    WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
71
    DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile" cetlib
72
    COMMENT "Generating Doxygen docs for ${PROJECT_NAME}"
73
    )
74
  add_custom_target(doc ALL DEPENDS "${DOXYGEN_OUTPUT_DIR}/html/index.html")
75
endif()
76

  
60 77
# ----------------------------------------------------------------------
61 78
# Packaging utility
62 79

  
Doxyfile.in
1
# Doxyfile 1.8.10
2

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

  
16
#---------------------------------------------------------------------------
17
# Project related configuration options
18
#---------------------------------------------------------------------------
19

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

  
27
DOXYFILE_ENCODING      = UTF-8
28

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

  
35
PROJECT_NAME           = "@PROJECT_NAME@"
36

  
37
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38
# could be handy for archiving the generated documentation or if some version
39
# control system is used.
40

  
41
PROJECT_NUMBER         ="@cet_dot_version@"
42

  
43
# Using the PROJECT_BRIEF tag one can provide an optional one line description
44
# for a project that appears at the top of each page and should give viewer a
45
# quick idea about the purpose of the project. Keep the description short.
46

  
47
PROJECT_BRIEF          =
48

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

  
54
PROJECT_LOGO           =
55

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

  
61
OUTPUT_DIRECTORY       = "@DOXYGEN_OUTPUT_DIR@"
62

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

  
71
CREATE_SUBDIRS         = NO
72

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

  
79
ALLOW_UNICODE_NAMES    = NO
80

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

  
94
OUTPUT_LANGUAGE        = English
95

  
96
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
97
# descriptions after the members that are listed in the file and class
98
# documentation (similar to Javadoc). Set to NO to disable this.
99
# The default value is: YES.
100

  
101
BRIEF_MEMBER_DESC      = YES
102

  
103
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
104
# description of a member or function before the detailed description
105
#
106
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107
# brief descriptions will be completely suppressed.
108
# The default value is: YES.
109

  
110
REPEAT_BRIEF           = YES
111

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

  
121
ABBREVIATE_BRIEF       =
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
125
# description.
126
# The default value is: NO.
127

  
128
ALWAYS_DETAILED_SEC    = NO
129

  
130
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131
# inherited members of a class in the documentation of that class as if those
132
# members were ordinary class members. Constructors, destructors and assignment
133
# operators of the base classes will not be shown.
134
# The default value is: NO.
135

  
136
INLINE_INHERITED_MEMB  = NO
137

  
138
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
139
# before files name in the file list and in the header files. If set to NO the
140
# shortest path that makes the file name unique will be used
141
# The default value is: YES.
142

  
143
FULL_PATH_NAMES        = YES
144

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

  
155
STRIP_FROM_PATH        = "@PROJECT_SOURCE_DIR@"
156

  
157
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158
# path mentioned in the documentation of a class, which tells the reader which
159
# header file to include in order to use a class. If left blank only the name of
160
# the header file containing the class definition is used. Otherwise one should
161
# specify the list of include paths that are normally passed to the compiler
162
# using the -I flag.
163

  
164
STRIP_FROM_INC_PATH    = "@PROJECT_SOURCE_DIR@"
165

  
166
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167
# less readable) file names. This can be useful is your file systems doesn't
168
# support long names like on DOS, Mac, or CD-ROM.
169
# The default value is: NO.
170

  
171
SHORT_NAMES            = NO
172

  
173
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174
# first line (until the first dot) of a Javadoc-style comment as the brief
175
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
176
# style comments (thus requiring an explicit @brief command for a brief
177
# description.)
178
# The default value is: NO.
179

  
180
JAVADOC_AUTOBRIEF      = NO
181

  
182
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183
# line (until the first dot) of a Qt-style comment as the brief description. If
184
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
185
# requiring an explicit \brief command for a brief description.)
186
# The default value is: NO.
187

  
188
QT_AUTOBRIEF           = NO
189

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

  
200
MULTILINE_CPP_IS_BRIEF = NO
201

  
202
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
203
# documentation from any documented member that it re-implements.
204
# The default value is: YES.
205

  
206
INHERIT_DOCS           = YES
207

  
208
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
209
# page for each member. If set to NO, the documentation of a member will be part
210
# of the file/class/namespace that contains it.
211
# The default value is: NO.
212

  
213
SEPARATE_MEMBER_PAGES  = NO
214

  
215
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216
# uses this value to replace tabs by spaces in code fragments.
217
# Minimum value: 1, maximum value: 16, default value: 4.
218

  
219
TAB_SIZE               = 4
220

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

  
231
ALIASES                =
232

  
233
# This tag can be used to specify a number of word-keyword mappings (TCL only).
234
# A mapping has the form "name=value". For example adding "class=itcl::class"
235
# will allow you to use the command class in the itcl::class meaning.
236

  
237
TCL_SUBST              =
238

  
239
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240
# only. Doxygen will then generate output that is more tailored for C. For
241
# instance, some of the names that are used will be different. The list of all
242
# members will be omitted, etc.
243
# The default value is: NO.
244

  
245
OPTIMIZE_OUTPUT_FOR_C  = NO
246

  
247
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
248
# Python sources only. Doxygen will then generate output that is more tailored
249
# for that language. For instance, namespaces will be presented as packages,
250
# qualified scopes will look different, etc.
251
# The default value is: NO.
252

  
253
OPTIMIZE_OUTPUT_JAVA   = NO
254

  
255
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
256
# sources. Doxygen will then generate output that is tailored for Fortran.
257
# The default value is: NO.
258

  
259
OPTIMIZE_FOR_FORTRAN   = NO
260

  
261
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
262
# sources. Doxygen will then generate output that is tailored for VHDL.
263
# The default value is: NO.
264

  
265
OPTIMIZE_OUTPUT_VHDL   = NO
266

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

  
284
EXTENSION_MAPPING      =
285

  
286
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287
# according to the Markdown format, which allows for more readable
288
# documentation. See http://daringfireball.net/projects/markdown/ for details.
289
# The output of markdown processing is further processed by doxygen, so you can
290
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
291
# case of backward compatibilities issues.
292
# The default value is: YES.
293

  
294
MARKDOWN_SUPPORT       = YES
295

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

  
302
AUTOLINK_SUPPORT       = YES
303

  
304
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
305
# to include (a tag file for) the STL sources as input, then you should set this
306
# tag to YES in order to let doxygen match functions declarations and
307
# definitions whose arguments contain STL classes (e.g. func(std::string);
308
# versus func(std::string) {}). This also make the inheritance and collaboration
309
# diagrams that involve STL classes more complete and accurate.
310
# The default value is: NO.
311

  
312
BUILTIN_STL_SUPPORT    = NO
313

  
314
# If you use Microsoft's C++/CLI language, you should set this option to YES to
315
# enable parsing support.
316
# The default value is: NO.
317

  
318
CPP_CLI_SUPPORT        = NO
319

  
320
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
321
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
322
# will parse them like normal C++ but will assume all classes use public instead
323
# of private inheritance when no explicit protection keyword is present.
324
# The default value is: NO.
325

  
326
SIP_SUPPORT            = NO
327

  
328
# For Microsoft's IDL there are propget and propput attributes to indicate
329
# getter and setter methods for a property. Setting this option to YES will make
330
# doxygen to replace the get and set methods by a property in the documentation.
331
# This will only work if the methods are indeed getting or setting a simple
332
# type. If this is not the case, or you want to show the methods anyway, you
333
# should set this option to NO.
334
# The default value is: YES.
335

  
336
IDL_PROPERTY_SUPPORT   = YES
337

  
338
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
339
# tag is set to YES then doxygen will reuse the documentation of the first
340
# member in the group (if any) for the other members of the group. By default
341
# all members of a group must be documented explicitly.
342
# The default value is: NO.
343

  
344
DISTRIBUTE_GROUP_DOC   = NO
345

  
346
# If one adds a struct or class to a group and this option is enabled, then also
347
# any nested class or struct is added to the same group. By default this option
348
# is disabled and one has to add nested compounds explicitly via \ingroup.
349
# The default value is: NO.
350

  
351
GROUP_NESTED_COMPOUNDS = NO
352

  
353
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
354
# (for instance a group of public functions) to be put as a subgroup of that
355
# type (e.g. under the Public Functions section). Set it to NO to prevent
356
# subgrouping. Alternatively, this can be done per class using the
357
# \nosubgrouping command.
358
# The default value is: YES.
359

  
360
SUBGROUPING            = YES
361

  
362
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
363
# are shown inside the group in which they are included (e.g. using \ingroup)
364
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
365
# and RTF).
366
#
367
# Note that this feature does not work in combination with
368
# SEPARATE_MEMBER_PAGES.
369
# The default value is: NO.
370

  
371
INLINE_GROUPED_CLASSES = NO
372

  
373
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
374
# with only public data fields or simple typedef fields will be shown inline in
375
# the documentation of the scope in which they are defined (i.e. file,
376
# namespace, or group documentation), provided this scope is documented. If set
377
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
378
# Man pages) or section (for LaTeX and RTF).
379
# The default value is: NO.
380

  
381
INLINE_SIMPLE_STRUCTS  = NO
382

  
383
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
384
# enum is documented as struct, union, or enum with the name of the typedef. So
385
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
386
# with name TypeT. When disabled the typedef will appear as a member of a file,
387
# namespace, or class. And the struct will be named TypeS. This can typically be
388
# useful for C code in case the coding convention dictates that all compound
389
# types are typedef'ed and only the typedef is referenced, never the tag name.
390
# The default value is: NO.
391

  
392
TYPEDEF_HIDES_STRUCT   = NO
393

  
394
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
395
# cache is used to resolve symbols given their name and scope. Since this can be
396
# an expensive process and often the same symbol appears multiple times in the
397
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
398
# doxygen will become slower. If the cache is too large, memory is wasted. The
399
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
400
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
401
# symbols. At the end of a run doxygen will report the cache usage and suggest
402
# the optimal cache size from a speed point of view.
403
# Minimum value: 0, maximum value: 9, default value: 0.
404

  
405
LOOKUP_CACHE_SIZE      = 0
406

  
407
#---------------------------------------------------------------------------
408
# Build related configuration options
409
#---------------------------------------------------------------------------
410

  
411
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
412
# documentation are documented, even if no documentation was available. Private
413
# class members and static file members will be hidden unless the
414
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
415
# Note: This will also disable the warnings about undocumented members that are
416
# normally produced when WARNINGS is set to YES.
417
# The default value is: NO.
418

  
419
EXTRACT_ALL            = YES
420

  
421
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
422
# be included in the documentation.
423
# The default value is: NO.
424

  
425
EXTRACT_PRIVATE        = NO
426

  
427
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
428
# scope will be included in the documentation.
429
# The default value is: NO.
430

  
431
EXTRACT_PACKAGE        = NO
432

  
433
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
434
# included in the documentation.
435
# The default value is: NO.
436

  
437
EXTRACT_STATIC         = NO
438

  
439
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
440
# locally in source files will be included in the documentation. If set to NO,
441
# only classes defined in header files are included. Does not have any effect
442
# for Java sources.
443
# The default value is: YES.
444

  
445
EXTRACT_LOCAL_CLASSES  = YES
446

  
447
# This flag is only useful for Objective-C code. If set to YES, local methods,
448
# which are defined in the implementation section but not in the interface are
449
# included in the documentation. If set to NO, only methods in the interface are
450
# included.
451
# The default value is: NO.
452

  
453
EXTRACT_LOCAL_METHODS  = NO
454

  
455
# If this flag is set to YES, the members of anonymous namespaces will be
456
# extracted and appear in the documentation as a namespace called
457
# 'anonymous_namespace{file}', where file will be replaced with the base name of
458
# the file that contains the anonymous namespace. By default anonymous namespace
459
# are hidden.
460
# The default value is: NO.
461

  
462
EXTRACT_ANON_NSPACES   = NO
463

  
464
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
465
# undocumented members inside documented classes or files. If set to NO these
466
# members will be included in the various overviews, but no documentation
467
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
468
# The default value is: NO.
469

  
470
HIDE_UNDOC_MEMBERS     = NO
471

  
472
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
473
# undocumented classes that are normally visible in the class hierarchy. If set
474
# to NO, these classes will be included in the various overviews. This option
475
# has no effect if EXTRACT_ALL is enabled.
476
# The default value is: NO.
477

  
478
HIDE_UNDOC_CLASSES     = NO
479

  
480
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
481
# (class|struct|union) declarations. If set to NO, these declarations will be
482
# included in the documentation.
483
# The default value is: NO.
484

  
485
HIDE_FRIEND_COMPOUNDS  = NO
486

  
487
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
488
# documentation blocks found inside the body of a function. If set to NO, these
489
# blocks will be appended to the function's detailed documentation block.
490
# The default value is: NO.
491

  
492
HIDE_IN_BODY_DOCS      = NO
493

  
494
# The INTERNAL_DOCS tag determines if documentation that is typed after a
495
# \internal command is included. If the tag is set to NO then the documentation
496
# will be excluded. Set it to YES to include the internal documentation.
497
# The default value is: NO.
498

  
499
INTERNAL_DOCS          = NO
500

  
501
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
502
# names in lower-case letters. If set to YES, upper-case letters are also
503
# allowed. This is useful if you have classes or files whose names only differ
504
# in case and if your file system supports case sensitive file names. Windows
505
# and Mac users are advised to set this option to NO.
506
# The default value is: system dependent.
507

  
508
CASE_SENSE_NAMES       = NO
509

  
510
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
511
# their full class and namespace scopes in the documentation. If set to YES, the
512
# scope will be hidden.
513
# The default value is: NO.
514

  
515
HIDE_SCOPE_NAMES       = NO
516

  
517
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
518
# append additional text to a page's title, such as Class Reference. If set to
519
# YES the compound reference will be hidden.
520
# The default value is: NO.
521

  
522
HIDE_COMPOUND_REFERENCE= NO
523

  
524
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
525
# the files that are included by a file in the documentation of that file.
526
# The default value is: YES.
527

  
528
SHOW_INCLUDE_FILES     = YES
529

  
530
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
531
# grouped member an include statement to the documentation, telling the reader
532
# which file to include in order to use the member.
533
# The default value is: NO.
534

  
535
SHOW_GROUPED_MEMB_INC  = NO
536

  
537
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
538
# files with double quotes in the documentation rather than with sharp brackets.
539
# The default value is: NO.
540

  
541
FORCE_LOCAL_INCLUDES   = NO
542

  
543
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
544
# documentation for inline members.
545
# The default value is: YES.
546

  
547
INLINE_INFO            = YES
548

  
549
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
550
# (detailed) documentation of file and class members alphabetically by member
551
# name. If set to NO, the members will appear in declaration order.
552
# The default value is: YES.
553

  
554
SORT_MEMBER_DOCS       = YES
555

  
556
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
557
# descriptions of file, namespace and class members alphabetically by member
558
# name. If set to NO, the members will appear in declaration order. Note that
559
# this will also influence the order of the classes in the class list.
560
# The default value is: NO.
561

  
562
SORT_BRIEF_DOCS        = NO
563

  
564
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
565
# (brief and detailed) documentation of class members so that constructors and
566
# destructors are listed first. If set to NO the constructors will appear in the
567
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
568
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
569
# member documentation.
570
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
571
# detailed member documentation.
572
# The default value is: NO.
573

  
574
SORT_MEMBERS_CTORS_1ST = NO
575

  
576
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
577
# of group names into alphabetical order. If set to NO the group names will
578
# appear in their defined order.
579
# The default value is: NO.
580

  
581
SORT_GROUP_NAMES       = NO
582

  
583
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
584
# fully-qualified names, including namespaces. If set to NO, the class list will
585
# be sorted only by class name, not including the namespace part.
586
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
587
# Note: This option applies only to the class list, not to the alphabetical
588
# list.
589
# The default value is: NO.
590

  
591
SORT_BY_SCOPE_NAME     = NO
592

  
593
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
594
# type resolution of all parameters of a function it will reject a match between
595
# the prototype and the implementation of a member function even if there is
596
# only one candidate or it is obvious which candidate to choose by doing a
597
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
598
# accept a match between prototype and implementation in such cases.
599
# The default value is: NO.
600

  
601
STRICT_PROTO_MATCHING  = NO
602

  
603
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
604
# list. This list is created by putting \todo commands in the documentation.
605
# The default value is: YES.
606

  
607
GENERATE_TODOLIST      = YES
608

  
609
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
610
# list. This list is created by putting \test commands in the documentation.
611
# The default value is: YES.
612

  
613
GENERATE_TESTLIST      = YES
614

  
615
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
616
# list. This list is created by putting \bug commands in the documentation.
617
# The default value is: YES.
618

  
619
GENERATE_BUGLIST       = YES
620

  
621
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
622
# the deprecated list. This list is created by putting \deprecated commands in
623
# the documentation.
624
# The default value is: YES.
625

  
626
GENERATE_DEPRECATEDLIST= YES
627

  
628
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
629
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
630
# ... \endcond blocks.
631

  
632
ENABLED_SECTIONS       =
633

  
634
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
635
# initial value of a variable or macro / define can have for it to appear in the
636
# documentation. If the initializer consists of more lines than specified here
637
# it will be hidden. Use a value of 0 to hide initializers completely. The
638
# appearance of the value of individual variables and macros / defines can be
639
# controlled using \showinitializer or \hideinitializer command in the
640
# documentation regardless of this setting.
641
# Minimum value: 0, maximum value: 10000, default value: 30.
642

  
643
MAX_INITIALIZER_LINES  = 30
644

  
645
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
646
# the bottom of the documentation of classes and structs. If set to YES, the
647
# list will mention the files that were used to generate the documentation.
648
# The default value is: YES.
649

  
650
SHOW_USED_FILES        = YES
651

  
652
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
653
# will remove the Files entry from the Quick Index and from the Folder Tree View
654
# (if specified).
655
# The default value is: YES.
656

  
657
SHOW_FILES             = YES
658

  
659
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
660
# page. This will remove the Namespaces entry from the Quick Index and from the
661
# Folder Tree View (if specified).
662
# The default value is: YES.
663

  
664
SHOW_NAMESPACES        = YES
665

  
666
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
667
# doxygen should invoke to get the current version for each file (typically from
668
# the version control system). Doxygen will invoke the program by executing (via
669
# popen()) the command command input-file, where command is the value of the
670
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
671
# by doxygen. Whatever the program writes to standard output is used as the file
672
# version. For an example see the documentation.
673

  
674
FILE_VERSION_FILTER    =
675

  
676
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
677
# by doxygen. The layout file controls the global structure of the generated
678
# output files in an output format independent way. To create the layout file
679
# that represents doxygen's defaults, run doxygen with the -l option. You can
680
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
681
# will be used as the name of the layout file.
682
#
683
# Note that if you run doxygen from a directory containing a file called
684
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
685
# tag is left empty.
686

  
687
LAYOUT_FILE            =
688

  
689
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
690
# the reference definitions. This must be a list of .bib files. The .bib
691
# extension is automatically appended if omitted. This requires the bibtex tool
692
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
693
# For LaTeX the style of the bibliography can be controlled using
694
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
695
# search path. See also \cite for info how to create references.
696

  
697
CITE_BIB_FILES         =
698

  
699
#---------------------------------------------------------------------------
700
# Configuration options related to warning and progress messages
701
#---------------------------------------------------------------------------
702

  
703
# The QUIET tag can be used to turn on/off the messages that are generated to
704
# standard output by doxygen. If QUIET is set to YES this implies that the
705
# messages are off.
706
# The default value is: NO.
707

  
708
QUIET                  = NO
709

  
710
# The WARNINGS tag can be used to turn on/off the warning messages that are
711
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
712
# this implies that the warnings are on.
713
#
714
# Tip: Turn warnings on while writing the documentation.
715
# The default value is: YES.
716

  
717
WARNINGS               = YES
718

  
719
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
720
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
721
# will automatically be disabled.
722
# The default value is: YES.
723

  
724
WARN_IF_UNDOCUMENTED   = YES
725

  
726
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
727
# potential errors in the documentation, such as not documenting some parameters
728
# in a documented function, or documenting parameters that don't exist or using
729
# markup commands wrongly.
730
# The default value is: YES.
731

  
732
WARN_IF_DOC_ERROR      = YES
733

  
734
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
735
# are documented, but have no documentation for their parameters or return
736
# value. If set to NO, doxygen will only warn about wrong or incomplete
737
# parameter documentation, but not about the absence of documentation.
738
# The default value is: NO.
739

  
740
WARN_NO_PARAMDOC       = NO
741

  
742
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
743
# can produce. The string should contain the $file, $line, and $text tags, which
744
# will be replaced by the file and line number from which the warning originated
745
# and the warning text. Optionally the format may contain $version, which will
746
# be replaced by the version of the file (if it could be obtained via
747
# FILE_VERSION_FILTER)
748
# The default value is: $file:$line: $text.
749

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

  
752
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
753
# messages should be written. If left blank the output is written to standard
754
# error (stderr).
755

  
756
WARN_LOGFILE           =
757

  
758
#---------------------------------------------------------------------------
759
# Configuration options related to the input files
760
#---------------------------------------------------------------------------
761

  
762
# The INPUT tag is used to specify the files and/or directories that contain
763
# documented source files. You may enter file names like myfile.cpp or
764
# directories like /usr/src/myproject. Separate the files or directories with
765
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
766
# Note: If this tag is empty the current directory is searched.
767

  
768
INPUT                  = "@PROJECT_SOURCE_DIR@/README.md" \
769
                         "@PROJECT_SOURCE_DIR@/cetlib" \
770
                         "@PROJECT_SOURCE_DIR@/polarssl"
771

  
772
# This tag can be used to specify the character encoding of the source files
773
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
774
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
775
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
776
# possible encodings.
777
# The default value is: UTF-8.
778

  
779
INPUT_ENCODING         = UTF-8
780

  
781
# If the value of the INPUT tag contains directories, you can use the
782
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
783
# *.h) to filter out the source-files in the directories.
784
#
785
# Note that for custom extensions or not directly supported extensions you also
786
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
787
# read by doxygen.
788
#
789
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
790
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
791
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
792
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd,
793
# *.vhdl, *.ucf, *.qsf, *.as and *.js.
794

  
795
FILE_PATTERNS          =
796

  
797
# The RECURSIVE tag can be used to specify whether or not subdirectories should
798
# be searched for input files as well.
799
# The default value is: NO.
800

  
801
RECURSIVE              = YES
802

  
803
# The EXCLUDE tag can be used to specify files and/or directories that should be
804
# excluded from the INPUT source files. This way you can easily exclude a
805
# subdirectory from a directory tree whose root is specified with the INPUT tag.
806
#
807
# Note that relative paths are relative to the directory from which doxygen is
808
# run.
809

  
810
EXCLUDE                =
811

  
812
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
813
# directories that are symbolic links (a Unix file system feature) are excluded
814
# from the input.
815
# The default value is: NO.
816

  
817
EXCLUDE_SYMLINKS       = NO
818

  
819
# If the value of the INPUT tag contains directories, you can use the
820
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
821
# certain files from those directories.
822
#
823
# Note that the wildcards are matched against the file with absolute path, so to
824
# exclude all test directories for example use the pattern */test/*
825

  
826
EXCLUDE_PATTERNS       =
827

  
828
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
829
# (namespaces, classes, functions, etc.) that should be excluded from the
830
# output. The symbol name can be a fully qualified name, a word, or if the
831
# wildcard * is used, a substring. Examples: ANamespace, AClass,
832
# AClass::ANamespace, ANamespace::*Test
833
#
834
# Note that the wildcards are matched against the file with absolute path, so to
835
# exclude all test directories use the pattern */test/*
836

  
837
EXCLUDE_SYMBOLS        =
838

  
839
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
840
# that contain example code fragments that are included (see the \include
841
# command).
842

  
843
EXAMPLE_PATH           =
844

  
845
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
846
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
847
# *.h) to filter out the source-files in the directories. If left blank all
848
# files are included.
849

  
850
EXAMPLE_PATTERNS       =
851

  
852
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
853
# searched for input files to be used with the \include or \dontinclude commands
854
# irrespective of the value of the RECURSIVE tag.
855
# The default value is: NO.
856

  
857
EXAMPLE_RECURSIVE      = NO
858

  
859
# The IMAGE_PATH tag can be used to specify one or more files or directories
860
# that contain images that are to be included in the documentation (see the
861
# \image command).
862

  
863
IMAGE_PATH             =
864

  
865
# The INPUT_FILTER tag can be used to specify a program that doxygen should
866
# invoke to filter for each input file. Doxygen will invoke the filter program
867
# by executing (via popen()) the command:
868
#
869
# <filter> <input-file>
870
#
871
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
872
# name of an input file. Doxygen will then use the output that the filter
873
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
874
# will be ignored.
875
#
876
# Note that the filter must not add or remove lines; it is applied before the
877
# code is scanned, but not when the output code is generated. If lines are added
878
# or removed, the anchors will not be placed correctly.
879

  
880
INPUT_FILTER           =
881

  
882
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
883
# basis. Doxygen will compare the file name with each pattern and apply the
884
# filter if there is a match. The filters are a list of the form: pattern=filter
885
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
886
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
887
# patterns match the file name, INPUT_FILTER is applied.
888

  
889
FILTER_PATTERNS        =
890

  
891
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
892
# INPUT_FILTER) will also be used to filter the input files that are used for
893
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
894
# The default value is: NO.
895

  
896
FILTER_SOURCE_FILES    = NO
897

  
898
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
899
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
900
# it is also possible to disable source filtering for a specific pattern using
901
# *.ext= (so without naming a filter).
902
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
903

  
904
FILTER_SOURCE_PATTERNS =
905

  
906
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
907
# is part of the input, its contents will be placed on the main page
908
# (index.html). This can be useful if you have a project on for instance GitHub
909
# and want to reuse the introduction page also for the doxygen output.
910

  
911
USE_MDFILE_AS_MAINPAGE = "@PROJECT_SOURCE_DIR@/README.md"
912

  
913
#---------------------------------------------------------------------------
914
# Configuration options related to source browsing
915
#---------------------------------------------------------------------------
916

  
917
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
918
# generated. Documented entities will be cross-referenced with these sources.
919
#
920
# Note: To get rid of all source code in the generated output, make sure that
921
# also VERBATIM_HEADERS is set to NO.
922
# The default value is: NO.
923

  
924
SOURCE_BROWSER         = NO
925

  
926
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
927
# classes and enums directly into the documentation.
928
# The default value is: NO.
929

  
930
INLINE_SOURCES         = NO
931

  
932
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
933
# special comment blocks from generated source code fragments. Normal C, C++ and
934
# Fortran comments will always remain visible.
935
# The default value is: YES.
936

  
937
STRIP_CODE_COMMENTS    = YES
938

  
939
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
940
# function all documented functions referencing it will be listed.
941
# The default value is: NO.
942

  
943
REFERENCED_BY_RELATION = NO
944

  
945
# If the REFERENCES_RELATION tag is set to YES then for each documented function
946
# all documented entities called/used by that function will be listed.
947
# The default value is: NO.
948

  
949
REFERENCES_RELATION    = NO
950

  
951
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
952
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
953
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
954
# link to the documentation.
955
# The default value is: YES.
956

  
957
REFERENCES_LINK_SOURCE = YES
958

  
959
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
960
# source code will show a tooltip with additional information such as prototype,
961
# brief description and links to the definition and documentation. Since this
962
# will make the HTML file larger and loading of large files a bit slower, you
963
# can opt to disable this feature.
964
# The default value is: YES.
965
# This tag requires that the tag SOURCE_BROWSER is set to YES.
966

  
967
SOURCE_TOOLTIPS        = YES
968

  
969
# If the USE_HTAGS tag is set to YES then the references to source code will
970
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
971
# source browser. The htags tool is part of GNU's global source tagging system
972
# (see http://www.gnu.org/software/global/global.html). You will need version
973
# 4.8.6 or higher.
974
#
975
# To use it do the following:
976
# - Install the latest version of global
977
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
978
# - Make sure the INPUT points to the root of the source tree
979
# - Run doxygen as normal
980
#
981
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
982
# tools must be available from the command line (i.e. in the search path).
983
#
984
# The result: instead of the source browser generated by doxygen, the links to
985
# source code will now point to the output of htags.
986
# The default value is: NO.
987
# This tag requires that the tag SOURCE_BROWSER is set to YES.
988

  
989
USE_HTAGS              = NO
990

  
991
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
992
# verbatim copy of the header file for each class for which an include is
993
# specified. Set to NO to disable this.
994
# See also: Section \class.
995
# The default value is: YES.
996

  
997
VERBATIM_HEADERS       = YES
998

  
999
#---------------------------------------------------------------------------
1000
# Configuration options related to the alphabetical class index
1001
#---------------------------------------------------------------------------
1002

  
1003
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1004
# compounds will be generated. Enable this if the project contains a lot of
1005
# classes, structs, unions or interfaces.
1006
# The default value is: YES.
1007

  
1008
ALPHABETICAL_INDEX     = YES
1009

  
1010
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1011
# which the alphabetical index list will be split.
1012
# Minimum value: 1, maximum value: 20, default value: 5.
1013
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1014

  
1015
COLS_IN_ALPHA_INDEX    = 5
1016

  
1017
# In case all classes in a project start with a common prefix, all classes will
1018
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1019
# can be used to specify a prefix (or a list of prefixes) that should be ignored
1020
# while generating the index headers.
1021
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1022

  
1023
IGNORE_PREFIX          =
1024

  
1025
#---------------------------------------------------------------------------
1026
# Configuration options related to the HTML output
1027
#---------------------------------------------------------------------------
1028

  
1029
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1030
# The default value is: YES.
1031

  
1032
GENERATE_HTML          = YES
1033

  
1034
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1035
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1036
# it.
1037
# The default directory is: html.
1038
# This tag requires that the tag GENERATE_HTML is set to YES.
1039

  
1040
HTML_OUTPUT            = html
1041

  
1042
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1043
# generated HTML page (for example: .htm, .php, .asp).
1044
# The default value is: .html.
1045
# This tag requires that the tag GENERATE_HTML is set to YES.
1046

  
1047
HTML_FILE_EXTENSION    = .html
1048

  
1049
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1050
# each generated HTML page. If the tag is left blank doxygen will generate a
1051
# standard header.
1052
#
1053
# To get valid HTML the header file that includes any scripts and style sheets
1054
# that doxygen needs, which is dependent on the configuration options used (e.g.
1055
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1056
# default header using
1057
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1058
# YourConfigFile
1059
# and then modify the file new_header.html. See also section "Doxygen usage"
1060
# for information on how to generate the default header that doxygen normally
1061
# uses.
1062
# Note: The header is subject to change so you typically have to regenerate the
1063
# default header when upgrading to a newer version of doxygen. For a description
1064
# of the possible markers and block names see the documentation.
1065
# This tag requires that the tag GENERATE_HTML is set to YES.
1066

  
1067
HTML_HEADER            =
1068

  
1069
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1070
# generated HTML page. If the tag is left blank doxygen will generate a standard
1071
# footer. See HTML_HEADER for more information on how to generate a default
1072
# footer and what special commands can be used inside the footer. See also
1073
# section "Doxygen usage" for information on how to generate the default footer
1074
# that doxygen normally uses.
1075
# This tag requires that the tag GENERATE_HTML is set to YES.
1076

  
1077
HTML_FOOTER            =
1078

  
1079
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1080
# sheet that is used by each HTML page. It can be used to fine-tune the look of
1081
# the HTML output. If left blank doxygen will generate a default style sheet.
1082
# See also section "Doxygen usage" for information on how to generate the style
1083
# sheet that doxygen normally uses.
1084
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1085
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1086
# obsolete.
1087
# This tag requires that the tag GENERATE_HTML is set to YES.
1088

  
1089
HTML_STYLESHEET        =
1090

  
1091
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1092
# cascading style sheets that are included after the standard style sheets
1093
# created by doxygen. Using this option one can overrule certain style aspects.
1094
# This is preferred over using HTML_STYLESHEET since it does not replace the
1095
# standard style sheet and is therefore more robust against future updates.
1096
# Doxygen will copy the style sheet files to the output directory.
1097
# Note: The order of the extra style sheet files is of importance (e.g. the last
1098
# style sheet in the list overrules the setting of the previous ones in the
1099
# list). For an example see the documentation.
1100
# This tag requires that the tag GENERATE_HTML is set to YES.
1101

  
1102
HTML_EXTRA_STYLESHEET  =
1103

  
1104
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1105
# other source files which should be copied to the HTML output directory. Note
1106
# that these files will be copied to the base HTML output directory. Use the
1107
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1108
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1109
# files will be copied as-is; there are no commands or markers available.
1110
# This tag requires that the tag GENERATE_HTML is set to YES.
1111

  
1112
HTML_EXTRA_FILES       =
1113

  
1114
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1115
# will adjust the colors in the style sheet and background images according to
1116
# this color. Hue is specified as an angle on a colorwheel, see
1117
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1118
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1119
# purple, and 360 is red again.
1120
# Minimum value: 0, maximum value: 359, default value: 220.
1121
# This tag requires that the tag GENERATE_HTML is set to YES.
1122

  
1123
HTML_COLORSTYLE_HUE    = 220
1124

  
1125
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1126
# in the HTML output. For a value of 0 the output will use grayscales only. A
1127
# value of 255 will produce the most vivid colors.
1128
# Minimum value: 0, maximum value: 255, default value: 100.
1129
# This tag requires that the tag GENERATE_HTML is set to YES.
1130

  
1131
HTML_COLORSTYLE_SAT    = 100
1132

  
1133
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1134
# luminance component of the colors in the HTML output. Values below 100
1135
# gradually make the output lighter, whereas values above 100 make the output
1136
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1137
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1138
# change the gamma.
1139
# Minimum value: 40, maximum value: 240, default value: 80.
1140
# This tag requires that the tag GENERATE_HTML is set to YES.
1141

  
1142
HTML_COLORSTYLE_GAMMA  = 80
1143

  
1144
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1145
# page will contain the date and time when the page was generated. Setting this
1146
# to YES can help to show when doxygen was last run and thus if the
1147
# documentation is up to date.
1148
# The default value is: NO.
1149
# This tag requires that the tag GENERATE_HTML is set to YES.
1150

  
1151
HTML_TIMESTAMP         = NO
1152

  
1153
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1154
# documentation will contain sections that can be hidden and shown after the
1155
# page has loaded.
1156
# The default value is: NO.
1157
# This tag requires that the tag GENERATE_HTML is set to YES.
1158

  
1159
HTML_DYNAMIC_SECTIONS  = NO
1160

  
1161
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1162
# shown in the various tree structured indices initially; the user can expand
1163
# and collapse entries dynamically later on. Doxygen will expand the tree to
1164
# such a level that at most the specified number of entries are visible (unless
1165
# a fully collapsed tree already exceeds this amount). So setting the number of
1166
# entries 1 will produce a full collapsed tree by default. 0 is a special value
1167
# representing an infinite number of entries and will result in a full expanded
1168
# tree by default.
1169
# Minimum value: 0, maximum value: 9999, default value: 100.
1170
# This tag requires that the tag GENERATE_HTML is set to YES.
1171

  
1172
HTML_INDEX_NUM_ENTRIES = 100
1173

  
1174
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1175
# generated that can be used as input for Apple's Xcode 3 integrated development
1176
# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1177
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1178
# Makefile in the HTML output directory. Running make will produce the docset in
1179
# that directory and running make install will install the docset in
1180
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1181
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1182
# for more information.
1183
# The default value is: NO.
1184
# This tag requires that the tag GENERATE_HTML is set to YES.
1185

  
1186
GENERATE_DOCSET        = NO
1187

  
1188
# This tag determines the name of the docset feed. A documentation feed provides
1189
# an umbrella under which multiple documentation sets from a single provider
1190
# (such as a company or product suite) can be grouped.
1191
# The default value is: Doxygen generated docs.
1192
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1193

  
1194
DOCSET_FEEDNAME        = "Doxygen generated docs"
1195

  
1196
# This tag specifies a string that should uniquely identify the documentation
1197
# set bundle. This should be a reverse domain-name style string, e.g.
1198
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1199
# The default value is: org.doxygen.Project.
1200
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1201

  
1202
DOCSET_BUNDLE_ID       = org.doxygen.Project
1203

  
1204
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1205
# the documentation publisher. This should be a reverse domain-name style
1206
# string, e.g. com.mycompany.MyDocSet.documentation.
1207
# The default value is: org.doxygen.Publisher.
1208
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1209

  
1210
DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1211

  
1212
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1213
# The default value is: Publisher.
1214
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1215

  
1216
DOCSET_PUBLISHER_NAME  = Publisher
1217

  
1218
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1219
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1220
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1221
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1222
# Windows.
1223
#
1224
# The HTML Help Workshop contains a compiler that can convert all HTML output
1225
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1226
# files are now used as the Windows 98 help format, and will replace the old
1227
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1228
# HTML files also contain an index, a table of contents, and you can search for
1229
# words in the documentation. The HTML workshop also contains a viewer for
1230
# compressed HTML files.
1231
# The default value is: NO.
1232
# This tag requires that the tag GENERATE_HTML is set to YES.
1233

  
1234
GENERATE_HTMLHELP      = NO
1235

  
1236
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1237
# file. You can add a path in front of the file if the result should not be
1238
# written to the html output directory.
1239
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1240

  
1241
CHM_FILE               =
1242

  
1243
# The HHC_LOCATION tag can be used to specify the location (absolute path
1244
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1245
# doxygen will try to run the HTML help compiler on the generated index.hhp.
1246
# The file has to be specified with full path.
1247
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1248

  
1249
HHC_LOCATION           =
1250

  
1251
# The GENERATE_CHI flag controls if a separate .chi index file is generated
1252
# (YES) or that it should be included in the master .chm file (NO).
1253
# The default value is: NO.
1254
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1255

  
1256
GENERATE_CHI           = NO
1257

  
1258
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1259
# and project file content.
1260
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1261

  
1262
CHM_INDEX_ENCODING     =
1263

  
1264
# The BINARY_TOC flag controls whether a binary table of contents is generated
1265
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1266
# enables the Previous and Next buttons.
1267
# The default value is: NO.
1268
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1269

  
1270
BINARY_TOC             = NO
1271

  
1272
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1273
# the table of contents of the HTML help documentation and to the tree view.
1274
# The default value is: NO.
1275
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1276

  
1277
TOC_EXPAND             = NO
1278

  
1279
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1280
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1281
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1282
# (.qch) of the generated HTML documentation.
1283
# The default value is: NO.
1284
# This tag requires that the tag GENERATE_HTML is set to YES.
1285

  
1286
GENERATE_QHP           = NO
1287

  
1288
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1289
# the file name of the resulting .qch file. The path specified is relative to
1290
# the HTML output folder.
1291
# This tag requires that the tag GENERATE_QHP is set to YES.
1292

  
1293
QCH_FILE               =
1294

  
1295
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1296
# Project output. For more information please see Qt Help Project / Namespace
1297
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1298
# The default value is: org.doxygen.Project.
1299
# This tag requires that the tag GENERATE_QHP is set to YES.
1300

  
1301
QHP_NAMESPACE          = org.doxygen.Project
1302

  
1303
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1304
# Help Project output. For more information please see Qt Help Project / Virtual
1305
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1306
# folders).
1307
# The default value is: doc.
1308
# This tag requires that the tag GENERATE_QHP is set to YES.
1309

  
1310
QHP_VIRTUAL_FOLDER     = doc
1311

  
1312
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1313
# filter to add. For more information please see Qt Help Project / Custom
1314
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1315
# filters).
1316
# This tag requires that the tag GENERATE_QHP is set to YES.
1317

  
1318
QHP_CUST_FILTER_NAME   =
1319

  
1320
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1321
# custom filter to add. For more information please see Qt Help Project / Custom
1322
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1323
# filters).
1324
# This tag requires that the tag GENERATE_QHP is set to YES.
1325

  
1326
QHP_CUST_FILTER_ATTRS  =
1327

  
1328
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1329
# project's filter section matches. Qt Help Project / Filter Attributes (see:
1330
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1331
# This tag requires that the tag GENERATE_QHP is set to YES.
1332

  
1333
QHP_SECT_FILTER_ATTRS  =
1334

  
1335
# The QHG_LOCATION tag can be used to specify the location of Qt's
1336
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1337
# generated .qhp file.
1338
# This tag requires that the tag GENERATE_QHP is set to YES.
1339

  
1340
QHG_LOCATION           =
1341

  
1342
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1343
# generated, together with the HTML files, they form an Eclipse help plugin. To
1344
# install this plugin and make it available under the help contents menu in
1345
# Eclipse, the contents of the directory containing the HTML and XML files needs
1346
# to be copied into the plugins directory of eclipse. The name of the directory
1347
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1348
# After copying Eclipse needs to be restarted before the help appears.
1349
# The default value is: NO.
1350
# This tag requires that the tag GENERATE_HTML is set to YES.
1351

  
1352
GENERATE_ECLIPSEHELP   = NO
1353

  
1354
# A unique identifier for the Eclipse help plugin. When installing the plugin
1355
# the directory name containing the HTML and XML files should also have this
1356
# name. Each documentation set should have its own identifier.
1357
# The default value is: org.doxygen.Project.
1358
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1359

  
1360
ECLIPSE_DOC_ID         = org.doxygen.Project
1361

  
1362
# If you want full control over the layout of the generated HTML pages it might
1363
# be necessary to disable the index and replace it with your own. The
1364
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1365
# of each HTML page. A value of NO enables the index and the value YES disables
1366
# it. Since the tabs in the index contain the same information as the navigation
1367
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1368
# The default value is: NO.
1369
# This tag requires that the tag GENERATE_HTML is set to YES.
1370

  
1371
DISABLE_INDEX          = NO
1372

  
1373
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1374
# structure should be generated to display hierarchical information. If the tag
1375
# value is set to YES, a side panel will be generated containing a tree-like
1376
# index structure (just like the one that is generated for HTML Help). For this
1377
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1378
# (i.e. any modern browser). Windows users are probably better off using the
1379
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1380
# further fine-tune the look of the index. As an example, the default style
1381
# sheet generated by doxygen has an example that shows how to put an image at
1382
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1383
# the same information as the tab index, you could consider setting
1384
# DISABLE_INDEX to YES when enabling this option.
1385
# The default value is: NO.
1386
# This tag requires that the tag GENERATE_HTML is set to YES.
1387

  
1388
GENERATE_TREEVIEW      = NO
1389

  
1390
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1391
# doxygen will group on one line in the generated HTML documentation.
1392
#
1393
# Note that a value of 0 will completely suppress the enum values from appearing
1394
# in the overview section.
1395
# Minimum value: 0, maximum value: 20, default value: 4.
1396
# This tag requires that the tag GENERATE_HTML is set to YES.
1397

  
1398
ENUM_VALUES_PER_LINE   = 4
1399

  
1400
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1401
# to set the initial width (in pixels) of the frame in which the tree is shown.
1402
# Minimum value: 0, maximum value: 1500, default value: 250.
1403
# This tag requires that the tag GENERATE_HTML is set to YES.
1404

  
1405
TREEVIEW_WIDTH         = 250
1406

  
1407
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1408
# external symbols imported via tag files in a separate window.
1409
# The default value is: NO.
1410
# This tag requires that the tag GENERATE_HTML is set to YES.
1411

  
1412
EXT_LINKS_IN_WINDOW    = NO
1413

  
1414
# Use this tag to change the font size of LaTeX formulas included as images in
1415
# the HTML documentation. When you change the font size after a successful
1416
# doxygen run you need to manually remove any form_*.png images from the HTML
1417
# output directory to force them to be regenerated.
1418
# Minimum value: 8, maximum value: 50, default value: 10.
1419
# This tag requires that the tag GENERATE_HTML is set to YES.
1420

  
1421
FORMULA_FONTSIZE       = 10
1422

  
1423
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1424
# generated for formulas are transparent PNGs. Transparent PNGs are not
1425
# supported properly for IE 6.0, but are supported on all modern browsers.
1426
#
1427
# Note that when changing this option you need to delete any form_*.png files in
1428
# the HTML output directory before the changes have effect.
... This diff was truncated because it exceeds the maximum size that can be displayed.