xref: /aoo4110/main/solenv/doc/gbuild/doxygen.cfg (revision b1cdbd2c)
1# Doxyfile 1.5.8
2# *************************************************************
3#
4#  Licensed to the Apache Software Foundation (ASF) under one
5#  or more contributor license agreements.  See the NOTICE file
6#  distributed with this work for additional information
7#  regarding copyright ownership.  The ASF licenses this file
8#  to you under the Apache License, Version 2.0 (the
9#  "License"); you may not use this file except in compliance
10#  with the License.  You may obtain a copy of the License at
11#
12#    http://www.apache.org/licenses/LICENSE-2.0
13#
14#  Unless required by applicable law or agreed to in writing,
15#  software distributed under the License is distributed on an
16#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17#  KIND, either express or implied.  See the License for the
18#  specific language governing permissions and limitations
19#  under the License.
20#
21# *************************************************************
22
23# This file describes the settings to be used by the documentation system
24# doxygen (www.doxygen.org) for a project
25#
26# All text after a hash (#) is considered a comment and will be ignored
27# The format is:
28#       TAG = value [value, ...]
29# For lists items can also be appended using:
30#       TAG += value [value, ...]
31# Values that contain spaces should be placed between quotes (" ")
32
33#---------------------------------------------------------------------------
34# Project related configuration options
35#---------------------------------------------------------------------------
36
37# This tag specifies the encoding used for all characters in the config file
38# that follow. The default is UTF-8 which is also the encoding used for all
39# text before the first occurrence of this tag. Doxygen uses libiconv (or the
40# iconv built into libc) for the transcoding. See
41# http://www.gnu.org/software/libiconv for the list of possible encodings.
42
43DOXYFILE_ENCODING      = UTF-8
44
45# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
46# by quotes) that should identify the project.
47
48PROJECT_NAME           = gbuild
49
50# The PROJECT_NUMBER tag can be used to enter a project or revision number.
51# This could be handy for archiving the generated documentation or
52# if some version control system is used.
53
54PROJECT_NUMBER         =
55
56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
57# base path where the generated documentation will be put.
58# If a relative path is entered, it will be relative to the location
59# where doxygen was started. If left blank the current directory will be used.
60
61OUTPUT_DIRECTORY       = ./output
62
63# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
64# 4096 sub-directories (in 2 levels) under the output directory of each output
65# format and will distribute the generated files over these directories.
66# Enabling this option can be useful when feeding doxygen a huge amount of
67# source files, where putting all generated files in the same directory would
68# otherwise cause performance problems for the file system.
69
70CREATE_SUBDIRS         = NO
71
72# The OUTPUT_LANGUAGE tag is used to specify the language in which all
73# documentation generated by doxygen is written. Doxygen will use this
74# information to generate all constant output in the proper language.
75# The default language is English, other supported languages are:
76# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
77# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
78# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
79# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
80# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
81# Spanish, Swedish, and Ukrainian.
82
83OUTPUT_LANGUAGE        = English
84
85# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
86# include brief member descriptions after the members that are listed in
87# the file and class documentation (similar to JavaDoc).
88# Set to NO to disable this.
89
90BRIEF_MEMBER_DESC      = YES
91
92# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
93# the brief description of a member or function before the detailed description.
94# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
95# brief descriptions will be completely suppressed.
96
97REPEAT_BRIEF           = YES
98
99# This tag implements a quasi-intelligent brief description abbreviator
100# that is used to form the text in various listings. Each string
101# in this list, if found as the leading text of the brief description, will be
102# stripped from the text and the result after processing the whole list, is
103# used as the annotated text. Otherwise, the brief description is used as-is.
104# If left blank, the following values are used ("$name" is automatically
105# replaced with the name of the entity): "The $name class" "The $name widget"
106# "The $name file" "is" "provides" "specifies" "contains"
107# "represents" "a" "an" "the"
108
109ABBREVIATE_BRIEF       =
110
111# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
112# Doxygen will generate a detailed section even if there is only a brief
113# description.
114
115ALWAYS_DETAILED_SEC    = NO
116
117# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
118# inherited members of a class in the documentation of that class as if those
119# members were ordinary class members. Constructors, destructors and assignment
120# operators of the base classes will not be shown.
121
122INLINE_INHERITED_MEMB  = YES
123
124# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
125# path before files name in the file list and in the header files. If set
126# to NO the shortest path that makes the file name unique will be used.
127
128FULL_PATH_NAMES        = YES
129
130# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
131# can be used to strip a user-defined part of the path. Stripping is
132# only done if one of the specified strings matches the left-hand part of
133# the path. The tag can be used to show relative paths in the file list.
134# If left blank the directory from which doxygen is run is used as the
135# path to strip.
136
137STRIP_FROM_PATH        =
138
139# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
140# the path mentioned in the documentation of a class, which tells
141# the reader which header file to include in order to use a class.
142# If left blank only the name of the header file containing the class
143# definition is used. Otherwise one should specify the include paths that
144# are normally passed to the compiler using the -I flag.
145
146STRIP_FROM_INC_PATH    =
147
148# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
149# (but less readable) file names. This can be useful is your file systems
150# doesn't support long names like on DOS, Mac, or CD-ROM.
151
152SHORT_NAMES            = NO
153
154# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
155# will interpret the first line (until the first dot) of a JavaDoc-style
156# comment as the brief description. If set to NO, the JavaDoc
157# comments will behave just like regular Qt-style comments
158# (thus requiring an explicit @brief command for a brief description.)
159
160JAVADOC_AUTOBRIEF      = NO
161
162# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
163# interpret the first line (until the first dot) of a Qt-style
164# comment as the brief description. If set to NO, the comments
165# will behave just like regular Qt-style comments (thus requiring
166# an explicit \brief command for a brief description.)
167
168QT_AUTOBRIEF           = NO
169
170# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
171# treat a multi-line C++ special comment block (i.e. a block of //! or ///
172# comments) as a brief description. This used to be the default behaviour.
173# The new default is to treat a multi-line C++ comment block as a detailed
174# description. Set this tag to YES if you prefer the old behaviour instead.
175
176MULTILINE_CPP_IS_BRIEF = NO
177
178# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
179# member inherits the documentation from any documented member that it
180# re-implements.
181
182INHERIT_DOCS           = YES
183
184# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
185# a new page for each member. If set to NO, the documentation of a member will
186# be part of the file/class/namespace that contains it.
187
188SEPARATE_MEMBER_PAGES  = NO
189
190# The TAB_SIZE tag can be used to set the number of spaces in a tab.
191# Doxygen uses this value to replace tabs by spaces in code fragments.
192
193TAB_SIZE               = 4
194
195# This tag can be used to specify a number of aliases that acts
196# as commands in the documentation. An alias has the form "name=value".
197# For example adding "sideeffect=\par Side Effects:\n" will allow you to
198# put the command \sideeffect (or @sideeffect) in the documentation, which
199# will result in a user-defined paragraph with heading "Side Effects:".
200# You can put \n's in the value part of an alias to insert newlines.
201
202ALIASES                =
203
204# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
205# sources only. Doxygen will then generate output that is more tailored for C.
206# For instance, some of the names that are used will be different. The list
207# of all members will be omitted, etc.
208
209OPTIMIZE_OUTPUT_FOR_C  = NO
210
211# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
212# sources only. Doxygen will then generate output that is more tailored for
213# Java. For instance, namespaces will be presented as packages, qualified
214# scopes will look different, etc.
215
216OPTIMIZE_OUTPUT_JAVA   = NO
217
218# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
219# sources only. Doxygen will then generate output that is more tailored for
220# Fortran.
221
222OPTIMIZE_FOR_FORTRAN   = NO
223
224# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
225# sources. Doxygen will then generate output that is tailored for
226# VHDL.
227
228OPTIMIZE_OUTPUT_VHDL   = NO
229
230# Doxygen selects the parser to use depending on the extension of the files it parses.
231# With this tag you can assign which parser to use for a given extension.
232# Doxygen has a built-in mapping, but you can override or extend it using this tag.
233# The format is ext=language, where ext is a file extension, and language is one of
234# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
235# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
236# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
237# use: inc=Fortran f=C
238
239EXTENSION_MAPPING      = mk=IDL
240
241# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
242# to include (a tag file for) the STL sources as input, then you should
243# set this tag to YES in order to let doxygen match functions declarations and
244# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
245# func(std::string) {}). This also make the inheritance and collaboration
246# diagrams that involve STL classes more complete and accurate.
247
248BUILTIN_STL_SUPPORT    = NO
249
250# If you use Microsoft's C++/CLI language, you should set this option to YES to
251# enable parsing support.
252
253CPP_CLI_SUPPORT        = NO
254
255# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
256# Doxygen will parse them like normal C++ but will assume all classes use public
257# instead of private inheritance when no explicit protection keyword is present.
258
259SIP_SUPPORT            = NO
260
261# For Microsoft's IDL there are propget and propput attributes to indicate getter
262# and setter methods for a property. Setting this option to YES (the default)
263# will make doxygen to replace the get and set methods by a property in the
264# documentation. This will only work if the methods are indeed getting or
265# setting a simple type. If this is not the case, or you want to show the
266# methods anyway, you should set this option to NO.
267
268IDL_PROPERTY_SUPPORT   = YES
269
270# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
271# tag is set to YES, then doxygen will reuse the documentation of the first
272# member in the group (if any) for the other members of the group. By default
273# all members of a group must be documented explicitly.
274
275DISTRIBUTE_GROUP_DOC   = NO
276
277# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
278# the same type (for instance a group of public functions) to be put as a
279# subgroup of that type (e.g. under the Public Functions section). Set it to
280# NO to prevent subgrouping. Alternatively, this can be done per class using
281# the \nosubgrouping command.
282
283SUBGROUPING            = YES
284
285# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
286# is documented as struct, union, or enum with the name of the typedef. So
287# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
288# with name TypeT. When disabled the typedef will appear as a member of a file,
289# namespace, or class. And the struct will be named TypeS. This can typically
290# be useful for C code in case the coding convention dictates that all compound
291# types are typedef'ed and only the typedef is referenced, never the tag name.
292
293TYPEDEF_HIDES_STRUCT   = NO
294
295# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
296# determine which symbols to keep in memory and which to flush to disk.
297# When the cache is full, less often used symbols will be written to disk.
298# For small to medium size projects (<1000 input files) the default value is
299# probably good enough. For larger projects a too small cache size can cause
300# doxygen to be busy swapping symbols to and from disk most of the time
301# causing a significant performance penality.
302# If the system has enough physical memory increasing the cache will improve the
303# performance by keeping more symbols in memory. Note that the value works on
304# a logarithmic scale so increasing the size by one will rougly double the
305# memory usage. The cache size is given by this formula:
306# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
307# corresponding to a cache size of 2^16 = 65536 symbols
308
309SYMBOL_CACHE_SIZE      = 0
310
311#---------------------------------------------------------------------------
312# Build related configuration options
313#---------------------------------------------------------------------------
314
315# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
316# documentation are documented, even if no documentation was available.
317# Private class members and static file members will be hidden unless
318# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
319
320EXTRACT_ALL            = YES
321
322# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
323# will be included in the documentation.
324
325EXTRACT_PRIVATE        = YES
326
327# If the EXTRACT_STATIC tag is set to YES all static members of a file
328# will be included in the documentation.
329
330EXTRACT_STATIC         = YES
331
332# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
333# defined locally in source files will be included in the documentation.
334# If set to NO only classes defined in header files are included.
335
336EXTRACT_LOCAL_CLASSES  = YES
337
338# This flag is only useful for Objective-C code. When set to YES local
339# methods, which are defined in the implementation section but not in
340# the interface are included in the documentation.
341# If set to NO (the default) only methods in the interface are included.
342
343EXTRACT_LOCAL_METHODS  = NO
344
345# If this flag is set to YES, the members of anonymous namespaces will be
346# extracted and appear in the documentation as a namespace called
347# 'anonymous_namespace{file}', where file will be replaced with the base
348# name of the file that contains the anonymous namespace. By default
349# anonymous namespace are hidden.
350
351EXTRACT_ANON_NSPACES   = NO
352
353# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
354# undocumented members of documented classes, files or namespaces.
355# If set to NO (the default) these members will be included in the
356# various overviews, but no documentation section is generated.
357# This option has no effect if EXTRACT_ALL is enabled.
358
359HIDE_UNDOC_MEMBERS     = NO
360
361# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
362# undocumented classes that are normally visible in the class hierarchy.
363# If set to NO (the default) these classes will be included in the various
364# overviews. This option has no effect if EXTRACT_ALL is enabled.
365
366HIDE_UNDOC_CLASSES     = NO
367
368# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
369# friend (class|struct|union) declarations.
370# If set to NO (the default) these declarations will be included in the
371# documentation.
372
373HIDE_FRIEND_COMPOUNDS  = NO
374
375# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
376# documentation blocks found inside the body of a function.
377# If set to NO (the default) these blocks will be appended to the
378# function's detailed documentation block.
379
380HIDE_IN_BODY_DOCS      = NO
381
382# The INTERNAL_DOCS tag determines if documentation
383# that is typed after a \internal command is included. If the tag is set
384# to NO (the default) then the documentation will be excluded.
385# Set it to YES to include the internal documentation.
386
387INTERNAL_DOCS          = NO
388
389# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
390# file names in lower-case letters. If set to YES upper-case letters are also
391# allowed. This is useful if you have classes or files whose names only differ
392# in case and if your file system supports case sensitive file names. Windows
393# and Mac users are advised to set this option to NO.
394
395CASE_SENSE_NAMES       = YES
396
397# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
398# will show members with their full class and namespace scopes in the
399# documentation. If set to YES the scope will be hidden.
400
401HIDE_SCOPE_NAMES       = NO
402
403# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
404# will put a list of the files that are included by a file in the documentation
405# of that file.
406
407SHOW_INCLUDE_FILES     = YES
408
409# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
410# is inserted in the documentation for inline members.
411
412INLINE_INFO            = YES
413
414# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
415# will sort the (detailed) documentation of file and class members
416# alphabetically by member name. If set to NO the members will appear in
417# declaration order.
418
419SORT_MEMBER_DOCS       = YES
420
421# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
422# brief documentation of file, namespace and class members alphabetically
423# by member name. If set to NO (the default) the members will appear in
424# declaration order.
425
426SORT_BRIEF_DOCS        = NO
427
428# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
429# hierarchy of group names into alphabetical order. If set to NO (the default)
430# the group names will appear in their defined order.
431
432SORT_GROUP_NAMES       = NO
433
434# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
435# sorted by fully-qualified names, including namespaces. If set to
436# NO (the default), the class list will be sorted only by class name,
437# not including the namespace part.
438# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
439# Note: This option applies only to the class list, not to the
440# alphabetical list.
441
442SORT_BY_SCOPE_NAME     = NO
443
444# The GENERATE_TODOLIST tag can be used to enable (YES) or
445# disable (NO) the todo list. This list is created by putting \todo
446# commands in the documentation.
447
448GENERATE_TODOLIST      = YES
449
450# The GENERATE_TESTLIST tag can be used to enable (YES) or
451# disable (NO) the test list. This list is created by putting \test
452# commands in the documentation.
453
454GENERATE_TESTLIST      = YES
455
456# The GENERATE_BUGLIST tag can be used to enable (YES) or
457# disable (NO) the bug list. This list is created by putting \bug
458# commands in the documentation.
459
460GENERATE_BUGLIST       = YES
461
462# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
463# disable (NO) the deprecated list. This list is created by putting
464# \deprecated commands in the documentation.
465
466GENERATE_DEPRECATEDLIST= YES
467
468# The ENABLED_SECTIONS tag can be used to enable conditional
469# documentation sections, marked by \if sectionname ... \endif.
470
471ENABLED_SECTIONS       =
472
473# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
474# the initial value of a variable or define consists of for it to appear in
475# the documentation. If the initializer consists of more lines than specified
476# here it will be hidden. Use a value of 0 to hide initializers completely.
477# The appearance of the initializer of individual variables and defines in the
478# documentation can be controlled using \showinitializer or \hideinitializer
479# command in the documentation regardless of this setting.
480
481MAX_INITIALIZER_LINES  = 30
482
483# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
484# at the bottom of the documentation of classes and structs. If set to YES the
485# list will mention the files that were used to generate the documentation.
486
487SHOW_USED_FILES        = YES
488
489# If the sources in your project are distributed over multiple directories
490# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
491# in the documentation. The default is NO.
492
493SHOW_DIRECTORIES       = NO
494
495# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
496# This will remove the Files entry from the Quick Index and from the
497# Folder Tree View (if specified). The default is YES.
498
499SHOW_FILES             = YES
500
501# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
502# Namespaces page.
503# This will remove the Namespaces entry from the Quick Index
504# and from the Folder Tree View (if specified). The default is YES.
505
506SHOW_NAMESPACES        = YES
507
508# The FILE_VERSION_FILTER tag can be used to specify a program or script that
509# doxygen should invoke to get the current version for each file (typically from
510# the version control system). Doxygen will invoke the program by executing (via
511# popen()) the command <command> <input-file>, where <command> is the value of
512# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
513# provided by doxygen. Whatever the program writes to standard output
514# is used as the file version. See the manual for examples.
515
516FILE_VERSION_FILTER    =
517
518# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
519# doxygen. The layout file controls the global structure of the generated output files
520# in an output format independent way. The create the layout file that represents
521# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
522# file name after the option, if omitted DoxygenLayout.xml will be used as the name
523# of the layout file.
524
525LAYOUT_FILE            =
526
527#---------------------------------------------------------------------------
528# configuration options related to warning and progress messages
529#---------------------------------------------------------------------------
530
531# The QUIET tag can be used to turn on/off the messages that are generated
532# by doxygen. Possible values are YES and NO. If left blank NO is used.
533
534QUIET                  = NO
535
536# The WARNINGS tag can be used to turn on/off the warning messages that are
537# generated by doxygen. Possible values are YES and NO. If left blank
538# NO is used.
539
540WARNINGS               = YES
541
542# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
543# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
544# automatically be disabled.
545
546WARN_IF_UNDOCUMENTED   = YES
547
548# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
549# potential errors in the documentation, such as not documenting some
550# parameters in a documented function, or documenting parameters that
551# don't exist or using markup commands wrongly.
552
553WARN_IF_DOC_ERROR      = YES
554
555# This WARN_NO_PARAMDOC option can be abled to get warnings for
556# functions that are documented, but have no documentation for their parameters
557# or return value. If set to NO (the default) doxygen will only warn about
558# wrong or incomplete parameter documentation, but not about the absence of
559# documentation.
560
561WARN_NO_PARAMDOC       = NO
562
563# The WARN_FORMAT tag determines the format of the warning messages that
564# doxygen can produce. The string should contain the $file, $line, and $text
565# tags, which will be replaced by the file and line number from which the
566# warning originated and the warning text. Optionally the format may contain
567# $version, which will be replaced by the version of the file (if it could
568# be obtained via FILE_VERSION_FILTER)
569
570WARN_FORMAT            = "$file:$line: $text"
571
572# The WARN_LOGFILE tag can be used to specify a file to which warning
573# and error messages should be written. If left blank the output is written
574# to stderr.
575
576WARN_LOGFILE           =
577
578#---------------------------------------------------------------------------
579# configuration options related to the input files
580#---------------------------------------------------------------------------
581
582# The INPUT tag can be used to specify the files and/or directories that contain
583# documented source files. You may enter file names like "myfile.cpp" or
584# directories like "/usr/src/myproject". Separate the files or directories
585# with spaces.
586
587INPUT                  = solenv/gbuild
588
589# This tag can be used to specify the character encoding of the source files
590# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
591# also the default input encoding. Doxygen uses libiconv (or the iconv built
592# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
593# the list of possible encodings.
594
595INPUT_ENCODING         = UTF-8
596
597# If the value of the INPUT tag contains directories, you can use the
598# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
599# and *.h) to filter out the source-files in the directories. If left
600# blank the following patterns are tested:
601# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
602# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
603
604FILE_PATTERNS          = *.mk
605
606# The RECURSIVE tag can be used to turn specify whether or not subdirectories
607# should be searched for input files as well. Possible values are YES and NO.
608# If left blank NO is used.
609
610RECURSIVE              = YES
611
612# The EXCLUDE tag can be used to specify files and/or directories that should
613# excluded from the INPUT source files. This way you can easily exclude a
614# subdirectory from a directory tree whose root is specified with the INPUT tag.
615
616EXCLUDE                =
617
618# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
619# directories that are symbolic links (a Unix filesystem feature) are excluded
620# from the input.
621
622EXCLUDE_SYMLINKS       = NO
623
624# If the value of the INPUT tag contains directories, you can use the
625# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
626# certain files from those directories. Note that the wildcards are matched
627# against the file with absolute path, so to exclude all test directories
628# for example use the pattern */test/*
629
630EXCLUDE_PATTERNS       =
631
632# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
633# (namespaces, classes, functions, etc.) that should be excluded from the
634# output. The symbol name can be a fully qualified name, a word, or if the
635# wildcard * is used, a substring. Examples: ANamespace, AClass,
636# AClass::ANamespace, ANamespace::*Test
637
638EXCLUDE_SYMBOLS        =
639
640# The EXAMPLE_PATH tag can be used to specify one or more files or
641# directories that contain example code fragments that are included (see
642# the \include command).
643
644EXAMPLE_PATH           =
645
646# If the value of the EXAMPLE_PATH tag contains directories, you can use the
647# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
648# and *.h) to filter out the source-files in the directories. If left
649# blank all files are included.
650
651EXAMPLE_PATTERNS       =
652
653# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
654# searched for input files to be used with the \include or \dontinclude
655# commands irrespective of the value of the RECURSIVE tag.
656# Possible values are YES and NO. If left blank NO is used.
657
658EXAMPLE_RECURSIVE      = NO
659
660# The IMAGE_PATH tag can be used to specify one or more files or
661# directories that contain image that are included in the documentation (see
662# the \image command).
663
664IMAGE_PATH             =
665
666# The INPUT_FILTER tag can be used to specify a program that doxygen should
667# invoke to filter for each input file. Doxygen will invoke the filter program
668# by executing (via popen()) the command <filter> <input-file>, where <filter>
669# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
670# input file. Doxygen will then use the output that the filter program writes
671# to standard output.
672# If FILTER_PATTERNS is specified, this tag will be
673# ignored.
674
675INPUT_FILTER           =
676
677# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
678# basis.
679# Doxygen will compare the file name with each pattern and apply the
680# filter if there is a match.
681# The filters are a list of the form:
682# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
683# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
684# is applied to all files.
685
686FILTER_PATTERNS        =
687
688# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
689# INPUT_FILTER) will be used to filter the input files when producing source
690# files to browse (i.e. when SOURCE_BROWSER is set to YES).
691
692FILTER_SOURCE_FILES    = NO
693
694#---------------------------------------------------------------------------
695# configuration options related to source browsing
696#---------------------------------------------------------------------------
697
698# If the SOURCE_BROWSER tag is set to YES then a list of source files will
699# be generated. Documented entities will be cross-referenced with these sources.
700# Note: To get rid of all source code in the generated output, make sure also
701# VERBATIM_HEADERS is set to NO.
702
703SOURCE_BROWSER         = NO
704
705# Setting the INLINE_SOURCES tag to YES will include the body
706# of functions and classes directly in the documentation.
707
708INLINE_SOURCES         = NO
709
710# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
711# doxygen to hide any special comment blocks from generated source code
712# fragments. Normal C and C++ comments will always remain visible.
713
714STRIP_CODE_COMMENTS    = YES
715
716# If the REFERENCED_BY_RELATION tag is set to YES
717# then for each documented function all documented
718# functions referencing it will be listed.
719
720REFERENCED_BY_RELATION = NO
721
722# If the REFERENCES_RELATION tag is set to YES
723# then for each documented function all documented entities
724# called/used by that function will be listed.
725
726REFERENCES_RELATION    = NO
727
728# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
729# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
730# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
731# link to the source code.
732# Otherwise they will link to the documentation.
733
734REFERENCES_LINK_SOURCE = YES
735
736# If the USE_HTAGS tag is set to YES then the references to source code
737# will point to the HTML generated by the htags(1) tool instead of doxygen
738# built-in source browser. The htags tool is part of GNU's global source
739# tagging system (see http://www.gnu.org/software/global/global.html). You
740# will need version 4.8.6 or higher.
741
742USE_HTAGS              = NO
743
744# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
745# will generate a verbatim copy of the header file for each class for
746# which an include is specified. Set to NO to disable this.
747
748VERBATIM_HEADERS       = YES
749
750#---------------------------------------------------------------------------
751# configuration options related to the alphabetical class index
752#---------------------------------------------------------------------------
753
754# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
755# of all compounds will be generated. Enable this if the project
756# contains a lot of classes, structs, unions or interfaces.
757
758ALPHABETICAL_INDEX     = NO
759
760# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
761# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
762# in which this list will be split (can be a number in the range [1..20])
763
764COLS_IN_ALPHA_INDEX    = 5
765
766# In case all classes in a project start with a common prefix, all
767# classes will be put under the same header in the alphabetical index.
768# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
769# should be ignored while generating the index headers.
770
771IGNORE_PREFIX          =
772
773#---------------------------------------------------------------------------
774# configuration options related to the HTML output
775#---------------------------------------------------------------------------
776
777# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
778# generate HTML output.
779
780GENERATE_HTML          = YES
781
782# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
783# If a relative path is entered the value of OUTPUT_DIRECTORY will be
784# put in front of it. If left blank `html' will be used as the default path.
785
786HTML_OUTPUT            = html
787
788# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
789# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
790# doxygen will generate files with .html extension.
791
792HTML_FILE_EXTENSION    = .html
793
794# The HTML_HEADER tag can be used to specify a personal HTML header for
795# each generated HTML page. If it is left blank doxygen will generate a
796# standard header.
797
798HTML_HEADER            =
799
800# The HTML_FOOTER tag can be used to specify a personal HTML footer for
801# each generated HTML page. If it is left blank doxygen will generate a
802# standard footer.
803
804HTML_FOOTER            =
805
806# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
807# style sheet that is used by each HTML page. It can be used to
808# fine-tune the look of the HTML output. If the tag is left blank doxygen
809# will generate a default style sheet. Note that doxygen will try to copy
810# the style sheet file to the HTML output directory, so don't put your own
811# stylesheet in the HTML output directory as well, or it will be erased!
812
813HTML_STYLESHEET        =
814
815# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
816# files or namespaces will be aligned in HTML using tables. If set to
817# NO a bullet list will be used.
818
819HTML_ALIGN_MEMBERS     = YES
820
821# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
822# documentation will contain sections that can be hidden and shown after the
823# page has loaded. For this to work a browser that supports
824# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
825# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
826
827HTML_DYNAMIC_SECTIONS  = NO
828
829# If the GENERATE_DOCSET tag is set to YES, additional index files
830# will be generated that can be used as input for Apple's Xcode 3
831# integrated development environment, introduced with OSX 10.5 (Leopard).
832# To create a documentation set, doxygen will generate a Makefile in the
833# HTML output directory. Running make will produce the docset in that
834# directory and running "make install" will install the docset in
835# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
836# it at startup.
837# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
838
839GENERATE_DOCSET        = NO
840
841# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
842# feed. A documentation feed provides an umbrella under which multiple
843# documentation sets from a single provider (such as a company or product suite)
844# can be grouped.
845
846DOCSET_FEEDNAME        = "Doxygen generated docs"
847
848# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
849# should uniquely identify the documentation set bundle. This should be a
850# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
851# will append .docset to the name.
852
853DOCSET_BUNDLE_ID       = org.openoffice.gbuild
854
855# If the GENERATE_HTMLHELP tag is set to YES, additional index files
856# will be generated that can be used as input for tools like the
857# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
858# of the generated HTML documentation.
859
860GENERATE_HTMLHELP      = NO
861
862# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
863# be used to specify the file name of the resulting .chm file. You
864# can add a path in front of the file if the result should not be
865# written to the html output directory.
866
867CHM_FILE               =
868
869# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
870# be used to specify the location (absolute path including file name) of
871# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
872# the HTML help compiler on the generated index.hhp.
873
874HHC_LOCATION           =
875
876# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
877# controls if a separate .chi index file is generated (YES) or that
878# it should be included in the master .chm file (NO).
879
880GENERATE_CHI           = NO
881
882# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
883# is used to encode HtmlHelp index (hhk), content (hhc) and project file
884# content.
885
886CHM_INDEX_ENCODING     =
887
888# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
889# controls whether a binary table of contents is generated (YES) or a
890# normal table of contents (NO) in the .chm file.
891
892BINARY_TOC             = NO
893
894# The TOC_EXPAND flag can be set to YES to add extra items for group members
895# to the contents of the HTML help documentation and to the tree view.
896
897TOC_EXPAND             = NO
898
899# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
900# are set, an additional index file will be generated that can be used as input for
901# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
902# HTML documentation.
903
904GENERATE_QHP           = NO
905
906# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
907# be used to specify the file name of the resulting .qch file.
908# The path specified is relative to the HTML output folder.
909
910QCH_FILE               =
911
912# The QHP_NAMESPACE tag specifies the namespace to use when generating
913# Qt Help Project output. For more information please see
914# http://doc.trolltech.com/qthelpproject.html#namespace
915
916QHP_NAMESPACE          =
917
918# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
919# Qt Help Project output. For more information please see
920# http://doc.trolltech.com/qthelpproject.html#virtual-folders
921
922QHP_VIRTUAL_FOLDER     = doc
923
924# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
925# For more information please see
926# http://doc.trolltech.com/qthelpproject.html#custom-filters
927
928QHP_CUST_FILTER_NAME   =
929
930# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
931# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
932
933QHP_CUST_FILTER_ATTRS  =
934
935# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
936# filter section matches.
937# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
938
939QHP_SECT_FILTER_ATTRS  =
940
941# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
942# be used to specify the location of Qt's qhelpgenerator.
943# If non-empty doxygen will try to run qhelpgenerator on the generated
944# .qhp file.
945
946QHG_LOCATION           =
947
948# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
949# top of each HTML page. The value NO (the default) enables the index and
950# the value YES disables it.
951
952DISABLE_INDEX          = NO
953
954# This tag can be used to set the number of enum values (range [1..20])
955# that doxygen will group on one line in the generated HTML documentation.
956
957ENUM_VALUES_PER_LINE   = 4
958
959# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
960# structure should be generated to display hierarchical information.
961# If the tag value is set to FRAME, a side panel will be generated
962# containing a tree-like index structure (just like the one that
963# is generated for HTML Help). For this to work a browser that supports
964# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
965# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
966# probably better off using the HTML help feature. Other possible values
967# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
968# and Class Hierarchy pages using a tree view instead of an ordered list;
969# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
970# disables this behavior completely. For backwards compatibility with previous
971# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
972# respectively.
973
974GENERATE_TREEVIEW      = NONE
975
976# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
977# used to set the initial width (in pixels) of the frame in which the tree
978# is shown.
979
980TREEVIEW_WIDTH         = 250
981
982# Use this tag to change the font size of Latex formulas included
983# as images in the HTML documentation. The default is 10. Note that
984# when you change the font size after a successful doxygen run you need
985# to manually remove any form_*.png images from the HTML output directory
986# to force them to be regenerated.
987
988FORMULA_FONTSIZE       = 10
989
990#---------------------------------------------------------------------------
991# configuration options related to the LaTeX output
992#---------------------------------------------------------------------------
993
994# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
995# generate Latex output.
996
997GENERATE_LATEX         = YES
998
999# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1000# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1001# put in front of it. If left blank `latex' will be used as the default path.
1002
1003LATEX_OUTPUT           = latex
1004
1005# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1006# invoked. If left blank `latex' will be used as the default command name.
1007
1008LATEX_CMD_NAME         = latex
1009
1010# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1011# generate index for LaTeX. If left blank `makeindex' will be used as the
1012# default command name.
1013
1014MAKEINDEX_CMD_NAME     = makeindex
1015
1016# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1017# LaTeX documents. This may be useful for small projects and may help to
1018# save some trees in general.
1019
1020COMPACT_LATEX          = NO
1021
1022# The PAPER_TYPE tag can be used to set the paper type that is used
1023# by the printer. Possible values are: a4, a4wide, letter, legal and
1024# executive. If left blank a4wide will be used.
1025
1026PAPER_TYPE             = a4wide
1027
1028# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1029# packages that should be included in the LaTeX output.
1030
1031EXTRA_PACKAGES         =
1032
1033# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1034# the generated latex document. The header should contain everything until
1035# the first chapter. If it is left blank doxygen will generate a
1036# standard header. Notice: only use this tag if you know what you are doing!
1037
1038LATEX_HEADER           =
1039
1040# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1041# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1042# contain links (just like the HTML output) instead of page references
1043# This makes the output suitable for online browsing using a pdf viewer.
1044
1045PDF_HYPERLINKS         = YES
1046
1047# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1048# plain latex in the generated Makefile. Set this option to YES to get a
1049# higher quality PDF documentation.
1050
1051USE_PDFLATEX           = YES
1052
1053# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1054# command to the generated LaTeX files. This will instruct LaTeX to keep
1055# running if errors occur, instead of asking the user for help.
1056# This option is also used when generating formulas in HTML.
1057
1058LATEX_BATCHMODE        = NO
1059
1060# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1061# include the index chapters (such as File Index, Compound Index, etc.)
1062# in the output.
1063
1064LATEX_HIDE_INDICES     = NO
1065
1066#---------------------------------------------------------------------------
1067# configuration options related to the RTF output
1068#---------------------------------------------------------------------------
1069
1070# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1071# The RTF output is optimized for Word 97 and may not look very pretty with
1072# other RTF readers or editors.
1073
1074GENERATE_RTF           = NO
1075
1076# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1077# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1078# put in front of it. If left blank `rtf' will be used as the default path.
1079
1080RTF_OUTPUT             = rtf
1081
1082# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1083# RTF documents. This may be useful for small projects and may help to
1084# save some trees in general.
1085
1086COMPACT_RTF            = NO
1087
1088# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1089# will contain hyperlink fields. The RTF file will
1090# contain links (just like the HTML output) instead of page references.
1091# This makes the output suitable for online browsing using WORD or other
1092# programs which support those fields.
1093# Note: wordpad (write) and others do not support links.
1094
1095RTF_HYPERLINKS         = NO
1096
1097# Load stylesheet definitions from file. Syntax is similar to doxygen's
1098# config file, i.e. a series of assignments. You only have to provide
1099# replacements, missing definitions are set to their default value.
1100
1101RTF_STYLESHEET_FILE    =
1102
1103# Set optional variables used in the generation of an rtf document.
1104# Syntax is similar to doxygen's config file.
1105
1106RTF_EXTENSIONS_FILE    =
1107
1108#---------------------------------------------------------------------------
1109# configuration options related to the man page output
1110#---------------------------------------------------------------------------
1111
1112# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1113# generate man pages
1114
1115GENERATE_MAN           = NO
1116
1117# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1118# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1119# put in front of it. If left blank `man' will be used as the default path.
1120
1121MAN_OUTPUT             = man
1122
1123# The MAN_EXTENSION tag determines the extension that is added to
1124# the generated man pages (default is the subroutine's section .3)
1125
1126MAN_EXTENSION          = .3
1127
1128# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1129# then it will generate one additional man file for each entity
1130# documented in the real man page(s). These additional files
1131# only source the real man page, but without them the man command
1132# would be unable to find the correct page. The default is NO.
1133
1134MAN_LINKS              = NO
1135
1136#---------------------------------------------------------------------------
1137# configuration options related to the XML output
1138#---------------------------------------------------------------------------
1139
1140# If the GENERATE_XML tag is set to YES Doxygen will
1141# generate an XML file that captures the structure of
1142# the code including all documentation.
1143
1144GENERATE_XML           = NO
1145
1146# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1147# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1148# put in front of it. If left blank `xml' will be used as the default path.
1149
1150XML_OUTPUT             = xml
1151
1152# The XML_SCHEMA tag can be used to specify an XML schema,
1153# which can be used by a validating XML parser to check the
1154# syntax of the XML files.
1155
1156XML_SCHEMA             =
1157
1158# The XML_DTD tag can be used to specify an XML DTD,
1159# which can be used by a validating XML parser to check the
1160# syntax of the XML files.
1161
1162XML_DTD                =
1163
1164# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1165# dump the program listings (including syntax highlighting
1166# and cross-referencing information) to the XML output. Note that
1167# enabling this will significantly increase the size of the XML output.
1168
1169XML_PROGRAMLISTING     = YES
1170
1171#---------------------------------------------------------------------------
1172# configuration options for the AutoGen Definitions output
1173#---------------------------------------------------------------------------
1174
1175# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1176# generate an AutoGen Definitions (see autogen.sf.net) file
1177# that captures the structure of the code including all
1178# documentation. Note that this feature is still experimental
1179# and incomplete at the moment.
1180
1181GENERATE_AUTOGEN_DEF   = NO
1182
1183#---------------------------------------------------------------------------
1184# configuration options related to the Perl module output
1185#---------------------------------------------------------------------------
1186
1187# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1188# generate a Perl module file that captures the structure of
1189# the code including all documentation. Note that this
1190# feature is still experimental and incomplete at the
1191# moment.
1192
1193GENERATE_PERLMOD       = NO
1194
1195# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1196# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1197# to generate PDF and DVI output from the Perl module output.
1198
1199PERLMOD_LATEX          = NO
1200
1201# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1202# nicely formatted so it can be parsed by a human reader.
1203# This is useful
1204# if you want to understand what is going on.
1205# On the other hand, if this
1206# tag is set to NO the size of the Perl module output will be much smaller
1207# and Perl will parse it just the same.
1208
1209PERLMOD_PRETTY         = YES
1210
1211# The names of the make variables in the generated doxyrules.make file
1212# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1213# This is useful so different doxyrules.make files included by the same
1214# Makefile don't overwrite each other's variables.
1215
1216PERLMOD_MAKEVAR_PREFIX =
1217
1218#---------------------------------------------------------------------------
1219# Configuration options related to the preprocessor
1220#---------------------------------------------------------------------------
1221
1222# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1223# evaluate all C-preprocessor directives found in the sources and include
1224# files.
1225
1226ENABLE_PREPROCESSING   = YES
1227
1228# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1229# names in the source code. If set to NO (the default) only conditional
1230# compilation will be performed. Macro expansion can be done in a controlled
1231# way by setting EXPAND_ONLY_PREDEF to YES.
1232
1233MACRO_EXPANSION        = NO
1234
1235# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1236# then the macro expansion is limited to the macros specified with the
1237# PREDEFINED and EXPAND_AS_DEFINED tags.
1238
1239EXPAND_ONLY_PREDEF     = NO
1240
1241# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1242# in the INCLUDE_PATH (see below) will be search if a #include is found.
1243
1244SEARCH_INCLUDES        = YES
1245
1246# The INCLUDE_PATH tag can be used to specify one or more directories that
1247# contain include files that are not input files but should be processed by
1248# the preprocessor.
1249
1250INCLUDE_PATH           =
1251
1252# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1253# patterns (like *.h and *.hpp) to filter out the header-files in the
1254# directories. If left blank, the patterns specified with FILE_PATTERNS will
1255# be used.
1256
1257INCLUDE_FILE_PATTERNS  =
1258
1259# The PREDEFINED tag can be used to specify one or more macro names that
1260# are defined before the preprocessor is started (similar to the -D option of
1261# gcc). The argument of the tag is a list of macros of the form: name
1262# or name=definition (no spaces). If the definition and the = are
1263# omitted =1 is assumed. To prevent a macro definition from being
1264# undefined via #undef or recursively expanded use the := operator
1265# instead of the = operator.
1266
1267PREDEFINED             =
1268
1269# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1270# this tag can be used to specify a list of macro names that should be expanded.
1271# The macro definition that is found in the sources will be used.
1272# Use the PREDEFINED tag if you want to use a different macro definition.
1273
1274EXPAND_AS_DEFINED      =
1275
1276# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1277# doxygen's preprocessor will remove all function-like macros that are alone
1278# on a line, have an all uppercase name, and do not end with a semicolon. Such
1279# function macros are typically used for boiler-plate code, and will confuse
1280# the parser if not removed.
1281
1282SKIP_FUNCTION_MACROS   = YES
1283
1284#---------------------------------------------------------------------------
1285# Configuration::additions related to external references
1286#---------------------------------------------------------------------------
1287
1288# The TAGFILES option can be used to specify one or more tagfiles.
1289# Optionally an initial location of the external documentation
1290# can be added for each tagfile. The format of a tag file without
1291# this location is as follows:
1292#
1293# TAGFILES = file1 file2 ...
1294# Adding location for the tag files is done as follows:
1295#
1296# TAGFILES = file1=loc1 "file2 = loc2" ...
1297# where "loc1" and "loc2" can be relative or absolute paths or
1298# URLs. If a location is present for each tag, the installdox tool
1299# does not have to be run to correct the links.
1300# Note that each tag file must have a unique name
1301# (where the name does NOT include the path)
1302# If a tag file is not located in the directory in which doxygen
1303# is run, you must also specify the path to the tagfile here.
1304
1305TAGFILES               =
1306
1307# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1308# a tag file that is based on the input files it reads.
1309
1310GENERATE_TAGFILE       =
1311
1312# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1313# in the class index. If set to NO only the inherited external classes
1314# will be listed.
1315
1316ALLEXTERNALS           = NO
1317
1318# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1319# in the modules index. If set to NO, only the current project's groups will
1320# be listed.
1321
1322EXTERNAL_GROUPS        = YES
1323
1324# The PERL_PATH should be the absolute path and name of the perl script
1325# interpreter (i.e. the result of `which perl').
1326
1327PERL_PATH              = /usr/bin/perl
1328
1329#---------------------------------------------------------------------------
1330# Configuration options related to the dot tool
1331#---------------------------------------------------------------------------
1332
1333# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1334# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1335# or super classes. Setting the tag to NO turns the diagrams off. Note that
1336# this option is superseded by the HAVE_DOT option below. This is only a
1337# fallback. It is recommended to install and use dot, since it yields more
1338# powerful graphs.
1339
1340CLASS_DIAGRAMS         = YES
1341
1342# You can define message sequence charts within doxygen comments using the \msc
1343# command. Doxygen will then run the mscgen tool (see
1344# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1345# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1346# the mscgen tool resides. If left empty the tool is assumed to be found in the
1347# default search path.
1348
1349MSCGEN_PATH            =
1350
1351# If set to YES, the inheritance and collaboration graphs will hide
1352# inheritance and usage relations if the target is undocumented
1353# or is not a class.
1354
1355HIDE_UNDOC_RELATIONS   = YES
1356
1357# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1358# available from the path. This tool is part of Graphviz, a graph visualization
1359# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1360# have no effect if this option is set to NO (the default)
1361
1362HAVE_DOT               = NO
1363
1364# By default doxygen will write a font called FreeSans.ttf to the output
1365# directory and reference it in all dot files that doxygen generates. This
1366# font does not include all possible unicode characters however, so when you need
1367# these (or just want a differently looking font) you can specify the font name
1368# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1369# which can be done by putting it in a standard location or by setting the
1370# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1371# containing the font.
1372
1373DOT_FONTNAME           = FreeSans
1374
1375# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1376# The default size is 10pt.
1377
1378DOT_FONTSIZE           = 10
1379
1380# By default doxygen will tell dot to use the output directory to look for the
1381# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1382# different font using DOT_FONTNAME you can set the path where dot
1383# can find it using this tag.
1384
1385DOT_FONTPATH           =
1386
1387# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1388# will generate a graph for each documented class showing the direct and
1389# indirect inheritance relations. Setting this tag to YES will force the
1390# the CLASS_DIAGRAMS tag to NO.
1391
1392CLASS_GRAPH            = YES
1393
1394# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1395# will generate a graph for each documented class showing the direct and
1396# indirect implementation dependencies (inheritance, containment, and
1397# class references variables) of the class with other documented classes.
1398
1399COLLABORATION_GRAPH    = YES
1400
1401# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1402# will generate a graph for groups, showing the direct groups dependencies
1403
1404GROUP_GRAPHS           = YES
1405
1406# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1407# collaboration diagrams in a style similar to the OMG's Unified Modeling
1408# Language.
1409
1410UML_LOOK               = NO
1411
1412# If set to YES, the inheritance and collaboration graphs will show the
1413# relations between templates and their instances.
1414
1415TEMPLATE_RELATIONS     = NO
1416
1417# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1418# tags are set to YES then doxygen will generate a graph for each documented
1419# file showing the direct and indirect include dependencies of the file with
1420# other documented files.
1421
1422INCLUDE_GRAPH          = YES
1423
1424# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1425# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1426# documented header file showing the documented files that directly or
1427# indirectly include this file.
1428
1429INCLUDED_BY_GRAPH      = YES
1430
1431# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1432# doxygen will generate a call dependency graph for every global function
1433# or class method. Note that enabling this option will significantly increase
1434# the time of a run. So in most cases it will be better to enable call graphs
1435# for selected functions only using the \callgraph command.
1436
1437CALL_GRAPH             = NO
1438
1439# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1440# doxygen will generate a caller dependency graph for every global function
1441# or class method. Note that enabling this option will significantly increase
1442# the time of a run. So in most cases it will be better to enable caller
1443# graphs for selected functions only using the \callergraph command.
1444
1445CALLER_GRAPH           = NO
1446
1447# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1448# will graphical hierarchy of all classes instead of a textual one.
1449
1450GRAPHICAL_HIERARCHY    = YES
1451
1452# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1453# then doxygen will show the dependencies a directory has on other directories
1454# in a graphical way. The dependency relations are determined by the #include
1455# relations between the files in the directories.
1456
1457DIRECTORY_GRAPH        = YES
1458
1459# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1460# generated by dot. Possible values are png, jpg, or gif
1461# If left blank png will be used.
1462
1463DOT_IMAGE_FORMAT       = png
1464
1465# The tag DOT_PATH can be used to specify the path where the dot tool can be
1466# found. If left blank, it is assumed the dot tool can be found in the path.
1467
1468DOT_PATH               =
1469
1470# The DOTFILE_DIRS tag can be used to specify one or more directories that
1471# contain dot files that are included in the documentation (see the
1472# \dotfile command).
1473
1474DOTFILE_DIRS           =
1475
1476# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1477# nodes that will be shown in the graph. If the number of nodes in a graph
1478# becomes larger than this value, doxygen will truncate the graph, which is
1479# visualized by representing a node as a red box. Note that doxygen if the
1480# number of direct children of the root node in a graph is already larger than
1481# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1482# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1483
1484DOT_GRAPH_MAX_NODES    = 50
1485
1486# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1487# graphs generated by dot. A depth value of 3 means that only nodes reachable
1488# from the root by following a path via at most 3 edges will be shown. Nodes
1489# that lay further from the root node will be omitted. Note that setting this
1490# option to 1 or 2 may greatly reduce the computation time needed for large
1491# code bases. Also note that the size of a graph can be further restricted by
1492# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1493
1494MAX_DOT_GRAPH_DEPTH    = 0
1495
1496# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1497# background. This is disabled by default, because dot on Windows does not
1498# seem to support this out of the box. Warning: Depending on the platform used,
1499# enabling this option may lead to badly anti-aliased labels on the edges of
1500# a graph (i.e. they become hard to read).
1501
1502DOT_TRANSPARENT        = NO
1503
1504# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1505# files in one run (i.e. multiple -o and -T options on the command line). This
1506# makes dot run faster, but since only newer versions of dot (>1.8.10)
1507# support this, this feature is disabled by default.
1508
1509DOT_MULTI_TARGETS      = NO
1510
1511# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1512# generate a legend page explaining the meaning of the various boxes and
1513# arrows in the dot generated graphs.
1514
1515GENERATE_LEGEND        = YES
1516
1517# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1518# remove the intermediate dot files that are used to generate
1519# the various graphs.
1520
1521DOT_CLEANUP            = YES
1522
1523#---------------------------------------------------------------------------
1524# Options related to the search engine
1525#---------------------------------------------------------------------------
1526
1527# The SEARCHENGINE tag specifies whether or not a search engine should be
1528# used. If set to NO the values of all tags below this one will be ignored.
1529
1530SEARCHENGINE           = NO
1531