source: trunk/doc/doxygen.config.in

Last change on this file was 3987, checked in by Peter, 2 years ago

merge release 0.17.2 into trunk

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