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

Last change on this file since 1637 was 1556, checked in by Jari Häkkinen, 13 years ago

Fixes #424

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