Doxyfile 66 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Doxyfile 1.6.3

# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
#
# All text after a hash (#) is considered a comment and will be ignored
# The format is:
#       TAG = value [value, ...]
# For lists items can also be appended using:
#       TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ")

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

17
18
19
20
# This tag specifies the encoding used for all characters in the config file
# 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
21
22
23
24
# http://www.gnu.org/software/libiconv for the list of possible encodings.

DOXYFILE_ENCODING      = UTF-8

25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26
27
28
29
# by quotes) that should identify the project.

PROJECT_NAME           = "MTL 4"

30
31
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
32
33
34
35
# if some version control system is used.

PROJECT_NUMBER         = ""

36
37
38
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
39
40
41
42
# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY       = libs/numeric/mtl/doc

43
44
45
46
47
# 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
48
49
50
51
# otherwise cause performance problems for the file system.

CREATE_SUBDIRS         = NO

52
53
54
55
56
57
58
59
60
# 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.
# The default language is English, other supported languages are:
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61
62
63
64
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.

OUTPUT_LANGUAGE        = English

65
66
67
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
68
69
70
71
# Set to NO to disable this.

BRIEF_MEMBER_DESC      = YES

72
73
74
# If the REPEAT_BRIEF tag is set to YES (the default) 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
75
76
77
78
# brief descriptions will be completely suppressed.

REPEAT_BRIEF           = YES

79
80
81
82
83
84
85
86
# 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"
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# "represents" "a" "an" "the"

ABBREVIATE_BRIEF       = "The $name class" \
                         "The $name widget" \
                         "The $name file" \
                         is \
                         provides \
                         specifies \
                         contains \
                         represents \
                         a \
                         an \
                         the

101
102
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# Doxygen will generate a detailed section even if there is only a brief
103
104
105
106
# description.

ALWAYS_DETAILED_SEC    = NO

107
108
109
# 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
110
111
112
113
# operators of the base classes will not be shown.

INLINE_INHERITED_MEMB  = NO

114
115
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
# path before files name in the file list and in the header files. If set
116
117
118
119
# to NO the shortest path that makes the file name unique will be used.

FULL_PATH_NAMES        = NO

120
121
122
123
124
# If the FULL_PATH_NAMES tag is set to YES then 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
125
126
127
128
# path to strip.

STRIP_FROM_PATH        = /Volumes/Doxygen/

129
130
131
132
133
# 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 include paths that
134
135
# are normally passed to the compiler using the -I flag.

136
STRIP_FROM_INC_PATH    =
137

138
139
# 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
140
141
142
143
# doesn't support long names like on DOS, Mac, or CD-ROM.

SHORT_NAMES            = NO

144
145
146
147
# 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
# comments will behave just like regular Qt-style comments
148
149
150
151
# (thus requiring an explicit @brief command for a brief description.)

JAVADOC_AUTOBRIEF      = NO

152
153
154
155
# 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 comments
# will behave just like regular Qt-style comments (thus requiring
156
157
158
159
# an explicit \brief command for a brief description.)

QT_AUTOBRIEF           = NO

160
161
162
163
# 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 behaviour.
# The new default is to treat a multi-line C++ comment block as a detailed
164
165
166
167
# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

168
169
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
170
171
172
173
# re-implements.

INHERIT_DOCS           = YES

174
175
# 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
176
177
178
179
# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  = NO

180
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
181
182
183
184
# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE               = 8

185
186
187
188
189
# This tag can be used to specify a number of aliases that acts
# 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:".
190
191
# You can put \n's in the value part of an alias to insert newlines.

192
ALIASES                =
193

194
195
196
# 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
197
198
199
200
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = NO

201
202
203
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
# sources only. Doxygen will then generate output that is more tailored for
# Java. For instance, namespaces will be presented as packages, qualified
204
205
206
207
# scopes will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

208
209
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for
210
211
212
213
# Fortran.

OPTIMIZE_FOR_FORTRAN   = NO

214
215
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
216
217
218
219
# VHDL.

OPTIMIZE_OUTPUT_VHDL   = NO

