]> begriffs open source - cmsis/blob - CMSIS/DoxyGen/Core_A/core_A.dxy
Add new compiler macros:
[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 1.2.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                          src/ref_gic.txt \
758                          src/ref_core_register.txt \
759                          src/ref_cache.txt \
760                          src/ref_timer.txt \
761                          src/ref_mmu.txt \
762                          src/core_ca.txt \
763                          src/cmsis_armcc.txt \
764                          src/irq_ctrl.txt \
765                          ../../Core_A/Include/core_ca.h \
766                          ../../Core_A/Include/cmsis_armcc.h \
767                          ../../Core_A/Include/cmsis_cp15.h \
768                          ../../Core_A/Source/irq_ctrl_gic.c \
769                          ../../Core_A/Include/irq_ctrl.h \
770                          ../../../Device/ARM/ARMCA9/Include/ARMCA9.h \
771                          ../../../Device/ARM/ARMCA9/Config/mem_ARMCA9.h \
772                          ../../../Device/ARM/ARMCA9/Config/system_ARMCA9.h \
773                          ../../../Device/ARM/ARMCA9/Source/AC6/startup_ARMCA9.c
774
775 # This tag can be used to specify the character encoding of the source files
776 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
777 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
778 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
779 # possible encodings.
780 # The default value is: UTF-8.
781
782 INPUT_ENCODING         = UTF-8
783
784 # If the value of the INPUT tag contains directories, you can use the
785 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
786 # *.h) to filter out the source-files in the directories. If left blank the
787 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
788 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
789 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
790 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
791 # *.qsf, *.as and *.js.
792
793 FILE_PATTERNS          = 
794
795 # The RECURSIVE tag can be used to specify whether or not subdirectories should
796 # be searched for input files as well.
797 # The default value is: NO.
798
799 RECURSIVE              = NO
800
801 # The EXCLUDE tag can be used to specify files and/or directories that should be
802 # excluded from the INPUT source files. This way you can easily exclude a
803 # subdirectory from a directory tree whose root is specified with the INPUT tag.
804 #
805 # Note that relative paths are relative to the directory from which doxygen is
806 # run.
807
808 EXCLUDE                = system*.c \
809                          startup*.s \
810                          src/exclude/
811
812 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
813 # directories that are symbolic links (a Unix file system feature) are excluded
814 # from the input.
815 # The default value is: NO.
816
817 EXCLUDE_SYMLINKS       = NO
818
819 # If the value of the INPUT tag contains directories, you can use the
820 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
821 # certain files from those directories.
822 #
823 # Note that the wildcards are matched against the file with absolute path, so to
824 # exclude all test directories for example use the pattern */test/*
825
826 EXCLUDE_PATTERNS       = 
827
828 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
829 # (namespaces, classes, functions, etc.) that should be excluded from the
830 # output. The symbol name can be a fully qualified name, a word, or if the
831 # wildcard * is used, a substring. Examples: ANamespace, AClass,
832 # AClass::ANamespace, ANamespace::*Test
833 #
834 # Note that the wildcards are matched against the file with absolute path, so to
835 # exclude all test directories use the pattern */test/*
836
837 EXCLUDE_SYMBOLS        = 
838
839 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
840 # that contain example code fragments that are included (see the \include
841 # command).
842
843 EXAMPLE_PATH           = ../../../Device/_Template_Vendor/Vendor/Device_A
844
845 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
846 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
847 # *.h) to filter out the source-files in the directories. If left blank all
848 # files are included.
849
850 EXAMPLE_PATTERNS       = *
851
852 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
853 # searched for input files to be used with the \include or \dontinclude commands
854 # irrespective of the value of the RECURSIVE tag.
855 # The default value is: NO.
856
857 EXAMPLE_RECURSIVE      = NO
858
859 # The IMAGE_PATH tag can be used to specify one or more files or directories
860 # that contain images that are to be included in the documentation (see the
861 # \image command).
862
863 IMAGE_PATH             = src/images
864
865 # The INPUT_FILTER tag can be used to specify a program that doxygen should
866 # invoke to filter for each input file. Doxygen will invoke the filter program
867 # by executing (via popen()) the command:
868 #
869 # <filter> <input-file>
870 #
871 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
872 # name of an input file. Doxygen will then use the output that the filter
873 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
874 # will be ignored.
875 #
876 # Note that the filter must not add or remove lines; it is applied before the
877 # code is scanned, but not when the output code is generated. If lines are added
878 # or removed, the anchors will not be placed correctly.
879
880 INPUT_FILTER           = 
881
882 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
883 # basis. Doxygen will compare the file name with each pattern and apply the
884 # filter if there is a match. The filters are a list of the form: pattern=filter
885 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
886 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
887 # patterns match the file name, INPUT_FILTER is applied.
888
889 FILTER_PATTERNS        = 
890
891 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
892 # INPUT_FILTER ) will also be used to filter the input files that are used for
893 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
894 # The default value is: NO.
895
896 FILTER_SOURCE_FILES    = NO
897
898 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
899 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
900 # it is also possible to disable source filtering for a specific pattern using
901 # *.ext= (so without naming a filter).
902 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
903
904 FILTER_SOURCE_PATTERNS = 
905
906 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
907 # is part of the input, its contents will be placed on the main page
908 # (index.html). This can be useful if you have a project on for instance GitHub
909 # and want to reuse the introduction page also for the doxygen output.
910
911 USE_MDFILE_AS_MAINPAGE = 
912
913 #---------------------------------------------------------------------------
914 # Configuration options related to source browsing
915 #---------------------------------------------------------------------------
916
917 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
918 # generated. Documented entities will be cross-referenced with these sources.
919 #
920 # Note: To get rid of all source code in the generated output, make sure that
921 # also VERBATIM_HEADERS is set to NO.
922 # The default value is: NO.
923
924 SOURCE_BROWSER         = NO
925
926 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
927 # classes and enums directly into the documentation.
928 # The default value is: NO.
929
930 INLINE_SOURCES         = NO
931
932 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
933 # special comment blocks from generated source code fragments. Normal C, C++ and
934 # Fortran comments will always remain visible.
935 # The default value is: YES.
936
937 STRIP_CODE_COMMENTS    = YES
938
939 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
940 # function all documented functions referencing it will be listed.
941 # The default value is: NO.
942
943 REFERENCED_BY_RELATION = NO
944
945 # If the REFERENCES_RELATION tag is set to YES then for each documented function
946 # all documented entities called/used by that function will be listed.
947 # The default value is: NO.
948
949 REFERENCES_RELATION    = NO
950
951 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
952 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
953 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
954 # link to the documentation.
955 # The default value is: YES.
956
957 REFERENCES_LINK_SOURCE = NO
958
959 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
960 # source code will show a tooltip with additional information such as prototype,
961 # brief description and links to the definition and documentation. Since this
962 # will make the HTML file larger and loading of large files a bit slower, you
963 # can opt to disable this feature.
964 # The default value is: YES.
965 # This tag requires that the tag SOURCE_BROWSER is set to YES.
966
967 SOURCE_TOOLTIPS        = YES
968
969 # If the USE_HTAGS tag is set to YES then the references to source code will
970 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
971 # source browser. The htags tool is part of GNU's global source tagging system
972 # (see http://www.gnu.org/software/global/global.html). You will need version
973 # 4.8.6 or higher.
974 #
975 # To use it do the following:
976 # - Install the latest version of global
977 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
978 # - Make sure the INPUT points to the root of the source tree
979 # - Run doxygen as normal
980 #
981 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
982 # tools must be available from the command line (i.e. in the search path).
983 #
984 # The result: instead of the source browser generated by doxygen, the links to
985 # source code will now point to the output of htags.
986 # The default value is: NO.
987 # This tag requires that the tag SOURCE_BROWSER is set to YES.
988
989 USE_HTAGS              = NO
990
991 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
992 # verbatim copy of the header file for each class for which an include is
993 # specified. Set to NO to disable this.
994 # See also: Section \class.
995 # The default value is: YES.
996
997 VERBATIM_HEADERS       = NO
998
999 #---------------------------------------------------------------------------
1000 # Configuration options related to the alphabetical class index
1001 #---------------------------------------------------------------------------
1002
1003 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1004 # compounds will be generated. Enable this if the project contains a lot of
1005 # classes, structs, unions or interfaces.
1006 # The default value is: YES.
1007
1008 ALPHABETICAL_INDEX     = NO
1009
1010 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1011 # which the alphabetical index list will be split.
1012 # Minimum value: 1, maximum value: 20, default value: 5.
1013 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1014
1015 COLS_IN_ALPHA_INDEX    = 5
1016
1017 # In case all classes in a project start with a common prefix, all classes will
1018 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1019 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1020 # while generating the index headers.
1021 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1022
1023 IGNORE_PREFIX          = 
1024
1025 #---------------------------------------------------------------------------
1026 # Configuration options related to the HTML output
1027 #---------------------------------------------------------------------------
1028
1029 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1030 # The default value is: YES.
1031
1032 GENERATE_HTML          = YES
1033
1034 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1035 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1036 # it.
1037 # The default directory is: html.
1038 # This tag requires that the tag GENERATE_HTML is set to YES.
1039
1040 HTML_OUTPUT            = html
1041
1042 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1043 # generated HTML page (for example: .htm, .php, .asp).
1044 # The default value is: .html.
1045 # This tag requires that the tag GENERATE_HTML is set to YES.
1046
1047 HTML_FILE_EXTENSION    = .html
1048
1049 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1050 # each generated HTML page. If the tag is left blank doxygen will generate a
1051 # standard header.
1052 #
1053 # To get valid HTML the header file that includes any scripts and style sheets
1054 # that doxygen needs, which is dependent on the configuration options used (e.g.
1055 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1056 # default header using
1057 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1058 # YourConfigFile
1059 # and then modify the file new_header.html. See also section "Doxygen usage"
1060 # for information on how to generate the default header that doxygen normally
1061 # uses.
1062 # Note: The header is subject to change so you typically have to regenerate the
1063 # default header when upgrading to a newer version of doxygen. For a description
1064 # of the possible markers and block names see the documentation.
1065 # This tag requires that the tag GENERATE_HTML is set to YES.
1066
1067 HTML_HEADER            = ../Doxygen_Templates/cmsis_header.html
1068
1069 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1070 # generated HTML page. If the tag is left blank doxygen will generate a standard
1071 # footer. See HTML_HEADER for more information on how to generate a default
1072 # footer and what special commands can be used inside the footer. See also
1073 # section "Doxygen usage" for information on how to generate the default footer
1074 # that doxygen normally uses.
1075 # This tag requires that the tag GENERATE_HTML is set to YES.
1076
1077 HTML_FOOTER            = ../Doxygen_Templates/cmsis_footer.html
1078
1079 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1080 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1081 # the HTML output. If left blank doxygen will generate a default style sheet.
1082 # See also section "Doxygen usage" for information on how to generate the style
1083 # sheet that doxygen normally uses.
1084 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1085 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1086 # obsolete.
1087 # This tag requires that the tag GENERATE_HTML is set to YES.
1088
1089 HTML_STYLESHEET        = 
1090
1091 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1092 # defined cascading style sheet that is included after the standard style sheets
1093 # created by doxygen. Using this option one can overrule certain style aspects.
1094 # This is preferred over using HTML_STYLESHEET since it does not replace the
1095 # standard style sheet and is therefor more robust against future updates.
1096 # Doxygen will copy the style sheet file to the output directory. For an example
1097 # see the documentation.
1098 # This tag requires that the tag GENERATE_HTML is set to YES.
1099
1100 HTML_EXTRA_STYLESHEET  = ../Doxygen_Templates/cmsis.css
1101
1102 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1103 # other source files which should be copied to the HTML output directory. Note
1104 # that these files will be copied to the base HTML output directory. Use the
1105 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1106 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1107 # files will be copied as-is; there are no commands or markers available.
1108 # This tag requires that the tag GENERATE_HTML is set to YES.
1109
1110 HTML_EXTRA_FILES       = ../Doxygen_Templates/tabs.css \
1111                          ../Doxygen_Templates/tab_topnav.png \
1112                          ../Doxygen_Templates/search.css \
1113                          ../Doxygen_Templates/check.png \
1114                          ../Doxygen_Templates/printComponentTabs.js
1115
1116 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1117 # will adjust the colors in the stylesheet and background images according to
1118 # this color. Hue is specified as an angle on a colorwheel, see
1119 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1120 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1121 # purple, and 360 is red again.
1122 # Minimum value: 0, maximum value: 359, default value: 220.
1123 # This tag requires that the tag GENERATE_HTML is set to YES.
1124
1125 HTML_COLORSTYLE_HUE    = 220
1126
1127 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1128 # in the HTML output. For a value of 0 the output will use grayscales only. A
1129 # value of 255 will produce the most vivid colors.
1130 # Minimum value: 0, maximum value: 255, default value: 100.
1131 # This tag requires that the tag GENERATE_HTML is set to YES.
1132
1133 HTML_COLORSTYLE_SAT    = 106
1134
1135 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1136 # luminance component of the colors in the HTML output. Values below 100
1137 # gradually make the output lighter, whereas values above 100 make the output
1138 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1139 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1140 # change the gamma.
1141 # Minimum value: 40, maximum value: 240, default value: 80.
1142 # This tag requires that the tag GENERATE_HTML is set to YES.
1143
1144 HTML_COLORSTYLE_GAMMA  = 80
1145
1146 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1147 # page will contain the date and time when the page was generated. Setting this
1148 # to NO can help when comparing the output of multiple runs.
1149 # The default value is: YES.
1150 # This tag requires that the tag GENERATE_HTML is set to YES.
1151
1152 HTML_TIMESTAMP         = YES
1153
1154 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1155 # documentation will contain sections that can be hidden and shown after the
1156 # page has loaded.
1157 # The default value is: NO.
1158 # This tag requires that the tag GENERATE_HTML is set to YES.
1159
1160 HTML_DYNAMIC_SECTIONS  = NO
1161
1162 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1163 # shown in the various tree structured indices initially; the user can expand
1164 # and collapse entries dynamically later on. Doxygen will expand the tree to
1165 # such a level that at most the specified number of entries are visible (unless
1166 # a fully collapsed tree already exceeds this amount). So setting the number of
1167 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1168 # representing an infinite number of entries and will result in a full expanded
1169 # tree by default.
1170 # Minimum value: 0, maximum value: 9999, default value: 100.
1171 # This tag requires that the tag GENERATE_HTML is set to YES.
1172
1173 HTML_INDEX_NUM_ENTRIES = 100
1174
1175 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1176 # generated that can be used as input for Apple's Xcode 3 integrated development
1177 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1178 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1179 # Makefile in the HTML output directory. Running make will produce the docset in
1180 # that directory and running make install will install the docset in
1181 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1182 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1183 # for more information.
1184 # The default value is: NO.
1185 # This tag requires that the tag GENERATE_HTML is set to YES.
1186
1187 GENERATE_DOCSET        = NO
1188
1189 # This tag determines the name of the docset feed. A documentation feed provides
1190 # an umbrella under which multiple documentation sets from a single provider
1191 # (such as a company or product suite) can be grouped.
1192 # The default value is: Doxygen generated docs.
1193 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1194
1195 DOCSET_FEEDNAME        = "Doxygen generated docs"
1196
1197 # This tag specifies a string that should uniquely identify the documentation
1198 # set bundle. This should be a reverse domain-name style string, e.g.
1199 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1200 # The default value is: org.doxygen.Project.
1201 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1202
1203 DOCSET_BUNDLE_ID       = org.doxygen.Project
1204
1205 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1206 # the documentation publisher. This should be a reverse domain-name style
1207 # string, e.g. com.mycompany.MyDocSet.documentation.
1208 # The default value is: org.doxygen.Publisher.
1209 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1210
1211 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1212
1213 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1214 # The default value is: Publisher.
1215 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1216
1217 DOCSET_PUBLISHER_NAME  = Publisher
1218
1219 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1220 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1221 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1222 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1223 # Windows.
1224 #
1225 # The HTML Help Workshop contains a compiler that can convert all HTML output
1226 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1227 # files are now used as the Windows 98 help format, and will replace the old
1228 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1229 # HTML files also contain an index, a table of contents, and you can search for
1230 # words in the documentation. The HTML workshop also contains a viewer for
1231 # compressed HTML files.
1232 # The default value is: NO.
1233 # This tag requires that the tag GENERATE_HTML is set to YES.
1234
1235 GENERATE_HTMLHELP      = NO
1236
1237 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1238 # file. You can add a path in front of the file if the result should not be
1239 # written to the html output directory.
1240 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1241
1242 CHM_FILE               = CMSIS_Core.chm
1243
1244 # The HHC_LOCATION tag can be used to specify the location (absolute path
1245 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1246 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1247 # The file has to be specified with full path.
1248 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1249
1250 HHC_LOCATION           = "C:/Program Files/HTML Help Workshop/hhc.exe"
1251
1252 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1253 # YES) or that it should be included in the master .chm file ( NO).
1254 # The default value is: NO.
1255 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1256
1257 GENERATE_CHI           = NO
1258
1259 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1260 # and project file content.
1261 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1262
1263 CHM_INDEX_ENCODING     = 
1264
1265 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1266 # YES) or a normal table of contents ( NO) in the .chm file.
1267 # The default value is: NO.
1268 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1269
1270 BINARY_TOC             = NO
1271
1272 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1273 # the table of contents of the HTML help documentation and to the tree view.
1274 # The default value is: NO.
1275 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1276
1277 TOC_EXPAND             = NO
1278
1279 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1280 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1281 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1282 # (.qch) of the generated HTML documentation.
1283 # The default value is: NO.
1284 # This tag requires that the tag GENERATE_HTML is set to YES.
1285
1286 GENERATE_QHP           = NO
1287
1288 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1289 # the file name of the resulting .qch file. The path specified is relative to
1290 # the HTML output folder.
1291 # This tag requires that the tag GENERATE_QHP is set to YES.
1292
1293 QCH_FILE               = 
1294
1295 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1296 # Project output. For more information please see Qt Help Project / Namespace
1297 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1298 # The default value is: org.doxygen.Project.
1299 # This tag requires that the tag GENERATE_QHP is set to YES.
1300
1301 QHP_NAMESPACE          = org.doxygen.Project
1302
1303 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1304 # Help Project output. For more information please see Qt Help Project / Virtual
1305 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1306 # folders).
1307 # The default value is: doc.
1308 # This tag requires that the tag GENERATE_QHP is set to YES.
1309
1310 QHP_VIRTUAL_FOLDER     = doc
1311
1312 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1313 # filter to add. For more information please see Qt Help Project / Custom
1314 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1315 # filters).
1316 # This tag requires that the tag GENERATE_QHP is set to YES.
1317
1318 QHP_CUST_FILTER_NAME   = 
1319
1320 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1321 # custom filter to add. For more information please see Qt Help Project / Custom
1322 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1323 # filters).
1324 # This tag requires that the tag GENERATE_QHP is set to YES.
1325
1326 QHP_CUST_FILTER_ATTRS  = 
1327
1328 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1329 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1330 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1331 # This tag requires that the tag GENERATE_QHP is set to YES.
1332
1333 QHP_SECT_FILTER_ATTRS  = 
1334
1335 # The QHG_LOCATION tag can be used to specify the location of Qt's
1336 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1337 # generated .qhp file.
1338 # This tag requires that the tag GENERATE_QHP is set to YES.
1339
1340 QHG_LOCATION           = 
1341
1342 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1343 # generated, together with the HTML files, they form an Eclipse help plugin. To
1344 # install this plugin and make it available under the help contents menu in
1345 # Eclipse, the contents of the directory containing the HTML and XML files needs
1346 # to be copied into the plugins directory of eclipse. The name of the directory
1347 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1348 # After copying Eclipse needs to be restarted before the help appears.
1349 # The default value is: NO.
1350 # This tag requires that the tag GENERATE_HTML is set to YES.
1351
1352 GENERATE_ECLIPSEHELP   = NO
1353
1354 # A unique identifier for the Eclipse help plugin. When installing the plugin
1355 # the directory name containing the HTML and XML files should also have this
1356 # name. Each documentation set should have its own identifier.
1357 # The default value is: org.doxygen.Project.
1358 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1359
1360 ECLIPSE_DOC_ID         = org.doxygen.Project
1361
1362 # If you want full control over the layout of the generated HTML pages it might
1363 # be necessary to disable the index and replace it with your own. The
1364 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1365 # of each HTML page. A value of NO enables the index and the value YES disables
1366 # it. Since the tabs in the index contain the same information as the navigation
1367 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1368 # The default value is: NO.
1369 # This tag requires that the tag GENERATE_HTML is set to YES.
1370
1371 DISABLE_INDEX          = NO
1372
1373 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1374 # structure should be generated to display hierarchical information. If the tag
1375 # value is set to YES, a side panel will be generated containing a tree-like
1376 # index structure (just like the one that is generated for HTML Help). For this
1377 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1378 # (i.e. any modern browser). Windows users are probably better off using the
1379 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1380 # further fine-tune the look of the index. As an example, the default style
1381 # sheet generated by doxygen has an example that shows how to put an image at
1382 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1383 # the same information as the tab index, you could consider setting
1384 # DISABLE_INDEX to YES when enabling this option.
1385 # The default value is: NO.
1386 # This tag requires that the tag GENERATE_HTML is set to YES.
1387
1388 GENERATE_TREEVIEW      = YES
1389
1390 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1391 # doxygen will group on one line in the generated HTML documentation.
1392 #
1393 # Note that a value of 0 will completely suppress the enum values from appearing
1394 # in the overview section.
1395 # Minimum value: 0, maximum value: 20, default value: 4.
1396 # This tag requires that the tag GENERATE_HTML is set to YES.
1397
1398 ENUM_VALUES_PER_LINE   = 1
1399
1400 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1401 # to set the initial width (in pixels) of the frame in which the tree is shown.
1402 # Minimum value: 0, maximum value: 1500, default value: 250.
1403 # This tag requires that the tag GENERATE_HTML is set to YES.
1404
1405 TREEVIEW_WIDTH         = 250
1406
1407 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1408 # external symbols imported via tag files in a separate window.
1409 # The default value is: NO.
1410 # This tag requires that the tag GENERATE_HTML is set to YES.
1411
1412 EXT_LINKS_IN_WINDOW    = NO
1413
1414 # Use this tag to change the font size of LaTeX formulas included as images in
1415 # the HTML documentation. When you change the font size after a successful
1416 # doxygen run you need to manually remove any form_*.png images from the HTML
1417 # output directory to force them to be regenerated.
1418 # Minimum value: 8, maximum value: 50, default value: 10.
1419 # This tag requires that the tag GENERATE_HTML is set to YES.
1420
1421 FORMULA_FONTSIZE       = 10
1422
1423 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1424 # generated for formulas are transparent PNGs. Transparent PNGs are not
1425 # supported properly for IE 6.0, but are supported on all modern browsers.
1426 #
1427 # Note that when changing this option you need to delete any form_*.png files in
1428 # the HTML output directory before the changes have effect.
1429 # The default value is: YES.
1430 # This tag requires that the tag GENERATE_HTML is set to YES.
1431
1432 FORMULA_TRANSPARENT    = YES
1433
1434 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1435 # http://www.mathjax.org) which uses client side Javascript for the rendering
1436 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
1437 # installed or if you want to formulas look prettier in the HTML output. When
1438 # enabled you may also need to install MathJax separately and configure the path
1439 # to it using the MATHJAX_RELPATH option.
1440 # The default value is: NO.
1441 # This tag requires that the tag GENERATE_HTML is set to YES.
1442
1443 USE_MATHJAX            = NO
1444
1445 # When MathJax is enabled you can set the default output format to be used for
1446 # the MathJax output. See the MathJax site (see:
1447 # http://docs.mathjax.org/en/latest/output.html) for more details.
1448 # Possible values are: HTML-CSS (which is slower, but has the best
1449 # compatibility), NativeMML (i.e. MathML) and SVG.
1450 # The default value is: HTML-CSS.
1451 # This tag requires that the tag USE_MATHJAX is set to YES.
1452
1453 MATHJAX_FORMAT         = HTML-CSS
1454
1455 # When MathJax is enabled you need to specify the location relative to the HTML
1456 # output directory using the MATHJAX_RELPATH option. The destination directory
1457 # should contain the MathJax.js script. For instance, if the mathjax directory
1458 # is located at the same level as the HTML output directory, then
1459 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1460 # Content Delivery Network so you can quickly see the result without installing
1461 # MathJax. However, it is strongly recommended to install a local copy of
1462 # MathJax from http://www.mathjax.org before deployment.
1463 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1464 # This tag requires that the tag USE_MATHJAX is set to YES.
1465
1466 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1467
1468 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1469 # extension names that should be enabled during MathJax rendering. For example
1470 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1471 # This tag requires that the tag USE_MATHJAX is set to YES.
1472
1473 MATHJAX_EXTENSIONS     = 
1474
1475 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1476 # of code that will be used on startup of the MathJax code. See the MathJax site
1477 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1478 # example see the documentation.
1479 # This tag requires that the tag USE_MATHJAX is set to YES.
1480
1481 MATHJAX_CODEFILE       = 
1482
1483 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1484 # the HTML output. The underlying search engine uses javascript and DHTML and
1485 # should work on any modern browser. Note that when using HTML help
1486 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1487 # there is already a search function so this one should typically be disabled.
1488 # For large projects the javascript based search engine can be slow, then
1489 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1490 # search using the keyboard; to jump to the search box use <access key> + S
1491 # (what the <access key> is depends on the OS and browser, but it is typically
1492 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1493 # key> to jump into the search results window, the results can be navigated
1494 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1495 # the search. The filter options can be selected when the cursor is inside the
1496 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1497 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1498 # option.
1499 # The default value is: YES.
1500 # This tag requires that the tag GENERATE_HTML is set to YES.
1501
1502 SEARCHENGINE           = YES
1503
1504 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1505 # implemented using a web server instead of a web client using Javascript. There
1506 # are two flavours of web server based searching depending on the
1507 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1508 # searching and an index file used by the script. When EXTERNAL_SEARCH is
1509 # enabled the indexing and searching needs to be provided by external tools. See
1510 # the section "External Indexing and Searching" for details.
1511 # The default value is: NO.
1512 # This tag requires that the tag SEARCHENGINE is set to YES.
1513
1514 SERVER_BASED_SEARCH    = NO
1515
1516 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1517 # script for searching. Instead the search results are written to an XML file
1518 # which needs to be processed by an external indexer. Doxygen will invoke an
1519 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1520 # search results.
1521 #
1522 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1523 # (doxysearch.cgi) which are based on the open source search engine library
1524 # Xapian (see: http://xapian.org/).
1525 #
1526 # See the section "External Indexing and Searching" for details.
1527 # The default value is: NO.
1528 # This tag requires that the tag SEARCHENGINE is set to YES.
1529
1530 EXTERNAL_SEARCH        = NO
1531
1532 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1533 # which will return the search results when EXTERNAL_SEARCH is enabled.
1534 #
1535 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1536 # (doxysearch.cgi) which are based on the open source search engine library
1537 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1538 # Searching" for details.
1539 # This tag requires that the tag SEARCHENGINE is set to YES.
1540
1541 SEARCHENGINE_URL       = 
1542
1543 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1544 # search data is written to a file for indexing by an external tool. With the
1545 # SEARCHDATA_FILE tag the name of this file can be specified.
1546 # The default file is: searchdata.xml.
1547 # This tag requires that the tag SEARCHENGINE is set to YES.
1548
1549 SEARCHDATA_FILE        = searchdata.xml
1550
1551 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1552 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1553 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1554 # projects and redirect the results back to the right project.
1555 # This tag requires that the tag SEARCHENGINE is set to YES.
1556
1557 EXTERNAL_SEARCH_ID     = 
1558
1559 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1560 # projects other than the one defined by this configuration file, but that are
1561 # all added to the same external search index. Each project needs to have a
1562 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1563 # to a relative location where the documentation can be found. The format is:
1564 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1565 # This tag requires that the tag SEARCHENGINE is set to YES.
1566
1567 EXTRA_SEARCH_MAPPINGS  = 
1568
1569 #---------------------------------------------------------------------------
1570 # Configuration options related to the LaTeX output
1571 #---------------------------------------------------------------------------
1572
1573 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1574 # The default value is: YES.
1575
1576 GENERATE_LATEX         = NO
1577
1578 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1579 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1580 # it.
1581 # The default directory is: latex.
1582 # This tag requires that the tag GENERATE_LATEX is set to YES.
1583
1584 LATEX_OUTPUT           = latex
1585
1586 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1587 # invoked.
1588 #
1589 # Note that when enabling USE_PDFLATEX this option is only used for generating
1590 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1591 # written to the output directory.
1592 # The default file is: latex.
1593 # This tag requires that the tag GENERATE_LATEX is set to YES.
1594
1595 LATEX_CMD_NAME         = latex
1596
1597 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1598 # index for LaTeX.
1599 # The default file is: makeindex.
1600 # This tag requires that the tag GENERATE_LATEX is set to YES.
1601
1602 MAKEINDEX_CMD_NAME     = makeindex
1603
1604 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1605 # documents. This may be useful for small projects and may help to save some
1606 # trees in general.
1607 # The default value is: NO.
1608 # This tag requires that the tag GENERATE_LATEX is set to YES.
1609
1610 COMPACT_LATEX          = NO
1611
1612 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1613 # printer.
1614 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1615 # 14 inches) and executive (7.25 x 10.5 inches).
1616 # The default value is: a4.
1617 # This tag requires that the tag GENERATE_LATEX is set to YES.
1618
1619 PAPER_TYPE             = a4
1620
1621 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1622 # that should be included in the LaTeX output. To get the times font for
1623 # instance you can specify
1624 # EXTRA_PACKAGES=times
1625 # If left blank no extra packages will be included.
1626 # This tag requires that the tag GENERATE_LATEX is set to YES.
1627
1628 EXTRA_PACKAGES         = 
1629
1630 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1631 # generated LaTeX document. The header should contain everything until the first
1632 # chapter. If it is left blank doxygen will generate a standard header. See
1633 # section "Doxygen usage" for information on how to let doxygen write the
1634 # default header to a separate file.
1635 #
1636 # Note: Only use a user-defined header if you know what you are doing! The
1637 # following commands have a special meaning inside the header: $title,
1638 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1639 # replace them by respectively the title of the page, the current date and time,
1640 # only the current date, the version number of doxygen, the project name (see
1641 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1642 # This tag requires that the tag GENERATE_LATEX is set to YES.
1643
1644 LATEX_HEADER           = 
1645
1646 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1647 # generated LaTeX document. The footer should contain everything after the last
1648 # chapter. If it is left blank doxygen will generate a standard footer.
1649 #
1650 # Note: Only use a user-defined footer if you know what you are doing!
1651 # This tag requires that the tag GENERATE_LATEX is set to YES.
1652
1653 LATEX_FOOTER           = 
1654
1655 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1656 # other source files which should be copied to the LATEX_OUTPUT output
1657 # directory. Note that the files will be copied as-is; there are no commands or
1658 # markers available.
1659 # This tag requires that the tag GENERATE_LATEX is set to YES.
1660
1661 LATEX_EXTRA_FILES      = 
1662
1663 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1664 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1665 # contain links (just like the HTML output) instead of page references. This
1666 # makes the output suitable for online browsing using a PDF viewer.
1667 # The default value is: YES.
1668 # This tag requires that the tag GENERATE_LATEX is set to YES.
1669
1670 PDF_HYPERLINKS         = YES
1671
1672 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1673 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1674 # higher quality PDF documentation.
1675 # The default value is: YES.
1676 # This tag requires that the tag GENERATE_LATEX is set to YES.
1677
1678 USE_PDFLATEX           = YES
1679
1680 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1681 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1682 # if errors occur, instead of asking the user for help. This option is also used
1683 # when generating formulas in HTML.
1684 # The default value is: NO.
1685 # This tag requires that the tag GENERATE_LATEX is set to YES.
1686
1687 LATEX_BATCHMODE        = NO
1688
1689 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1690 # index chapters (such as File Index, Compound Index, etc.) in the output.
1691 # The default value is: NO.
1692 # This tag requires that the tag GENERATE_LATEX is set to YES.
1693
1694 LATEX_HIDE_INDICES     = NO
1695
1696 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1697 # code with syntax highlighting in the LaTeX output.
1698 #
1699 # Note that which sources are shown also depends on other settings such as
1700 # SOURCE_BROWSER.
1701 # The default value is: NO.
1702 # This tag requires that the tag GENERATE_LATEX is set to YES.
1703
1704 LATEX_SOURCE_CODE      = NO
1705
1706 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1707 # bibliography, e.g. plainnat, or ieeetr. See
1708 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1709 # The default value is: plain.
1710 # This tag requires that the tag GENERATE_LATEX is set to YES.
1711
1712 LATEX_BIB_STYLE        = plain
1713
1714 #---------------------------------------------------------------------------
1715 # Configuration options related to the RTF output
1716 #---------------------------------------------------------------------------
1717
1718 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1719 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1720 # readers/editors.
1721 # The default value is: NO.
1722
1723 GENERATE_RTF           = NO
1724
1725 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1726 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1727 # it.
1728 # The default directory is: rtf.
1729 # This tag requires that the tag GENERATE_RTF is set to YES.
1730
1731 RTF_OUTPUT             = rtf
1732
1733 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1734 # documents. This may be useful for small projects and may help to save some
1735 # trees in general.
1736 # The default value is: NO.
1737 # This tag requires that the tag GENERATE_RTF is set to YES.
1738
1739 COMPACT_RTF            = NO
1740
1741 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1742 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1743 # output) instead of page references. This makes the output suitable for online
1744 # browsing using Word or some other Word compatible readers that support those
1745 # fields.
1746 #
1747 # Note: WordPad (write) and others do not support links.
1748 # The default value is: NO.
1749 # This tag requires that the tag GENERATE_RTF is set to YES.
1750
1751 RTF_HYPERLINKS         = NO
1752
1753 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1754 # file, i.e. a series of assignments. You only have to provide replacements,
1755 # missing definitions are set to their default value.
1756 #
1757 # See also section "Doxygen usage" for information on how to generate the
1758 # default style sheet that doxygen normally uses.
1759 # This tag requires that the tag GENERATE_RTF is set to YES.
1760
1761 RTF_STYLESHEET_FILE    = 
1762
1763 # Set optional variables used in the generation of an RTF document. Syntax is
1764 # similar to doxygen's config file. A template extensions file can be generated
1765 # using doxygen -e rtf extensionFile.
1766 # This tag requires that the tag GENERATE_RTF is set to YES.
1767
1768 RTF_EXTENSIONS_FILE    = 
1769
1770 #---------------------------------------------------------------------------
1771 # Configuration options related to the man page output
1772 #---------------------------------------------------------------------------
1773
1774 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1775 # classes and files.
1776 # The default value is: NO.
1777
1778 GENERATE_MAN           = NO
1779
1780 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1781 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1782 # it. A directory man3 will be created inside the directory specified by
1783 # MAN_OUTPUT.
1784 # The default directory is: man.
1785 # This tag requires that the tag GENERATE_MAN is set to YES.
1786
1787 MAN_OUTPUT             = man
1788
1789 # The MAN_EXTENSION tag determines the extension that is added to the generated
1790 # man pages. In case the manual section does not start with a number, the number
1791 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1792 # optional.
1793 # The default value is: .3.
1794 # This tag requires that the tag GENERATE_MAN is set to YES.
1795
1796 MAN_EXTENSION          = .3
1797
1798 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1799 # will generate one additional man file for each entity documented in the real
1800 # man page(s). These additional files only source the real man page, but without
1801 # them the man command would be unable to find the correct page.
1802 # The default value is: NO.
1803 # This tag requires that the tag GENERATE_MAN is set to YES.
1804
1805 MAN_LINKS              = NO
1806
1807 #---------------------------------------------------------------------------
1808 # Configuration options related to the XML output
1809 #---------------------------------------------------------------------------
1810
1811 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1812 # captures the structure of the code including all documentation.
1813 # The default value is: NO.
1814
1815 GENERATE_XML           = NO
1816
1817 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1818 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1819 # it.
1820 # The default directory is: xml.
1821 # This tag requires that the tag GENERATE_XML is set to YES.
1822
1823 XML_OUTPUT             = xml
1824
1825 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1826 # validating XML parser to check the syntax of the XML files.
1827 # This tag requires that the tag GENERATE_XML is set to YES.
1828
1829 XML_SCHEMA             = 
1830
1831 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1832 # validating XML parser to check the syntax of the XML files.
1833 # This tag requires that the tag GENERATE_XML is set to YES.
1834
1835 XML_DTD                = 
1836
1837 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1838 # listings (including syntax highlighting and cross-referencing information) to
1839 # the XML output. Note that enabling this will significantly increase the size
1840 # of the XML output.
1841 # The default value is: YES.
1842 # This tag requires that the tag GENERATE_XML is set to YES.
1843
1844 XML_PROGRAMLISTING     = YES
1845
1846 #---------------------------------------------------------------------------
1847 # Configuration options related to the DOCBOOK output
1848 #---------------------------------------------------------------------------
1849
1850 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1851 # that can be used to generate PDF.
1852 # The default value is: NO.
1853
1854 GENERATE_DOCBOOK       = NO
1855
1856 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1857 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1858 # front of it.
1859 # The default directory is: docbook.
1860 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1861
1862 DOCBOOK_OUTPUT         = docbook
1863
1864 #---------------------------------------------------------------------------
1865 # Configuration options for the AutoGen Definitions output
1866 #---------------------------------------------------------------------------
1867
1868 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1869 # Definitions (see http://autogen.sf.net) file that captures the structure of
1870 # the code including all documentation. Note that this feature is still
1871 # experimental and incomplete at the moment.
1872 # The default value is: NO.
1873
1874 GENERATE_AUTOGEN_DEF   = NO
1875
1876 #---------------------------------------------------------------------------
1877 # Configuration options related to the Perl module output
1878 #---------------------------------------------------------------------------
1879
1880 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1881 # file that captures the structure of the code including all documentation.
1882 #
1883 # Note that this feature is still experimental and incomplete at the moment.
1884 # The default value is: NO.
1885
1886 GENERATE_PERLMOD       = NO
1887
1888 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1889 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1890 # output from the Perl module output.
1891 # The default value is: NO.
1892 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1893
1894 PERLMOD_LATEX          = NO
1895
1896 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1897 # formatted so it can be parsed by a human reader. This is useful if you want to
1898 # understand what is going on. On the other hand, if this tag is set to NO the
1899 # size of the Perl module output will be much smaller and Perl will parse it
1900 # just the same.
1901 # The default value is: YES.
1902 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1903
1904 PERLMOD_PRETTY         = YES
1905
1906 # The names of the make variables in the generated doxyrules.make file are
1907 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1908 # so different doxyrules.make files included by the same Makefile don't
1909 # overwrite each other's variables.
1910 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1911
1912 PERLMOD_MAKEVAR_PREFIX = 
1913
1914 #---------------------------------------------------------------------------
1915 # Configuration options related to the preprocessor
1916 #---------------------------------------------------------------------------
1917
1918 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1919 # C-preprocessor directives found in the sources and include files.
1920 # The default value is: YES.
1921
1922 ENABLE_PREPROCESSING   = YES
1923
1924 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1925 # in the source code. If set to NO only conditional compilation will be
1926 # performed. Macro expansion can be done in a controlled way by setting
1927 # EXPAND_ONLY_PREDEF to YES.
1928 # The default value is: NO.
1929 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1930
1931 MACRO_EXPANSION        = NO
1932
1933 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1934 # the macro expansion is limited to the macros specified with the PREDEFINED and
1935 # EXPAND_AS_DEFINED tags.
1936 # The default value is: NO.
1937 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1938
1939 EXPAND_ONLY_PREDEF     = NO
1940
1941 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1942 # INCLUDE_PATH will be searched if a #include is found.
1943 # The default value is: YES.
1944 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1945
1946 SEARCH_INCLUDES        = YES
1947
1948 # The INCLUDE_PATH tag can be used to specify one or more directories that
1949 # contain include files that are not input files but should be processed by the
1950 # preprocessor.
1951 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1952
1953 INCLUDE_PATH           = 
1954
1955 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1956 # patterns (like *.h and *.hpp) to filter out the header-files in the
1957 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1958 # used.
1959 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1960
1961 INCLUDE_FILE_PATTERNS  = 
1962
1963 # The PREDEFINED tag can be used to specify one or more macro names that are
1964 # defined before the preprocessor is started (similar to the -D option of e.g.
1965 # gcc). The argument of the tag is a list of macros of the form: name or
1966 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1967 # is assumed. To prevent a macro definition from being undefined via #undef or
1968 # recursively expanded use the := operator instead of the = operator.
1969 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1970
1971 PREDEFINED             = DOXYGEN \
1972                          __L2C_PRESENT:=1 \
1973                          __CC_ARM:=1 \
1974                          __TARGET_FPU_VFP:=1 \
1975                          __CHECK_DEVICE_DEFINES:=1 \
1976                          __cplusplus:=1 \
1977                          __TI_ARM__:=1 \
1978                          __TASKING__:=1 \
1979                          __NO_EMBEDDED_ASM:=0 \
1980                          __CORTEX_A:=9 \
1981              __CA_REV:=0x0000 \
1982                          __TARGET_ARCH_7_A:=1
1983
1984 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1985 # tag can be used to specify a list of macro names that should be expanded. The
1986 # macro definition that is found in the sources will be used. Use the PREDEFINED
1987 # tag if you want to use a different macro definition that overrules the
1988 # definition found in the source code.
1989 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1990
1991 EXPAND_AS_DEFINED      = 
1992
1993 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1994 # remove all refrences to function-like macros that are alone on a line, have an
1995 # all uppercase name, and do not end with a semicolon. Such function macros are
1996 # typically used for boiler-plate code, and will confuse the parser if not
1997 # removed.
1998 # The default value is: YES.
1999 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2000
2001 SKIP_FUNCTION_MACROS   = YES
2002
2003 #---------------------------------------------------------------------------
2004 # Configuration options related to external references
2005 #---------------------------------------------------------------------------
2006
2007 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2008 # file the location of the external documentation should be added. The format of
2009 # a tag file without this location is as follows:
2010 # TAGFILES = file1 file2 ...
2011 # Adding location for the tag files is done as follows:
2012 # TAGFILES = file1=loc1 "file2 = loc2" ...
2013 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2014 # section "Linking to external documentation" for more information about the use
2015 # of tag files.
2016 # Note: Each tag file must have an unique name (where the name does NOT include
2017 # the path). If a tag file is not located in the directory in which doxygen is
2018 # run, you must also specify the path to the tagfile here.
2019
2020 TAGFILES               = 
2021
2022 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2023 # tag file that is based on the input files it reads. See section "Linking to
2024 # external documentation" for more information about the usage of tag files.
2025
2026 GENERATE_TAGFILE       = 
2027
2028 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2029 # class index. If set to NO only the inherited external classes will be listed.
2030 # The default value is: NO.
2031
2032 ALLEXTERNALS           = NO
2033
2034 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2035 # the modules index. If set to NO, only the current project's groups will be
2036 # listed.
2037 # The default value is: YES.
2038
2039 EXTERNAL_GROUPS        = YES
2040
2041 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2042 # the related pages index. If set to NO, only the current project's pages will
2043 # be listed.
2044 # The default value is: YES.
2045
2046 EXTERNAL_PAGES         = YES
2047
2048 # The PERL_PATH should be the absolute path and name of the perl script
2049 # interpreter (i.e. the result of 'which perl').
2050 # The default file (with absolute path) is: /usr/bin/perl.
2051
2052 PERL_PATH              = /usr/bin/perl
2053
2054 #---------------------------------------------------------------------------
2055 # Configuration options related to the dot tool
2056 #---------------------------------------------------------------------------
2057
2058 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2059 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2060 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2061 # disabled, but it is recommended to install and use dot, since it yields more
2062 # powerful graphs.
2063 # The default value is: YES.
2064
2065 CLASS_DIAGRAMS         = YES
2066
2067 # You can define message sequence charts within doxygen comments using the \msc
2068 # command. Doxygen will then run the mscgen tool (see:
2069 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2070 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2071 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2072 # default search path.
2073
2074 MSCGEN_PATH            = 
2075
2076 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2077 # then run dia to produce the diagram and insert it in the documentation. The
2078 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2079 # If left empty dia is assumed to be found in the default search path.
2080
2081 DIA_PATH               = 
2082
2083 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2084 # and usage relations if the target is undocumented or is not a class.
2085 # The default value is: YES.
2086
2087 HIDE_UNDOC_RELATIONS   = YES
2088
2089 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2090 # available from the path. This tool is part of Graphviz (see:
2091 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2092 # Bell Labs. The other options in this section have no effect if this option is
2093 # set to NO
2094 # The default value is: NO.
2095
2096 HAVE_DOT               = NO
2097
2098 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2099 # to run in parallel. When set to 0 doxygen will base this on the number of
2100 # processors available in the system. You can set it explicitly to a value
2101 # larger than 0 to get control over the balance between CPU load and processing
2102 # speed.
2103 # Minimum value: 0, maximum value: 32, default value: 0.
2104 # This tag requires that the tag HAVE_DOT is set to YES.
2105
2106 DOT_NUM_THREADS        = 0
2107
2108 # When you want a differently looking font n the dot files that doxygen
2109 # generates you can specify the font name using DOT_FONTNAME. You need to make
2110 # sure dot is able to find the font, which can be done by putting it in a
2111 # standard location or by setting the DOTFONTPATH environment variable or by
2112 # setting DOT_FONTPATH to the directory containing the font.
2113 # The default value is: Helvetica.
2114 # This tag requires that the tag HAVE_DOT is set to YES.
2115
2116 DOT_FONTNAME           = Helvetica
2117
2118 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2119 # dot graphs.
2120 # Minimum value: 4, maximum value: 24, default value: 10.
2121 # This tag requires that the tag HAVE_DOT is set to YES.
2122
2123 DOT_FONTSIZE           = 10
2124
2125 # By default doxygen will tell dot to use the default font as specified with
2126 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2127 # the path where dot can find it using this tag.
2128 # This tag requires that the tag HAVE_DOT is set to YES.
2129
2130 DOT_FONTPATH           = 
2131
2132 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2133 # each documented class showing the direct and indirect inheritance relations.
2134 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2135 # The default value is: YES.
2136 # This tag requires that the tag HAVE_DOT is set to YES.
2137
2138 CLASS_GRAPH            = YES
2139
2140 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2141 # graph for each documented class showing the direct and indirect implementation
2142 # dependencies (inheritance, containment, and class references variables) of the
2143 # class with other documented classes.
2144 # The default value is: YES.
2145 # This tag requires that the tag HAVE_DOT is set to YES.
2146
2147 COLLABORATION_GRAPH    = YES
2148
2149 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2150 # groups, showing the direct groups dependencies.
2151 # The default value is: YES.
2152 # This tag requires that the tag HAVE_DOT is set to YES.
2153
2154 GROUP_GRAPHS           = YES
2155
2156 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2157 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2158 # Language.
2159 # The default value is: NO.
2160 # This tag requires that the tag HAVE_DOT is set to YES.
2161
2162 UML_LOOK               = NO
2163
2164 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2165 # class node. If there are many fields or methods and many nodes the graph may
2166 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2167 # number of items for each type to make the size more manageable. Set this to 0
2168 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2169 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2170 # but if the number exceeds 15, the total amount of fields shown is limited to
2171 # 10.
2172 # Minimum value: 0, maximum value: 100, default value: 10.
2173 # This tag requires that the tag HAVE_DOT is set to YES.
2174
2175 UML_LIMIT_NUM_FIELDS   = 10
2176
2177 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2178 # collaboration graphs will show the relations between templates and their
2179 # instances.
2180 # The default value is: NO.
2181 # This tag requires that the tag HAVE_DOT is set to YES.
2182
2183 TEMPLATE_RELATIONS     = NO
2184
2185 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2186 # YES then doxygen will generate a graph for each documented file showing the
2187 # direct and indirect include dependencies of the file with other documented
2188 # files.
2189 # The default value is: YES.
2190 # This tag requires that the tag HAVE_DOT is set to YES.
2191
2192 INCLUDE_GRAPH          = YES
2193
2194 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2195 # set to YES then doxygen will generate a graph for each documented file showing
2196 # the direct and indirect include dependencies of the file with other documented
2197 # files.
2198 # The default value is: YES.
2199 # This tag requires that the tag HAVE_DOT is set to YES.
2200
2201 INCLUDED_BY_GRAPH      = YES
2202
2203 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2204 # dependency graph for every global function or class method.
2205 #
2206 # Note that enabling this option will significantly increase the time of a run.
2207 # So in most cases it will be better to enable call graphs for selected
2208 # functions only using the \callgraph command.
2209 # The default value is: NO.
2210 # This tag requires that the tag HAVE_DOT is set to YES.
2211
2212 CALL_GRAPH             = NO
2213
2214 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2215 # dependency graph for every global function or class method.
2216 #
2217 # Note that enabling this option will significantly increase the time of a run.
2218 # So in most cases it will be better to enable caller graphs for selected
2219 # functions only using the \callergraph command.
2220 # The default value is: NO.
2221 # This tag requires that the tag HAVE_DOT is set to YES.
2222
2223 CALLER_GRAPH           = NO
2224
2225 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2226 # hierarchy of all classes instead of a textual one.
2227 # The default value is: YES.
2228 # This tag requires that the tag HAVE_DOT is set to YES.
2229
2230 GRAPHICAL_HIERARCHY    = YES
2231
2232 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2233 # dependencies a directory has on other directories in a graphical way. The
2234 # dependency relations are determined by the #include relations between the
2235 # files in the directories.
2236 # The default value is: YES.
2237 # This tag requires that the tag HAVE_DOT is set to YES.
2238
2239 DIRECTORY_GRAPH        = YES
2240
2241 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2242 # generated by dot.
2243 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2244 # to make the SVG files visible in IE 9+ (other browsers do not have this
2245 # requirement).
2246 # Possible values are: png, jpg, gif and svg.
2247 # The default value is: png.
2248 # This tag requires that the tag HAVE_DOT is set to YES.
2249
2250 DOT_IMAGE_FORMAT       = png
2251
2252 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2253 # enable generation of interactive SVG images that allow zooming and panning.
2254 #
2255 # Note that this requires a modern browser other than Internet Explorer. Tested
2256 # and working are Firefox, Chrome, Safari, and Opera.
2257 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2258 # the SVG files visible. Older versions of IE do not have SVG support.
2259 # The default value is: NO.
2260 # This tag requires that the tag HAVE_DOT is set to YES.
2261
2262 INTERACTIVE_SVG        = NO
2263
2264 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2265 # found. If left blank, it is assumed the dot tool can be found in the path.
2266 # This tag requires that the tag HAVE_DOT is set to YES.
2267
2268 DOT_PATH               = 
2269
2270 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2271 # contain dot files that are included in the documentation (see the \dotfile
2272 # command).
2273 # This tag requires that the tag HAVE_DOT is set to YES.
2274
2275 DOTFILE_DIRS           = 
2276
2277 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2278 # contain msc files that are included in the documentation (see the \mscfile
2279 # command).
2280
2281 MSCFILE_DIRS           = 
2282
2283 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2284 # contain dia files that are included in the documentation (see the \diafile
2285 # command).
2286
2287 DIAFILE_DIRS           = 
2288
2289 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2290 # that will be shown in the graph. If the number of nodes in a graph becomes
2291 # larger than this value, doxygen will truncate the graph, which is visualized
2292 # by representing a node as a red box. Note that doxygen if the number of direct
2293 # children of the root node in a graph is already larger than
2294 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2295 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2296 # Minimum value: 0, maximum value: 10000, default value: 50.
2297 # This tag requires that the tag HAVE_DOT is set to YES.
2298
2299 DOT_GRAPH_MAX_NODES    = 50
2300
2301 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2302 # generated by dot. A depth value of 3 means that only nodes reachable from the
2303 # root by following a path via at most 3 edges will be shown. Nodes that lay
2304 # further from the root node will be omitted. Note that setting this option to 1
2305 # or 2 may greatly reduce the computation time needed for large code bases. Also
2306 # note that the size of a graph can be further restricted by
2307 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2308 # Minimum value: 0, maximum value: 1000, default value: 0.
2309 # This tag requires that the tag HAVE_DOT is set to YES.
2310
2311 MAX_DOT_GRAPH_DEPTH    = 0
2312
2313 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2314 # background. This is disabled by default, because dot on Windows does not seem
2315 # to support this out of the box.
2316 #
2317 # Warning: Depending on the platform used, enabling this option may lead to
2318 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2319 # read).
2320 # The default value is: NO.
2321 # This tag requires that the tag HAVE_DOT is set to YES.
2322
2323 DOT_TRANSPARENT        = NO
2324
2325 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2326 # files in one run (i.e. multiple -o and -T options on the command line). This
2327 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2328 # this, this feature is disabled by default.
2329 # The default value is: NO.
2330 # This tag requires that the tag HAVE_DOT is set to YES.
2331
2332 DOT_MULTI_TARGETS      = NO
2333
2334 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2335 # explaining the meaning of the various boxes and arrows in the dot generated
2336 # graphs.
2337 # The default value is: YES.
2338 # This tag requires that the tag HAVE_DOT is set to YES.
2339
2340 GENERATE_LEGEND        = YES
2341
2342 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2343 # files that are used to generate the various graphs.
2344 # The default value is: YES.
2345 # This tag requires that the tag HAVE_DOT is set to YES.
2346
2347 DOT_CLEANUP            = YES