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

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

Revised make dependencies for generating doxygen docs (fixes #438 and #501).

In doxygen.config removed variables INPUT and FILE_PATTERN to avoid us
from editing these values. The variables ignored in the new setup.

doc/Makefile includes a 'doxygen.mk' located in each of the
directories with header files. This is similar to how Maefiles include
files from '.deps/' to get dependencies for source and header
files. The inclusion relies on an undocumented feature in Automake,
but it should likely not be a problem with future versions of Automake
as it has been frequently been mentioned as a solution on the automake
mailing list.

These 'doxygen.mk' are generated during 'make all' in each of these
directories; they are also updated during 'make {doc|html|dvi|ps|pdf}'
in topdir and topdir/yat. This latter is to avoid situations in which
doc/Makefile is corrupted because of missing include.

This implies that obscure things like
make clean && cd doc && make doc
will fail noisily.

One could let doc/Makefile go into yat/subdirs and create the
doxygen.mk files but I don't like that kind of setup.

Another thought might be to have doxygen.mk removed during 'make
distclean' rather than 'make clean'. Thoughts are welcome.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 36.0 KB
Line 
1# @configure_input@
2# $Id: doxygen.config.in 1905 2009-04-17 16:46:43Z 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 Jari Häkkinen, Peter Johansson, Markus Ringnér
8# Copyright (C) 2009 Peter Johansson
9#
10# This file is part of the yat library, http://dev.thep.lu.se/yat
11#
12# The yat library is free software; you can redistribute it
13# and/or modify it under the terms of the GNU General Public License as
14# published by the Free Software Foundation; either version 3 of the
15# License, or (at your option) any later version.
16#
17# The yat library is distributed in the hope that it will be useful,
18# but WITHOUT ANY WARRANTY; without even the implied warranty of
19# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20# General Public License for more details.
21#
22# You should have received a copy of the GNU General Public License
23# along with yat. If not, see <http://www.gnu.org/licenses/>.
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 = "trivial_iterator=<a href=\"http://www.sgi.com/tech/stl/TrivialIterator.html\">Trivial Iterator</a>"
276ALIASES += "input_iterator=<a href=\"http://www.sgi.com/tech/stl/InputIterator.html\">Input Iterator</a>"
277ALIASES += "output_iterator=<a href=\"http://www.sgi.com/tech/stl/OutputIterator.html\">Output Iterator</a>"
278ALIASES += "forward_iterator=<a href=\"http://www.sgi.com/tech/stl/ForwardIterator.html\">Forward Iterator</a>"
279ALIASES += "bidirectional_iterator=<a href=\"http://www.sgi.com/tech/stl/BidirectionalIterator.html\">Bidirectional Iterator</a>"
280ALIASES += "random_access_iterator=<a href=\"http://www.sgi.com/tech/stl/RandomAccessIterator.html\">Random Access Iterator</a>"
281
282# The ENABLED_SECTIONS tag can be used to enable conditional
283# documentation sections, marked by \if sectionname ... \endif.
284
285ENABLED_SECTIONS       =
286
287# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
288# the initial value of a variable or define consist of for it to appear in
289# the documentation. If the initializer consists of more lines than specified
290# here it will be hidden. Use a value of 0 to hide initializers completely.
291# The appearance of the initializer of individual variables and defines in the
292# documentation can be controlled using \showinitializer or \hideinitializer
293# command in the documentation regardless of this setting.
294
295MAX_INITIALIZER_LINES  = 30
296
297# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
298# only. Doxygen will then generate output that is more tailored for C.
299# For instance some of the names that are used will be different. The list
300# of all members will be omitted, etc.
301
302OPTIMIZE_OUTPUT_FOR_C  = NO
303
304# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
305# at the bottom of the documentation of classes and structs. If set to YES the
306# list will mention the files that were used to generate the documentation.
307
308SHOW_USED_FILES        = YES
309
310#---------------------------------------------------------------------------
311# configuration options related to warning and progress messages
312#---------------------------------------------------------------------------
313
314# The QUIET tag can be used to turn on/off the messages that are generated
315# by doxygen. Possible values are YES and NO. If left blank NO is used.
316
317QUIET                  = NO
318
319# The WARNINGS tag can be used to turn on/off the warning messages that are
320# generated by doxygen. Possible values are YES and NO. If left blank
321# NO is used.
322
323WARNINGS               = YES
324
325# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
326# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
327# automatically be disabled.
328
329WARN_IF_UNDOCUMENTED   = YES
330
331# The WARN_FORMAT tag determines the format of the warning messages that
332# doxygen can produce. The string should contain the $file, $line, and $text
333# tags, which will be replaced by the file and line number from which the
334# warning originated and the warning text.
335
336WARN_FORMAT            =
337
338# The WARN_LOGFILE tag can be used to specify a file to which warning
339# and error messages should be written. If left blank the output is written
340# to stderr.
341
342WARN_LOGFILE           = doxygen.error
343
344#---------------------------------------------------------------------------
345# configuration options related to the input files
346#---------------------------------------------------------------------------
347
348# The RECURSIVE tag can be used to turn specify whether or not subdirectories
349# should be searched for input files as well. Possible values are YES and NO.
350# If left blank NO is used.
351
352RECURSIVE              = YES
353
354# The EXCLUDE tag can be used to specify files and/or directories that should
355# excluded from the INPUT source files. This way you can easily exclude a
356# subdirectory from a directory tree whose root is specified with the INPUT tag.
357
358EXCLUDE                =
359
360# If the value of the INPUT tag contains directories, you can use the
361# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
362# certain files from those directories.
363
364EXCLUDE_PATTERNS       = .svn .deps .libs .svndigest
365
366# The EXAMPLE_PATH tag can be used to specify one or more files or
367# directories that contain example code fragments that are included (see
368# the \include command).
369
370EXAMPLE_PATH           =
371
372# If the value of the EXAMPLE_PATH tag contains directories, you can use the
373# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
374# and *.h) to filter out the source-files in the directories. If left
375# blank all files are included.
376
377EXAMPLE_PATTERNS       =
378
379# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
380# searched for input files to be used with the \include or \dontinclude
381# commands irrespective of the value of the RECURSIVE tag.
382# Possible values are YES and NO. If left blank NO is used.
383
384EXAMPLE_RECURSIVE      = NO
385
386# The IMAGE_PATH tag can be used to specify one or more files or
387# directories that contain image that are included in the documentation (see
388# the \image command).
389
390IMAGE_PATH             =
391
392# The INPUT_FILTER tag can be used to specify a program that doxygen should
393# invoke to filter for each input file. Doxygen will invoke the filter program
394# by executing (via popen()) the command <filter> <input-file>, where <filter>
395# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
396# input file. Doxygen will then use the output that the filter program writes
397# to standard output.
398
399INPUT_FILTER           =
400
401# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
402# INPUT_FILTER) will be used to filter the input files when producing source
403# files to browse.
404
405FILTER_SOURCE_FILES    = NO
406
407#---------------------------------------------------------------------------
408# configuration options related to source browsing
409#---------------------------------------------------------------------------
410
411# If the SOURCE_BROWSER tag is set to YES then a list of source files will
412# be generated. Documented entities will be cross-referenced with these sources.
413
414SOURCE_BROWSER         = NO
415
416# Setting the INLINE_SOURCES tag to YES will include the body
417# of functions and classes directly in the documentation.
418
419INLINE_SOURCES         = NO
420
421# If the REFERENCED_BY_RELATION tag is set to YES (the default)
422# then for each documented function all documented
423# functions referencing it will be listed.
424
425REFERENCED_BY_RELATION = NO
426
427# If the REFERENCES_RELATION tag is set to YES (the default)
428# then for each documented function all documented entities
429# called/used by that function will be listed.
430
431REFERENCES_RELATION    = NO
432
433#---------------------------------------------------------------------------
434# configuration options related to the alphabetical class index
435#---------------------------------------------------------------------------
436
437# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
438# of all compounds will be generated. Enable this if the project
439# contains a lot of classes, structs, unions or interfaces.
440
441ALPHABETICAL_INDEX     = YES
442
443# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
444# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
445# in which this list will be split (can be a number in the range [1..20])
446
447COLS_IN_ALPHA_INDEX    = 5
448
449# In case all classes in a project start with a common prefix, all
450# classes will be put under the same header in the alphabetical index.
451# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
452# should be ignored while generating the index headers.
453
454IGNORE_PREFIX          =
455
456#---------------------------------------------------------------------------
457# configuration options related to the HTML output
458#---------------------------------------------------------------------------
459
460# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
461# generate HTML output.
462
463GENERATE_HTML          = NO
464
465# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
466# If a relative path is entered the value of OUTPUT_DIRECTORY will be
467# put in front of it. If left blank `html' will be used as the default path.
468
469HTML_OUTPUT            = @DX_HTML_OUTPUT@
470
471# The HTML_HEADER tag can be used to specify a personal HTML header for
472# each generated HTML page. If it is left blank doxygen will generate a
473# standard header.
474
475HTML_HEADER            =
476
477# The HTML_FOOTER tag can be used to specify a personal HTML footer for
478# each generated HTML page. If it is left blank doxygen will generate a
479# standard footer.
480
481HTML_FOOTER            =
482
483# The HTML_STYLESHEET tag can be used to specify a user defined cascading
484# style sheet that is used by each HTML page. It can be used to
485# fine-tune the look of the HTML output. If the tag is left blank doxygen
486# will generate a default style sheet
487
488HTML_STYLESHEET        =
489
490# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
491# files or namespaces will be aligned in HTML using tables. If set to
492# NO a bullet list will be used.
493
494HTML_ALIGN_MEMBERS     = YES
495
496# If the GENERATE_HTMLHELP tag is set to YES, additional index files
497# will be generated that can be used as input for tools like the
498# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
499# of the generated HTML documentation.
500
501GENERATE_HTMLHELP      = NO
502
503# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
504# controls if a separate .chi index file is generated (YES) or that
505# it should be included in the master .chm file (NO).
506
507GENERATE_CHI           = NO
508
509# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
510# controls whether a binary table of contents is generated (YES) or a
511# normal table of contents (NO) in the .chm file.
512
513BINARY_TOC             = NO
514
515# The TOC_EXPAND flag can be set to YES to add extra items for group members
516# to the contents of the Html help documentation and to the tree view.
517
518TOC_EXPAND             = NO
519
520# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
521# top of each HTML page. The value NO (the default) enables the index and
522# the value YES disables it.
523
524DISABLE_INDEX          = NO
525
526# This tag can be used to set the number of enum values (range [1..20])
527# that doxygen will group on one line in the generated HTML documentation.
528
529ENUM_VALUES_PER_LINE   = 4
530
531# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
532# generated containing a tree-like index structure (just like the one that
533# is generated for HTML Help). For this to work a browser that supports
534# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
535# or Internet explorer 4.0+). Note that for large projects the tree generation
536# can take a very long time. In such cases it is better to disable this feature.
537# Windows users are probably better off using the HTML help feature.
538
539GENERATE_TREEVIEW      = NO
540
541# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
542# used to set the initial width (in pixels) of the frame in which the tree
543# is shown.
544
545TREEVIEW_WIDTH         = 250
546
547#---------------------------------------------------------------------------
548# configuration options related to the LaTeX output
549#---------------------------------------------------------------------------
550
551# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
552# generate Latex output.
553
554GENERATE_LATEX         = NO
555
556# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
557# If a relative path is entered the value of OUTPUT_DIRECTORY will be
558# put in front of it. If left blank `latex' will be used as the default path.
559
560LATEX_OUTPUT           = @DX_LATEX_OUTPUT@
561
562# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
563# LaTeX documents. This may be useful for small projects and may help to
564# save some trees in general.
565
566COMPACT_LATEX          = NO
567
568# The PAPER_TYPE tag can be used to set the paper type that is used
569# by the printer. Possible values are: a4, a4wide, letter, legal and
570# executive. If left blank a4wide will be used.
571
572PAPER_TYPE             = a4wide
573
574# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
575# packages that should be included in the LaTeX output.
576
577EXTRA_PACKAGES         =
578
579# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
580# the generated latex document. The header should contain everything until
581# the first chapter. If it is left blank doxygen will generate a
582# standard header. Notice: only use this tag if you know what you are doing!
583
584LATEX_HEADER           =
585
586# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
587# is prepared for conversion to pdf (using ps2pdf). The pdf file will
588# contain links (just like the HTML output) instead of page references
589# This makes the output suitable for online browsing using a pdf viewer.
590
591PDF_HYPERLINKS         = YES
592
593# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
594# plain latex in the generated Makefile. Set this option to YES to get a
595# higher quality PDF documentation.
596
597USE_PDFLATEX           = YES
598
599# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
600# command to the generated LaTeX files. This will instruct LaTeX to keep
601# running if errors occur, instead of asking the user for help.
602# This option is also used when generating formulas in HTML.
603
604LATEX_BATCHMODE        = NO
605
606#---------------------------------------------------------------------------
607# configuration options related to the RTF output
608#---------------------------------------------------------------------------
609
610# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
611# The RTF output is optimised for Word 97 and may not look very pretty with
612# other RTF readers or editors.
613
614GENERATE_RTF           = NO
615
616# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
617# If a relative path is entered the value of OUTPUT_DIRECTORY will be
618# put in front of it. If left blank `rtf' will be used as the default path.
619
620RTF_OUTPUT             =
621
622# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
623# RTF documents. This may be useful for small projects and may help to
624# save some trees in general.
625
626COMPACT_RTF            = NO
627
628# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
629# will contain hyperlink fields. The RTF file will
630# contain links (just like the HTML output) instead of page references.
631# This makes the output suitable for online browsing using WORD or other
632# programs which support those fields.
633# Note: wordpad (write) and others do not support links.
634
635RTF_HYPERLINKS         = NO
636
637# Load stylesheet definitions from file. Syntax is similar to doxygen's
638# config file, i.e. a series of assigments. You only have to provide
639# replacements, missing definitions are set to their default value.
640
641RTF_STYLESHEET_FILE    =
642
643# Set optional variables used in the generation of an rtf document.
644# Syntax is similar to doxygen's config file.
645
646RTF_EXTENSIONS_FILE    =
647
648#---------------------------------------------------------------------------
649# configuration options related to the man page output
650#---------------------------------------------------------------------------
651
652# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
653# generate man pages
654
655GENERATE_MAN           = NO
656
657# The MAN_OUTPUT tag is used to specify where the man pages will be put.
658# If a relative path is entered the value of OUTPUT_DIRECTORY will be
659# put in front of it. If left blank `man' will be used as the default path.
660
661MAN_OUTPUT             =
662
663# The MAN_EXTENSION tag determines the extension that is added to
664# the generated man pages (default is the subroutine's section .3)
665
666MAN_EXTENSION          =
667
668# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
669# then it will generate one additional man file for each entity
670# documented in the real man page(s). These additional files
671# only source the real man page, but without them the man command
672# would be unable to find the correct page. The default is NO.
673
674MAN_LINKS              = NO
675
676#---------------------------------------------------------------------------
677# configuration options related to the XML output
678#---------------------------------------------------------------------------
679
680# If the GENERATE_XML tag is set to YES Doxygen will
681# generate an XML file that captures the structure of
682# the code including all documentation. Note that this
683# feature is still experimental and incomplete at the
684# moment.
685
686GENERATE_XML           = NO
687
688#---------------------------------------------------------------------------
689# configuration options for the AutoGen Definitions output
690#---------------------------------------------------------------------------
691
692# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
693# generate an AutoGen Definitions (see autogen.sf.net) file
694# that captures the structure of the code including all
695# documentation. Note that this feature is still experimental
696# and incomplete at the moment.
697
698GENERATE_AUTOGEN_DEF   = NO
699
700#---------------------------------------------------------------------------
701# Configuration options related to the preprocessor   
702#---------------------------------------------------------------------------
703
704# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
705# evaluate all C-preprocessor directives found in the sources and include
706# files.
707
708ENABLE_PREPROCESSING   = YES
709
710# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
711# names in the source code. If set to NO (the default) only conditional
712# compilation will be performed. Macro expansion can be done in a controlled
713# way by setting EXPAND_ONLY_PREDEF to YES.
714
715MACRO_EXPANSION        = NO
716
717# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
718# then the macro expansion is limited to the macros specified with the
719# PREDEFINED and EXPAND_AS_PREDEFINED tags.
720
721EXPAND_ONLY_PREDEF     = NO
722
723# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
724# in the INCLUDE_PATH (see below) will be search if a #include is found.
725
726SEARCH_INCLUDES        = YES
727
728# The INCLUDE_PATH tag can be used to specify one or more directories that
729# contain include files that are not input files but should be processed by
730# the preprocessor.
731
732INCLUDE_PATH           =
733
734# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
735# patterns (like *.h and *.hpp) to filter out the header-files in the
736# directories. If left blank, the patterns specified with FILE_PATTERNS will
737# be used.
738
739INCLUDE_FILE_PATTERNS  =
740
741# The PREDEFINED tag can be used to specify one or more macro names that
742# are defined before the preprocessor is started (similar to the -D option of
743# gcc). The argument of the tag is a list of macros of the form: name
744# or name=definition (no spaces). If the definition and the = are
745# omitted =1 is assumed.
746
747PREDEFINED             =
748
749# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
750# this tag can be used to specify a list of macro names that should be expanded.
751# The macro definition that is found in the sources will be used.
752# Use the PREDEFINED tag if you want to use a different macro definition.
753
754EXPAND_AS_DEFINED      =
755
756# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
757# doxygen's preprocessor will remove all function-like macros that are alone
758# on a line and do not end with a semicolon. Such function macros are typically
759# used for boiler-plate code, and will confuse the parser if not removed.
760
761SKIP_FUNCTION_MACROS   = YES
762
763#---------------------------------------------------------------------------
764# Configuration::addtions related to external references   
765#---------------------------------------------------------------------------
766
767# The TAGFILES tag can be used to specify one or more tagfiles.
768
769TAGFILES               =
770
771# When a file name is specified after GENERATE_TAGFILE, doxygen will create
772# a tag file that is based on the input files it reads.
773
774GENERATE_TAGFILE       =
775
776# If the ALLEXTERNALS tag is set to YES all external classes will be listed
777# in the class index. If set to NO only the inherited external classes
778# will be listed.
779
780ALLEXTERNALS           = NO
781
782# The PERL_PATH should be the absolute path and name of the perl script
783# interpreter (i.e. the result of `which perl').
784
785PERL_PATH              = @PERL@
786
787#---------------------------------------------------------------------------
788# Configuration options related to the dot tool   
789#---------------------------------------------------------------------------
790
791# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
792# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
793# super classes. Setting the tag to NO turns the diagrams off. Note that this
794# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
795# recommended to install and use dot, since it yield more powerful graphs.
796
797CLASS_DIAGRAMS         = YES
798
799# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
800# available from the path. This tool is part of Graphviz, a graph visualization
801# toolkit from AT&T and Lucent Bell Labs. The other options in this section
802# have no effect if this option is set to NO (the default)
803
804HAVE_DOT               = NO
805
806# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
807# will generate a graph for each documented class showing the direct and
808# indirect inheritance relations. Setting this tag to YES will force the
809# the CLASS_DIAGRAMS tag to NO.
810
811CLASS_GRAPH            = YES
812
813# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
814# will generate a graph for each documented class showing the direct and
815# indirect implementation dependencies (inheritance, containment, and
816# class references variables) of the class with other documented classes.
817
818COLLABORATION_GRAPH    = YES
819
820# If set to YES, the inheritance and collaboration graphs will show the
821# relations between templates and their instances.
822
823TEMPLATE_RELATIONS     = YES
824
825# If set to YES, the inheritance and collaboration graphs will hide
826# inheritance and usage relations if the target is undocumented
827# or is not a class.
828
829HIDE_UNDOC_RELATIONS   = YES
830
831# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
832# tags are set to YES then doxygen will generate a graph for each documented
833# file showing the direct and indirect include dependencies of the file with
834# other documented files.
835
836INCLUDE_GRAPH          = YES
837
838# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
839# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
840# documented header file showing the documented files that directly or
841# indirectly include this file.
842
843INCLUDED_BY_GRAPH      = YES
844
845# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
846# will graphical hierarchy of all classes instead of a textual one.
847
848GRAPHICAL_HIERARCHY    = YES
849
850# The tag DOT_PATH can be used to specify the path where the dot tool can be
851# found. If left blank, it is assumed the dot tool can be found on the path.
852
853DOT_PATH               =
854
855# The DOTFILE_DIRS tag can be used to specify one or more directories that
856# contain dot files that are included in the documentation (see the
857# \dotfile command).
858
859DOTFILE_DIRS           =
860
861# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
862# generate a legend page explaining the meaning of the various boxes and
863# arrows in the dot generated graphs.
864
865GENERATE_LEGEND        = YES
866
867# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
868# remove the intermedate dot files that are used to generate
869# the various graphs.
870
871DOT_CLEANUP            = YES
872
873#---------------------------------------------------------------------------
874# Configuration::addtions related to the search engine   
875#---------------------------------------------------------------------------
876
877# The SEARCHENGINE tag specifies whether or not a search engine should be
878# used. If set to NO the values of all tags below this one will be ignored.
879
880SEARCHENGINE           = NO
881
882# The CGI_NAME tag should be the name of the CGI script that
883# starts the search engine (doxysearch) with the correct parameters.
884# A script with this name will be generated by doxygen.
885
886#CGI_NAME               =
887
888# The CGI_URL tag should be the absolute URL to the directory where the
889# cgi binaries are located. See the documentation of your http daemon for
890# details.
891
892#CGI_URL                =
893
894# The DOC_URL tag should be the absolute URL to the directory where the
895# documentation is located. If left blank the absolute path to the
896# documentation, with file:// prepended to it, will be used.
897
898#DOC_URL                =
899
900# The DOC_ABSPATH tag should be the absolute path to the directory where the
901# documentation is located. If left blank the directory on the local machine
902# will be used.
903
904#DOC_ABSPATH            =
905
906# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
907# is installed.
908
909#BIN_ABSPATH            =
910
911# The EXT_DOC_PATHS tag can be used to specify one or more paths to
912# documentation generated for other projects. This allows doxysearch to search
913# the documentation for these projects as well.
914
915#EXT_DOC_PATHS          =
Note: See TracBrowser for help on using the repository browser.