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

Last change on this file since 831 was 831, checked in by Peter, 15 years ago

Refs #185.

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