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