COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/Doxyfile @ 479:82b7894bed0c

Last change on this file since 479:82b7894bed0c was 479:82b7894bed0c, checked in by Alpar Juttner, 16 years ago

Main page added.

File size: 45.4 KB
Line 
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 (" ")
12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
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
20PROJECT_NAME           = HugoLib
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
26PROJECT_NUMBER         = 0.1
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
33OUTPUT_DIRECTORY       =
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
44OUTPUT_LANGUAGE        = English
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
54USE_WINDOWS_ENCODING   = NO
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         = YES
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  = NO
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
196EXTRACT_ALL            = NO
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
201EXTRACT_PRIVATE        = NO
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
206EXTRACT_STATIC         = NO
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
212EXTRACT_LOCAL_CLASSES  = YES
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
220HIDE_UNDOC_MEMBERS     = YES
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
227HIDE_UNDOC_CLASSES     = YES
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
234HIDE_FRIEND_COMPOUNDS  = NO
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
241HIDE_IN_BODY_DOCS      = NO
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
248INTERNAL_DOCS          = NO
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
256CASE_SENSE_NAMES       = YES
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
262HIDE_SCOPE_NAMES       = YES
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
268SHOW_INCLUDE_FILES     = YES
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
273INLINE_INFO            = YES
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
280SORT_MEMBER_DOCS       = NO
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
303GENERATE_TODOLIST      = YES
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
309GENERATE_TESTLIST      = YES
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
315GENERATE_BUGLIST       = YES
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
321GENERATE_DEPRECATEDLIST= YES
322
323# The ENABLED_SECTIONS tag can be used to enable conditional
324# documentation sections, marked by \if sectionname ... \endif.
325
326ENABLED_SECTIONS       =
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
336MAX_INITIALIZER_LINES  = 30
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
342SHOW_USED_FILES        = YES
343
344#---------------------------------------------------------------------------
345# configuration options related to warning and progress messages
346#---------------------------------------------------------------------------
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
351QUIET                  = NO
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
357WARNINGS               = YES
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
363WARN_IF_UNDOCUMENTED   = YES
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
370WARN_IF_DOC_ERROR      = YES
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
377WARN_FORMAT            = "$file:$line: $text"
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
383WARN_LOGFILE           = doxygen.log
384
385#---------------------------------------------------------------------------
386# configuration options related to the input files
387#---------------------------------------------------------------------------
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
394INPUT                  = mainpage.dox \
395                         maps.dox groups.dox \
396                         ../src/include/skeletons/graph.h \
397                         ../src/include/invalid.h \
398                         ../src/include/smart_graph.h \
399                         ../src/include/skeletons/maps.h \
400                         ../src/include/dijkstra.h \
401                         ../src/include/bin_heap.h \
402                         ../src/include/fib_heap.h \
403                         ../src/include/dimacs.h \
404                         ../src/include/time_measure.h \
405                         ../src/include/xy.h \
406                         ../src/work/alpar/list_graph.h \
407                         ../src/work/athos/minlengthpaths.h \
408                         ../src/work/klao/path.h \
409                         ../src/work/johanna/unionfind.h \
410                         ../src/work/marci/graph_wrapper.h     
411                         
412
413# If the value of the INPUT tag contains directories, you can use the
414# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
415# and *.h) to filter out the source-files in the directories. If left
416# blank the following patterns are tested:
417# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
418# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
419
420FILE_PATTERNS          =
421
422# The RECURSIVE tag can be used to turn specify whether or not subdirectories
423# should be searched for input files as well. Possible values are YES and NO.
424# If left blank NO is used.
425
426RECURSIVE              = NO
427
428# The EXCLUDE tag can be used to specify files and/or directories that should
429# excluded from the INPUT source files. This way you can easily exclude a
430# subdirectory from a directory tree whose root is specified with the INPUT tag.
431
432EXCLUDE                =
433
434# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
435# that are symbolic links (a Unix filesystem feature) are excluded from the input.
436
437EXCLUDE_SYMLINKS       = NO
438
439# If the value of the INPUT tag contains directories, you can use the
440# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
441# certain files from those directories.
442
443EXCLUDE_PATTERNS       =
444
445# The EXAMPLE_PATH tag can be used to specify one or more files or
446# directories that contain example code fragments that are included (see
447# the \include command).
448
449EXAMPLE_PATH           = examples
450
451# If the value of the EXAMPLE_PATH tag contains directories, you can use the
452# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
453# and *.h) to filter out the source-files in the directories. If left
454# blank all files are included.
455
456EXAMPLE_PATTERNS       =
457
458# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
459# searched for input files to be used with the \include or \dontinclude
460# commands irrespective of the value of the RECURSIVE tag.
461# Possible values are YES and NO. If left blank NO is used.
462
463EXAMPLE_RECURSIVE      = NO
464
465# The IMAGE_PATH tag can be used to specify one or more files or
466# directories that contain image that are included in the documentation (see
467# the \image command).
468
469IMAGE_PATH             =
470
471# The INPUT_FILTER tag can be used to specify a program that doxygen should
472# invoke to filter for each input file. Doxygen will invoke the filter program
473# by executing (via popen()) the command <filter> <input-file>, where <filter>
474# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
475# input file. Doxygen will then use the output that the filter program writes
476# to standard output.
477
478INPUT_FILTER           =
479
480# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
481# INPUT_FILTER) will be used to filter the input files when producing source
482# files to browse (i.e. when SOURCE_BROWSER is set to YES).
483
484FILTER_SOURCE_FILES    = NO
485
486#---------------------------------------------------------------------------
487# configuration options related to source browsing
488#---------------------------------------------------------------------------
489
490# If the SOURCE_BROWSER tag is set to YES then a list of source files will
491# be generated. Documented entities will be cross-referenced with these sources.
492# Note: To get rid of all source code in the generated output, make sure also
493# VERBATIM_HEADERS is set to NO.
494
495SOURCE_BROWSER         = YES
496
497# Setting the INLINE_SOURCES tag to YES will include the body
498# of functions and classes directly in the documentation.
499
500INLINE_SOURCES         = NO
501
502# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
503# doxygen to hide any special comment blocks from generated source code
504# fragments. Normal C and C++ comments will always remain visible.
505
506STRIP_CODE_COMMENTS    = YES
507
508# If the REFERENCED_BY_RELATION tag is set to YES (the default)
509# then for each documented function all documented
510# functions referencing it will be listed.
511
512REFERENCED_BY_RELATION = YES
513
514# If the REFERENCES_RELATION tag is set to YES (the default)
515# then for each documented function all documented entities
516# called/used by that function will be listed.
517
518REFERENCES_RELATION    = YES
519
520# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
521# will generate a verbatim copy of the header file for each class for
522# which an include is specified. Set to NO to disable this.
523
524VERBATIM_HEADERS       = YES
525
526#---------------------------------------------------------------------------
527# configuration options related to the alphabetical class index
528#---------------------------------------------------------------------------
529
530# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
531# of all compounds will be generated. Enable this if the project
532# contains a lot of classes, structs, unions or interfaces.
533
534ALPHABETICAL_INDEX     = YES
535
536# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
537# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
538# in which this list will be split (can be a number in the range [1..20])
539
540COLS_IN_ALPHA_INDEX    = 2
541
542# In case all classes in a project start with a common prefix, all
543# classes will be put under the same header in the alphabetical index.
544# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
545# should be ignored while generating the index headers.
546
547IGNORE_PREFIX          =
548
549#---------------------------------------------------------------------------
550# configuration options related to the HTML output
551#---------------------------------------------------------------------------
552
553# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
554# generate HTML output.
555
556GENERATE_HTML          = YES
557
558# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
559# If a relative path is entered the value of OUTPUT_DIRECTORY will be
560# put in front of it. If left blank `html' will be used as the default path.
561
562HTML_OUTPUT            = html
563
564# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
565# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
566# doxygen will generate files with .html extension.
567
568HTML_FILE_EXTENSION    = .html
569
570# The HTML_HEADER tag can be used to specify a personal HTML header for
571# each generated HTML page. If it is left blank doxygen will generate a
572# standard header.
573
574HTML_HEADER            =
575
576# The HTML_FOOTER tag can be used to specify a personal HTML footer for
577# each generated HTML page. If it is left blank doxygen will generate a
578# standard footer.
579
580HTML_FOOTER            =
581
582# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
583# style sheet that is used by each HTML page. It can be used to
584# fine-tune the look of the HTML output. If the tag is left blank doxygen
585# will generate a default style sheet. Note that doxygen will try to copy
586# the style sheet file to the HTML output directory, so don't put your own
587# stylesheet in the HTML output directory as well, or it will be erased!
588
589HTML_STYLESHEET        =
590
591# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
592# files or namespaces will be aligned in HTML using tables. If set to
593# NO a bullet list will be used.
594
595HTML_ALIGN_MEMBERS     = YES
596
597# If the GENERATE_HTMLHELP tag is set to YES, additional index files
598# will be generated that can be used as input for tools like the
599# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
600# of the generated HTML documentation.
601
602GENERATE_HTMLHELP      = NO
603
604# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
605# be used to specify the file name of the resulting .chm file. You
606# can add a path in front of the file if the result should not be
607# written to the html output directory.
608
609CHM_FILE               =
610
611# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
612# be used to specify the location (absolute path including file name) of
613# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
614# the HTML help compiler on the generated index.hhp.
615
616HHC_LOCATION           =
617
618# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
619# controls if a separate .chi index file is generated (YES) or that
620# it should be included in the master .chm file (NO).
621
622GENERATE_CHI           = NO
623
624# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
625# controls whether a binary table of contents is generated (YES) or a
626# normal table of contents (NO) in the .chm file.
627
628BINARY_TOC             = NO
629
630# The TOC_EXPAND flag can be set to YES to add extra items for group members
631# to the contents of the HTML help documentation and to the tree view.
632
633TOC_EXPAND             = NO
634
635# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
636# top of each HTML page. The value NO (the default) enables the index and
637# the value YES disables it.
638
639DISABLE_INDEX          = NO
640
641# This tag can be used to set the number of enum values (range [1..20])
642# that doxygen will group on one line in the generated HTML documentation.
643
644ENUM_VALUES_PER_LINE   = 4
645
646# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
647# generated containing a tree-like index structure (just like the one that
648# is generated for HTML Help). For this to work a browser that supports
649# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
650# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
651# probably better off using the HTML help feature.
652
653GENERATE_TREEVIEW      = YES
654
655# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
656# used to set the initial width (in pixels) of the frame in which the tree
657# is shown.
658
659TREEVIEW_WIDTH         = 250
660
661#---------------------------------------------------------------------------
662# configuration options related to the LaTeX output
663#---------------------------------------------------------------------------
664
665# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
666# generate Latex output.
667
668GENERATE_LATEX         = NO
669
670# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
671# If a relative path is entered the value of OUTPUT_DIRECTORY will be
672# put in front of it. If left blank `latex' will be used as the default path.
673
674LATEX_OUTPUT           = latex
675
676# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
677# invoked. If left blank `latex' will be used as the default command name.
678
679LATEX_CMD_NAME         = latex
680
681# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
682# generate index for LaTeX. If left blank `makeindex' will be used as the
683# default command name.
684
685MAKEINDEX_CMD_NAME     = makeindex
686
687# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
688# LaTeX documents. This may be useful for small projects and may help to
689# save some trees in general.
690
691COMPACT_LATEX          = YES
692
693# The PAPER_TYPE tag can be used to set the paper type that is used
694# by the printer. Possible values are: a4, a4wide, letter, legal and
695# executive. If left blank a4wide will be used.
696
697PAPER_TYPE             = a4wide
698
699# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
700# packages that should be included in the LaTeX output.
701
702EXTRA_PACKAGES         =
703
704# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
705# the generated latex document. The header should contain everything until
706# the first chapter. If it is left blank doxygen will generate a
707# standard header. Notice: only use this tag if you know what you are doing!
708
709LATEX_HEADER           =
710
711# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
712# is prepared for conversion to pdf (using ps2pdf). The pdf file will
713# contain links (just like the HTML output) instead of page references
714# This makes the output suitable for online browsing using a pdf viewer.
715
716PDF_HYPERLINKS         = YES
717
718# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
719# plain latex in the generated Makefile. Set this option to YES to get a
720# higher quality PDF documentation.
721
722USE_PDFLATEX           = YES
723
724# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
725# command to the generated LaTeX files. This will instruct LaTeX to keep
726# running if errors occur, instead of asking the user for help.
727# This option is also used when generating formulas in HTML.
728
729LATEX_BATCHMODE        = NO
730
731# If LATEX_HIDE_INDICES is set to YES then doxygen will not
732# include the index chapters (such as File Index, Compound Index, etc.)
733# in the output.
734
735LATEX_HIDE_INDICES     = NO
736
737#---------------------------------------------------------------------------
738# configuration options related to the RTF output
739#---------------------------------------------------------------------------
740
741# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
742# The RTF output is optimized for Word 97 and may not look very pretty with
743# other RTF readers or editors.
744
745GENERATE_RTF           = NO
746
747# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
748# If a relative path is entered the value of OUTPUT_DIRECTORY will be
749# put in front of it. If left blank `rtf' will be used as the default path.
750
751RTF_OUTPUT             = rtf
752
753# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
754# RTF documents. This may be useful for small projects and may help to
755# save some trees in general.
756
757COMPACT_RTF            = NO
758
759# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
760# will contain hyperlink fields. The RTF file will
761# contain links (just like the HTML output) instead of page references.
762# This makes the output suitable for online browsing using WORD or other
763# programs which support those fields.
764# Note: wordpad (write) and others do not support links.
765
766RTF_HYPERLINKS         = NO
767
768# Load stylesheet definitions from file. Syntax is similar to doxygen's
769# config file, i.e. a series of assignments. You only have to provide
770# replacements, missing definitions are set to their default value.
771
772RTF_STYLESHEET_FILE    =
773
774# Set optional variables used in the generation of an rtf document.
775# Syntax is similar to doxygen's config file.
776
777RTF_EXTENSIONS_FILE    =
778
779#---------------------------------------------------------------------------
780# configuration options related to the man page output
781#---------------------------------------------------------------------------
782
783# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
784# generate man pages
785
786GENERATE_MAN           = NO
787
788# The MAN_OUTPUT tag is used to specify where the man pages will be put.
789# If a relative path is entered the value of OUTPUT_DIRECTORY will be
790# put in front of it. If left blank `man' will be used as the default path.
791
792MAN_OUTPUT             = man
793
794# The MAN_EXTENSION tag determines the extension that is added to
795# the generated man pages (default is the subroutine's section .3)
796
797MAN_EXTENSION          = .3
798
799# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
800# then it will generate one additional man file for each entity
801# documented in the real man page(s). These additional files
802# only source the real man page, but without them the man command
803# would be unable to find the correct page. The default is NO.
804
805MAN_LINKS              = NO
806
807#---------------------------------------------------------------------------
808# configuration options related to the XML output
809#---------------------------------------------------------------------------
810
811# If the GENERATE_XML tag is set to YES Doxygen will
812# generate an XML file that captures the structure of
813# the code including all documentation.
814
815GENERATE_XML           = NO
816
817# The XML_OUTPUT tag is used to specify where the XML pages will be put.
818# If a relative path is entered the value of OUTPUT_DIRECTORY will be
819# put in front of it. If left blank `xml' will be used as the default path.
820
821XML_OUTPUT             = xml
822
823# The XML_SCHEMA tag can be used to specify an XML schema,
824# which can be used by a validating XML parser to check the
825# syntax of the XML files.
826
827XML_SCHEMA             =
828
829# The XML_DTD tag can be used to specify an XML DTD,
830# which can be used by a validating XML parser to check the
831# syntax of the XML files.
832
833XML_DTD                =
834
835# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
836# dump the program listings (including syntax highlighting
837# and cross-referencing information) to the XML output. Note that
838# enabling this will significantly increase the size of the XML output.
839
840XML_PROGRAMLISTING     = YES
841
842#---------------------------------------------------------------------------
843# configuration options for the AutoGen Definitions output
844#---------------------------------------------------------------------------
845
846# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
847# generate an AutoGen Definitions (see autogen.sf.net) file
848# that captures the structure of the code including all
849# documentation. Note that this feature is still experimental
850# and incomplete at the moment.
851
852GENERATE_AUTOGEN_DEF   = NO
853
854#---------------------------------------------------------------------------
855# configuration options related to the Perl module output
856#---------------------------------------------------------------------------
857
858# If the GENERATE_PERLMOD tag is set to YES Doxygen will
859# generate a Perl module file that captures the structure of
860# the code including all documentation. Note that this
861# feature is still experimental and incomplete at the
862# moment.
863
864GENERATE_PERLMOD       = NO
865
866# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
867# the necessary Makefile rules, Perl scripts and LaTeX code to be able
868# to generate PDF and DVI output from the Perl module output.
869
870PERLMOD_LATEX          = NO
871
872# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
873# nicely formatted so it can be parsed by a human reader.  This is useful
874# if you want to understand what is going on.  On the other hand, if this
875# tag is set to NO the size of the Perl module output will be much smaller
876# and Perl will parse it just the same.
877
878PERLMOD_PRETTY         = YES
879
880# The names of the make variables in the generated doxyrules.make file
881# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
882# This is useful so different doxyrules.make files included by the same
883# Makefile don't overwrite each other's variables.
884
885PERLMOD_MAKEVAR_PREFIX =
886
887#---------------------------------------------------------------------------
888# Configuration options related to the preprocessor   
889#---------------------------------------------------------------------------
890
891# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
892# evaluate all C-preprocessor directives found in the sources and include
893# files.
894
895ENABLE_PREPROCESSING   = YES
896
897# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
898# names in the source code. If set to NO (the default) only conditional
899# compilation will be performed. Macro expansion can be done in a controlled
900# way by setting EXPAND_ONLY_PREDEF to YES.
901
902MACRO_EXPANSION        = NO
903
904# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
905# then the macro expansion is limited to the macros specified with the
906# PREDEFINED and EXPAND_AS_PREDEFINED tags.
907
908EXPAND_ONLY_PREDEF     = NO
909
910# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
911# in the INCLUDE_PATH (see below) will be search if a #include is found.
912
913SEARCH_INCLUDES        = YES
914
915# The INCLUDE_PATH tag can be used to specify one or more directories that
916# contain include files that are not input files but should be processed by
917# the preprocessor.
918
919INCLUDE_PATH           =
920
921# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
922# patterns (like *.h and *.hpp) to filter out the header-files in the
923# directories. If left blank, the patterns specified with FILE_PATTERNS will
924# be used.
925
926INCLUDE_FILE_PATTERNS  =
927
928# The PREDEFINED tag can be used to specify one or more macro names that
929# are defined before the preprocessor is started (similar to the -D option of
930# gcc). The argument of the tag is a list of macros of the form: name
931# or name=definition (no spaces). If the definition and the = are
932# omitted =1 is assumed.
933
934PREDEFINED             = DOXYGEN
935
936# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
937# this tag can be used to specify a list of macro names that should be expanded.
938# The macro definition that is found in the sources will be used.
939# Use the PREDEFINED tag if you want to use a different macro definition.
940
941EXPAND_AS_DEFINED      =
942
943# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
944# doxygen's preprocessor will remove all function-like macros that are alone
945# on a line, have an all uppercase name, and do not end with a semicolon. Such
946# function macros are typically used for boiler-plate code, and will confuse the
947# parser if not removed.
948
949SKIP_FUNCTION_MACROS   = YES
950
951#---------------------------------------------------------------------------
952# Configuration::additions related to external references   
953#---------------------------------------------------------------------------
954
955# The TAGFILES option can be used to specify one or more tagfiles.
956# Optionally an initial location of the external documentation
957# can be added for each tagfile. The format of a tag file without
958# this location is as follows:
959#   TAGFILES = file1 file2 ...
960# Adding location for the tag files is done as follows:
961#   TAGFILES = file1=loc1 "file2 = loc2" ...
962# where "loc1" and "loc2" can be relative or absolute paths or
963# URLs. If a location is present for each tag, the installdox tool
964# does not have to be run to correct the links.
965# Note that each tag file must have a unique name
966# (where the name does NOT include the path)
967# If a tag file is not located in the directory in which doxygen
968# is run, you must also specify the path to the tagfile here.
969
970TAGFILES               =
971
972# When a file name is specified after GENERATE_TAGFILE, doxygen will create
973# a tag file that is based on the input files it reads.
974
975GENERATE_TAGFILE       =
976
977# If the ALLEXTERNALS tag is set to YES all external classes will be listed
978# in the class index. If set to NO only the inherited external classes
979# will be listed.
980
981ALLEXTERNALS           = NO
982
983# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
984# in the modules index. If set to NO, only the current project's groups will
985# be listed.
986
987EXTERNAL_GROUPS        = YES
988
989# The PERL_PATH should be the absolute path and name of the perl script
990# interpreter (i.e. the result of `which perl').
991
992PERL_PATH              = /usr/bin/perl
993
994#---------------------------------------------------------------------------
995# Configuration options related to the dot tool   
996#---------------------------------------------------------------------------
997
998# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
999# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1000# super classes. Setting the tag to NO turns the diagrams off. Note that this
1001# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1002# recommended to install and use dot, since it yields more powerful graphs.
1003
1004CLASS_DIAGRAMS         = YES
1005
1006# If set to YES, the inheritance and collaboration graphs will hide
1007# inheritance and usage relations if the target is undocumented
1008# or is not a class.
1009
1010HIDE_UNDOC_RELATIONS   = NO
1011
1012# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1013# available from the path. This tool is part of Graphviz, a graph visualization
1014# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1015# have no effect if this option is set to NO (the default)
1016
1017HAVE_DOT               = YES
1018
1019# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1020# will generate a graph for each documented class showing the direct and
1021# indirect inheritance relations. Setting this tag to YES will force the
1022# the CLASS_DIAGRAMS tag to NO.
1023
1024CLASS_GRAPH            = YES
1025
1026# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1027# will generate a graph for each documented class showing the direct and
1028# indirect implementation dependencies (inheritance, containment, and
1029# class references variables) of the class with other documented classes.
1030
1031COLLABORATION_GRAPH    = YES
1032
1033# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1034# collaboration diagrams in a style similar to the OMG's Unified Modeling
1035# Language.
1036
1037UML_LOOK               = NO
1038
1039# If set to YES, the inheritance and collaboration graphs will show the
1040# relations between templates and their instances.
1041
1042TEMPLATE_RELATIONS     = YES
1043
1044# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1045# tags are set to YES then doxygen will generate a graph for each documented
1046# file showing the direct and indirect include dependencies of the file with
1047# other documented files.
1048
1049INCLUDE_GRAPH          = YES
1050
1051# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1052# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1053# documented header file showing the documented files that directly or
1054# indirectly include this file.
1055
1056INCLUDED_BY_GRAPH      = YES
1057
1058# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1059# generate a call dependency graph for every global function or class method.
1060# Note that enabling this option will significantly increase the time of a run.
1061# So in most cases it will be better to enable call graphs for selected
1062# functions only using the \callgraph command.
1063
1064CALL_GRAPH             = YES
1065
1066# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1067# will graphical hierarchy of all classes instead of a textual one.
1068
1069GRAPHICAL_HIERARCHY    = YES
1070
1071# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1072# generated by dot. Possible values are png, jpg, or gif
1073# If left blank png will be used.
1074
1075DOT_IMAGE_FORMAT       = png
1076
1077# The tag DOT_PATH can be used to specify the path where the dot tool can be
1078# found. If left blank, it is assumed the dot tool can be found on the path.
1079
1080DOT_PATH               =
1081
1082# The DOTFILE_DIRS tag can be used to specify one or more directories that
1083# contain dot files that are included in the documentation (see the
1084# \dotfile command).
1085
1086DOTFILE_DIRS           =
1087
1088# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1089# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1090# this value, doxygen will try to truncate the graph, so that it fits within
1091# the specified constraint. Beware that most browsers cannot cope with very
1092# large images.
1093
1094MAX_DOT_GRAPH_WIDTH    = 1024
1095
1096# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1097# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1098# this value, doxygen will try to truncate the graph, so that it fits within
1099# the specified constraint. Beware that most browsers cannot cope with very
1100# large images.
1101
1102MAX_DOT_GRAPH_HEIGHT   = 1024
1103
1104# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1105# graphs generated by dot. A depth value of 3 means that only nodes reachable
1106# from the root by following a path via at most 3 edges will be shown. Nodes that
1107# lay further from the root node will be omitted. Note that setting this option to
1108# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1109# note that a graph may be further truncated if the graph's image dimensions are
1110# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1111# If 0 is used for the depth value (the default), the graph is not depth-constrained.
1112
1113MAX_DOT_GRAPH_DEPTH    = 0
1114
1115# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1116# generate a legend page explaining the meaning of the various boxes and
1117# arrows in the dot generated graphs.
1118
1119GENERATE_LEGEND        = YES
1120
1121# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1122# remove the intermediate dot files that are used to generate
1123# the various graphs.
1124
1125DOT_CLEANUP            = YES
1126
1127#---------------------------------------------------------------------------
1128# Configuration::additions related to the search engine   
1129#---------------------------------------------------------------------------
1130
1131# The SEARCHENGINE tag specifies whether or not a search engine should be
1132# used. If set to NO the values of all tags below this one will be ignored.
1133
1134SEARCHENGINE           = YES
Note: See TracBrowser for help on using the repository browser.