COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/Doxyfile @ 462:0ab31578af67

Last change on this file since 462:0ab31578af67 was 462:0ab31578af67, checked in by beckerjc, 16 years ago

Doc for the union-find structures.

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