COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/Doxyfile @ 1030:c8a41699e613

Last change on this file since 1030:c8a41699e613 was 1030:c8a41699e613, checked in by Mihaly Barasz, 15 years ago

Undirected graph documentation and concept refinements.

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