annotate Doxyfile @ 2934:c32036aa4b4d trunk

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