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