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