COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/Doxyfile @ 1003:ac4f15d1191a

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