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