]> git.saurik.com Git - bison.git/blame - doc/Doxyfile.in
Don't apply the default %destructor or %printer to the error token,
[bison.git] / doc / Doxyfile.in
CommitLineData
2073e1b6
AD
1# Doxyfile 1.3.4 -*- Makefile -*-
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project
5#
6# All text after a hash (#) is considered a comment and will be ignored
7# The format is:
8# TAG = value [value, ...]
9# For lists items can also be appended using:
10# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")
12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
16
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18# by quotes) that should identify the project.
19
20PROJECT_NAME = "@PACKAGE_NAME@"
21
22# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or
24# if some version control system is used.
25
26PROJECT_NUMBER = "@PACKAGE_VERSION@ @ID@"
27
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29# base path where the generated documentation will be put.
30# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.
32
33OUTPUT_DIRECTORY = .
34
35# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36# documentation generated by doxygen is written. Doxygen will use this
37# information to generate all constant output in the proper language.
38# The default language is English, other supported languages are:
39# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41# (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
42# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
43
44OUTPUT_LANGUAGE = English
45
46# This tag can be used to specify the encoding used in the generated output.
47# The encoding is not always determined by the language that is chosen,
48# but also whether or not the output is meant for Windows or non-Windows users.
49# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
50# forces the Windows encoding (this is the default for the Windows binary),
51# whereas setting the tag to NO uses a Unix-style encoding (the default for
52# all platforms other than Windows).
53
54USE_WINDOWS_ENCODING = NO
55
56# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57# include brief member descriptions after the members that are listed in
58# the file and class documentation (similar to JavaDoc).
59# Set to NO to disable this.
60
61BRIEF_MEMBER_DESC = YES
62
63# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64# the brief description of a member or function before the detailed description.
65# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66# brief descriptions will be completely suppressed.
67
68REPEAT_BRIEF = YES
69
70# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
71# Doxygen will generate a detailed section even if there is only a brief
72# description.
73
74ALWAYS_DETAILED_SEC = YES
75
76# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
77# members of a class in the documentation of that class as if those members were
78# ordinary class members. Constructors, destructors and assignment operators of
79# the base classes will not be shown.
80
81INLINE_INHERITED_MEMB = YES
82
83# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
84# path before files name in the file list and in the header files. If set
85# to NO the shortest path that makes the file name unique will be used.
86
87FULL_PATH_NAMES = NO
88
89# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
90# can be used to strip a user-defined part of the path. Stripping is
91# only done if one of the specified strings matches the left-hand part of
92# the path. It is allowed to use relative paths in the argument list.
93
94STRIP_FROM_PATH =
95
96# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
97# (but less readable) file names. This can be useful is your file systems
98# doesn't support long names like on DOS, Mac, or CD-ROM.
99
100SHORT_NAMES = NO
101
102# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
103# will interpret the first line (until the first dot) of a JavaDoc-style
104# comment as the brief description. If set to NO, the JavaDoc
105# comments will behave just like the Qt-style comments (thus requiring an
106# explict @brief command for a brief description.
107
108JAVADOC_AUTOBRIEF = NO
109
110# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
111# treat a multi-line C++ special comment block (i.e. a block of //! or ///
112# comments) as a brief description. This used to be the default behaviour.
113# The new default is to treat a multi-line C++ comment block as a detailed
114# description. Set this tag to YES if you prefer the old behaviour instead.
115
116MULTILINE_CPP_IS_BRIEF = NO
117
118# If the DETAILS_AT_TOP tag is set to YES then Doxygen
119# will output the detailed description near the top, like JavaDoc.
120# If set to NO, the detailed description appears after the member
121# documentation.
122
123DETAILS_AT_TOP = NO
124
125# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
126# member inherits the documentation from any documented member that it
127# reimplements.
128
129INHERIT_DOCS = YES
130
131# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
132# tag is set to YES, then doxygen will reuse the documentation of the first
133# member in the group (if any) for the other members of the group. By default
134# all members of a group must be documented explicitly.
135
136DISTRIBUTE_GROUP_DOC = NO
137
138# The TAB_SIZE tag can be used to set the number of spaces in a tab.
139# Doxygen uses this value to replace tabs by spaces in code fragments.
140
141TAB_SIZE = 8
142
143# This tag can be used to specify a number of aliases that acts
144# as commands in the documentation. An alias has the form "name=value".
145# For example adding "sideeffect=\par Side Effects:\n" will allow you to
146# put the command \sideeffect (or @sideeffect) in the documentation, which
147# will result in a user-defined paragraph with heading "Side Effects:".
148# You can put \n's in the value part of an alias to insert newlines.
149
150ALIASES =
151
152# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
153# only. Doxygen will then generate output that is more tailored for C.
154# For instance, some of the names that are used will be different. The list
155# of all members will be omitted, etc.
156
157OPTIMIZE_OUTPUT_FOR_C = NO
158
159# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
160# only. Doxygen will then generate output that is more tailored for Java.
161# For instance, namespaces will be presented as packages, qualified scopes
162# will look different, etc.
163
164OPTIMIZE_OUTPUT_JAVA = NO
165
166# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
167# the same type (for instance a group of public functions) to be put as a
168# subgroup of that type (e.g. under the Public Functions section). Set it to
169# NO to prevent subgrouping. Alternatively, this can be done per class using
170# the \nosubgrouping command.
171
172SUBGROUPING = YES
173
174#---------------------------------------------------------------------------
175# Build related configuration options
176#---------------------------------------------------------------------------
177
178# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
179# documentation are documented, even if no documentation was available.
180# Private class members and static file members will be hidden unless
181# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
182
183EXTRACT_ALL = YES
184
185# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
186# will be included in the documentation.
187
188EXTRACT_PRIVATE = YES
189
190# If the EXTRACT_STATIC tag is set to YES all static members of a file
191# will be included in the documentation.
192
193EXTRACT_STATIC = YES
194
195# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
196# defined locally in source files will be included in the documentation.
197# If set to NO only classes defined in header files are included.
198
199EXTRACT_LOCAL_CLASSES = YES
200
201# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
202# undocumented members of documented classes, files or namespaces.
203# If set to NO (the default) these members will be included in the
204# various overviews, but no documentation section is generated.
205# This option has no effect if EXTRACT_ALL is enabled.
206
207HIDE_UNDOC_MEMBERS = NO
208
209# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
210# undocumented classes that are normally visible in the class hierarchy.
211# If set to NO (the default) these classes will be included in the various
212# overviews. This option has no effect if EXTRACT_ALL is enabled.
213
214HIDE_UNDOC_CLASSES = NO
215
216# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
217# friend (class|struct|union) declarations.
218# If set to NO (the default) these declarations will be included in the
219# documentation.
220
221HIDE_FRIEND_COMPOUNDS = NO
222
223# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
224# documentation blocks found inside the body of a function.
225# If set to NO (the default) these blocks will be appended to the
226# function's detailed documentation block.
227
228HIDE_IN_BODY_DOCS = NO
229
230# The INTERNAL_DOCS tag determines if documentation
231# that is typed after a \internal command is included. If the tag is set
232# to NO (the default) then the documentation will be excluded.
233# Set it to YES to include the internal documentation.
234
235INTERNAL_DOCS = NO
236
237# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
238# file names in lower-case letters. If set to YES upper-case letters are also
239# allowed. This is useful if you have classes or files whose names only differ
240# in case and if your file system supports case sensitive file names. Windows
241# users are advised to set this option to NO.
242
243CASE_SENSE_NAMES = YES
244
245# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
246# will show members with their full class and namespace scopes in the
247# documentation. If set to YES the scope will be hidden.
248
249HIDE_SCOPE_NAMES = NO
250
251# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
252# will put a list of the files that are included by a file in the documentation
253# of that file.
254
255SHOW_INCLUDE_FILES = YES
256
257# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
258# is inserted in the documentation for inline members.
259
260INLINE_INFO = YES
261
262# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
263# will sort the (detailed) documentation of file and class members
264# alphabetically by member name. If set to NO the members will appear in
265# declaration order.
266
267SORT_MEMBER_DOCS = YES
268
269# The GENERATE_TODOLIST tag can be used to enable (YES) or
270# disable (NO) the todo list. This list is created by putting \todo
271# commands in the documentation.
272
273GENERATE_TODOLIST = YES
274
275# The GENERATE_TESTLIST tag can be used to enable (YES) or
276# disable (NO) the test list. This list is created by putting \test
277# commands in the documentation.
278
279GENERATE_TESTLIST = YES
280
281# The GENERATE_BUGLIST tag can be used to enable (YES) or
282# disable (NO) the bug list. This list is created by putting \bug
283# commands in the documentation.
284
285GENERATE_BUGLIST = YES
286
287# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
288# disable (NO) the deprecated list. This list is created by putting
289# \deprecated commands in the documentation.
290
291GENERATE_DEPRECATEDLIST= YES
292
293# The ENABLED_SECTIONS tag can be used to enable conditional
294# documentation sections, marked by \if sectionname ... \endif.
295
296ENABLED_SECTIONS =
297
298# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
299# the initial value of a variable or define consists of for it to appear in
300# the documentation. If the initializer consists of more lines than specified
301# here it will be hidden. Use a value of 0 to hide initializers completely.
302# The appearance of the initializer of individual variables and defines in the
303# documentation can be controlled using \showinitializer or \hideinitializer
304# command in the documentation regardless of this setting.
305
306MAX_INITIALIZER_LINES = 30
307
308# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
309# at the bottom of the documentation of classes and structs. If set to YES the
310# list will mention the files that were used to generate the documentation.
311
312SHOW_USED_FILES = YES
313
314#---------------------------------------------------------------------------
315# configuration options related to warning and progress messages
316#---------------------------------------------------------------------------
317
318# The QUIET tag can be used to turn on/off the messages that are generated
319# by doxygen. Possible values are YES and NO. If left blank NO is used.
320
321QUIET = YES
322
323# The WARNINGS tag can be used to turn on/off the warning messages that are
324# generated by doxygen. Possible values are YES and NO. If left blank
325# NO is used.
326
327WARNINGS = YES
328
329# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
330# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
331# automatically be disabled.
332
333WARN_IF_UNDOCUMENTED = YES
334
335# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
336# potential errors in the documentation, such as not documenting some
337# parameters in a documented function, or documenting parameters that
338# don't exist or using markup commands wrongly.
339
340WARN_IF_DOC_ERROR = YES
341
342# The WARN_FORMAT tag determines the format of the warning messages that
343# doxygen can produce. The string should contain the $file, $line, and $text
344# tags, which will be replaced by the file and line number from which the
345# warning originated and the warning text.
346
347WARN_FORMAT = "$file:$line: $text"
348
349# The WARN_LOGFILE tag can be used to specify a file to which warning
350# and error messages should be written. If left blank the output is written
351# to stderr.
352
353WARN_LOGFILE =
354
355#---------------------------------------------------------------------------
356# configuration options related to the input files
357#---------------------------------------------------------------------------
358
359# The INPUT tag can be used to specify the files and/or directories that contain
360# documented source files. You may enter file names like "myfile.cpp" or
361# directories like "/usr/src/myproject". Separate the files or directories
362# with spaces.
363
364INPUT = @top_srcdir@/src \
365 @top_builddir@/src
366
367# If the value of the INPUT tag contains directories, you can use the
368# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
369# and *.h) to filter out the source-files in the directories. If left
370# blank the following patterns are tested:
371# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
372# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
373
374FILE_PATTERNS = *.c \
375 *.h \
376 *.l \
377 *.y
378
379# The RECURSIVE tag can be used to turn specify whether or not subdirectories
380# should be searched for input files as well. Possible values are YES and NO.
381# If left blank NO is used.
382
383RECURSIVE = YES
384
385# The EXCLUDE tag can be used to specify files and/or directories that should
386# excluded from the INPUT source files. This way you can easily exclude a
387# subdirectory from a directory tree whose root is specified with the INPUT tag.
388
389EXCLUDE = @top_srcdir@/src/scan-gram.c \
390 @top_srcdir@/src/scan-skel.c \
391 @top_builddir@/src/parse-*.[ch]
392
393# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
394# directories that are symbolic links (a Unix filesystem feature) are
395# excluded from the input.
396
397EXCLUDE_SYMLINKS = YES
398
399# If the value of the INPUT tag contains directories, you can use the
400# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
401# certain files from those directories.
402
403EXCLUDE_PATTERNS =
404
405# The EXAMPLE_PATH tag can be used to specify one or more files or
406# directories that contain example code fragments that are included (see
407# the \include command).
408
409EXAMPLE_PATH =
410
411# If the value of the EXAMPLE_PATH tag contains directories, you can use the
412# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
413# and *.h) to filter out the source-files in the directories. If left
414# blank all files are included.
415
416EXAMPLE_PATTERNS =
417
418# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
419# searched for input files to be used with the \include or \dontinclude
420# commands irrespective of the value of the RECURSIVE tag.
421# Possible values are YES and NO. If left blank NO is used.
422
423EXAMPLE_RECURSIVE = NO
424
425# The IMAGE_PATH tag can be used to specify one or more files or
426# directories that contain image that are included in the documentation (see
427# the \image command).
428
429IMAGE_PATH =
430
431# The INPUT_FILTER tag can be used to specify a program that doxygen should
432# invoke to filter for each input file. Doxygen will invoke the filter program
433# by executing (via popen()) the command <filter> <input-file>, where <filter>
434# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
435# input file. Doxygen will then use the output that the filter program writes
436# to standard output.
437
438INPUT_FILTER =
439
440# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
441# INPUT_FILTER) will be used to filter the input files when producing source
442# files to browse (i.e. when SOURCE_BROWSER is set to YES).
443
444FILTER_SOURCE_FILES = NO
445
446#---------------------------------------------------------------------------
447# configuration options related to source browsing
448#---------------------------------------------------------------------------
449
450# If the SOURCE_BROWSER tag is set to YES then a list of source files will
451# be generated. Documented entities will be cross-referenced with these sources.
452
453SOURCE_BROWSER = NO
454
455# Setting the INLINE_SOURCES tag to YES will include the body
456# of functions and classes directly in the documentation.
457
458INLINE_SOURCES = NO
459
460# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
461# doxygen to hide any special comment blocks from generated source code
462# fragments. Normal C and C++ comments will always remain visible.
463
464STRIP_CODE_COMMENTS = YES
465
466# If the REFERENCED_BY_RELATION tag is set to YES (the default)
467# then for each documented function all documented
468# functions referencing it will be listed.
469
470REFERENCED_BY_RELATION = YES
471
472# If the REFERENCES_RELATION tag is set to YES (the default)
473# then for each documented function all documented entities
474# called/used by that function will be listed.
475
476REFERENCES_RELATION = YES
477
478# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
479# will generate a verbatim copy of the header file for each class for
480# which an include is specified. Set to NO to disable this.
481
482VERBATIM_HEADERS = YES
483
484#---------------------------------------------------------------------------
485# configuration options related to the alphabetical class index
486#---------------------------------------------------------------------------
487
488# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
489# of all compounds will be generated. Enable this if the project
490# contains a lot of classes, structs, unions or interfaces.
491
492ALPHABETICAL_INDEX = YES
493
494# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
495# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
496# in which this list will be split (can be a number in the range [1..20])
497
498COLS_IN_ALPHA_INDEX = 5
499
500# In case all classes in a project start with a common prefix, all
501# classes will be put under the same header in the alphabetical index.
502# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
503# should be ignored while generating the index headers.
504
505IGNORE_PREFIX =
506
507#---------------------------------------------------------------------------
508# configuration options related to the HTML output
509#---------------------------------------------------------------------------
510
511# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
512# generate HTML output.
513
514GENERATE_HTML = YES
515
516# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
517# If a relative path is entered the value of OUTPUT_DIRECTORY will be
518# put in front of it. If left blank `html' will be used as the default path.
519
520HTML_OUTPUT = html
521
522# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
523# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
524# doxygen will generate files with .html extension.
525
526HTML_FILE_EXTENSION = .html
527
528# The HTML_HEADER tag can be used to specify a personal HTML header for
529# each generated HTML page. If it is left blank doxygen will generate a
530# standard header.
531
532HTML_HEADER =
533
534# The HTML_FOOTER tag can be used to specify a personal HTML footer for
535# each generated HTML page. If it is left blank doxygen will generate a
536# standard footer.
537
538HTML_FOOTER =
539
540# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
541# style sheet that is used by each HTML page. It can be used to
542# fine-tune the look of the HTML output. If the tag is left blank doxygen
543# will generate a default style sheet
544
545HTML_STYLESHEET =
546
547# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
548# files or namespaces will be aligned in HTML using tables. If set to
549# NO a bullet list will be used.
550
551HTML_ALIGN_MEMBERS = YES
552
553# If the GENERATE_HTMLHELP tag is set to YES, additional index files
554# will be generated that can be used as input for tools like the
555# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
556# of the generated HTML documentation.
557
558GENERATE_HTMLHELP = NO
559
560# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
561# be used to specify the file name of the resulting .chm file. You
562# can add a path in front of the file if the result should not be
563# written to the html output dir.
564
565CHM_FILE =
566
567# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
568# be used to specify the location (absolute path including file name) of
569# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
570# the HTML help compiler on the generated index.hhp.
571
572HHC_LOCATION =
573
574# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
575# controls if a separate .chi index file is generated (YES) or that
576# it should be included in the master .chm file (NO).
577
578GENERATE_CHI = NO
579
580# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
581# controls whether a binary table of contents is generated (YES) or a
582# normal table of contents (NO) in the .chm file.
583
584BINARY_TOC = NO
585
586# The TOC_EXPAND flag can be set to YES to add extra items for group members
587# to the contents of the HTML help documentation and to the tree view.
588
589TOC_EXPAND = NO
590
591# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
592# top of each HTML page. The value NO (the default) enables the index and
593# the value YES disables it.
594
595DISABLE_INDEX = NO
596
597# This tag can be used to set the number of enum values (range [1..20])
598# that doxygen will group on one line in the generated HTML documentation.
599
600ENUM_VALUES_PER_LINE = 4
601
602# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
603# generated containing a tree-like index structure (just like the one that
604# is generated for HTML Help). For this to work a browser that supports
605# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
606# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
607# probably better off using the HTML help feature.
608
609GENERATE_TREEVIEW = YES
610
611# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
612# used to set the initial width (in pixels) of the frame in which the tree
613# is shown.
614
615TREEVIEW_WIDTH = 250
616
617#---------------------------------------------------------------------------
618# configuration options related to the LaTeX output
619#---------------------------------------------------------------------------
620
621# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
622# generate Latex output.
623
624GENERATE_LATEX = NO
625
626# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
627# If a relative path is entered the value of OUTPUT_DIRECTORY will be
628# put in front of it. If left blank `latex' will be used as the default path.
629
630LATEX_OUTPUT = latex
631
632# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
633# invoked. If left blank `latex' will be used as the default command name.
634
635LATEX_CMD_NAME = latex
636
637# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
638# generate index for LaTeX. If left blank `makeindex' will be used as the
639# default command name.
640
641MAKEINDEX_CMD_NAME = makeindex
642
643# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
644# LaTeX documents. This may be useful for small projects and may help to
645# save some trees in general.
646
647COMPACT_LATEX = NO
648
649# The PAPER_TYPE tag can be used to set the paper type that is used
650# by the printer. Possible values are: a4, a4wide, letter, legal and
651# executive. If left blank a4wide will be used.
652
653PAPER_TYPE = a4wide
654
655# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
656# packages that should be included in the LaTeX output.
657
658EXTRA_PACKAGES =
659
660# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
661# the generated latex document. The header should contain everything until
662# the first chapter. If it is left blank doxygen will generate a
663# standard header. Notice: only use this tag if you know what you are doing!
664
665LATEX_HEADER =
666
667# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
668# is prepared for conversion to pdf (using ps2pdf). The pdf file will
669# contain links (just like the HTML output) instead of page references
670# This makes the output suitable for online browsing using a pdf viewer.
671
672PDF_HYPERLINKS = YES
673
674# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
675# plain latex in the generated Makefile. Set this option to YES to get a
676# higher quality PDF documentation.
677
678USE_PDFLATEX = YES
679
680# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
681# command to the generated LaTeX files. This will instruct LaTeX to keep
682# running if errors occur, instead of asking the user for help.
683# This option is also used when generating formulas in HTML.
684
685LATEX_BATCHMODE = YES
686
687# If LATEX_HIDE_INDICES is set to YES then doxygen will not
688# include the index chapters (such as File Index, Compound Index, etc.)
689# in the output.
690
691LATEX_HIDE_INDICES = NO
692
693#---------------------------------------------------------------------------
694# configuration options related to the RTF output
695#---------------------------------------------------------------------------
696
697# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
698# The RTF output is optimised for Word 97 and may not look very pretty with
699# other RTF readers or editors.
700
701GENERATE_RTF = NO
702
703# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
704# If a relative path is entered the value of OUTPUT_DIRECTORY will be
705# put in front of it. If left blank `rtf' will be used as the default path.
706
707RTF_OUTPUT = rtf
708
709# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
710# RTF documents. This may be useful for small projects and may help to
711# save some trees in general.
712
713COMPACT_RTF = NO
714
715# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
716# will contain hyperlink fields. The RTF file will
717# contain links (just like the HTML output) instead of page references.
718# This makes the output suitable for online browsing using WORD or other
719# programs which support those fields.
720# Note: wordpad (write) and others do not support links.
721
722RTF_HYPERLINKS = NO
723
724# Load stylesheet definitions from file. Syntax is similar to doxygen's
725# config file, i.e. a series of assigments. You only have to provide
726# replacements, missing definitions are set to their default value.
727
728RTF_STYLESHEET_FILE =
729
730# Set optional variables used in the generation of an rtf document.
731# Syntax is similar to doxygen's config file.
732
733RTF_EXTENSIONS_FILE =
734
735#---------------------------------------------------------------------------
736# configuration options related to the man page output
737#---------------------------------------------------------------------------
738
739# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
740# generate man pages
741
742GENERATE_MAN = NO
743
744# The MAN_OUTPUT tag is used to specify where the man pages will be put.
745# If a relative path is entered the value of OUTPUT_DIRECTORY will be
746# put in front of it. If left blank `man' will be used as the default path.
747
748MAN_OUTPUT = man
749
750# The MAN_EXTENSION tag determines the extension that is added to
751# the generated man pages (default is the subroutine's section .3)
752
753MAN_EXTENSION = .3
754
755# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
756# then it will generate one additional man file for each entity
757# documented in the real man page(s). These additional files
758# only source the real man page, but without them the man command
759# would be unable to find the correct page. The default is NO.
760
761MAN_LINKS = NO
762
763#---------------------------------------------------------------------------
764# configuration options related to the XML output
765#---------------------------------------------------------------------------
766
767# If the GENERATE_XML tag is set to YES Doxygen will
768# generate an XML file that captures the structure of
769# the code including all documentation. Note that this
770# feature is still experimental and incomplete at the
771# moment.
772
773GENERATE_XML = NO
774
775# The XML_OUTPUT tag is used to specify where the XML pages will be put.
776# If a relative path is entered the value of OUTPUT_DIRECTORY will be
777# put in front of it. If left blank `xml' will be used as the default path.
778
779XML_OUTPUT = xml
780
781# The XML_SCHEMA tag can be used to specify an XML schema,
782# which can be used by a validating XML parser to check the
783# syntax of the XML files.
784
785XML_SCHEMA =
786
787# The XML_DTD tag can be used to specify an XML DTD,
788# which can be used by a validating XML parser to check the
789# syntax of the XML files.
790
791XML_DTD =
792
793#---------------------------------------------------------------------------
794# configuration options for the AutoGen Definitions output
795#---------------------------------------------------------------------------
796
797# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
798# generate an AutoGen Definitions (see autogen.sf.net) file
799# that captures the structure of the code including all
800# documentation. Note that this feature is still experimental
801# and incomplete at the moment.
802
803GENERATE_AUTOGEN_DEF = NO
804
805#---------------------------------------------------------------------------
806# configuration options related to the Perl module output
807#---------------------------------------------------------------------------
808
809# If the GENERATE_PERLMOD tag is set to YES Doxygen will
810# generate a Perl module file that captures the structure of
811# the code including all documentation. Note that this
812# feature is still experimental and incomplete at the
813# moment.
814
815GENERATE_PERLMOD = NO
816
817# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
818# the necessary Makefile rules, Perl scripts and LaTeX code to be able
819# to generate PDF and DVI output from the Perl module output.
820
821PERLMOD_LATEX = NO
822
823# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
824# nicely formatted so it can be parsed by a human reader. This is useful
825# if you want to understand what is going on. On the other hand, if this
826# tag is set to NO the size of the Perl module output will be much smaller
827# and Perl will parse it just the same.
828
829PERLMOD_PRETTY = YES
830
831# The names of the make variables in the generated doxyrules.make file
832# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
833# This is useful so different doxyrules.make files included by the same
834# Makefile don't overwrite each other's variables.
835
836PERLMOD_MAKEVAR_PREFIX =
837
838#---------------------------------------------------------------------------
839# Configuration options related to the preprocessor
840#---------------------------------------------------------------------------
841
842# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
843# evaluate all C-preprocessor directives found in the sources and include
844# files.
845
846ENABLE_PREPROCESSING = YES
847
848# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
849# names in the source code. If set to NO (the default) only conditional
850# compilation will be performed. Macro expansion can be done in a controlled
851# way by setting EXPAND_ONLY_PREDEF to YES.
852
853MACRO_EXPANSION = NO
854
855# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
856# then the macro expansion is limited to the macros specified with the
857# PREDEFINED and EXPAND_AS_PREDEFINED tags.
858
859EXPAND_ONLY_PREDEF = NO
860
861# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
862# in the INCLUDE_PATH (see below) will be search if a #include is found.
863
864SEARCH_INCLUDES = YES
865
866# The INCLUDE_PATH tag can be used to specify one or more directories that
867# contain include files that are not input files but should be processed by
868# the preprocessor.
869
870INCLUDE_PATH =
871
872# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
873# patterns (like *.h and *.hpp) to filter out the header-files in the
874# directories. If left blank, the patterns specified with FILE_PATTERNS will
875# be used.
876
877INCLUDE_FILE_PATTERNS =
878
879# The PREDEFINED tag can be used to specify one or more macro names that
880# are defined before the preprocessor is started (similar to the -D option of
881# gcc). The argument of the tag is a list of macros of the form: name
882# or name=definition (no spaces). If the definition and the = are
883# omitted =1 is assumed.
884
885PREDEFINED =
886
887# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
888# this tag can be used to specify a list of macro names that should be expanded.
889# The macro definition that is found in the sources will be used.
890# Use the PREDEFINED tag if you want to use a different macro definition.
891
892EXPAND_AS_DEFINED =
893
894# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
895# doxygen's preprocessor will remove all function-like macros that are alone
896# on a line, have an all uppercase name, and do not end with a semicolon. Such
897# function macros are typically used for boiler-plate code, and will confuse the
898# parser if not removed.
899
900SKIP_FUNCTION_MACROS = YES
901
902#---------------------------------------------------------------------------
903# Configuration::addtions related to external references
904#---------------------------------------------------------------------------
905
906# The TAGFILES option can be used to specify one or more tagfiles.
907# Optionally an initial location of the external documentation
908# can be added for each tagfile. The format of a tag file without
909# this location is as follows:
910# TAGFILES = file1 file2 ...
911# Adding location for the tag files is done as follows:
912# TAGFILES = file1=loc1 "file2 = loc2" ...
913# where "loc1" and "loc2" can be relative or absolute paths or
914# URLs. If a location is present for each tag, the installdox tool
915# does not have to be run to correct the links.
916# Note that each tag file must have a unique name
917# (where the name does NOT include the path)
918# If a tag file is not located in the directory in which doxygen
919# is run, you must also specify the path to the tagfile here.
920
921TAGFILES =
922
923# When a file name is specified after GENERATE_TAGFILE, doxygen will create
924# a tag file that is based on the input files it reads.
925
926GENERATE_TAGFILE =
927
928# If the ALLEXTERNALS tag is set to YES all external classes will be listed
929# in the class index. If set to NO only the inherited external classes
930# will be listed.
931
932ALLEXTERNALS = NO
933
934# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
935# in the modules index. If set to NO, only the current project's groups will
936# be listed.
937
938EXTERNAL_GROUPS = YES
939
940# The PERL_PATH should be the absolute path and name of the perl script
941# interpreter (i.e. the result of `which perl').
942
943PERL_PATH = /usr/bin/perl
944
945#---------------------------------------------------------------------------
946# Configuration options related to the dot tool
947#---------------------------------------------------------------------------
948
949# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
950# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
951# super classes. Setting the tag to NO turns the diagrams off. Note that this
952# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
953# recommended to install and use dot, since it yields more powerful graphs.
954
955CLASS_DIAGRAMS = YES
956
957# If set to YES, the inheritance and collaboration graphs will hide
958# inheritance and usage relations if the target is undocumented
959# or is not a class.
960
961HIDE_UNDOC_RELATIONS = YES
962
963# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
964# available from the path. This tool is part of Graphviz, a graph visualization
965# toolkit from AT&T and Lucent Bell Labs. The other options in this section
966# have no effect if this option is set to NO (the default)
967
968HAVE_DOT = YES
969
970# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
971# will generate a graph for each documented class showing the direct and
972# indirect inheritance relations. Setting this tag to YES will force the
973# the CLASS_DIAGRAMS tag to NO.
974
975CLASS_GRAPH = YES
976
977# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
978# will generate a graph for each documented class showing the direct and
979# indirect implementation dependencies (inheritance, containment, and
980# class references variables) of the class with other documented classes.
981
982COLLABORATION_GRAPH = YES
983
984# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
985# collaboration diagrams in a style similiar to the OMG's Unified Modeling
986# Language.
987
988UML_LOOK = NO
989
990# If set to YES, the inheritance and collaboration graphs will show the
991# relations between templates and their instances.
992
993TEMPLATE_RELATIONS = YES
994
995# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
996# tags are set to YES then doxygen will generate a graph for each documented
997# file showing the direct and indirect include dependencies of the file with
998# other documented files.
999
1000INCLUDE_GRAPH = YES
1001
1002# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1003# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1004# documented header file showing the documented files that directly or
1005# indirectly include this file.
1006
1007INCLUDED_BY_GRAPH = YES
1008
1009# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1010# generate a call dependency graph for every global function or class method.
1011# Note that enabling this option will significantly increase the time of a run.
1012# So in most cases it will be better to enable call graphs for selected
1013# functions only using the \callgraph command.
1014
1015CALL_GRAPH = NO
1016
1017# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1018# will graphical hierarchy of all classes instead of a textual one.
1019
1020GRAPHICAL_HIERARCHY = YES
1021
1022# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1023# generated by dot. Possible values are png, jpg, or gif
1024# If left blank png will be used.
1025
1026DOT_IMAGE_FORMAT = png
1027
1028# The tag DOT_PATH can be used to specify the path where the dot tool can be
1029# found. If left blank, it is assumed the dot tool can be found on the path.
1030
1031DOT_PATH =
1032
1033# The DOTFILE_DIRS tag can be used to specify one or more directories that
1034# contain dot files that are included in the documentation (see the
1035# \dotfile command).
1036
1037DOTFILE_DIRS =
1038
1039# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1040# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1041# this value, doxygen will try to truncate the graph, so that it fits within
1042# the specified constraint. Beware that most browsers cannot cope with very
1043# large images.
1044
1045MAX_DOT_GRAPH_WIDTH = 1024
1046
1047# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1048# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1049# this value, doxygen will try to truncate the graph, so that it fits within
1050# the specified constraint. Beware that most browsers cannot cope with very
1051# large images.
1052
1053MAX_DOT_GRAPH_HEIGHT = 1024
1054
1055# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of
1056# the graphs generated by dot. A depth value of 3 means that only
1057# nodes reachable from the root by following a path via at most 3
1058# edges will be shown. Nodes that lay further from the root node will
1059# be omitted. Note that setting this option to 1 or 2 may greatly
1060# reduce the computation time needed for large code bases. Also note
1061# that a graph may be further truncated if the graph's image
1062# dimensions are not sufficient to fit the graph (see
1063# MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the
1064# depth value (the default), the graph is not depth-constrained.
1065
1066MAX_DOT_GRAPH_DEPTH = 0
1067
1068# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1069# generate a legend page explaining the meaning of the various boxes and
1070# arrows in the dot generated graphs.
1071
1072GENERATE_LEGEND = YES
1073
1074# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1075# remove the intermediate dot files that are used to generate
1076# the various graphs.
1077
1078DOT_CLEANUP = YES
1079
1080#---------------------------------------------------------------------------
1081# Configuration::addtions related to the search engine
1082#---------------------------------------------------------------------------
1083
1084# The SEARCHENGINE tag specifies whether or not a search engine should be
1085# used. If set to NO the values of all tags below this one will be ignored.
1086
1087SEARCHENGINE = NO