source: trunk/doc/doxygen.config.in @ 2526

Last change on this file since 2526 was 2354, checked in by Peter, 12 years ago

Before we generate other docs in other formats than html. Remove leftovers reflecting that.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 36.1 KB
Line 
1# @configure_input@
2# $Id: doxygen.config.in 2354 2010-11-30 16:56:28Z peter $
3
4# Copyright (C) 2003, 2004 Jari Häkkinen
5# Copyright (C) 2005 Peter Johansson
6# Copyright (C) 2006, 2007 Jari Häkkinen, Peter Johansson
7# Copyright (C) 2008 Jari Häkkinen, Peter Johansson, Markus Ringnér
8# Copyright (C) 2009, 2010 Peter Johansson
9#
10# This file is part of the yat library, http://dev.thep.lu.se/yat
11#
12# The yat library is free software; you can redistribute it
13# and/or modify it under the terms of the GNU General Public License as
14# published by the Free Software Foundation; either version 3 of the
15# License, or (at your option) any later version.
16#
17# The yat library is distributed in the hope that it will be useful,
18# but WITHOUT ANY WARRANTY; without even the implied warranty of
19# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20# General Public License for more details.
21#
22# You should have received a copy of the GNU General Public License
23# along with yat. If not, see <http://www.gnu.org/licenses/>.
24#
25
26# Doxyfile 1.2.13.1
27
28# This file describes the settings to be used by the documentation system
29# doxygen (www.doxygen.org) for a project
30#
31# All text after a hash (#) is considered a comment and will be ignored
32# The format is:
33#       TAG = value [value, ...]
34# For lists items can also be appended using:
35#       TAG += value [value, ...]
36# Values that contain spaces should be placed between quotes (" ")
37
38#---------------------------------------------------------------------------
39# General configuration options
40#---------------------------------------------------------------------------
41
42# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
43# by quotes) that should identify the project.
44
45PROJECT_NAME           = "@PACKAGE@"
46
47# The PROJECT_NUMBER tag can be used to enter a project or revision number.
48# This could be handy for archiving the generated documentation or
49# if some version control system is used.
50
51PROJECT_NUMBER         = @PACKAGE_VERSION@
52
53# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
54# base path where the generated documentation will be put.
55# If a relative path is entered, it will be relative to the location
56# where doxygen was started. If left blank the current directory will be used.
57
58OUTPUT_DIRECTORY       = .
59
60# The OUTPUT_LANGUAGE tag is used to specify the language in which all
61# documentation generated by doxygen is written. Doxygen will use this
62# information to generate all constant output in the proper language.
63# The default language is English, other supported languages are:
64# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
65# German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
66# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
67
68OUTPUT_LANGUAGE        = English
69
70# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
71# documentation are documented, even if no documentation was available.
72# Private class members and static file members will be hidden unless
73# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
74
75EXTRACT_ALL            = NO
76
77# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
78# will be included in the documentation.
79
80EXTRACT_PRIVATE        = NO
81
82# If the EXTRACT_STATIC tag is set to YES all static members of a file
83# will be included in the documentation.
84
85EXTRACT_STATIC         = NO
86
87# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
88# defined locally in source files will be included in the documentation.
89# If set to NO only classes defined in header files are included.
90
91EXTRACT_LOCAL_CLASSES  = YES
92
93# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
94# undocumented members of documented classes, files or namespaces.
95# If set to NO (the default) these members will be included in the
96# various overviews, but no documentation section is generated.
97# This option has no effect if EXTRACT_ALL is enabled.
98
99HIDE_UNDOC_MEMBERS     = NO
100
101# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
102# undocumented classes that are normally visible in the class hierarchy.
103# If set to NO (the default) these class will be included in the various
104# overviews. This option has no effect if EXTRACT_ALL is enabled.
105
106HIDE_UNDOC_CLASSES     = NO
107
108# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
109# include brief member descriptions after the members that are listed in
110# the file and class documentation (similar to JavaDoc).
111# Set to NO to disable this.
112
113BRIEF_MEMBER_DESC      = YES
114
115# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
116# the brief description of a member or function before the detailed description.
117# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
118# brief descriptions will be completely suppressed.
119
120REPEAT_BRIEF           = YES
121
122# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
123# Doxygen will generate a detailed section even if there is only a brief
124# description.
125
126ALWAYS_DETAILED_SEC    = NO
127
128# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
129# members of a class in the documentation of that class as if those members were
130# ordinary class members. Constructors, destructors and assignment operators of
131# the base classes will not be shown.
132
133INLINE_INHERITED_MEMB  = YES
134
135# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
136# path before files name in the file list and in the header files. If set
137# to NO the shortest path that makes the file name unique will be used.
138
139FULL_PATH_NAMES        = YES
140
141# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
142# can be used to strip a user defined part of the path. Stripping is
143# only done if one of the specified strings matches the left-hand part of
144# the path. It is allowed to use relative paths in the argument list.
145
146STRIP_FROM_PATH        = @top_srcdir@
147
148# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
149# the path mentioned in the documentation of a class, which tells
150# the reader which header file to include in order to use a class.
151# If left blank only the name of the header file containing the class
152# definition is used. Otherwise one should specify the include paths that
153# are normally passed to the compiler using the -I flag.
154
155STRIP_FROM_INC_PATH    = @top_srcdir@
156
157# The INTERNAL_DOCS tag determines if documentation
158# that is typed after a \internal command is included. If the tag is set
159# to NO (the default) then the documentation will be excluded.
160# Set it to YES to include the internal documentation.
161
162INTERNAL_DOCS          = YES
163
164# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
165# doxygen to hide any special comment blocks from generated source code
166# fragments. Normal C and C++ comments will always remain visible.
167
168STRIP_CODE_COMMENTS    = YES
169
170# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
171# file names in lower case letters. If set to YES upper case letters are also
172# allowed. This is useful if you have classes or files whose names only differ
173# in case and if your file system supports case sensitive file names. Windows
174# users are adviced to set this option to NO.
175
176CASE_SENSE_NAMES       = YES
177
178# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
179# (but less readable) file names. This can be useful is your file systems
180# doesn't support long names like on DOS, Mac, or CD-ROM.
181
182SHORT_NAMES            = NO
183
184# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
185# will show members with their full class and namespace scopes in the
186# documentation. If set to YES the scope will be hidden.
187
188HIDE_SCOPE_NAMES       = NO
189
190# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
191# will generate a verbatim copy of the header file for each class for
192# which an include is specified. Set to NO to disable this.
193
194VERBATIM_HEADERS       = YES
195
196# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
197# will put list of the files that are included by a file in the documentation
198# of that file.
199
200SHOW_INCLUDE_FILES     = YES
201
202# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
203# will interpret the first line (until the first dot) of a JavaDoc-style
204# comment as the brief description. If set to NO, the JavaDoc
205# comments  will behave just like the Qt-style comments (thus requiring an
206# explict @brief command for a brief description.
207
208JAVADOC_AUTOBRIEF      = NO
209
210# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
211# member inherits the documentation from any documented member that it
212# reimplements.
213
214INHERIT_DOCS           = YES
215
216# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
217# is inserted in the documentation for inline members.
218
219INLINE_INFO            = YES
220
221# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
222# will sort the (detailed) documentation of file and class members
223# alphabetically by member name. If set to NO the members will appear in
224# declaration order.
225
226SORT_MEMBER_DOCS       = YES
227
228# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
229# sorted by fully-qualified names, including namespaces. If set to
230# NO (the default), the class list will be sorted only by class name,
231# not including the namespace part.
232# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
233# Note: This option applies only to the class list, not to the
234# alphabetical list.
235
236SORT_BY_SCOPE_NAME     = YES
237
238# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
239# tag is set to YES, then doxygen will reuse the documentation of the first
240# member in the group (if any) for the other members of the group. By default
241# all members of a group must be documented explicitly.
242
243DISTRIBUTE_GROUP_DOC   = YES
244
245# The TAB_SIZE tag can be used to set the number of spaces in a tab.
246# Doxygen uses this value to replace tabs by spaces in code fragments.
247
248TAB_SIZE               = 2
249
250# The GENERATE_TODOLIST tag can be used to enable (YES) or
251# disable (NO) the todo list. This list is created by putting \todo
252# commands in the documentation.
253
254GENERATE_TODOLIST      = NO
255
256# The GENERATE_TESTLIST tag can be used to enable (YES) or
257# disable (NO) the test list. This list is created by putting \test
258# commands in the documentation.
259
260GENERATE_TESTLIST      = NO
261
262# The GENERATE_BUGLIST tag can be used to enable (YES) or
263# disable (NO) the bug list. This list is created by putting \bug
264# commands in the documentation.
265
266GENERATE_BUGLIST       = NO
267
268# This tag can be used to specify a number of aliases that acts
269# as commands in the documentation. An alias has the form "name=value".
270# For example adding "sideeffect=\par Side Effects:\n" will allow you to
271# put the command \sideeffect (or @sideeffect) in the documentation, which
272# will result in a user defined paragraph with heading "Side Effects:".
273# You can put \n's in the value part of an alias to insert newlines.
274
275ALIASES = "trivial_iterator=<a href=\"http://www.sgi.com/tech/stl/TrivialIterator.html\">Trivial Iterator</a>"
276ALIASES += "input_iterator=<a href=\"http://www.sgi.com/tech/stl/InputIterator.html\">Input Iterator</a>"
277ALIASES += "output_iterator=<a href=\"http://www.sgi.com/tech/stl/OutputIterator.html\">Output Iterator</a>"
278ALIASES += "forward_iterator=<a href=\"http://www.sgi.com/tech/stl/ForwardIterator.html\">Forward Iterator</a>"
279ALIASES += "bidirectional_iterator=<a href=\"http://www.sgi.com/tech/stl/BidirectionalIterator.html\">Bidirectional Iterator</a>"
280ALIASES += "random_access_iterator=<a href=\"http://www.sgi.com/tech/stl/RandomAccessIterator.html\">Random Access Iterator</a>"
281ALIASES += "boost_url=http://www.boost.org/doc/libs/1_35_0/libs"
282
283# The ENABLED_SECTIONS tag can be used to enable conditional
284# documentation sections, marked by \if sectionname ... \endif.
285
286ENABLED_SECTIONS       =
287
288# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
289# the initial value of a variable or define consist of for it to appear in
290# the documentation. If the initializer consists of more lines than specified
291# here it will be hidden. Use a value of 0 to hide initializers completely.
292# The appearance of the initializer of individual variables and defines in the
293# documentation can be controlled using \showinitializer or \hideinitializer
294# command in the documentation regardless of this setting.
295
296MAX_INITIALIZER_LINES  = 30
297
298# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
299# only. Doxygen will then generate output that is more tailored for C.
300# For instance some of the names that are used will be different. The list
301# of all members will be omitted, etc.
302
303OPTIMIZE_OUTPUT_FOR_C  = NO
304
305# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
306# at the bottom of the documentation of classes and structs. If set to YES the
307# list will mention the files that were used to generate the documentation.
308
309SHOW_USED_FILES        = YES
310
311#---------------------------------------------------------------------------
312# configuration options related to warning and progress messages
313#---------------------------------------------------------------------------
314
315# The QUIET tag can be used to turn on/off the messages that are generated
316# by doxygen. Possible values are YES and NO. If left blank NO is used.
317
318QUIET                  = NO
319
320# The WARNINGS tag can be used to turn on/off the warning messages that are
321# generated by doxygen. Possible values are YES and NO. If left blank
322# NO is used.
323
324WARNINGS               = YES
325
326# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
327# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
328# automatically be disabled.
329
330WARN_IF_UNDOCUMENTED   = YES
331
332# The WARN_FORMAT tag determines the format of the warning messages that
333# doxygen can produce. The string should contain the $file, $line, and $text
334# tags, which will be replaced by the file and line number from which the
335# warning originated and the warning text.
336
337WARN_FORMAT            =
338
339# The WARN_LOGFILE tag can be used to specify a file to which warning
340# and error messages should be written. If left blank the output is written
341# to stderr.
342
343WARN_LOGFILE           = doxygen.error
344
345#---------------------------------------------------------------------------
346# configuration options related to the input files
347#---------------------------------------------------------------------------
348
349# The RECURSIVE tag can be used to turn specify whether or not subdirectories
350# should be searched for input files as well. Possible values are YES and NO.
351# If left blank NO is used.
352
353RECURSIVE              = YES
354
355# The EXCLUDE tag can be used to specify files and/or directories that should
356# excluded from the INPUT source files. This way you can easily exclude a
357# subdirectory from a directory tree whose root is specified with the INPUT tag.
358
359EXCLUDE                =
360
361# If the value of the INPUT tag contains directories, you can use the
362# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
363# certain files from those directories.
364
365EXCLUDE_PATTERNS       = .svn .deps .libs .svndigest
366
367# The EXAMPLE_PATH tag can be used to specify one or more files or
368# directories that contain example code fragments that are included (see
369# the \include command).
370
371EXAMPLE_PATH           =
372
373# If the value of the EXAMPLE_PATH tag contains directories, you can use the
374# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
375# and *.h) to filter out the source-files in the directories. If left
376# blank all files are included.
377
378EXAMPLE_PATTERNS       =
379
380# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
381# searched for input files to be used with the \include or \dontinclude
382# commands irrespective of the value of the RECURSIVE tag.
383# Possible values are YES and NO. If left blank NO is used.
384
385EXAMPLE_RECURSIVE      = NO
386
387# The IMAGE_PATH tag can be used to specify one or more files or
388# directories that contain image that are included in the documentation (see
389# the \image command).
390
391IMAGE_PATH             =
392
393# The INPUT_FILTER tag can be used to specify a program that doxygen should
394# invoke to filter for each input file. Doxygen will invoke the filter program
395# by executing (via popen()) the command <filter> <input-file>, where <filter>
396# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
397# input file. Doxygen will then use the output that the filter program writes
398# to standard output.
399
400INPUT_FILTER           =
401
402# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
403# INPUT_FILTER) will be used to filter the input files when producing source
404# files to browse.
405
406FILTER_SOURCE_FILES    = NO
407
408#---------------------------------------------------------------------------
409# configuration options related to source browsing
410#---------------------------------------------------------------------------
411
412# If the SOURCE_BROWSER tag is set to YES then a list of source files will
413# be generated. Documented entities will be cross-referenced with these sources.
414
415SOURCE_BROWSER         = NO
416
417# Setting the INLINE_SOURCES tag to YES will include the body
418# of functions and classes directly in the documentation.
419
420INLINE_SOURCES         = NO
421
422# If the REFERENCED_BY_RELATION tag is set to YES (the default)
423# then for each documented function all documented
424# functions referencing it will be listed.
425
426REFERENCED_BY_RELATION = NO
427
428# If the REFERENCES_RELATION tag is set to YES (the default)
429# then for each documented function all documented entities
430# called/used by that function will be listed.
431
432REFERENCES_RELATION    = NO
433
434#---------------------------------------------------------------------------
435# configuration options related to the alphabetical class index
436#---------------------------------------------------------------------------
437
438# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
439# of all compounds will be generated. Enable this if the project
440# contains a lot of classes, structs, unions or interfaces.
441
442ALPHABETICAL_INDEX     = YES
443
444# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
445# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
446# in which this list will be split (can be a number in the range [1..20])
447
448COLS_IN_ALPHA_INDEX    = 5
449
450# In case all classes in a project start with a common prefix, all
451# classes will be put under the same header in the alphabetical index.
452# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
453# should be ignored while generating the index headers.
454
455IGNORE_PREFIX          =
456
457#---------------------------------------------------------------------------
458# configuration options related to the HTML output
459#---------------------------------------------------------------------------
460
461# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
462# generate HTML output.
463
464GENERATE_HTML          = NO
465
466# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
467# If a relative path is entered the value of OUTPUT_DIRECTORY will be
468# put in front of it. If left blank `html' will be used as the default path.
469
470HTML_OUTPUT            = @DX_HTML_OUTPUT@
471
472# The HTML_HEADER tag can be used to specify a personal HTML header for
473# each generated HTML page. If it is left blank doxygen will generate a
474# standard header.
475
476HTML_HEADER            =
477
478# The HTML_FOOTER tag can be used to specify a personal HTML footer for
479# each generated HTML page. If it is left blank doxygen will generate a
480# standard footer.
481
482HTML_FOOTER            = @srcdir@/footer.html
483
484# The HTML_STYLESHEET tag can be used to specify a user defined cascading
485# style sheet that is used by each HTML page. It can be used to
486# fine-tune the look of the HTML output. If the tag is left blank doxygen
487# will generate a default style sheet
488
489HTML_STYLESHEET        =
490
491# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
492# files or namespaces will be aligned in HTML using tables. If set to
493# NO a bullet list will be used.
494
495HTML_ALIGN_MEMBERS     = YES
496
497# If the GENERATE_HTMLHELP tag is set to YES, additional index files
498# will be generated that can be used as input for tools like the
499# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
500# of the generated HTML documentation.
501
502GENERATE_HTMLHELP      = NO
503
504# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
505# controls if a separate .chi index file is generated (YES) or that
506# it should be included in the master .chm file (NO).
507
508GENERATE_CHI           = NO
509
510# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
511# controls whether a binary table of contents is generated (YES) or a
512# normal table of contents (NO) in the .chm file.
513
514BINARY_TOC             = NO
515
516# The TOC_EXPAND flag can be set to YES to add extra items for group members
517# to the contents of the Html help documentation and to the tree view.
518
519TOC_EXPAND             = NO
520
521# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
522# top of each HTML page. The value NO (the default) enables the index and
523# the value YES disables it.
524
525DISABLE_INDEX          = NO
526
527# This tag can be used to set the number of enum values (range [1..20])
528# that doxygen will group on one line in the generated HTML documentation.
529
530ENUM_VALUES_PER_LINE   = 4
531
532# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
533# generated containing a tree-like index structure (just like the one that
534# is generated for HTML Help). For this to work a browser that supports
535# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
536# or Internet explorer 4.0+). Note that for large projects the tree generation
537# can take a very long time. In such cases it is better to disable this feature.
538# Windows users are probably better off using the HTML help feature.
539
540GENERATE_TREEVIEW      = NO
541
542# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
543# used to set the initial width (in pixels) of the frame in which the tree
544# is shown.
545
546TREEVIEW_WIDTH         = 250
547
548#---------------------------------------------------------------------------
549# configuration options related to the LaTeX output
550#---------------------------------------------------------------------------
551
552# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
553# generate Latex output.
554
555GENERATE_LATEX         = NO
556
557# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
558# If a relative path is entered the value of OUTPUT_DIRECTORY will be
559# put in front of it. If left blank `latex' will be used as the default path.
560
561LATEX_OUTPUT           =
562
563# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
564# LaTeX documents. This may be useful for small projects and may help to
565# save some trees in general.
566
567COMPACT_LATEX          = NO
568
569# The PAPER_TYPE tag can be used to set the paper type that is used
570# by the printer. Possible values are: a4, a4wide, letter, legal and
571# executive. If left blank a4wide will be used.
572
573PAPER_TYPE             = a4wide
574
575# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
576# packages that should be included in the LaTeX output.
577
578EXTRA_PACKAGES         =
579
580# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
581# the generated latex document. The header should contain everything until
582# the first chapter. If it is left blank doxygen will generate a
583# standard header. Notice: only use this tag if you know what you are doing!
584
585LATEX_HEADER           =
586
587# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
588# is prepared for conversion to pdf (using ps2pdf). The pdf file will
589# contain links (just like the HTML output) instead of page references
590# This makes the output suitable for online browsing using a pdf viewer.
591
592PDF_HYPERLINKS         = YES
593
594# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
595# plain latex in the generated Makefile. Set this option to YES to get a
596# higher quality PDF documentation.
597
598USE_PDFLATEX           = YES
599
600# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
601# command to the generated LaTeX files. This will instruct LaTeX to keep
602# running if errors occur, instead of asking the user for help.
603# This option is also used when generating formulas in HTML.
604
605LATEX_BATCHMODE        = NO
606
607#---------------------------------------------------------------------------
608# configuration options related to the RTF output
609#---------------------------------------------------------------------------
610
611# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
612# The RTF output is optimised for Word 97 and may not look very pretty with
613# other RTF readers or editors.
614
615GENERATE_RTF           = NO
616
617# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
618# If a relative path is entered the value of OUTPUT_DIRECTORY will be
619# put in front of it. If left blank `rtf' will be used as the default path.
620
621RTF_OUTPUT             =
622
623# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
624# RTF documents. This may be useful for small projects and may help to
625# save some trees in general.
626
627COMPACT_RTF            = NO
628
629# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
630# will contain hyperlink fields. The RTF file will
631# contain links (just like the HTML output) instead of page references.
632# This makes the output suitable for online browsing using WORD or other
633# programs which support those fields.
634# Note: wordpad (write) and others do not support links.
635
636RTF_HYPERLINKS         = NO
637
638# Load stylesheet definitions from file. Syntax is similar to doxygen's
639# config file, i.e. a series of assigments. You only have to provide
640# replacements, missing definitions are set to their default value.
641
642RTF_STYLESHEET_FILE    =
643
644# Set optional variables used in the generation of an rtf document.
645# Syntax is similar to doxygen's config file.
646
647RTF_EXTENSIONS_FILE    =
648
649#---------------------------------------------------------------------------
650# configuration options related to the man page output
651#---------------------------------------------------------------------------
652
653# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
654# generate man pages
655
656GENERATE_MAN           = NO
657
658# The MAN_OUTPUT tag is used to specify where the man pages will be put.
659# If a relative path is entered the value of OUTPUT_DIRECTORY will be
660# put in front of it. If left blank `man' will be used as the default path.
661
662MAN_OUTPUT             =
663
664# The MAN_EXTENSION tag determines the extension that is added to
665# the generated man pages (default is the subroutine's section .3)
666
667MAN_EXTENSION          =
668
669# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
670# then it will generate one additional man file for each entity
671# documented in the real man page(s). These additional files
672# only source the real man page, but without them the man command
673# would be unable to find the correct page. The default is NO.
674
675MAN_LINKS              = NO
676
677#---------------------------------------------------------------------------
678# configuration options related to the XML output
679#---------------------------------------------------------------------------
680
681# If the GENERATE_XML tag is set to YES Doxygen will
682# generate an XML file that captures the structure of
683# the code including all documentation. Note that this
684# feature is still experimental and incomplete at the
685# moment.
686
687GENERATE_XML           = NO
688
689#---------------------------------------------------------------------------
690# configuration options for the AutoGen Definitions output
691#---------------------------------------------------------------------------
692
693# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
694# generate an AutoGen Definitions (see autogen.sf.net) file
695# that captures the structure of the code including all
696# documentation. Note that this feature is still experimental
697# and incomplete at the moment.
698
699GENERATE_AUTOGEN_DEF   = NO
700
701#---------------------------------------------------------------------------
702# Configuration options related to the preprocessor   
703#---------------------------------------------------------------------------
704
705# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
706# evaluate all C-preprocessor directives found in the sources and include
707# files.
708
709ENABLE_PREPROCESSING   = YES
710
711# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
712# names in the source code. If set to NO (the default) only conditional
713# compilation will be performed. Macro expansion can be done in a controlled
714# way by setting EXPAND_ONLY_PREDEF to YES.
715
716MACRO_EXPANSION        = YES
717
718# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
719# then the macro expansion is limited to the macros specified with the
720# PREDEFINED and EXPAND_AS_PREDEFINED tags.
721
722EXPAND_ONLY_PREDEF     = YES
723
724# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
725# in the INCLUDE_PATH (see below) will be search if a #include is found.
726
727SEARCH_INCLUDES        = YES
728
729# The INCLUDE_PATH tag can be used to specify one or more directories that
730# contain include files that are not input files but should be processed by
731# the preprocessor.
732
733INCLUDE_PATH           =
734
735# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
736# patterns (like *.h and *.hpp) to filter out the header-files in the
737# directories. If left blank, the patterns specified with FILE_PATTERNS will
738# be used.
739
740INCLUDE_FILE_PATTERNS  =
741
742# The PREDEFINED tag can be used to specify one or more macro names that
743# are defined before the preprocessor is started (similar to the -D option of
744# gcc). The argument of the tag is a list of macros of the form: name
745# or name=definition (no spaces). If the definition and the = are
746# omitted =1 is assumed.
747
748PREDEFINED             = YAT_DEPRECATE=
749
750# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
751# this tag can be used to specify a list of macro names that should be expanded.
752# The macro definition that is found in the sources will be used.
753# Use the PREDEFINED tag if you want to use a different macro definition.
754
755EXPAND_AS_DEFINED      =
756
757# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
758# doxygen's preprocessor will remove all function-like macros that are alone
759# on a line and do not end with a semicolon. Such function macros are typically
760# used for boiler-plate code, and will confuse the parser if not removed.
761
762SKIP_FUNCTION_MACROS   = YES
763
764#---------------------------------------------------------------------------
765# Configuration::addtions related to external references   
766#---------------------------------------------------------------------------
767
768# The TAGFILES tag can be used to specify one or more tagfiles.
769
770TAGFILES               =
771
772# When a file name is specified after GENERATE_TAGFILE, doxygen will create
773# a tag file that is based on the input files it reads.
774
775GENERATE_TAGFILE       =
776
777# If the ALLEXTERNALS tag is set to YES all external classes will be listed
778# in the class index. If set to NO only the inherited external classes
779# will be listed.
780
781ALLEXTERNALS           = NO
782
783# The PERL_PATH should be the absolute path and name of the perl script
784# interpreter (i.e. the result of `which perl').
785
786PERL_PATH              = @PERL@
787
788#---------------------------------------------------------------------------
789# Configuration options related to the dot tool   
790#---------------------------------------------------------------------------
791
792# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
793# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
794# super classes. Setting the tag to NO turns the diagrams off. Note that this
795# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
796# recommended to install and use dot, since it yield more powerful graphs.
797
798CLASS_DIAGRAMS         = YES
799
800# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
801# available from the path. This tool is part of Graphviz, a graph visualization
802# toolkit from AT&T and Lucent Bell Labs. The other options in this section
803# have no effect if this option is set to NO (the default)
804
805HAVE_DOT               = NO
806
807# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
808# will generate a graph for each documented class showing the direct and
809# indirect inheritance relations. Setting this tag to YES will force the
810# the CLASS_DIAGRAMS tag to NO.
811
812CLASS_GRAPH            = YES
813
814# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
815# will generate a graph for each documented class showing the direct and
816# indirect implementation dependencies (inheritance, containment, and
817# class references variables) of the class with other documented classes.
818
819COLLABORATION_GRAPH    = YES
820
821# If set to YES, the inheritance and collaboration graphs will show the
822# relations between templates and their instances.
823
824TEMPLATE_RELATIONS     = YES
825
826# If set to YES, the inheritance and collaboration graphs will hide
827# inheritance and usage relations if the target is undocumented
828# or is not a class.
829
830HIDE_UNDOC_RELATIONS   = YES
831
832# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
833# tags are set to YES then doxygen will generate a graph for each documented
834# file showing the direct and indirect include dependencies of the file with
835# other documented files.
836
837INCLUDE_GRAPH          = YES
838
839# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
840# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
841# documented header file showing the documented files that directly or
842# indirectly include this file.
843
844INCLUDED_BY_GRAPH      = YES
845
846# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
847# will graphical hierarchy of all classes instead of a textual one.
848
849GRAPHICAL_HIERARCHY    = YES
850
851# The tag DOT_PATH can be used to specify the path where the dot tool can be
852# found. If left blank, it is assumed the dot tool can be found on the path.
853
854DOT_PATH               =
855
856# The DOTFILE_DIRS tag can be used to specify one or more directories that
857# contain dot files that are included in the documentation (see the
858# \dotfile command).
859
860DOTFILE_DIRS           =
861
862# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
863# generate a legend page explaining the meaning of the various boxes and
864# arrows in the dot generated graphs.
865
866GENERATE_LEGEND        = YES
867
868# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
869# remove the intermedate dot files that are used to generate
870# the various graphs.
871
872DOT_CLEANUP            = YES
873
874#---------------------------------------------------------------------------
875# Configuration::addtions related to the search engine   
876#---------------------------------------------------------------------------
877
878# The SEARCHENGINE tag specifies whether or not a search engine should be
879# used. If set to NO the values of all tags below this one will be ignored.
880
881SEARCHENGINE           = NO
882
883# The CGI_NAME tag should be the name of the CGI script that
884# starts the search engine (doxysearch) with the correct parameters.
885# A script with this name will be generated by doxygen.
886
887#CGI_NAME               =
888
889# The CGI_URL tag should be the absolute URL to the directory where the
890# cgi binaries are located. See the documentation of your http daemon for
891# details.
892
893#CGI_URL                =
894
895# The DOC_URL tag should be the absolute URL to the directory where the
896# documentation is located. If left blank the absolute path to the
897# documentation, with file:// prepended to it, will be used.
898
899#DOC_URL                =
900
901# The DOC_ABSPATH tag should be the absolute path to the directory where the
902# documentation is located. If left blank the directory on the local machine
903# will be used.
904
905#DOC_ABSPATH            =
906
907# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
908# is installed.
909
910#BIN_ABSPATH            =
911
912# The EXT_DOC_PATHS tag can be used to specify one or more paths to
913# documentation generated for other projects. This allows doxysearch to search
914# the documentation for these projects as well.
915
916#EXT_DOC_PATHS          =
Note: See TracBrowser for help on using the repository browser.