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

Last change on this file since 1258 was 1258, checked in by Peter, 13 years ago

enable alphabetical index and adding *.cc to file patterns. The rationale behind the latter change is that we have REFERENCED_BY_RELATION and REFERENCES_RELATION enabled, which adds references which functions are used and vice versa. In order to make sense, not only cover templates, we must allow doxygen to parse not only header files but all source code.

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