Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(47)

Side by Side Diff: ppapi/cpp/documentation/Doxyfile

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

Powered by Google App Engine
This is Rietveld 408576698