5
# This file describes the settings to be used by the documentation system
6
# doxygen (www.doxygen.org) for a project
8
# All text after a hash (#) is considered a comment and will be ignored
10
# TAG = value [value, ...]
11
# For lists items can also be appended using:
12
# TAG += value [value, ...]
13
# Values that contain spaces should be placed between quotes (" ")
15
#---------------------------------------------------------------------------
16
# Project related configuration options
17
#---------------------------------------------------------------------------
19
# This tag specifies the encoding used for all characters in the config file that
20
# follow. The default is UTF-8 which is also the encoding used for all text before
21
# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
22
# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
25
DOXYFILE_ENCODING = UTF-8
27
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
28
# by quotes) that should identify the project.
30
PROJECT_NAME = "libLAS API Reference"
32
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
33
# This could be handy for archiving the generated documentation or
34
# if some version control system is used.
36
PROJECT_NUMBER = (svn-trunk)
38
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
39
# base path where the generated documentation will be put.
40
# If a relative path is entered, it will be relative to the location
41
# where doxygen was started. If left blank the current directory will be used.
45
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
46
# 4096 sub-directories (in 2 levels) under the output directory of each output
47
# format and will distribute the generated files over these directories.
48
# Enabling this option can be useful when feeding doxygen a huge amount of
49
# source files, where putting all generated files in the same directory would
50
# otherwise cause performance problems for the file system.
54
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
55
# documentation generated by doxygen is written. Doxygen will use this
56
# information to generate all constant output in the proper language.
57
# The default language is English, other supported languages are:
58
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
59
# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
60
# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
61
# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
62
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
64
OUTPUT_LANGUAGE = English
66
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
67
# include brief member descriptions after the members that are listed in
68
# the file and class documentation (similar to JavaDoc).
69
# Set to NO to disable this.
71
BRIEF_MEMBER_DESC = YES
73
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
74
# the brief description of a member or function before the detailed description.
75
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
76
# brief descriptions will be completely suppressed.
80
# This tag implements a quasi-intelligent brief description abbreviator
81
# that is used to form the text in various listings. Each string
82
# in this list, if found as the leading text of the brief description, will be
83
# stripped from the text and the result after processing the whole list, is
84
# used as the annotated text. Otherwise, the brief description is used as-is.
85
# If left blank, the following values are used ("$name" is automatically
86
# replaced with the name of the entity): "The $name class" "The $name widget"
87
# "The $name file" "is" "provides" "specifies" "contains"
88
# "represents" "a" "an" "the"
92
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
93
# Doxygen will generate a detailed section even if there is only a brief
96
ALWAYS_DETAILED_SEC = NO
98
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
99
# inherited members of a class in the documentation of that class as if those
100
# members were ordinary class members. Constructors, destructors and assignment
101
# operators of the base classes will not be shown.
103
INLINE_INHERITED_MEMB = NO
105
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
106
# path before files name in the file list and in the header files. If set
107
# to NO the shortest path that makes the file name unique will be used.
111
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
112
# can be used to strip a user-defined part of the path. Stripping is
113
# only done if one of the specified strings matches the left-hand part of
114
# the path. The tag can be used to show relative paths in the file list.
115
# If left blank the directory from which doxygen is run is used as the
120
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
121
# the path mentioned in the documentation of a class, which tells
122
# the reader which header file to include in order to use a class.
123
# If left blank only the name of the header file containing the class
124
# definition is used. Otherwise one should specify the include paths that
125
# are normally passed to the compiler using the -I flag.
127
STRIP_FROM_INC_PATH =
129
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
130
# (but less readable) file names. This can be useful is your file systems
131
# doesn't support long names like on DOS, Mac, or CD-ROM.
135
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
136
# will interpret the first line (until the first dot) of a JavaDoc-style
137
# comment as the brief description. If set to NO, the JavaDoc
138
# comments will behave just like the Qt-style comments (thus requiring an
139
# explicit @brief command for a brief description.
141
JAVADOC_AUTOBRIEF = YES
143
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
144
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
145
# comments) as a brief description. This used to be the default behaviour.
146
# The new default is to treat a multi-line C++ comment block as a detailed
147
# description. Set this tag to YES if you prefer the old behaviour instead.
149
MULTILINE_CPP_IS_BRIEF = NO
151
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
152
# will output the detailed description near the top, like JavaDoc.
153
# If set to NO, the detailed description appears after the member
158
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159
# member inherits the documentation from any documented member that it
164
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165
# a new page for each member. If set to NO, the documentation of a member will
166
# be part of the file/class/namespace that contains it.
168
SEPARATE_MEMBER_PAGES = NO
170
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
171
# Doxygen uses this value to replace tabs by spaces in code fragments.
175
# This tag can be used to specify a number of aliases that acts
176
# as commands in the documentation. An alias has the form "name=value".
177
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
178
# put the command \sideeffect (or @sideeffect) in the documentation, which
179
# will result in a user-defined paragraph with heading "Side Effects:".
180
# You can put \n's in the value part of an alias to insert newlines.
184
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185
# sources only. Doxygen will then generate output that is more tailored for C.
186
# For instance, some of the names that are used will be different. The list
187
# of all members will be omitted, etc.
189
OPTIMIZE_OUTPUT_FOR_C = NO
191
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192
# sources only. Doxygen will then generate output that is more tailored for Java.
193
# For instance, namespaces will be presented as packages, qualified scopes
194
# will look different, etc.
196
OPTIMIZE_OUTPUT_JAVA = NO
198
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
199
# include (a tag file for) the STL sources as input, then you should
200
# set this tag to YES in order to let doxygen match functions declarations and
201
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
202
# func(std::string) {}). This also make the inheritance and collaboration
203
# diagrams that involve STL classes more complete and accurate.
205
BUILTIN_STL_SUPPORT = NO
207
# If you use Microsoft's C++/CLI language, you should set this option to YES to
208
# enable parsing support.
212
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
213
# tag is set to YES, then doxygen will reuse the documentation of the first
214
# member in the group (if any) for the other members of the group. By default
215
# all members of a group must be documented explicitly.
217
DISTRIBUTE_GROUP_DOC = NO
219
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
220
# the same type (for instance a group of public functions) to be put as a
221
# subgroup of that type (e.g. under the Public Functions section). Set it to
222
# NO to prevent subgrouping. Alternatively, this can be done per class using
223
# the \nosubgrouping command.
227
#---------------------------------------------------------------------------
228
# Build related configuration options
229
#---------------------------------------------------------------------------
231
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
232
# documentation are documented, even if no documentation was available.
233
# Private class members and static file members will be hidden unless
234
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
238
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
239
# will be included in the documentation.
243
# If the EXTRACT_STATIC tag is set to YES all static members of a file
244
# will be included in the documentation.
248
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
249
# defined locally in source files will be included in the documentation.
250
# If set to NO only classes defined in header files are included.
252
EXTRACT_LOCAL_CLASSES = NO
254
# This flag is only useful for Objective-C code. When set to YES local
255
# methods, which are defined in the implementation section but not in
256
# the interface are included in the documentation.
257
# If set to NO (the default) only methods in the interface are included.
259
EXTRACT_LOCAL_METHODS = YES
261
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
262
# undocumented members of documented classes, files or namespaces.
263
# If set to NO (the default) these members will be included in the
264
# various overviews, but no documentation section is generated.
265
# This option has no effect if EXTRACT_ALL is enabled.
267
HIDE_UNDOC_MEMBERS = NO
269
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
270
# undocumented classes that are normally visible in the class hierarchy.
271
# If set to NO (the default) these classes will be included in the various
272
# overviews. This option has no effect if EXTRACT_ALL is enabled.
274
HIDE_UNDOC_CLASSES = NO
276
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
277
# friend (class|struct|union) declarations.
278
# If set to NO (the default) these declarations will be included in the
281
HIDE_FRIEND_COMPOUNDS = NO
283
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
284
# documentation blocks found inside the body of a function.
285
# If set to NO (the default) these blocks will be appended to the
286
# function's detailed documentation block.
288
HIDE_IN_BODY_DOCS = NO
290
# The INTERNAL_DOCS tag determines if documentation
291
# that is typed after a \internal command is included. If the tag is set
292
# to NO (the default) then the documentation will be excluded.
293
# Set it to YES to include the internal documentation.
297
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
298
# file names in lower-case letters. If set to YES upper-case letters are also
299
# allowed. This is useful if you have classes or files whose names only differ
300
# in case and if your file system supports case sensitive file names. Windows
301
# and Mac users are advised to set this option to NO.
303
CASE_SENSE_NAMES = YES
305
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
306
# will show members with their full class and namespace scopes in the
307
# documentation. If set to YES the scope will be hidden.
309
HIDE_SCOPE_NAMES = NO
311
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
312
# will put a list of the files that are included by a file in the documentation
315
SHOW_INCLUDE_FILES = YES
317
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
318
# is inserted in the documentation for inline members.
322
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
323
# will sort the (detailed) documentation of file and class members
324
# alphabetically by member name. If set to NO the members will appear in
327
SORT_MEMBER_DOCS = YES
329
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
330
# brief documentation of file, namespace and class members alphabetically
331
# by member name. If set to NO (the default) the members will appear in
336
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
337
# sorted by fully-qualified names, including namespaces. If set to
338
# NO (the default), the class list will be sorted only by class name,
339
# not including the namespace part.
340
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
341
# Note: This option applies only to the class list, not to the
344
SORT_BY_SCOPE_NAME = NO
346
# The GENERATE_TODOLIST tag can be used to enable (YES) or
347
# disable (NO) the todo list. This list is created by putting \todo
348
# commands in the documentation.
350
GENERATE_TODOLIST = YES
352
# The GENERATE_TESTLIST tag can be used to enable (YES) or
353
# disable (NO) the test list. This list is created by putting \test
354
# commands in the documentation.
356
GENERATE_TESTLIST = YES
358
# The GENERATE_BUGLIST tag can be used to enable (YES) or
359
# disable (NO) the bug list. This list is created by putting \bug
360
# commands in the documentation.
362
GENERATE_BUGLIST = YES
364
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
365
# disable (NO) the deprecated list. This list is created by putting
366
# \deprecated commands in the documentation.
368
GENERATE_DEPRECATEDLIST= YES
370
# The ENABLED_SECTIONS tag can be used to enable conditional
371
# documentation sections, marked by \if sectionname ... \endif.
375
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
376
# the initial value of a variable or define consists of for it to appear in
377
# the documentation. If the initializer consists of more lines than specified
378
# here it will be hidden. Use a value of 0 to hide initializers completely.
379
# The appearance of the initializer of individual variables and defines in the
380
# documentation can be controlled using \showinitializer or \hideinitializer
381
# command in the documentation regardless of this setting.
383
MAX_INITIALIZER_LINES = 30
385
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
386
# at the bottom of the documentation of classes and structs. If set to YES the
387
# list will mention the files that were used to generate the documentation.
389
SHOW_USED_FILES = YES
391
# If the sources in your project are distributed over multiple directories
392
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
393
# in the documentation. The default is NO.
395
SHOW_DIRECTORIES = YES
397
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
398
# doxygen should invoke to get the current version for each file (typically from the
399
# version control system). Doxygen will invoke the program by executing (via
400
# popen()) the command <command> <input-file>, where <command> is the value of
401
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
402
# provided by doxygen. Whatever the program writes to standard output
403
# is used as the file version. See the manual for examples.
405
FILE_VERSION_FILTER =
407
#---------------------------------------------------------------------------
408
# configuration options related to warning and progress messages
409
#---------------------------------------------------------------------------
411
# The QUIET tag can be used to turn on/off the messages that are generated
412
# by doxygen. Possible values are YES and NO. If left blank NO is used.
416
# The WARNINGS tag can be used to turn on/off the warning messages that are
417
# generated by doxygen. Possible values are YES and NO. If left blank
422
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
423
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
424
# automatically be disabled.
426
WARN_IF_UNDOCUMENTED = YES
428
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
429
# potential errors in the documentation, such as not documenting some
430
# parameters in a documented function, or documenting parameters that
431
# don't exist or using markup commands wrongly.
433
WARN_IF_DOC_ERROR = YES
435
# This WARN_NO_PARAMDOC option can be abled to get warnings for
436
# functions that are documented, but have no documentation for their parameters
437
# or return value. If set to NO (the default) doxygen will only warn about
438
# wrong or incomplete parameter documentation, but not about the absence of
441
WARN_NO_PARAMDOC = NO
443
# The WARN_FORMAT tag determines the format of the warning messages that
444
# doxygen can produce. The string should contain the $file, $line, and $text
445
# tags, which will be replaced by the file and line number from which the
446
# warning originated and the warning text. Optionally the format may contain
447
# $version, which will be replaced by the version of the file (if it could
448
# be obtained via FILE_VERSION_FILTER)
450
WARN_FORMAT = "$file:$line: $text"
452
# The WARN_LOGFILE tag can be used to specify a file to which warning
453
# and error messages should be written. If left blank the output is written
458
#---------------------------------------------------------------------------
459
# configuration options related to the input files
460
#---------------------------------------------------------------------------
462
# The INPUT tag can be used to specify the files and/or directories that contain
463
# documented source files. You may enter file names like "myfile.cpp" or
464
# directories like "/usr/src/myproject". Separate the files or directories
467
INPUT = ../../include/liblas ../../include/liblas/capi
469
# This tag can be used to specify the character encoding of the source files that
470
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
471
# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
472
# See http://www.gnu.org/software/libiconv for the list of possible encodings.
474
INPUT_ENCODING = UTF-8
476
# If the value of the INPUT tag contains directories, you can use the
477
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
478
# and *.h) to filter out the source-files in the directories. If left
479
# blank the following patterns are tested:
480
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
481
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
483
FILE_PATTERNS = *.hpp *.cpp *.h *.c
485
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
486
# should be searched for input files as well. Possible values are YES and NO.
487
# If left blank NO is used.
491
# The EXCLUDE tag can be used to specify files and/or directories that should
492
# excluded from the INPUT source files. This way you can easily exclude a
493
# subdirectory from a directory tree whose root is specified with the INPUT tag.
497
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
498
# directories that are symbolic links (a Unix filesystem feature) are excluded
501
EXCLUDE_SYMLINKS = NO
503
# If the value of the INPUT tag contains directories, you can use the
504
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
505
# certain files from those directories. Note that the wildcards are matched
506
# against the file with absolute path, so to exclude all test directories
507
# for example use the pattern */test/*
509
EXCLUDE_PATTERNS = */.svn/*
511
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
512
# (namespaces, classes, functions, etc.) that should be excluded from the output.
513
# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
514
# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
518
# The EXAMPLE_PATH tag can be used to specify one or more files or
519
# directories that contain example code fragments that are included (see
520
# the \include command).
524
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
525
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
526
# and *.h) to filter out the source-files in the directories. If left
527
# blank all files are included.
531
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
532
# searched for input files to be used with the \include or \dontinclude
533
# commands irrespective of the value of the RECURSIVE tag.
534
# Possible values are YES and NO. If left blank NO is used.
536
EXAMPLE_RECURSIVE = NO
538
# The IMAGE_PATH tag can be used to specify one or more files or
539
# directories that contain image that are included in the documentation (see
540
# the \image command).
544
# The INPUT_FILTER tag can be used to specify a program that doxygen should
545
# invoke to filter for each input file. Doxygen will invoke the filter program
546
# by executing (via popen()) the command <filter> <input-file>, where <filter>
547
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
548
# input file. Doxygen will then use the output that the filter program writes
549
# to standard output. If FILTER_PATTERNS is specified, this tag will be
554
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
555
# basis. Doxygen will compare the file name with each pattern and apply the
556
# filter if there is a match. The filters are a list of the form:
557
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
558
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
559
# is applied to all files.
563
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
564
# INPUT_FILTER) will be used to filter the input files when producing source
565
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
567
FILTER_SOURCE_FILES = NO
569
#---------------------------------------------------------------------------
570
# configuration options related to source browsing
571
#---------------------------------------------------------------------------
573
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
574
# be generated. Documented entities will be cross-referenced with these sources.
575
# Note: To get rid of all source code in the generated output, make sure also
576
# VERBATIM_HEADERS is set to NO.
580
# Setting the INLINE_SOURCES tag to YES will include the body
581
# of functions and classes directly in the documentation.
585
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
586
# doxygen to hide any special comment blocks from generated source code
587
# fragments. Normal C and C++ comments will always remain visible.
589
STRIP_CODE_COMMENTS = YES
591
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
592
# then for each documented function all documented
593
# functions referencing it will be listed.
595
REFERENCED_BY_RELATION = YES
597
# If the REFERENCES_RELATION tag is set to YES (the default)
598
# then for each documented function all documented entities
599
# called/used by that function will be listed.
601
REFERENCES_RELATION = YES
603
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
604
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
605
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
606
# link to the source code. Otherwise they will link to the documentstion.
608
REFERENCES_LINK_SOURCE = YES
610
# If the USE_HTAGS tag is set to YES then the references to source code
611
# will point to the HTML generated by the htags(1) tool instead of doxygen
612
# built-in source browser. The htags tool is part of GNU's global source
613
# tagging system (see http://www.gnu.org/software/global/global.html). You
614
# will need version 4.8.6 or higher.
618
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
619
# will generate a verbatim copy of the header file for each class for
620
# which an include is specified. Set to NO to disable this.
622
VERBATIM_HEADERS = YES
624
#---------------------------------------------------------------------------
625
# configuration options related to the alphabetical class index
626
#---------------------------------------------------------------------------
628
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
629
# of all compounds will be generated. Enable this if the project
630
# contains a lot of classes, structs, unions or interfaces.
632
ALPHABETICAL_INDEX = YES
634
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
635
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
636
# in which this list will be split (can be a number in the range [1..20])
638
COLS_IN_ALPHA_INDEX = 3
640
# In case all classes in a project start with a common prefix, all
641
# classes will be put under the same header in the alphabetical index.
642
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
643
# should be ignored while generating the index headers.
647
#---------------------------------------------------------------------------
648
# configuration options related to the HTML output
649
#---------------------------------------------------------------------------
651
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
652
# generate HTML output.
656
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
657
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
658
# put in front of it. If left blank `html' will be used as the default path.
662
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
663
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
664
# doxygen will generate files with .html extension.
666
HTML_FILE_EXTENSION = .html
668
# The HTML_HEADER tag can be used to specify a personal HTML header for
669
# each generated HTML page. If it is left blank doxygen will generate a
674
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
675
# each generated HTML page. If it is left blank doxygen will generate a
680
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
681
# style sheet that is used by each HTML page. It can be used to
682
# fine-tune the look of the HTML output. If the tag is left blank doxygen
683
# will generate a default style sheet. Note that doxygen will try to copy
684
# the style sheet file to the HTML output directory, so don't put your own
685
# stylesheet in the HTML output directory as well, or it will be erased!
687
HTML_STYLESHEET = doxygen.css
689
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
690
# files or namespaces will be aligned in HTML using tables. If set to
691
# NO a bullet list will be used.
693
HTML_ALIGN_MEMBERS = YES
695
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
696
# will be generated that can be used as input for tools like the
697
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
698
# of the generated HTML documentation.
700
GENERATE_HTMLHELP = NO
702
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
703
# be used to specify the file name of the resulting .chm file. You
704
# can add a path in front of the file if the result should not be
705
# written to the html output directory.
709
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
710
# be used to specify the location (absolute path including file name) of
711
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
712
# the HTML help compiler on the generated index.hhp.
716
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
717
# controls if a separate .chi index file is generated (YES) or that
718
# it should be included in the master .chm file (NO).
722
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
723
# controls whether a binary table of contents is generated (YES) or a
724
# normal table of contents (NO) in the .chm file.
728
# The TOC_EXPAND flag can be set to YES to add extra items for group members
729
# to the contents of the HTML help documentation and to the tree view.
733
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
734
# top of each HTML page. The value NO (the default) enables the index and
735
# the value YES disables it.
739
# This tag can be used to set the number of enum values (range [1..20])
740
# that doxygen will group on one line in the generated HTML documentation.
742
ENUM_VALUES_PER_LINE = 4
744
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
745
# generated containing a tree-like index structure (just like the one that
746
# is generated for HTML Help). For this to work a browser that supports
747
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
748
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
749
# probably better off using the HTML help feature.
751
GENERATE_TREEVIEW = YES
753
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
754
# used to set the initial width (in pixels) of the frame in which the tree
759
#---------------------------------------------------------------------------
760
# configuration options related to the LaTeX output
761
#---------------------------------------------------------------------------
763
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
764
# generate Latex output.
768
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
769
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
770
# put in front of it. If left blank `latex' will be used as the default path.
774
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
775
# invoked. If left blank `latex' will be used as the default command name.
777
LATEX_CMD_NAME = latex
779
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
780
# generate index for LaTeX. If left blank `makeindex' will be used as the
781
# default command name.
783
MAKEINDEX_CMD_NAME = makeindex
785
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
786
# LaTeX documents. This may be useful for small projects and may help to
787
# save some trees in general.
791
# The PAPER_TYPE tag can be used to set the paper type that is used
792
# by the printer. Possible values are: a4, a4wide, letter, legal and
793
# executive. If left blank a4wide will be used.
797
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
798
# packages that should be included in the LaTeX output.
802
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
803
# the generated latex document. The header should contain everything until
804
# the first chapter. If it is left blank doxygen will generate a
805
# standard header. Notice: only use this tag if you know what you are doing!
809
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
810
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
811
# contain links (just like the HTML output) instead of page references
812
# This makes the output suitable for online browsing using a pdf viewer.
816
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
817
# plain latex in the generated Makefile. Set this option to YES to get a
818
# higher quality PDF documentation.
822
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
823
# command to the generated LaTeX files. This will instruct LaTeX to keep
824
# running if errors occur, instead of asking the user for help.
825
# This option is also used when generating formulas in HTML.
829
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
830
# include the index chapters (such as File Index, Compound Index, etc.)
833
LATEX_HIDE_INDICES = NO
835
#---------------------------------------------------------------------------
836
# configuration options related to the RTF output
837
#---------------------------------------------------------------------------
839
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
840
# The RTF output is optimized for Word 97 and may not look very pretty with
841
# other RTF readers or editors.
845
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
846
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
847
# put in front of it. If left blank `rtf' will be used as the default path.
851
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
852
# RTF documents. This may be useful for small projects and may help to
853
# save some trees in general.
857
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
858
# will contain hyperlink fields. The RTF file will
859
# contain links (just like the HTML output) instead of page references.
860
# This makes the output suitable for online browsing using WORD or other
861
# programs which support those fields.
862
# Note: wordpad (write) and others do not support links.
866
# Load stylesheet definitions from file. Syntax is similar to doxygen's
867
# config file, i.e. a series of assignments. You only have to provide
868
# replacements, missing definitions are set to their default value.
870
RTF_STYLESHEET_FILE =
872
# Set optional variables used in the generation of an rtf document.
873
# Syntax is similar to doxygen's config file.
875
RTF_EXTENSIONS_FILE =
877
#---------------------------------------------------------------------------
878
# configuration options related to the man page output
879
#---------------------------------------------------------------------------
881
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
886
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
887
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
888
# put in front of it. If left blank `man' will be used as the default path.
892
# The MAN_EXTENSION tag determines the extension that is added to
893
# the generated man pages (default is the subroutine's section .3)
897
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
898
# then it will generate one additional man file for each entity
899
# documented in the real man page(s). These additional files
900
# only source the real man page, but without them the man command
901
# would be unable to find the correct page. The default is NO.
905
#---------------------------------------------------------------------------
906
# configuration options related to the XML output
907
#---------------------------------------------------------------------------
909
# If the GENERATE_XML tag is set to YES Doxygen will
910
# generate an XML file that captures the structure of
911
# the code including all documentation.
915
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
916
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
917
# put in front of it. If left blank `xml' will be used as the default path.
921
# The XML_SCHEMA tag can be used to specify an XML schema,
922
# which can be used by a validating XML parser to check the
923
# syntax of the XML files.
927
# The XML_DTD tag can be used to specify an XML DTD,
928
# which can be used by a validating XML parser to check the
929
# syntax of the XML files.
933
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
934
# dump the program listings (including syntax highlighting
935
# and cross-referencing information) to the XML output. Note that
936
# enabling this will significantly increase the size of the XML output.
938
XML_PROGRAMLISTING = YES
940
#---------------------------------------------------------------------------
941
# configuration options for the AutoGen Definitions output
942
#---------------------------------------------------------------------------
944
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
945
# generate an AutoGen Definitions (see autogen.sf.net) file
946
# that captures the structure of the code including all
947
# documentation. Note that this feature is still experimental
948
# and incomplete at the moment.
950
GENERATE_AUTOGEN_DEF = NO
952
#---------------------------------------------------------------------------
953
# configuration options related to the Perl module output
954
#---------------------------------------------------------------------------
956
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
957
# generate a Perl module file that captures the structure of
958
# the code including all documentation. Note that this
959
# feature is still experimental and incomplete at the
962
GENERATE_PERLMOD = NO
964
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
965
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
966
# to generate PDF and DVI output from the Perl module output.
970
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
971
# nicely formatted so it can be parsed by a human reader. This is useful
972
# if you want to understand what is going on. On the other hand, if this
973
# tag is set to NO the size of the Perl module output will be much smaller
974
# and Perl will parse it just the same.
978
# The names of the make variables in the generated doxyrules.make file
979
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
980
# This is useful so different doxyrules.make files included by the same
981
# Makefile don't overwrite each other's variables.
983
PERLMOD_MAKEVAR_PREFIX =
985
#---------------------------------------------------------------------------
986
# Configuration options related to the preprocessor
987
#---------------------------------------------------------------------------
989
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
990
# evaluate all C-preprocessor directives found in the sources and include
993
ENABLE_PREPROCESSING = YES
995
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
996
# names in the source code. If set to NO (the default) only conditional
997
# compilation will be performed. Macro expansion can be done in a controlled
998
# way by setting EXPAND_ONLY_PREDEF to YES.
1000
MACRO_EXPANSION = NO
1002
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1003
# then the macro expansion is limited to the macros specified with the
1004
# PREDEFINED and EXPAND_AS_DEFINED tags.
1006
EXPAND_ONLY_PREDEF = NO
1008
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1009
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1011
SEARCH_INCLUDES = YES
1013
# The INCLUDE_PATH tag can be used to specify one or more directories that
1014
# contain include files that are not input files but should be processed by
1019
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1020
# patterns (like *.h and *.hpp) to filter out the header-files in the
1021
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1024
INCLUDE_FILE_PATTERNS =
1026
# The PREDEFINED tag can be used to specify one or more macro names that
1027
# are defined before the preprocessor is started (similar to the -D option of
1028
# gcc). The argument of the tag is a list of macros of the form: name
1029
# or name=definition (no spaces). If the definition and the = are
1030
# omitted =1 is assumed. To prevent a macro definition from being
1031
# undefined via #undef or recursively expanded use the := operator
1032
# instead of the = operator.
1036
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1037
# this tag can be used to specify a list of macro names that should be expanded.
1038
# The macro definition that is found in the sources will be used.
1039
# Use the PREDEFINED tag if you want to use a different macro definition.
1043
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1044
# doxygen's preprocessor will remove all function-like macros that are alone
1045
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1046
# function macros are typically used for boiler-plate code, and will confuse
1047
# the parser if not removed.
1049
SKIP_FUNCTION_MACROS = YES
1051
#---------------------------------------------------------------------------
1052
# Configuration::additions related to external references
1053
#---------------------------------------------------------------------------
1055
# The TAGFILES option can be used to specify one or more tagfiles.
1056
# Optionally an initial location of the external documentation
1057
# can be added for each tagfile. The format of a tag file without
1058
# this location is as follows:
1059
# TAGFILES = file1 file2 ...
1060
# Adding location for the tag files is done as follows:
1061
# TAGFILES = file1=loc1 "file2 = loc2" ...
1062
# where "loc1" and "loc2" can be relative or absolute paths or
1063
# URLs. If a location is present for each tag, the installdox tool
1064
# does not have to be run to correct the links.
1065
# Note that each tag file must have a unique name
1066
# (where the name does NOT include the path)
1067
# If a tag file is not located in the directory in which doxygen
1068
# is run, you must also specify the path to the tagfile here.
1072
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1073
# a tag file that is based on the input files it reads.
1077
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1078
# in the class index. If set to NO only the inherited external classes
1083
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1084
# in the modules index. If set to NO, only the current project's groups will
1087
EXTERNAL_GROUPS = YES
1089
# The PERL_PATH should be the absolute path and name of the perl script
1090
# interpreter (i.e. the result of `which perl').
1092
PERL_PATH = /usr/bin/perl
1094
#---------------------------------------------------------------------------
1095
# Configuration options related to the dot tool
1096
#---------------------------------------------------------------------------
1098
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1099
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1100
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1101
# this option is superseded by the HAVE_DOT option below. This is only a
1102
# fallback. It is recommended to install and use dot, since it yields more
1105
CLASS_DIAGRAMS = YES
1107
# You can define message sequence charts within doxygen comments using the \msc
1108
# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1109
# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1110
# specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1111
# be found in the default search path.
1115
# If set to YES, the inheritance and collaboration graphs will hide
1116
# inheritance and usage relations if the target is undocumented
1117
# or is not a class.
1119
HIDE_UNDOC_RELATIONS = YES
1121
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1122
# available from the path. This tool is part of Graphviz, a graph visualization
1123
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1124
# have no effect if this option is set to NO (the default)
1128
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1129
# will generate a graph for each documented class showing the direct and
1130
# indirect inheritance relations. Setting this tag to YES will force the
1131
# the CLASS_DIAGRAMS tag to NO.
1135
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1136
# will generate a graph for each documented class showing the direct and
1137
# indirect implementation dependencies (inheritance, containment, and
1138
# class references variables) of the class with other documented classes.
1140
COLLABORATION_GRAPH = YES
1142
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1143
# will generate a graph for groups, showing the direct groups dependencies
1147
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1148
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1153
# If set to YES, the inheritance and collaboration graphs will show the
1154
# relations between templates and their instances.
1156
TEMPLATE_RELATIONS = YES
1158
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1159
# tags are set to YES then doxygen will generate a graph for each documented
1160
# file showing the direct and indirect include dependencies of the file with
1161
# other documented files.
1165
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1166
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1167
# documented header file showing the documented files that directly or
1168
# indirectly include this file.
1170
INCLUDED_BY_GRAPH = YES
1172
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1173
# generate a call dependency graph for every global function or class method.
1174
# Note that enabling this option will significantly increase the time of a run.
1175
# So in most cases it will be better to enable call graphs for selected
1176
# functions only using the \callgraph command.
1180
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1181
# generate a caller dependency graph for every global function or class method.
1182
# Note that enabling this option will significantly increase the time of a run.
1183
# So in most cases it will be better to enable caller graphs for selected
1184
# functions only using the \callergraph command.
1188
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1189
# will graphical hierarchy of all classes instead of a textual one.
1191
GRAPHICAL_HIERARCHY = YES
1193
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1194
# then doxygen will show the dependencies a directory has on other directories
1195
# in a graphical way. The dependency relations are determined by the #include
1196
# relations between the files in the directories.
1198
DIRECTORY_GRAPH = YES
1200
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1201
# generated by dot. Possible values are png, jpg, or gif
1202
# If left blank png will be used.
1204
DOT_IMAGE_FORMAT = png
1206
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1207
# found. If left blank, it is assumed the dot tool can be found in the path.
1209
DOT_PATH = "c:\Program Files\Graphviz2.16\bin"
1211
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1212
# contain dot files that are included in the documentation (see the
1213
# \dotfile command).
1217
# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1218
# nodes that will be shown in the graph. If the number of nodes in a graph
1219
# becomes larger than this value, doxygen will truncate the graph, which is
1220
# visualized by representing a node as a red box. Note that doxygen will always
1221
# show the root nodes and its direct children regardless of this setting.
1223
DOT_GRAPH_MAX_NODES = 50
1225
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1226
# background. This is disabled by default, which results in a white background.
1227
# Warning: Depending on the platform used, enabling this option may lead to
1228
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1231
DOT_TRANSPARENT = NO
1233
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1234
# files in one run (i.e. multiple -o and -T options on the command line). This
1235
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1236
# support this, this feature is disabled by default.
1238
DOT_MULTI_TARGETS = NO
1240
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1241
# generate a legend page explaining the meaning of the various boxes and
1242
# arrows in the dot generated graphs.
1244
GENERATE_LEGEND = YES
1246
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1247
# remove the intermediate dot files that are used to generate
1248
# the various graphs.
1252
#---------------------------------------------------------------------------
1253
# Configuration::additions related to the search engine
1254
#---------------------------------------------------------------------------
1256
# The SEARCHENGINE tag specifies whether or not a search engine should be
1257
# used. If set to NO the values of all tags below this one will be ignored.
added
removed
doc/api/doxygen.conf
