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