source: git/factory/doxygen.cfg @ 2537fa0

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