source: branches/0.4-stable/doc/doxygen.config.in @ 1743

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

updating copyright statements

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