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

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

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

Powered by Google App Engine
This is Rietveld 408576698