COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/Doxyfile @ 422:ede61a3d229b

Last change on this file since 422:ede61a3d229b was 406:e8377ac921b6, checked in by Alpar Juttner, 16 years ago

Docs are now divided into modules.

File size: 45.2 KB
RevLine 
[242]1# Doxyfile 1.3.6
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project
5#
6# All text after a hash (#) is considered a comment and will be ignored
7# The format is:
8#       TAG = value [value, ...]
9# For lists items can also be appended using:
10#       TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")
[186]12
13#---------------------------------------------------------------------------
[242]14# Project related configuration options
[186]15#---------------------------------------------------------------------------
[242]16
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18# by quotes) that should identify the project.
19
[248]20PROJECT_NAME           = HugoLib
[242]21
22# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or
24# if some version control system is used.
25
[186]26PROJECT_NUMBER         = 0.1
[242]27
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29# base path where the generated documentation will be put.
30# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.
32
[186]33OUTPUT_DIRECTORY       =
[242]34
35# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36# documentation generated by doxygen is written. Doxygen will use this
37# information to generate all constant output in the proper language.
38# The default language is English, other supported languages are:
39# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese,
42# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
43
[186]44OUTPUT_LANGUAGE        = English
[242]45
46# This tag can be used to specify the encoding used in the generated output.
47# The encoding is not always determined by the language that is chosen,
48# but also whether or not the output is meant for Windows or non-Windows users.
49# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
50# forces the Windows encoding (this is the default for the Windows binary),
51# whereas setting the tag to NO uses a Unix-style encoding (the default for
52# all platforms other than Windows).
53
[186]54USE_WINDOWS_ENCODING   = NO
[242]55
56# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57# include brief member descriptions after the members that are listed in
58# the file and class documentation (similar to JavaDoc).
59# Set to NO to disable this.
60
61BRIEF_MEMBER_DESC      = YES
62
63# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64# the brief description of a member or function before the detailed description.
65# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66# brief descriptions will be completely suppressed.
67
68REPEAT_BRIEF           = NO
69
70# This tag implements a quasi-intelligent brief description abbreviator
71# that is used to form the text in various listings. Each string
72# in this list, if found as the leading text of the brief description, will be
73# stripped from the text and the result after processing the whole list, is used
74# as the annotated text. Otherwise, the brief description is used as-is. If left
75# blank, the following values are used ("$name" is automatically replaced with the
76# name of the entity): "The $name class" "The $name widget" "The $name file"
77# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
78
79ABBREVIATE_BRIEF       =
80
81# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
82# Doxygen will generate a detailed section even if there is only a brief
83# description.
84
85ALWAYS_DETAILED_SEC    = NO
86
87# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
88# members of a class in the documentation of that class as if those members were
89# ordinary class members. Constructors, destructors and assignment operators of
90# the base classes will not be shown.
91
92INLINE_INHERITED_MEMB  = NO
93
94# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
95# path before files name in the file list and in the header files. If set
96# to NO the shortest path that makes the file name unique will be used.
97
98FULL_PATH_NAMES        = NO
99
100# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
101# can be used to strip a user-defined part of the path. Stripping is
102# only done if one of the specified strings matches the left-hand part of
103# the path. It is allowed to use relative paths in the argument list.
104# If left blank the directory from which doxygen is run is used as the
105# path to strip.
106
107STRIP_FROM_PATH        =
108
109# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
110# (but less readable) file names. This can be useful is your file systems
111# doesn't support long names like on DOS, Mac, or CD-ROM.
112
113SHORT_NAMES            = NO
114
115# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
116# will interpret the first line (until the first dot) of a JavaDoc-style
117# comment as the brief description. If set to NO, the JavaDoc
118# comments will behave just like the Qt-style comments (thus requiring an
119# explicit @brief command for a brief description.
120
121JAVADOC_AUTOBRIEF      = NO
122
123# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
124# treat a multi-line C++ special comment block (i.e. a block of //! or ///
125# comments) as a brief description. This used to be the default behaviour.
126# The new default is to treat a multi-line C++ comment block as a detailed
127# description. Set this tag to YES if you prefer the old behaviour instead.
128
129MULTILINE_CPP_IS_BRIEF = NO
130
131# If the DETAILS_AT_TOP tag is set to YES then Doxygen
132# will output the detailed description near the top, like JavaDoc.
133# If set to NO, the detailed description appears after the member
134# documentation.
135
136DETAILS_AT_TOP         = NO
137
138# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
139# member inherits the documentation from any documented member that it
140# re-implements.
141
142INHERIT_DOCS           = NO
143
144# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
145# tag is set to YES, then doxygen will reuse the documentation of the first
146# member in the group (if any) for the other members of the group. By default
147# all members of a group must be documented explicitly.
148
149DISTRIBUTE_GROUP_DOC   = NO
150
151# The TAB_SIZE tag can be used to set the number of spaces in a tab.
152# Doxygen uses this value to replace tabs by spaces in code fragments.
153
154TAB_SIZE               = 8
155
156# This tag can be used to specify a number of aliases that acts
157# as commands in the documentation. An alias has the form "name=value".
158# For example adding "sideeffect=\par Side Effects:\n" will allow you to
159# put the command \sideeffect (or @sideeffect) in the documentation, which
160# will result in a user-defined paragraph with heading "Side Effects:".
161# You can put \n's in the value part of an alias to insert newlines.
162
163ALIASES                =
164
165# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
166# only. Doxygen will then generate output that is more tailored for C.
167# For instance, some of the names that are used will be different. The list
168# of all members will be omitted, etc.
169
170OPTIMIZE_OUTPUT_FOR_C  = YES
171
172# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
173# only. Doxygen will then generate output that is more tailored for Java.
174# For instance, namespaces will be presented as packages, qualified scopes
175# will look different, etc.
176
177OPTIMIZE_OUTPUT_JAVA   = NO
178
179# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
180# the same type (for instance a group of public functions) to be put as a
181# subgroup of that type (e.g. under the Public Functions section). Set it to
182# NO to prevent subgrouping. Alternatively, this can be done per class using
183# the \nosubgrouping command.
184
185SUBGROUPING            = YES
186
187#---------------------------------------------------------------------------
188# Build related configuration options
189#---------------------------------------------------------------------------
190
191# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
192# documentation are documented, even if no documentation was available.
193# Private class members and static file members will be hidden unless
194# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
195
[186]196EXTRACT_ALL            = NO
[242]197
198# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
199# will be included in the documentation.
200
[186]201EXTRACT_PRIVATE        = NO
[242]202
203# If the EXTRACT_STATIC tag is set to YES all static members of a file
204# will be included in the documentation.
205
[186]206EXTRACT_STATIC         = NO
[242]207
208# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
209# defined locally in source files will be included in the documentation.
210# If set to NO only classes defined in header files are included.
211
[186]212EXTRACT_LOCAL_CLASSES  = YES
[242]213
214# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
215# undocumented members of documented classes, files or namespaces.
216# If set to NO (the default) these members will be included in the
217# various overviews, but no documentation section is generated.
218# This option has no effect if EXTRACT_ALL is enabled.
219
[186]220HIDE_UNDOC_MEMBERS     = YES
[242]221
222# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
223# undocumented classes that are normally visible in the class hierarchy.
224# If set to NO (the default) these classes will be included in the various
225# overviews. This option has no effect if EXTRACT_ALL is enabled.
226
[186]227HIDE_UNDOC_CLASSES     = YES
[242]228
229# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
230# friend (class|struct|union) declarations.
231# If set to NO (the default) these declarations will be included in the
232# documentation.
233
[186]234HIDE_FRIEND_COMPOUNDS  = NO
[242]235
236# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
237# documentation blocks found inside the body of a function.
238# If set to NO (the default) these blocks will be appended to the
239# function's detailed documentation block.
240
[186]241HIDE_IN_BODY_DOCS      = NO
[242]242
243# The INTERNAL_DOCS tag determines if documentation
244# that is typed after a \internal command is included. If the tag is set
245# to NO (the default) then the documentation will be excluded.
246# Set it to YES to include the internal documentation.
247
[186]248INTERNAL_DOCS          = NO
[242]249
250# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
251# file names in lower-case letters. If set to YES upper-case letters are also
252# allowed. This is useful if you have classes or files whose names only differ
253# in case and if your file system supports case sensitive file names. Windows
254# users are advised to set this option to NO.
255
[186]256CASE_SENSE_NAMES       = YES
[242]257
258# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
259# will show members with their full class and namespace scopes in the
260# documentation. If set to YES the scope will be hidden.
261
[186]262HIDE_SCOPE_NAMES       = YES
[242]263
264# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
265# will put a list of the files that are included by a file in the documentation
266# of that file.
267
[186]268SHOW_INCLUDE_FILES     = YES
[242]269
270# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
271# is inserted in the documentation for inline members.
272
[186]273INLINE_INFO            = YES
[242]274
275# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
276# will sort the (detailed) documentation of file and class members
277# alphabetically by member name. If set to NO the members will appear in
278# declaration order.
279
[186]280SORT_MEMBER_DOCS       = NO
[242]281
282# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
283# brief documentation of file, namespace and class members alphabetically
284# by member name. If set to NO (the default) the members will appear in
285# declaration order.
286
287SORT_BRIEF_DOCS        = NO
288
289# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
290# sorted by fully-qualified names, including namespaces. If set to
291# NO (the default), the class list will be sorted only by class name,
292# not including the namespace part.
293# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
294# Note: This option applies only to the class list, not to the
295# alphabetical list.
296
297SORT_BY_SCOPE_NAME     = NO
298
299# The GENERATE_TODOLIST tag can be used to enable (YES) or
300# disable (NO) the todo list. This list is created by putting \todo
301# commands in the documentation.
302
[186]303GENERATE_TODOLIST      = YES
[242]304
305# The GENERATE_TESTLIST tag can be used to enable (YES) or
306# disable (NO) the test list. This list is created by putting \test
307# commands in the documentation.
308
[186]309GENERATE_TESTLIST      = YES
[242]310
311# The GENERATE_BUGLIST tag can be used to enable (YES) or
312# disable (NO) the bug list. This list is created by putting \bug
313# commands in the documentation.
314
[186]315GENERATE_BUGLIST       = YES
[242]316
317# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
318# disable (NO) the deprecated list. This list is created by putting
319# \deprecated commands in the documentation.
320
[186]321GENERATE_DEPRECATEDLIST= YES
[242]322
323# The ENABLED_SECTIONS tag can be used to enable conditional
324# documentation sections, marked by \if sectionname ... \endif.
325
[186]326ENABLED_SECTIONS       =
[242]327
328# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
329# the initial value of a variable or define consists of for it to appear in
330# the documentation. If the initializer consists of more lines than specified
331# here it will be hidden. Use a value of 0 to hide initializers completely.
332# The appearance of the initializer of individual variables and defines in the
333# documentation can be controlled using \showinitializer or \hideinitializer
334# command in the documentation regardless of this setting.
335
[186]336MAX_INITIALIZER_LINES  = 30
[242]337
338# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
339# at the bottom of the documentation of classes and structs. If set to YES the
340# list will mention the files that were used to generate the documentation.
341
[186]342SHOW_USED_FILES        = YES
[242]343
[186]344#---------------------------------------------------------------------------
345# configuration options related to warning and progress messages
346#---------------------------------------------------------------------------
[242]347
348# The QUIET tag can be used to turn on/off the messages that are generated
349# by doxygen. Possible values are YES and NO. If left blank NO is used.
350
[186]351QUIET                  = NO
[242]352
353# The WARNINGS tag can be used to turn on/off the warning messages that are
354# generated by doxygen. Possible values are YES and NO. If left blank
355# NO is used.
356
[186]357WARNINGS               = YES
[242]358
359# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
360# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
361# automatically be disabled.
362
[186]363WARN_IF_UNDOCUMENTED   = YES
[242]364
365# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
366# potential errors in the documentation, such as not documenting some
367# parameters in a documented function, or documenting parameters that
368# don't exist or using markup commands wrongly.
369
[186]370WARN_IF_DOC_ERROR      = YES
[242]371
372# The WARN_FORMAT tag determines the format of the warning messages that
373# doxygen can produce. The string should contain the $file, $line, and $text
374# tags, which will be replaced by the file and line number from which the
375# warning originated and the warning text.
376
[186]377WARN_FORMAT            = "$file:$line: $text"
[242]378
379# The WARN_LOGFILE tag can be used to specify a file to which warning
380# and error messages should be written. If left blank the output is written
381# to stderr.
382
[186]383WARN_LOGFILE           =
[242]384
[186]385#---------------------------------------------------------------------------
386# configuration options related to the input files
387#---------------------------------------------------------------------------
[242]388
389# The INPUT tag can be used to specify the files and/or directories that contain
390# documented source files. You may enter file names like "myfile.cpp" or
391# directories like "/usr/src/myproject". Separate the files or directories
392# with spaces.
393
[406]394INPUT                  = maps.dox groups.dox \
395                         ../src/include/skeletons/graph.h \
[253]396                         ../src/include/invalid.h \
397                         ../src/include/smart_graph.h \
398                         ../src/include/skeletons/maps.h \
[255]399                         ../src/include/dijkstra.h \
[274]400                         ../src/include/bin_heap.h \
[255]401                         ../src/include/fib_heap.h \
[406]402                         ../src/work/alpar/list_graph.h \
[289]403                         ../src/work/athos/xy/xy.h \
[319]404                         ../src/work/athos/minlengthpaths.h \
[343]405                         ../src/work/marci/time_measure.h \
[406]406                         ../src/work/marci/graph_wrapper.h
407                         
[242]408
409# If the value of the INPUT tag contains directories, you can use the
410# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
411# and *.h) to filter out the source-files in the directories. If left
412# blank the following patterns are tested:
413# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
414# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
415
[186]416FILE_PATTERNS          =
[242]417
418# The RECURSIVE tag can be used to turn specify whether or not subdirectories
419# should be searched for input files as well. Possible values are YES and NO.
420# If left blank NO is used.
421
[186]422RECURSIVE              = NO
[242]423
424# The EXCLUDE tag can be used to specify files and/or directories that should
425# excluded from the INPUT source files. This way you can easily exclude a
426# subdirectory from a directory tree whose root is specified with the INPUT tag.
427
[186]428EXCLUDE                =
[242]429
430# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
431# that are symbolic links (a Unix filesystem feature) are excluded from the input.
432
[186]433EXCLUDE_SYMLINKS       = NO
[242]434
435# If the value of the INPUT tag contains directories, you can use the
436# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
437# certain files from those directories.
438
[186]439EXCLUDE_PATTERNS       =
[242]440
441# The EXAMPLE_PATH tag can be used to specify one or more files or
442# directories that contain example code fragments that are included (see
443# the \include command).
444
[186]445EXAMPLE_PATH           = examples
[242]446
447# If the value of the EXAMPLE_PATH tag contains directories, you can use the
448# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
449# and *.h) to filter out the source-files in the directories. If left
450# blank all files are included.
451
[186]452EXAMPLE_PATTERNS       =
[242]453
454# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
455# searched for input files to be used with the \include or \dontinclude
456# commands irrespective of the value of the RECURSIVE tag.
457# Possible values are YES and NO. If left blank NO is used.
458
[186]459EXAMPLE_RECURSIVE      = NO
[242]460
461# The IMAGE_PATH tag can be used to specify one or more files or
462# directories that contain image that are included in the documentation (see
463# the \image command).
464
[186]465IMAGE_PATH             =
[242]466
467# The INPUT_FILTER tag can be used to specify a program that doxygen should
468# invoke to filter for each input file. Doxygen will invoke the filter program
469# by executing (via popen()) the command <filter> <input-file>, where <filter>
470# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
471# input file. Doxygen will then use the output that the filter program writes
472# to standard output.
473
[186]474INPUT_FILTER           =
[242]475
476# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
477# INPUT_FILTER) will be used to filter the input files when producing source
478# files to browse (i.e. when SOURCE_BROWSER is set to YES).
479
[186]480FILTER_SOURCE_FILES    = NO
[242]481
[186]482#---------------------------------------------------------------------------
483# configuration options related to source browsing
484#---------------------------------------------------------------------------
[242]485
486# If the SOURCE_BROWSER tag is set to YES then a list of source files will
487# be generated. Documented entities will be cross-referenced with these sources.
488# Note: To get rid of all source code in the generated output, make sure also
489# VERBATIM_HEADERS is set to NO.
490
[186]491SOURCE_BROWSER         = YES
[242]492
493# Setting the INLINE_SOURCES tag to YES will include the body
494# of functions and classes directly in the documentation.
495
[186]496INLINE_SOURCES         = NO
[242]497
498# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
499# doxygen to hide any special comment blocks from generated source code
500# fragments. Normal C and C++ comments will always remain visible.
501
[186]502STRIP_CODE_COMMENTS    = YES
[242]503
504# If the REFERENCED_BY_RELATION tag is set to YES (the default)
505# then for each documented function all documented
506# functions referencing it will be listed.
507
[186]508REFERENCED_BY_RELATION = YES
[242]509
510# If the REFERENCES_RELATION tag is set to YES (the default)
511# then for each documented function all documented entities
512# called/used by that function will be listed.
513
[186]514REFERENCES_RELATION    = YES
[242]515
516# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
517# will generate a verbatim copy of the header file for each class for
518# which an include is specified. Set to NO to disable this.
519
[186]520VERBATIM_HEADERS       = YES
[242]521
[186]522#---------------------------------------------------------------------------
523# configuration options related to the alphabetical class index
524#---------------------------------------------------------------------------
[242]525
526# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
527# of all compounds will be generated. Enable this if the project
528# contains a lot of classes, structs, unions or interfaces.
529
[186]530ALPHABETICAL_INDEX     = YES
[242]531
532# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
533# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
534# in which this list will be split (can be a number in the range [1..20])
535
[186]536COLS_IN_ALPHA_INDEX    = 2
[242]537
538# In case all classes in a project start with a common prefix, all
539# classes will be put under the same header in the alphabetical index.
540# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
541# should be ignored while generating the index headers.
542
[186]543IGNORE_PREFIX          =
[242]544
[186]545#---------------------------------------------------------------------------
546# configuration options related to the HTML output
547#---------------------------------------------------------------------------
[242]548
549# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
550# generate HTML output.
551
[186]552GENERATE_HTML          = YES
[242]553
554# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
555# If a relative path is entered the value of OUTPUT_DIRECTORY will be
556# put in front of it. If left blank `html' will be used as the default path.
557
[186]558HTML_OUTPUT            = html
[242]559
560# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
561# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
562# doxygen will generate files with .html extension.
563
[186]564HTML_FILE_EXTENSION    = .html
[242]565
566# The HTML_HEADER tag can be used to specify a personal HTML header for
567# each generated HTML page. If it is left blank doxygen will generate a
568# standard header.
569
[186]570HTML_HEADER            =
[242]571
572# The HTML_FOOTER tag can be used to specify a personal HTML footer for
573# each generated HTML page. If it is left blank doxygen will generate a
574# standard footer.
575
[186]576HTML_FOOTER            =
[242]577
578# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
579# style sheet that is used by each HTML page. It can be used to
580# fine-tune the look of the HTML output. If the tag is left blank doxygen
581# will generate a default style sheet. Note that doxygen will try to copy
582# the style sheet file to the HTML output directory, so don't put your own
583# stylesheet in the HTML output directory as well, or it will be erased!
584
[186]585HTML_STYLESHEET        =
[242]586
587# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
588# files or namespaces will be aligned in HTML using tables. If set to
589# NO a bullet list will be used.
590
[186]591HTML_ALIGN_MEMBERS     = YES
[242]592
593# If the GENERATE_HTMLHELP tag is set to YES, additional index files
594# will be generated that can be used as input for tools like the
595# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
596# of the generated HTML documentation.
597
[186]598GENERATE_HTMLHELP      = NO
[242]599
600# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
601# be used to specify the file name of the resulting .chm file. You
602# can add a path in front of the file if the result should not be
603# written to the html output directory.
604
[186]605CHM_FILE               =
[242]606
607# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
608# be used to specify the location (absolute path including file name) of
609# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
610# the HTML help compiler on the generated index.hhp.
611
[186]612HHC_LOCATION           =
[242]613
614# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
615# controls if a separate .chi index file is generated (YES) or that
616# it should be included in the master .chm file (NO).
617
[186]618GENERATE_CHI           = NO
[242]619
620# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
621# controls whether a binary table of contents is generated (YES) or a
622# normal table of contents (NO) in the .chm file.
623
[186]624BINARY_TOC             = NO
[242]625
626# The TOC_EXPAND flag can be set to YES to add extra items for group members
627# to the contents of the HTML help documentation and to the tree view.
628
[186]629TOC_EXPAND             = NO
[242]630
631# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
632# top of each HTML page. The value NO (the default) enables the index and
633# the value YES disables it.
634
[186]635DISABLE_INDEX          = NO
[242]636
637# This tag can be used to set the number of enum values (range [1..20])
638# that doxygen will group on one line in the generated HTML documentation.
639
[186]640ENUM_VALUES_PER_LINE   = 4
[242]641
642# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
643# generated containing a tree-like index structure (just like the one that
644# is generated for HTML Help). For this to work a browser that supports
645# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
646# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
647# probably better off using the HTML help feature.
648
[186]649GENERATE_TREEVIEW      = YES
[242]650
651# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
652# used to set the initial width (in pixels) of the frame in which the tree
653# is shown.
654
[186]655TREEVIEW_WIDTH         = 250
[242]656
[186]657#---------------------------------------------------------------------------
658# configuration options related to the LaTeX output
659#---------------------------------------------------------------------------
[242]660
661# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
662# generate Latex output.
663
[293]664GENERATE_LATEX         = NO
[242]665
666# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
667# If a relative path is entered the value of OUTPUT_DIRECTORY will be
668# put in front of it. If left blank `latex' will be used as the default path.
669
[186]670LATEX_OUTPUT           = latex
[242]671
672# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
673# invoked. If left blank `latex' will be used as the default command name.
674
[186]675LATEX_CMD_NAME         = latex
[242]676
677# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
678# generate index for LaTeX. If left blank `makeindex' will be used as the
679# default command name.
680
[186]681MAKEINDEX_CMD_NAME     = makeindex
[242]682
683# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
684# LaTeX documents. This may be useful for small projects and may help to
685# save some trees in general.
686
[186]687COMPACT_LATEX          = YES
[242]688
689# The PAPER_TYPE tag can be used to set the paper type that is used
690# by the printer. Possible values are: a4, a4wide, letter, legal and
691# executive. If left blank a4wide will be used.
692
[186]693PAPER_TYPE             = a4wide
[242]694
695# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
696# packages that should be included in the LaTeX output.
697
[186]698EXTRA_PACKAGES         =
[242]699
700# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
701# the generated latex document. The header should contain everything until
702# the first chapter. If it is left blank doxygen will generate a
703# standard header. Notice: only use this tag if you know what you are doing!
704
[186]705LATEX_HEADER           =
[242]706
707# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
708# is prepared for conversion to pdf (using ps2pdf). The pdf file will
709# contain links (just like the HTML output) instead of page references
710# This makes the output suitable for online browsing using a pdf viewer.
711
[186]712PDF_HYPERLINKS         = YES
[242]713
714# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
715# plain latex in the generated Makefile. Set this option to YES to get a
716# higher quality PDF documentation.
717
[186]718USE_PDFLATEX           = YES
[242]719
720# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
721# command to the generated LaTeX files. This will instruct LaTeX to keep
722# running if errors occur, instead of asking the user for help.
723# This option is also used when generating formulas in HTML.
724
[186]725LATEX_BATCHMODE        = NO
[242]726
727# If LATEX_HIDE_INDICES is set to YES then doxygen will not
728# include the index chapters (such as File Index, Compound Index, etc.)
729# in the output.
730
[186]731LATEX_HIDE_INDICES     = NO
[242]732
[186]733#---------------------------------------------------------------------------
734# configuration options related to the RTF output
735#---------------------------------------------------------------------------
[242]736
737# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
738# The RTF output is optimized for Word 97 and may not look very pretty with
739# other RTF readers or editors.
740
[186]741GENERATE_RTF           = NO
[242]742
743# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
744# If a relative path is entered the value of OUTPUT_DIRECTORY will be
745# put in front of it. If left blank `rtf' will be used as the default path.
746
[186]747RTF_OUTPUT             = rtf
[242]748
749# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
750# RTF documents. This may be useful for small projects and may help to
751# save some trees in general.
752
[186]753COMPACT_RTF            = NO
[242]754
755# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
756# will contain hyperlink fields. The RTF file will
757# contain links (just like the HTML output) instead of page references.
758# This makes the output suitable for online browsing using WORD or other
759# programs which support those fields.
760# Note: wordpad (write) and others do not support links.
761
[186]762RTF_HYPERLINKS         = NO
[242]763
764# Load stylesheet definitions from file. Syntax is similar to doxygen's
765# config file, i.e. a series of assignments. You only have to provide
766# replacements, missing definitions are set to their default value.
767
[186]768RTF_STYLESHEET_FILE    =
[242]769
770# Set optional variables used in the generation of an rtf document.
771# Syntax is similar to doxygen's config file.
772
[186]773RTF_EXTENSIONS_FILE    =
[242]774
[186]775#---------------------------------------------------------------------------
776# configuration options related to the man page output
777#---------------------------------------------------------------------------
[242]778
779# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
780# generate man pages
781
[186]782GENERATE_MAN           = NO
[242]783
784# The MAN_OUTPUT tag is used to specify where the man pages will be put.
785# If a relative path is entered the value of OUTPUT_DIRECTORY will be
786# put in front of it. If left blank `man' will be used as the default path.
787
[186]788MAN_OUTPUT             = man
[242]789
790# The MAN_EXTENSION tag determines the extension that is added to
791# the generated man pages (default is the subroutine's section .3)
792
[186]793MAN_EXTENSION          = .3
[242]794
795# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
796# then it will generate one additional man file for each entity
797# documented in the real man page(s). These additional files
798# only source the real man page, but without them the man command
799# would be unable to find the correct page. The default is NO.
800
[186]801MAN_LINKS              = NO
[242]802
[186]803#---------------------------------------------------------------------------
804# configuration options related to the XML output
805#---------------------------------------------------------------------------
[242]806
807# If the GENERATE_XML tag is set to YES Doxygen will
808# generate an XML file that captures the structure of
809# the code including all documentation.
810
[186]811GENERATE_XML           = NO
[242]812
813# The XML_OUTPUT tag is used to specify where the XML pages will be put.
814# If a relative path is entered the value of OUTPUT_DIRECTORY will be
815# put in front of it. If left blank `xml' will be used as the default path.
816
[186]817XML_OUTPUT             = xml
[242]818
819# The XML_SCHEMA tag can be used to specify an XML schema,
820# which can be used by a validating XML parser to check the
821# syntax of the XML files.
822
[186]823XML_SCHEMA             =
[242]824
825# The XML_DTD tag can be used to specify an XML DTD,
826# which can be used by a validating XML parser to check the
827# syntax of the XML files.
828
[186]829XML_DTD                =
[242]830
831# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
832# dump the program listings (including syntax highlighting
833# and cross-referencing information) to the XML output. Note that
834# enabling this will significantly increase the size of the XML output.
835
836XML_PROGRAMLISTING     = YES
837
[186]838#---------------------------------------------------------------------------
839# configuration options for the AutoGen Definitions output
840#---------------------------------------------------------------------------
[242]841
842# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
843# generate an AutoGen Definitions (see autogen.sf.net) file
844# that captures the structure of the code including all
845# documentation. Note that this feature is still experimental
846# and incomplete at the moment.
847
[186]848GENERATE_AUTOGEN_DEF   = NO
[242]849
[186]850#---------------------------------------------------------------------------
851# configuration options related to the Perl module output
852#---------------------------------------------------------------------------
[242]853
854# If the GENERATE_PERLMOD tag is set to YES Doxygen will
855# generate a Perl module file that captures the structure of
856# the code including all documentation. Note that this
857# feature is still experimental and incomplete at the
858# moment.
859
[186]860GENERATE_PERLMOD       = NO
[242]861
862# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
863# the necessary Makefile rules, Perl scripts and LaTeX code to be able
864# to generate PDF and DVI output from the Perl module output.
865
[186]866PERLMOD_LATEX          = NO
[242]867
868# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
869# nicely formatted so it can be parsed by a human reader.  This is useful
870# if you want to understand what is going on.  On the other hand, if this
871# tag is set to NO the size of the Perl module output will be much smaller
872# and Perl will parse it just the same.
873
[186]874PERLMOD_PRETTY         = YES
[242]875
876# The names of the make variables in the generated doxyrules.make file
877# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
878# This is useful so different doxyrules.make files included by the same
879# Makefile don't overwrite each other's variables.
880
[186]881PERLMOD_MAKEVAR_PREFIX =
[242]882
[186]883#---------------------------------------------------------------------------
884# Configuration options related to the preprocessor   
885#---------------------------------------------------------------------------
[242]886
887# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
888# evaluate all C-preprocessor directives found in the sources and include
889# files.
890
[186]891ENABLE_PREPROCESSING   = YES
[242]892
893# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
894# names in the source code. If set to NO (the default) only conditional
895# compilation will be performed. Macro expansion can be done in a controlled
896# way by setting EXPAND_ONLY_PREDEF to YES.
897
[186]898MACRO_EXPANSION        = NO
[242]899
900# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
901# then the macro expansion is limited to the macros specified with the
902# PREDEFINED and EXPAND_AS_PREDEFINED tags.
903
[186]904EXPAND_ONLY_PREDEF     = NO
[242]905
906# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
907# in the INCLUDE_PATH (see below) will be search if a #include is found.
908
[186]909SEARCH_INCLUDES        = YES
[242]910
911# The INCLUDE_PATH tag can be used to specify one or more directories that
912# contain include files that are not input files but should be processed by
913# the preprocessor.
914
[186]915INCLUDE_PATH           =
[242]916
917# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
918# patterns (like *.h and *.hpp) to filter out the header-files in the
919# directories. If left blank, the patterns specified with FILE_PATTERNS will
920# be used.
921
[186]922INCLUDE_FILE_PATTERNS  =
[242]923
924# The PREDEFINED tag can be used to specify one or more macro names that
925# are defined before the preprocessor is started (similar to the -D option of
926# gcc). The argument of the tag is a list of macros of the form: name
927# or name=definition (no spaces). If the definition and the = are
928# omitted =1 is assumed.
929
[186]930PREDEFINED             = DOXYGEN
[242]931
932# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
933# this tag can be used to specify a list of macro names that should be expanded.
934# The macro definition that is found in the sources will be used.
935# Use the PREDEFINED tag if you want to use a different macro definition.
936
[186]937EXPAND_AS_DEFINED      =
[242]938
939# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
940# doxygen's preprocessor will remove all function-like macros that are alone
941# on a line, have an all uppercase name, and do not end with a semicolon. Such
942# function macros are typically used for boiler-plate code, and will confuse the
943# parser if not removed.
944
[186]945SKIP_FUNCTION_MACROS   = YES
[242]946
[186]947#---------------------------------------------------------------------------
[242]948# Configuration::additions related to external references   
[186]949#---------------------------------------------------------------------------
[242]950
951# The TAGFILES option can be used to specify one or more tagfiles.
952# Optionally an initial location of the external documentation
953# can be added for each tagfile. The format of a tag file without
954# this location is as follows:
955#   TAGFILES = file1 file2 ...
956# Adding location for the tag files is done as follows:
957#   TAGFILES = file1=loc1 "file2 = loc2" ...
958# where "loc1" and "loc2" can be relative or absolute paths or
959# URLs. If a location is present for each tag, the installdox tool
960# does not have to be run to correct the links.
961# Note that each tag file must have a unique name
962# (where the name does NOT include the path)
963# If a tag file is not located in the directory in which doxygen
964# is run, you must also specify the path to the tagfile here.
965
[186]966TAGFILES               =
[242]967
968# When a file name is specified after GENERATE_TAGFILE, doxygen will create
969# a tag file that is based on the input files it reads.
970
[186]971GENERATE_TAGFILE       =
[242]972
973# If the ALLEXTERNALS tag is set to YES all external classes will be listed
974# in the class index. If set to NO only the inherited external classes
975# will be listed.
976
[186]977ALLEXTERNALS           = NO
[242]978
979# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
980# in the modules index. If set to NO, only the current project's groups will
981# be listed.
982
[186]983EXTERNAL_GROUPS        = YES
[242]984
985# The PERL_PATH should be the absolute path and name of the perl script
986# interpreter (i.e. the result of `which perl').
987
[186]988PERL_PATH              = /usr/bin/perl
[242]989
[186]990#---------------------------------------------------------------------------
991# Configuration options related to the dot tool   
992#---------------------------------------------------------------------------
[242]993
994# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
995# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
996# super classes. Setting the tag to NO turns the diagrams off. Note that this
997# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
998# recommended to install and use dot, since it yields more powerful graphs.
999
[186]1000CLASS_DIAGRAMS         = YES
[242]1001
1002# If set to YES, the inheritance and collaboration graphs will hide
1003# inheritance and usage relations if the target is undocumented
1004# or is not a class.
1005
[186]1006HIDE_UNDOC_RELATIONS   = NO
[242]1007
1008# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1009# available from the path. This tool is part of Graphviz, a graph visualization
1010# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1011# have no effect if this option is set to NO (the default)
1012
[186]1013HAVE_DOT               = YES
[242]1014
1015# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1016# will generate a graph for each documented class showing the direct and
1017# indirect inheritance relations. Setting this tag to YES will force the
1018# the CLASS_DIAGRAMS tag to NO.
1019
[186]1020CLASS_GRAPH            = YES
[242]1021
1022# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1023# will generate a graph for each documented class showing the direct and
1024# indirect implementation dependencies (inheritance, containment, and
1025# class references variables) of the class with other documented classes.
1026
[186]1027COLLABORATION_GRAPH    = YES
[242]1028
1029# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1030# collaboration diagrams in a style similar to the OMG's Unified Modeling
1031# Language.
1032
[186]1033UML_LOOK               = NO
[242]1034
1035# If set to YES, the inheritance and collaboration graphs will show the
1036# relations between templates and their instances.
1037
[186]1038TEMPLATE_RELATIONS     = YES
[242]1039
1040# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1041# tags are set to YES then doxygen will generate a graph for each documented
1042# file showing the direct and indirect include dependencies of the file with
1043# other documented files.
1044
[186]1045INCLUDE_GRAPH          = YES
[242]1046
1047# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1048# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1049# documented header file showing the documented files that directly or
1050# indirectly include this file.
1051
[186]1052INCLUDED_BY_GRAPH      = YES
[242]1053
1054# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1055# generate a call dependency graph for every global function or class method.
1056# Note that enabling this option will significantly increase the time of a run.
1057# So in most cases it will be better to enable call graphs for selected
1058# functions only using the \callgraph command.
1059
[186]1060CALL_GRAPH             = YES
[242]1061
1062# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1063# will graphical hierarchy of all classes instead of a textual one.
1064
[186]1065GRAPHICAL_HIERARCHY    = YES
[242]1066
1067# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1068# generated by dot. Possible values are png, jpg, or gif
1069# If left blank png will be used.
1070
[186]1071DOT_IMAGE_FORMAT       = png
[242]1072
1073# The tag DOT_PATH can be used to specify the path where the dot tool can be
1074# found. If left blank, it is assumed the dot tool can be found on the path.
1075
[186]1076DOT_PATH               =
[242]1077
1078# The DOTFILE_DIRS tag can be used to specify one or more directories that
1079# contain dot files that are included in the documentation (see the
1080# \dotfile command).
1081
[186]1082DOTFILE_DIRS           =
[242]1083
1084# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1085# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1086# this value, doxygen will try to truncate the graph, so that it fits within
1087# the specified constraint. Beware that most browsers cannot cope with very
1088# large images.
1089
[186]1090MAX_DOT_GRAPH_WIDTH    = 1024
[242]1091
1092# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1093# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1094# this value, doxygen will try to truncate the graph, so that it fits within
1095# the specified constraint. Beware that most browsers cannot cope with very
1096# large images.
1097
[186]1098MAX_DOT_GRAPH_HEIGHT   = 1024
[242]1099
1100# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1101# graphs generated by dot. A depth value of 3 means that only nodes reachable
1102# from the root by following a path via at most 3 edges will be shown. Nodes that
1103# lay further from the root node will be omitted. Note that setting this option to
1104# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1105# note that a graph may be further truncated if the graph's image dimensions are
1106# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1107# If 0 is used for the depth value (the default), the graph is not depth-constrained.
1108
[186]1109MAX_DOT_GRAPH_DEPTH    = 0
[242]1110
1111# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1112# generate a legend page explaining the meaning of the various boxes and
1113# arrows in the dot generated graphs.
1114
[186]1115GENERATE_LEGEND        = YES
[242]1116
1117# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1118# remove the intermediate dot files that are used to generate
1119# the various graphs.
1120
[186]1121DOT_CLEANUP            = YES
[242]1122
[186]1123#---------------------------------------------------------------------------
[242]1124# Configuration::additions related to the search engine   
[186]1125#---------------------------------------------------------------------------
[242]1126
1127# The SEARCHENGINE tag specifies whether or not a search engine should be
1128# used. If set to NO the values of all tags below this one will be ignored.
1129
[186]1130SEARCHENGINE           = YES
Note: See TracBrowser for help on using the repository browser.