source: rtems-tools/linkers/rtl-host.conf @ eb1d8f4

Last change on this file since eb1d8f4 was e78e2b0, checked in by Chris Johns <chrisj@…>, on Jan 22, 2013 at 11:08:09 AM

Documentation.

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