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