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

Last change on this file since 1211 was 1211, checked in by Peter, 14 years ago

minor changes

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