220
221
222
223
224
225
226
# Doxygen selects the parser to use depending on the extension of the files it parses.
# With this tag you can assign which parser to use for a given extension.
# Doxygen has a built-in mapping, but you can override or extend it using this tag.
# The format is ext=language, where ext is a file extension, and language is one of
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
227
228
229
# use: inc=Fortran f=C. Note that for custom extensions you also need to set
# FILE_PATTERNS otherwise the files are not read by doxygen.

230
EXTENSION_MAPPING      =
231

232
233
234
235
236
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# 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); v.s.
# func(std::string) {}). This also make the inheritance and collaboration
237
238
239
240
# diagrams that involve STL classes more complete and accurate.

BUILTIN_STL_SUPPORT    = NO

241
# If you use Microsoft's C++/CLI language, you should set this option to YES to
242
243
244
245
# enable parsing support.

CPP_CLI_SUPPORT        = NO

246
247
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
# Doxygen will parse them like normal C++ but will assume all classes use public
248
249
250
251
# instead of private inheritance when no explicit protection keyword is present.

SIP_SUPPORT            = NO

252
253
254
255
256
# For Microsoft's IDL there are propget and propput attributes to indicate getter
# and setter methods for a property. Setting this option to YES (the default)
# 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
257
258
259
260
# methods anyway, you should set this option to NO.

IDL_PROPERTY_SUPPORT   = YES

261
262
263
# 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
264
265
266
267
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = NO

268
269
270
271
# Set the SUBGROUPING tag to YES (the default) 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
272
273
274
275
# the \nosubgrouping command.

SUBGROUPING            = YES

276
277
278
279
280
281
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
# is documented as struct, union, or enum with the name of the typedef. So
# 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,
# 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
282
283
284
285
# types are typedef'ed and only the typedef is referenced, never the tag name.

TYPEDEF_HIDES_STRUCT   = NO

286
287
288
289
290
291
292
293
294
295
296
297
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
# determine which symbols to keep in memory and which to flush to disk.
# When the cache is full, less often used symbols will be written to disk.
# For small to medium size projects (<1000 input files) the default value is
# probably good enough. For larger projects a too small cache size can cause
# doxygen to be busy swapping symbols to and from disk most of the time
# causing a significant performance penality.
# If the system has enough physical memory increasing the cache will improve the
# performance by keeping more symbols in memory. Note that the value works on
# a logarithmic scale so increasing the size by one will rougly double the
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
298
299
300
301
302
303
304
305
# corresponding to a cache size of 2^16 = 65536 symbols

SYMBOL_CACHE_SIZE      = 0

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

306
307
308
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available.
# Private class members and static file members will be hidden unless
309
310
311
312
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

EXTRACT_ALL            = NO

313
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
314
315
316
317
# will be included in the documentation.

EXTRACT_PRIVATE        = NO

318
# If the EXTRACT_STATIC tag is set to YES all static members of a file
319
320
321
322
# will be included in the documentation.

EXTRACT_STATIC         = NO

323
324
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
325
326
327
328
# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

329
330
331
# 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.
332
333
334
335
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = NO

336
337
338
339
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base
# name of the file that contains the anonymous namespace. By default
340
341
342
343
# anonymous namespace are hidden.

EXTRACT_ANON_NSPACES   = NO

344
345
346
347
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# various overviews, but no documentation section is generated.
348
349
350
351
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = YES

352
353
354
# 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 (the default) these classes will be included in the various
355
356
357
358
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = YES

359
360
361
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
# friend (class|struct|union) declarations.
# If set to NO (the default) these declarations will be included in the
362
363
364
365
# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

366
367
368
# 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 (the default) these blocks will be appended to the
369
370
371
372
# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

373
374
375
# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
376
377
378
379
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = NO

380
381
382
383
# 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
# 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
384
385
386
387
# and Mac users are advised to set this option to NO.

CASE_SENSE_NAMES       = NO

388
389
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
# will show members with their full class and namespace scopes in the
390
391
392
393
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

394
395
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
# will put a list of the files that are included by a file in the documentation
396
397
398
399
# of that file.

SHOW_INCLUDE_FILES     = YES

400
401
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
# will list include files with double quotes in the documentation
402
403
404
405
# rather than with sharp brackets.

FORCE_LOCAL_INCLUDES   = NO

406
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
407
408
409
410
# is inserted in the documentation for inline members.

INLINE_INFO            = YES

411
412
413
# If the SORT_MEMBER_DOCS tag is set to YES (the default) 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
414
415
416
417
# declaration order.

SORT_MEMBER_DOCS       = YES

418
419
420
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
# brief documentation of file, namespace and class members alphabetically
# by member name. If set to NO (the default) the members will appear in
421
422
423
424
425
426
427
428
429
430
431
432
433
434
# declaration order.

SORT_BRIEF_DOCS        = NO

# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
# will sort the (brief and detailed) documentation of class members so that
# constructors and destructors are listed first. If set to NO (the default)
# the constructors will appear in the respective orders defined by
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.

SORT_MEMBERS_CTORS_1ST = NO

435
436
# 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 default)
437
438
439
440
# the group names will appear in their defined order.

SORT_GROUP_NAMES       = NO

441
442
443
444
445
446
# 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 default), the class list will be sorted only by class name,
# not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the
447
448
449
450
# alphabetical list.

SORT_BY_SCOPE_NAME     = NO

451
452
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
453
454
455
456
# commands in the documentation.

GENERATE_TODOLIST      = YES

457
458
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
459
460
461
462
# commands in the documentation.

GENERATE_TESTLIST      = YES

463
464
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
465
466
467
468
# commands in the documentation.

GENERATE_BUGLIST       = YES

469
470
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
471
472
473
474
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

475
# The ENABLED_SECTIONS tag can be used to enable conditional
476
477
# documentation sections, marked by \if sectionname ... \endif.

478
ENABLED_SECTIONS       =
479

480
481
482
483
484
485
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
# the initial value of a variable or define consists of 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 initializer of individual variables and defines in the
# documentation can be controlled using \showinitializer or \hideinitializer
486
487
488
489
# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

490
491
# 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
492
493
494
495
# list will mention the files that were used to generate the documentation.

SHOW_USED_FILES        = YES

496
497
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
498
499
500
501
# in the documentation. The default is NO.

SHOW_DIRECTORIES       = NO

502
503
# 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
504
505
506
507
# Folder Tree View (if specified). The default is YES.

SHOW_FILES             = YES

508
509
# 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
510
511
512
513
# and from the Folder Tree View (if specified). The default is YES.

SHOW_NAMESPACES        = YES

514
515
516
517
518
519
# 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
# 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
520
521
# is used as the file version. See the manual for examples.

522
FILE_VERSION_FILTER    =
523

524
525
526
527
528
# 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 output files
# in an output format independent way. The create the layout file that represents
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
529
530
# of the layout file.

531
LAYOUT_FILE            =
532
533
534
535
536

#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------

537
# The QUIET tag can be used to turn on/off the messages that are generated
538
539
540
541
# by doxygen. Possible values are YES and NO. If left blank NO is used.

QUIET                  = NO

542
543
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
544
545
546
547
# NO is used.

WARNINGS               = YES

548
549
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
550
551
552
553
# automatically be disabled.

WARN_IF_UNDOCUMENTED   = YES

554
555
556
# If WARN_IF_DOC_ERROR 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
557
558
559
560
# don't exist or using markup commands wrongly.

WARN_IF_DOC_ERROR      = YES

561
562
563
564
# This WARN_NO_PARAMDOC option can be abled to get warnings for
# functions that are documented, but have no documentation for their parameters
# or return value. If set to NO (the default) doxygen will only warn about
# wrong or incomplete parameter documentation, but not about the absence of
565
566
567
568
# documentation.

WARN_NO_PARAMDOC       = NO

569
570
571
572
573
# 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
574
575
576
577
# be obtained via FILE_VERSION_FILTER)

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

578
579
# 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
580
581
# to stderr.

582
WARN_LOGFILE           =
583
584
585
586
587

#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------

588
589
590
# The INPUT tag can be 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
591
592
593
594
# with spaces.

INPUT                  = .

595
596
597
598
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
# also the default input encoding. Doxygen uses libiconv (or the iconv built
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
599
600
601
602
# the list of possible encodings.

INPUT_ENCODING         = UTF-8

603
604
605
606
607
# If the value of the INPUT tag contains directories, you can use the
# FILE_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 the following patterns are tested:
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90

FILE_PATTERNS          = *.c \
                         *.cc \
                         *.cxx \
                         *.cpp \
                         *.c++ \
                         *.d \
                         *.java \
                         *.ii \
                         *.ixx \
                         *.ipp \
                         *.i++ \
                         *.inl \
                         *.h \
                         *.hh \
                         *.hxx \
                         *.hpp \
                         *.h++ \
                         *.idl \
                         *.odl \
                         *.cs \
                         *.php \
                         *.php3 \
                         *.inc \
                         *.m \
                         *.mm \
                         *.dox \
                         *.py \
                         *.C \
                         *.CC \
                         *.C++ \
                         *.II \
                         *.I++ \
                         *.H \
                         *.HH \
                         *.H++ \
                         *.CS \
                         *.PHP \
                         *.PHP3 \
                         *.M \
                         *.MM \
                         *.PY

652
653
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
654
655
656
657
# If left blank NO is used.

RECURSIVE              = YES

658
659
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
660
661
662
663
664
665
# subdirectory from a directory tree whose root is specified with the INPUT tag.

EXCLUDE                = libs/numeric/mtl/doc/* \
                         libs/numeric/mtl/doc-complete/* \
                         packages

666
667
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
668
669
670
671
# from the input.

EXCLUDE_SYMLINKS       = NO

672
673
674
675
# 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
# certain files from those directories. Note that the wildcards are matched
# against the file with absolute path, so to exclude all test directories
676
677
678
679
# for example use the pattern */test/*

EXCLUDE_PATTERNS       = .svn

680
681
682
683
# 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,
684
685
# AClass::ANamespace, ANamespace::*Test

686
EXCLUDE_SYMBOLS        =
687

688
689
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
690
691
692
693
694
695
# the \include command).

EXAMPLE_PATH           = libs/numeric/mtl/examples \
                         boost/numeric/itl/krylov \
			 libs/numeric/mtl/experimental

696
697
698
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# 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
699
700
701
702
# blank all files are included.

EXAMPLE_PATTERNS       = *.*pp

703
704
705
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude
# commands irrespective of the value of the RECURSIVE tag.
706
707
708
709
# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      = NO

710
711
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
712
713
714
715
# the \image command).

IMAGE_PATH             = libs/numeric/mtl/examples/images

716
717
718
719
720
721
# 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
# 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
722
723
# ignored.

724
INPUT_FILTER           =
725

726
727
728
729
730
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# 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
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
731
732
# is applied to all files.

733
FILTER_PATTERNS        =
734

735
736
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source
737
738
739
740
741
742
743
744
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    = NO

#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------

745
746
747
# 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 also
748
749
750
751
# VERBATIM_HEADERS is set to NO.

SOURCE_BROWSER         = YES

752
# Setting the INLINE_SOURCES tag to YES will include the body
753
754
755
756
# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

757
758
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
759
760
761
762
# fragments. Normal C and C++ comments will always remain visible.

STRIP_CODE_COMMENTS    = YES

763
764
# If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented
765
766
767
768
# functions referencing it will be listed.

REFERENCED_BY_RELATION = NO

769
770
# If the REFERENCES_RELATION tag is set to YES
# then for each documented function all documented entities
771
772
773
774
# called/used by that function will be listed.

REFERENCES_RELATION    = NO

775
776
777
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
778
779
780
781
# link to the source code.  Otherwise they will link to the documentation.

REFERENCES_LINK_SOURCE = YES

782
783
784
785
# 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
786
787
788
789
# will need version 4.8.6 or higher.

USE_HTAGS              = NO

790
791
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
# will generate a verbatim copy of the header file for each class for
792
793
794
795
796
797
798
799
# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = YES

#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------

800
801
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
802
803
804
805
# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     = YES

806
807
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
808
809
810
811
# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX    = 5

812
813
814
# 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 one or more prefixes that
815
816
# should be ignored while generating the index headers.

817
IGNORE_PREFIX          =
818
819
820
821
822

#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------

823
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
824
825
826
827
# generate HTML output.

GENERATE_HTML          = YES

828
829
# 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
830
831
832
833
# put in front of it. If left blank `html' will be used as the default path.

HTML_OUTPUT            = html

834
835
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
836
837
838
839
# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    = .html

840
841
# The HTML_HEADER tag can be used to specify a personal HTML header for
# each generated HTML page. If it is left blank doxygen will generate a
842
843
844
845
# standard header.

HTML_HEADER            = libs/numeric/mtl/examples/doxygen_header.html

846
847
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
848
849
850
851
# standard footer.

HTML_FOOTER            = libs/numeric/mtl/examples/doxygen_footer.html

852
853
854
855
856
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen
# will generate a default style sheet. Note that doxygen will try to copy
# the style sheet file to the HTML output directory, so don't put your own
857
858
# stylesheet in the HTML output directory as well, or it will be erased!

859
HTML_STYLESHEET        =
860

861
862
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting
863
864
865
866
# this to NO can help when comparing the output of multiple runs.

HTML_TIMESTAMP         = YES

867
868
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
869
870
871
872
# NO a bullet list will be used.

HTML_ALIGN_MEMBERS     = YES

873
874
875
876
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
877
878
879
880
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).

HTML_DYNAMIC_SECTIONS  = NO

881
882
883
884
885
886
887
888
# If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3
# integrated development environment, introduced with OSX 10.5 (Leopard).
# To create a documentation set, doxygen will generate a Makefile in the
# HTML output directory. Running make will produce the docset in that
# directory and running "make install" will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# it at startup.
889
890
891
892
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.

GENERATE_DOCSET        = NO

893
894
895
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
# feed. A documentation feed provides an umbrella under which multiple
# documentation sets from a single provider (such as a company or product suite)
896
897
898
899
# can be grouped.

DOCSET_FEEDNAME        = "Doxygen generated docs"

900
901
902
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
# should uniquely identify the documentation set bundle. This should be a
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
903
904
905
906
# will append .docset to the name.

DOCSET_BUNDLE_ID       = org.doxygen.Project

907
908
909
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
910
911
912
913
# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

914
915
916
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
# be used to specify the file name of the resulting .chm file. You
# can add a path in front of the file if the result should not be
917
918
# written to the html output directory.

919
CHM_FILE               =
920

921
922
923
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
# be used to specify the location (absolute path including file name) of
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
924
925
# the HTML help compiler on the generated index.hhp.

926
HHC_LOCATION           =
927

928
929
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
# controls if a separate .chi index file is generated (YES) or that
930
931
932
933
# it should be included in the master .chm file (NO).

GENERATE_CHI           = NO

934
935
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
936
937
# content.

938
CHM_INDEX_ENCODING     =
939

940
941
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
# controls whether a binary table of contents is generated (YES) or a
942
943
944
945
# normal table of contents (NO) in the .chm file.

BINARY_TOC             = NO

946
# The TOC_EXPAND flag can be set to YES to add extra items for group members
947
948
949
950
# to the contents of the HTML help documentation and to the tree view.

TOC_EXPAND             = NO

951
952
953
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
# are set, an additional index file will be generated that can be used as input for
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
954
955
956
957
# HTML documentation.

GENERATE_QHP           = NO

958
959
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
960
961
# The path specified is relative to the HTML output folder.

962
QCH_FILE               =
963

964
965
# The QHP_NAMESPACE tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
966
967
968
969
# http://doc.trolltech.com/qthelpproject.html#namespace

QHP_NAMESPACE          = org.doxygen.Project

970
971
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
972
973
974
975
# http://doc.trolltech.com/qthelpproject.html#virtual-folders

QHP_VIRTUAL_FOLDER     = doc

976
977
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
# For more information please see
978
979
# http://doc.trolltech.com/qthelpproject.html#custom-filters

980
QHP_CUST_FILTER_NAME   =
981

982
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
983
984
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.

985
QHP_CUST_FILTER_ATTRS  =
986

987
988
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
# filter section matches.
989
990
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.

991
QHP_SECT_FILTER_ATTRS  =
992

993
994
995
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
# be used to specify the location of Qt's qhelpgenerator.
# If non-empty doxygen will try to run qhelpgenerator on the generated
996
997
# .qhp file.

998
QHG_LOCATION           =
999

1000
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
For faster browsing, not all history is shown. View entire blame