3 # This file describes the settings to be used by the documentation system
\r
4 # doxygen (www.doxygen.org) for a project
\r
6 # All text after a hash (#) is considered a comment and will be ignored
\r
8 # TAG = value [value, ...]
\r
9 # For lists items can also be appended using:
\r
10 # TAG += value [value, ...]
\r
11 # Values that contain spaces should be placed between quotes (" ")
\r
13 #---------------------------------------------------------------------------
\r
14 # Project related configuration options
\r
15 #---------------------------------------------------------------------------
\r
17 # This tag specifies the encoding used for all characters in the config file
\r
18 # that follow. The default is UTF-8 which is also the encoding used for all
\r
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
\r
20 # iconv built into libc) for the transcoding. See
\r
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
\r
23 DOXYFILE_ENCODING = UTF-8
\r
25 # The PROJECT_NAME tag is a single word (or sequence of words) that should
\r
26 # identify the project. Note that if you do not use Doxywizard you need
\r
27 # to put quotes around the project name if it contains spaces.
\r
29 PROJECT_NAME = LPCUSBlib
\r
31 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
\r
32 # This could be handy for archiving the generated documentation or
\r
33 # if some version control system is used.
\r
35 PROJECT_NUMBER = v0.95
\r
37 # Using the PROJECT_BRIEF tag one can provide an optional one line description
\r
38 # for a project that appears at the top of each page and should give viewer
\r
39 # a quick idea about the purpose of the project. Keep the description short.
\r
41 PROJECT_BRIEF = "A USB software library for NXP Cortex microcontrollers"
\r
43 # With the PROJECT_LOGO tag one can specify an logo or icon that is
\r
44 # included in the documentation. The maximum height of the logo should not
\r
45 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
\r
46 # Doxygen will copy the logo to the output directory.
\r
48 PROJECT_LOGO = "C:/Projects/LPCware.com/LPCUSBlib v0.93/UsersManual/LPCUSBlib_thumb_small.png"
\r
50 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
\r
51 # base path where the generated documentation will be put.
\r
52 # If a relative path is entered, it will be relative to the location
\r
53 # where doxygen was started. If left blank the current directory will be used.
\r
55 OUTPUT_DIRECTORY = ./Documentation/
\r
57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
\r
58 # 4096 sub-directories (in 2 levels) under the output directory of each output
\r
59 # format and will distribute the generated files over these directories.
\r
60 # Enabling this option can be useful when feeding doxygen a huge amount of
\r
61 # source files, where putting all generated files in the same directory would
\r
62 # otherwise cause performance problems for the file system.
\r
66 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
\r
67 # documentation generated by doxygen is written. Doxygen will use this
\r
68 # information to generate all constant output in the proper language.
\r
69 # The default language is English, other supported languages are:
\r
70 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
\r
71 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
\r
72 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
\r
73 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
\r
74 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
\r
75 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
\r
77 OUTPUT_LANGUAGE = English
\r
79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
\r
80 # include brief member descriptions after the members that are listed in
\r
81 # the file and class documentation (similar to JavaDoc).
\r
82 # Set to NO to disable this.
\r
84 BRIEF_MEMBER_DESC = YES
\r
86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
\r
87 # the brief description of a member or function before the detailed description.
\r
88 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
\r
89 # brief descriptions will be completely suppressed.
\r
93 # This tag implements a quasi-intelligent brief description abbreviator
\r
94 # that is used to form the text in various listings. Each string
\r
95 # in this list, if found as the leading text of the brief description, will be
\r
96 # stripped from the text and the result after processing the whole list, is
\r
97 # used as the annotated text. Otherwise, the brief description is used as-is.
\r
98 # If left blank, the following values are used ("$name" is automatically
\r
99 # replaced with the name of the entity): "The $name class" "The $name widget"
\r
100 # "The $name file" "is" "provides" "specifies" "contains"
\r
101 # "represents" "a" "an" "the"
\r
103 ABBREVIATE_BRIEF = "The $name class" \
\r
104 "The $name widget" \
\r
115 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
\r
116 # Doxygen will generate a detailed section even if there is only a brief
\r
119 ALWAYS_DETAILED_SEC = NO
\r
121 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
\r
122 # inherited members of a class in the documentation of that class as if those
\r
123 # members were ordinary class members. Constructors, destructors and assignment
\r
124 # operators of the base classes will not be shown.
\r
126 INLINE_INHERITED_MEMB = NO
\r
128 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
\r
129 # path before files name in the file list and in the header files. If set
\r
130 # to NO the shortest path that makes the file name unique will be used.
\r
132 FULL_PATH_NAMES = YES
\r
134 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
\r
135 # can be used to strip a user-defined part of the path. Stripping is
\r
136 # only done if one of the specified strings matches the left-hand part of
\r
137 # the path. The tag can be used to show relative paths in the file list.
\r
138 # If left blank the directory from which doxygen is run is used as the
\r
141 STRIP_FROM_PATH = C:\Projects\LPCware.com
\r
143 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
\r
144 # the path mentioned in the documentation of a class, which tells
\r
145 # the reader which header file to include in order to use a class.
\r
146 # If left blank only the name of the header file containing the class
\r
147 # definition is used. Otherwise one should specify the include paths that
\r
148 # are normally passed to the compiler using the -I flag.
\r
150 STRIP_FROM_INC_PATH = C:\Projects\LPCware.com
\r
152 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
\r
153 # (but less readable) file names. This can be useful if your file system
\r
154 # doesn't support long names like on DOS, Mac, or CD-ROM.
\r
158 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
\r
159 # will interpret the first line (until the first dot) of a JavaDoc-style
\r
160 # comment as the brief description. If set to NO, the JavaDoc
\r
161 # comments will behave just like regular Qt-style comments
\r
162 # (thus requiring an explicit @brief command for a brief description.)
\r
164 JAVADOC_AUTOBRIEF = NO
\r
166 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
\r
167 # interpret the first line (until the first dot) of a Qt-style
\r
168 # comment as the brief description. If set to NO, the comments
\r
169 # will behave just like regular Qt-style comments (thus requiring
\r
170 # an explicit \brief command for a brief description.)
\r
174 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
\r
175 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
\r
176 # comments) as a brief description. This used to be the default behaviour.
\r
177 # The new default is to treat a multi-line C++ comment block as a detailed
\r
178 # description. Set this tag to YES if you prefer the old behaviour instead.
\r
180 MULTILINE_CPP_IS_BRIEF = NO
\r
182 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
\r
183 # member inherits the documentation from any documented member that it
\r
188 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
\r
189 # a new page for each member. If set to NO, the documentation of a member will
\r
190 # be part of the file/class/namespace that contains it.
\r
192 SEPARATE_MEMBER_PAGES = NO
\r
194 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
\r
195 # Doxygen uses this value to replace tabs by spaces in code fragments.
\r
199 # This tag can be used to specify a number of aliases that acts
\r
200 # as commands in the documentation. An alias has the form "name=value".
\r
201 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
\r
202 # put the command \sideeffect (or @sideeffect) in the documentation, which
\r
203 # will result in a user-defined paragraph with heading "Side Effects:".
\r
204 # You can put \n's in the value part of an alias to insert newlines.
\r
208 # This tag can be used to specify a number of word-keyword mappings (TCL only).
\r
209 # A mapping has the form "name=value". For example adding
\r
210 # "class=itcl::class" will allow you to use the command class in the
\r
211 # itcl::class meaning.
\r
215 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
\r
216 # sources only. Doxygen will then generate output that is more tailored for C.
\r
217 # For instance, some of the names that are used will be different. The list
\r
218 # of all members will be omitted, etc.
\r
220 OPTIMIZE_OUTPUT_FOR_C = YES
\r
222 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
\r
223 # sources only. Doxygen will then generate output that is more tailored for
\r
224 # Java. For instance, namespaces will be presented as packages, qualified
\r
225 # scopes will look different, etc.
\r
227 OPTIMIZE_OUTPUT_JAVA = NO
\r
229 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
\r
230 # sources only. Doxygen will then generate output that is more tailored for
\r
233 OPTIMIZE_FOR_FORTRAN = NO
\r
235 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
\r
236 # sources. Doxygen will then generate output that is tailored for
\r
239 OPTIMIZE_OUTPUT_VHDL = NO
\r
241 # Doxygen selects the parser to use depending on the extension of the files it
\r
242 # parses. With this tag you can assign which parser to use for a given extension.
\r
243 # Doxygen has a built-in mapping, but you can override or extend it using this
\r
244 # tag. The format is ext=language, where ext is a file extension, and language
\r
245 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
\r
246 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
\r
247 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
\r
248 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
\r
249 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
\r
251 EXTENSION_MAPPING =
\r
253 # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
\r
254 # comments according to the Markdown format, which allows for more readable
\r
255 # documentation. See http://daringfireball.net/projects/markdown/ for details.
\r
256 # The output of markdown processing is further processed by doxygen, so you
\r
257 # can mix doxygen, HTML, and XML commands with Markdown formatting.
\r
258 # Disable only in case of backward compatibilities issues.
\r
260 MARKDOWN_SUPPORT = YES
\r
262 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
\r
263 # to include (a tag file for) the STL sources as input, then you should
\r
264 # set this tag to YES in order to let doxygen match functions declarations and
\r
265 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
\r
266 # func(std::string) {}). This also makes the inheritance and collaboration
\r
267 # diagrams that involve STL classes more complete and accurate.
\r
269 BUILTIN_STL_SUPPORT = NO
\r
271 # If you use Microsoft's C++/CLI language, you should set this option to YES to
\r
272 # enable parsing support.
\r
274 CPP_CLI_SUPPORT = NO
\r
276 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
\r
277 # Doxygen will parse them like normal C++ but will assume all classes use public
\r
278 # instead of private inheritance when no explicit protection keyword is present.
\r
282 # For Microsoft's IDL there are propget and propput attributes to indicate getter
\r
283 # and setter methods for a property. Setting this option to YES (the default)
\r
284 # will make doxygen replace the get and set methods by a property in the
\r
285 # documentation. This will only work if the methods are indeed getting or
\r
286 # setting a simple type. If this is not the case, or you want to show the
\r
287 # methods anyway, you should set this option to NO.
\r
289 IDL_PROPERTY_SUPPORT = YES
\r
291 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
\r
292 # tag is set to YES, then doxygen will reuse the documentation of the first
\r
293 # member in the group (if any) for the other members of the group. By default
\r
294 # all members of a group must be documented explicitly.
\r
296 DISTRIBUTE_GROUP_DOC = NO
\r
298 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
\r
299 # the same type (for instance a group of public functions) to be put as a
\r
300 # subgroup of that type (e.g. under the Public Functions section). Set it to
\r
301 # NO to prevent subgrouping. Alternatively, this can be done per class using
\r
302 # the \nosubgrouping command.
\r
306 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
\r
307 # unions are shown inside the group in which they are included (e.g. using
\r
308 # @ingroup) instead of on a separate page (for HTML and Man pages) or
\r
309 # section (for LaTeX and RTF).
\r
311 INLINE_GROUPED_CLASSES = NO
\r
313 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
\r
314 # unions with only public data fields will be shown inline in the documentation
\r
315 # of the scope in which they are defined (i.e. file, namespace, or group
\r
316 # documentation), provided this scope is documented. If set to NO (the default),
\r
317 # structs, classes, and unions are shown on a separate page (for HTML and Man
\r
318 # pages) or section (for LaTeX and RTF).
\r
320 INLINE_SIMPLE_STRUCTS = NO
\r
322 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
\r
323 # is documented as struct, union, or enum with the name of the typedef. So
\r
324 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
\r
325 # with name TypeT. When disabled the typedef will appear as a member of a file,
\r
326 # namespace, or class. And the struct will be named TypeS. This can typically
\r
327 # be useful for C code in case the coding convention dictates that all compound
\r
328 # types are typedef'ed and only the typedef is referenced, never the tag name.
\r
330 TYPEDEF_HIDES_STRUCT = YES
\r
332 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
\r
333 # determine which symbols to keep in memory and which to flush to disk.
\r
334 # When the cache is full, less often used symbols will be written to disk.
\r
335 # For small to medium size projects (<1000 input files) the default value is
\r
336 # probably good enough. For larger projects a too small cache size can cause
\r
337 # doxygen to be busy swapping symbols to and from disk most of the time
\r
338 # causing a significant performance penalty.
\r
339 # If the system has enough physical memory increasing the cache will improve the
\r
340 # performance by keeping more symbols in memory. Note that the value works on
\r
341 # a logarithmic scale so increasing the size by one will roughly double the
\r
342 # memory usage. The cache size is given by this formula:
\r
343 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
\r
344 # corresponding to a cache size of 2^16 = 65536 symbols.
\r
346 SYMBOL_CACHE_SIZE = 1
\r
348 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
\r
349 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
\r
350 # their name and scope. Since this can be an expensive process and often the
\r
351 # same symbol appear multiple times in the code, doxygen keeps a cache of
\r
352 # pre-resolved symbols. If the cache is too small doxygen will become slower.
\r
353 # If the cache is too large, memory is wasted. The cache size is given by this
\r
354 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
\r
355 # corresponding to a cache size of 2^16 = 65536 symbols.
\r
357 LOOKUP_CACHE_SIZE = 0
\r
359 #---------------------------------------------------------------------------
\r
360 # Build related configuration options
\r
361 #---------------------------------------------------------------------------
\r
363 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
\r
364 # documentation are documented, even if no documentation was available.
\r
365 # Private class members and static file members will be hidden unless
\r
366 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
\r
370 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
\r
371 # will be included in the documentation.
\r
373 EXTRACT_PRIVATE = YES
\r
375 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
\r
376 # scope will be included in the documentation.
\r
378 EXTRACT_PACKAGE = NO
\r
380 # If the EXTRACT_STATIC tag is set to YES all static members of a file
\r
381 # will be included in the documentation.
\r
383 EXTRACT_STATIC = YES
\r
385 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
\r
386 # defined locally in source files will be included in the documentation.
\r
387 # If set to NO only classes defined in header files are included.
\r
389 EXTRACT_LOCAL_CLASSES = YES
\r
391 # This flag is only useful for Objective-C code. When set to YES local
\r
392 # methods, which are defined in the implementation section but not in
\r
393 # the interface are included in the documentation.
\r
394 # If set to NO (the default) only methods in the interface are included.
\r
396 EXTRACT_LOCAL_METHODS = NO
\r
398 # If this flag is set to YES, the members of anonymous namespaces will be
\r
399 # extracted and appear in the documentation as a namespace called
\r
400 # 'anonymous_namespace{file}', where file will be replaced with the base
\r
401 # name of the file that contains the anonymous namespace. By default
\r
402 # anonymous namespaces are hidden.
\r
404 EXTRACT_ANON_NSPACES = NO
\r
406 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
\r
407 # undocumented members of documented classes, files or namespaces.
\r
408 # If set to NO (the default) these members will be included in the
\r
409 # various overviews, but no documentation section is generated.
\r
410 # This option has no effect if EXTRACT_ALL is enabled.
\r
412 HIDE_UNDOC_MEMBERS = NO
\r
414 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
\r
415 # undocumented classes that are normally visible in the class hierarchy.
\r
416 # If set to NO (the default) these classes will be included in the various
\r
417 # overviews. This option has no effect if EXTRACT_ALL is enabled.
\r
419 HIDE_UNDOC_CLASSES = NO
\r
421 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
\r
422 # friend (class|struct|union) declarations.
\r
423 # If set to NO (the default) these declarations will be included in the
\r
426 HIDE_FRIEND_COMPOUNDS = NO
\r
428 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
\r
429 # documentation blocks found inside the body of a function.
\r
430 # If set to NO (the default) these blocks will be appended to the
\r
431 # function's detailed documentation block.
\r
433 HIDE_IN_BODY_DOCS = NO
\r
435 # The INTERNAL_DOCS tag determines if documentation
\r
436 # that is typed after a \internal command is included. If the tag is set
\r
437 # to NO (the default) then the documentation will be excluded.
\r
438 # Set it to YES to include the internal documentation.
\r
442 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
\r
443 # file names in lower-case letters. If set to YES upper-case letters are also
\r
444 # allowed. This is useful if you have classes or files whose names only differ
\r
445 # in case and if your file system supports case sensitive file names. Windows
\r
446 # and Mac users are advised to set this option to NO.
\r
448 CASE_SENSE_NAMES = NO
\r
450 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
\r
451 # will show members with their full class and namespace scopes in the
\r
452 # documentation. If set to YES the scope will be hidden.
\r
454 HIDE_SCOPE_NAMES = NO
\r
456 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
\r
457 # will put a list of the files that are included by a file in the documentation
\r
460 SHOW_INCLUDE_FILES = YES
\r
462 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
\r
463 # will list include files with double quotes in the documentation
\r
464 # rather than with sharp brackets.
\r
466 FORCE_LOCAL_INCLUDES = NO
\r
468 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
\r
469 # is inserted in the documentation for inline members.
\r
473 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
\r
474 # will sort the (detailed) documentation of file and class members
\r
475 # alphabetically by member name. If set to NO the members will appear in
\r
476 # declaration order.
\r
478 SORT_MEMBER_DOCS = YES
\r
480 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
\r
481 # brief documentation of file, namespace and class members alphabetically
\r
482 # by member name. If set to NO (the default) the members will appear in
\r
483 # declaration order.
\r
485 SORT_BRIEF_DOCS = NO
\r
487 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
\r
488 # will sort the (brief and detailed) documentation of class members so that
\r
489 # constructors and destructors are listed first. If set to NO (the default)
\r
490 # the constructors will appear in the respective orders defined by
\r
491 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
\r
492 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
\r
493 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
\r
495 SORT_MEMBERS_CTORS_1ST = NO
\r
497 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
\r
498 # hierarchy of group names into alphabetical order. If set to NO (the default)
\r
499 # the group names will appear in their defined order.
\r
501 SORT_GROUP_NAMES = YES
\r
503 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
\r
504 # sorted by fully-qualified names, including namespaces. If set to
\r
505 # NO (the default), the class list will be sorted only by class name,
\r
506 # not including the namespace part.
\r
507 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
\r
508 # Note: This option applies only to the class list, not to the
\r
509 # alphabetical list.
\r
511 SORT_BY_SCOPE_NAME = NO
\r
513 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
\r
514 # do proper type resolution of all parameters of a function it will reject a
\r
515 # match between the prototype and the implementation of a member function even
\r
516 # if there is only one candidate or it is obvious which candidate to choose
\r
517 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
\r
518 # will still accept a match between prototype and implementation in such cases.
\r
520 STRICT_PROTO_MATCHING = NO
\r
522 # The GENERATE_TODOLIST tag can be used to enable (YES) or
\r
523 # disable (NO) the todo list. This list is created by putting \todo
\r
524 # commands in the documentation.
\r
526 GENERATE_TODOLIST = NO
\r
528 # The GENERATE_TESTLIST tag can be used to enable (YES) or
\r
529 # disable (NO) the test list. This list is created by putting \test
\r
530 # commands in the documentation.
\r
532 GENERATE_TESTLIST = NO
\r
534 # The GENERATE_BUGLIST tag can be used to enable (YES) or
\r
535 # disable (NO) the bug list. This list is created by putting \bug
\r
536 # commands in the documentation.
\r
538 GENERATE_BUGLIST = NO
\r
540 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
\r
541 # disable (NO) the deprecated list. This list is created by putting
\r
542 # \deprecated commands in the documentation.
\r
544 GENERATE_DEPRECATEDLIST= YES
\r
546 # The ENABLED_SECTIONS tag can be used to enable conditional
\r
547 # documentation sections, marked by \if sectionname ... \endif.
\r
549 ENABLED_SECTIONS =
\r
551 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
\r
552 # the initial value of a variable or macro consists of for it to appear in
\r
553 # the documentation. If the initializer consists of more lines than specified
\r
554 # here it will be hidden. Use a value of 0 to hide initializers completely.
\r
555 # The appearance of the initializer of individual variables and macros in the
\r
556 # documentation can be controlled using \showinitializer or \hideinitializer
\r
557 # command in the documentation regardless of this setting.
\r
559 MAX_INITIALIZER_LINES = 15
\r
561 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
\r
562 # at the bottom of the documentation of classes and structs. If set to YES the
\r
563 # list will mention the files that were used to generate the documentation.
\r
565 SHOW_USED_FILES = YES
\r
567 # If the sources in your project are distributed over multiple directories
\r
568 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
\r
569 # in the documentation. The default is NO.
\r
571 SHOW_DIRECTORIES = YES
\r
573 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
\r
574 # This will remove the Files entry from the Quick Index and from the
\r
575 # Folder Tree View (if specified). The default is YES.
\r
579 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
\r
580 # Namespaces page. This will remove the Namespaces entry from the Quick Index
\r
581 # and from the Folder Tree View (if specified). The default is YES.
\r
583 SHOW_NAMESPACES = YES
\r
585 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
\r
586 # doxygen should invoke to get the current version for each file (typically from
\r
587 # the version control system). Doxygen will invoke the program by executing (via
\r
588 # popen()) the command <command> <input-file>, where <command> is the value of
\r
589 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
\r
590 # provided by doxygen. Whatever the program writes to standard output
\r
591 # is used as the file version. See the manual for examples.
\r
593 FILE_VERSION_FILTER =
\r
595 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
\r
596 # by doxygen. The layout file controls the global structure of the generated
\r
597 # output files in an output format independent way. The create the layout file
\r
598 # that represents doxygen's defaults, run doxygen with the -l option.
\r
599 # You can optionally specify a file name after the option, if omitted
\r
600 # DoxygenLayout.xml will be used as the name of the layout file.
\r
604 # The CITE_BIB_FILES tag can be used to specify one or more bib files
\r
605 # containing the references data. This must be a list of .bib files. The
\r
606 # .bib extension is automatically appended if omitted. Using this command
\r
607 # requires the bibtex tool to be installed. See also
\r
608 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
\r
609 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
\r
610 # feature you need bibtex and perl available in the search path.
\r
614 #---------------------------------------------------------------------------
\r
615 # configuration options related to warning and progress messages
\r
616 #---------------------------------------------------------------------------
\r
618 # The QUIET tag can be used to turn on/off the messages that are generated
\r
619 # by doxygen. Possible values are YES and NO. If left blank NO is used.
\r
623 # The WARNINGS tag can be used to turn on/off the warning messages that are
\r
624 # generated by doxygen. Possible values are YES and NO. If left blank
\r
629 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
\r
630 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
\r
631 # automatically be disabled.
\r
633 WARN_IF_UNDOCUMENTED = YES
\r
635 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
\r
636 # potential errors in the documentation, such as not documenting some
\r
637 # parameters in a documented function, or documenting parameters that
\r
638 # don't exist or using markup commands wrongly.
\r
640 WARN_IF_DOC_ERROR = YES
\r
642 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
\r
643 # functions that are documented, but have no documentation for their parameters
\r
644 # or return value. If set to NO (the default) doxygen will only warn about
\r
645 # wrong or incomplete parameter documentation, but not about the absence of
\r
648 WARN_NO_PARAMDOC = YES
\r
650 # The WARN_FORMAT tag determines the format of the warning messages that
\r
651 # doxygen can produce. The string should contain the $file, $line, and $text
\r
652 # tags, which will be replaced by the file and line number from which the
\r
653 # warning originated and the warning text. Optionally the format may contain
\r
654 # $version, which will be replaced by the version of the file (if it could
\r
655 # be obtained via FILE_VERSION_FILTER)
\r
657 WARN_FORMAT = "$file:$line: $text"
\r
659 # The WARN_LOGFILE tag can be used to specify a file to which warning
\r
660 # and error messages should be written. If left blank the output is written
\r
665 #---------------------------------------------------------------------------
\r
666 # configuration options related to the input files
\r
667 #---------------------------------------------------------------------------
\r
669 # The INPUT tag can be used to specify the files and/or directories that contain
\r
670 # documented source files. You may enter file names like "myfile.cpp" or
\r
671 # directories like "/usr/src/myproject". Separate the files or directories
\r
676 ..\libraries\LPCUSBlib \
\r
680 # This tag can be used to specify the character encoding of the source files
\r
681 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
\r
682 # also the default input encoding. Doxygen uses libiconv (or the iconv built
\r
683 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
\r
684 # the list of possible encodings.
\r
686 INPUT_ENCODING = UTF-8
\r
688 # If the value of the INPUT tag contains directories, you can use the
\r
689 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
\r
690 # and *.h) to filter out the source-files in the directories. If left
\r
691 # blank the following patterns are tested:
\r
692 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
\r
693 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
\r
694 # *.f90 *.f *.for *.vhd *.vhdl
\r
696 FILE_PATTERNS = *.h \
\r
701 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
\r
702 # should be searched for input files as well. Possible values are YES and NO.
\r
703 # If left blank NO is used.
\r
707 # The EXCLUDE tag can be used to specify files and/or directories that should be
\r
708 # excluded from the INPUT source files. This way you can easily exclude a
\r
709 # subdirectory from a directory tree whose root is specified with the INPUT tag.
\r
710 # Note that relative paths are relative to the directory from which doxygen is
\r
713 EXCLUDE = Documentation/ \
\r
716 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
\r
717 # directories that are symbolic links (a Unix file system feature) are excluded
\r
720 EXCLUDE_SYMLINKS = NO
\r
722 # If the value of the INPUT tag contains directories, you can use the
\r
723 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
\r
724 # certain files from those directories. Note that the wildcards are matched
\r
725 # against the file with absolute path, so to exclude all test directories
\r
726 # for example use the pattern */test/*
\r
728 EXCLUDE_PATTERNS =
\r
730 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
\r
731 # (namespaces, classes, functions, etc.) that should be excluded from the
\r
732 # output. The symbol name can be a fully qualified name, a word, or if the
\r
733 # wildcard * is used, a substring. Examples: ANamespace, AClass,
\r
734 # AClass::ANamespace, ANamespace::*Test
\r
736 EXCLUDE_SYMBOLS = _* \
\r
739 # The EXAMPLE_PATH tag can be used to specify one or more files or
\r
740 # directories that contain example code fragments that are included (see
\r
741 # the \include command).
\r
745 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
\r
746 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
\r
747 # and *.h) to filter out the source-files in the directories. If left
\r
748 # blank all files are included.
\r
750 EXAMPLE_PATTERNS = *
\r
752 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
\r
753 # searched for input files to be used with the \include or \dontinclude
\r
754 # commands irrespective of the value of the RECURSIVE tag.
\r
755 # Possible values are YES and NO. If left blank NO is used.
\r
757 EXAMPLE_RECURSIVE = NO
\r
759 # The IMAGE_PATH tag can be used to specify one or more files or
\r
760 # directories that contain image that are included in the documentation (see
\r
761 # the \image command).
\r
765 # The INPUT_FILTER tag can be used to specify a program that doxygen should
\r
766 # invoke to filter for each input file. Doxygen will invoke the filter program
\r
767 # by executing (via popen()) the command <filter> <input-file>, where <filter>
\r
768 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
\r
769 # input file. Doxygen will then use the output that the filter program writes
\r
770 # to standard output. If FILTER_PATTERNS is specified, this tag will be
\r
775 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
\r
776 # basis. Doxygen will compare the file name with each pattern and apply the
\r
777 # filter if there is a match. The filters are a list of the form:
\r
778 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
\r
779 # info on how filters are used. If FILTER_PATTERNS is empty or if
\r
780 # non of the patterns match the file name, INPUT_FILTER is applied.
\r
784 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
\r
785 # INPUT_FILTER) will be used to filter the input files when producing source
\r
786 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
\r
788 FILTER_SOURCE_FILES = NO
\r
790 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
\r
791 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
\r
792 # and it is also possible to disable source filtering for a specific pattern
\r
793 # using *.ext= (so without naming a filter). This option only has effect when
\r
794 # FILTER_SOURCE_FILES is enabled.
\r
796 FILTER_SOURCE_PATTERNS =
\r
798 #---------------------------------------------------------------------------
\r
799 # configuration options related to source browsing
\r
800 #---------------------------------------------------------------------------
\r
802 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
\r
803 # be generated. Documented entities will be cross-referenced with these sources.
\r
804 # Note: To get rid of all source code in the generated output, make sure also
\r
805 # VERBATIM_HEADERS is set to NO.
\r
807 SOURCE_BROWSER = NO
\r
809 # Setting the INLINE_SOURCES tag to YES will include the body
\r
810 # of functions and classes directly in the documentation.
\r
812 INLINE_SOURCES = NO
\r
814 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
\r
815 # doxygen to hide any special comment blocks from generated source code
\r
816 # fragments. Normal C and C++ comments will always remain visible.
\r
818 STRIP_CODE_COMMENTS = YES
\r
820 # If the REFERENCED_BY_RELATION tag is set to YES
\r
821 # then for each documented function all documented
\r
822 # functions referencing it will be listed.
\r
824 REFERENCED_BY_RELATION = NO
\r
826 # If the REFERENCES_RELATION tag is set to YES
\r
827 # then for each documented function all documented entities
\r
828 # called/used by that function will be listed.
\r
830 REFERENCES_RELATION = NO
\r
832 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
\r
833 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
\r
834 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
\r
835 # link to the source code. Otherwise they will link to the documentation.
\r
837 REFERENCES_LINK_SOURCE = NO
\r
839 # If the USE_HTAGS tag is set to YES then the references to source code
\r
840 # will point to the HTML generated by the htags(1) tool instead of doxygen
\r
841 # built-in source browser. The htags tool is part of GNU's global source
\r
842 # tagging system (see http://www.gnu.org/software/global/global.html). You
\r
843 # will need version 4.8.6 or higher.
\r
847 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
\r
848 # will generate a verbatim copy of the header file for each class for
\r
849 # which an include is specified. Set to NO to disable this.
\r
851 VERBATIM_HEADERS = NO
\r
853 #---------------------------------------------------------------------------
\r
854 # configuration options related to the alphabetical class index
\r
855 #---------------------------------------------------------------------------
\r
857 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
\r
858 # of all compounds will be generated. Enable this if the project
\r
859 # contains a lot of classes, structs, unions or interfaces.
\r
861 ALPHABETICAL_INDEX = YES
\r
863 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
\r
864 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
\r
865 # in which this list will be split (can be a number in the range [1..20])
\r
867 COLS_IN_ALPHA_INDEX = 5
\r
869 # In case all classes in a project start with a common prefix, all
\r
870 # classes will be put under the same header in the alphabetical index.
\r
871 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
\r
872 # should be ignored while generating the index headers.
\r
876 #---------------------------------------------------------------------------
\r
877 # configuration options related to the HTML output
\r
878 #---------------------------------------------------------------------------
\r
880 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
\r
881 # generate HTML output.
\r
883 GENERATE_HTML = YES
\r
885 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
\r
886 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
\r
887 # put in front of it. If left blank `html' will be used as the default path.
\r
891 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
\r
892 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
\r
893 # doxygen will generate files with .html extension.
\r
895 HTML_FILE_EXTENSION = .html
\r
897 # The HTML_HEADER tag can be used to specify a personal HTML header for
\r
898 # each generated HTML page. If it is left blank doxygen will generate a
\r
899 # standard header. Note that when using a custom header you are responsible
\r
900 # for the proper inclusion of any scripts and style sheets that doxygen
\r
901 # needs, which is dependent on the configuration options used.
\r
902 # It is advised to generate a default header using "doxygen -w html
\r
903 # header.html footer.html stylesheet.css YourConfigFile" and then modify
\r
904 # that header. Note that the header is subject to change so you typically
\r
905 # have to redo this when upgrading to a newer version of doxygen or when
\r
906 # changing the value of configuration settings such as GENERATE_TREEVIEW!
\r
910 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
\r
911 # each generated HTML page. If it is left blank doxygen will generate a
\r
914 HTML_FOOTER = ./footer.htm
\r
916 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
\r
917 # style sheet that is used by each HTML page. It can be used to
\r
918 # fine-tune the look of the HTML output. If the tag is left blank doxygen
\r
919 # will generate a default style sheet. Note that doxygen will try to copy
\r
920 # the style sheet file to the HTML output directory, so don't put your own
\r
921 # style sheet in the HTML output directory as well, or it will be erased!
\r
925 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
\r
926 # other source files which should be copied to the HTML output directory. Note
\r
927 # that these files will be copied to the base HTML output directory. Use the
\r
928 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
\r
929 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
\r
930 # the files will be copied as-is; there are no commands or markers available.
\r
932 HTML_EXTRA_FILES =
\r
934 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
\r
935 # Doxygen will adjust the colors in the style sheet and background images
\r
936 # according to this color. Hue is specified as an angle on a colorwheel,
\r
937 # see http://en.wikipedia.org/wiki/Hue for more information.
\r
938 # For instance the value 0 represents red, 60 is yellow, 120 is green,
\r
939 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
\r
940 # The allowed range is 0 to 359.
\r
942 HTML_COLORSTYLE_HUE = 221
\r
944 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
\r
945 # the colors in the HTML output. For a value of 0 the output will use
\r
946 # grayscales only. A value of 255 will produce the most vivid colors.
\r
948 HTML_COLORSTYLE_SAT = 120
\r
950 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
\r
951 # the luminance component of the colors in the HTML output. Values below
\r
952 # 100 gradually make the output lighter, whereas values above 100 make
\r
953 # the output darker. The value divided by 100 is the actual gamma applied,
\r
954 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
\r
955 # and 100 does not change the gamma.
\r
957 HTML_COLORSTYLE_GAMMA = 80
\r
959 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
\r
960 # page will contain the date and time when the page was generated. Setting
\r
961 # this to NO can help when comparing the output of multiple runs.
\r
963 HTML_TIMESTAMP = NO
\r
965 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
\r
966 # files or namespaces will be aligned in HTML using tables. If set to
\r
967 # NO a bullet list will be used.
\r
969 HTML_ALIGN_MEMBERS = YES
\r
971 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
\r
972 # documentation will contain sections that can be hidden and shown after the
\r
973 # page has loaded. For this to work a browser that supports
\r
974 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
\r
975 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
\r
977 HTML_DYNAMIC_SECTIONS = YES
\r
979 # If the GENERATE_DOCSET tag is set to YES, additional index files
\r
980 # will be generated that can be used as input for Apple's Xcode 3
\r
981 # integrated development environment, introduced with OSX 10.5 (Leopard).
\r
982 # To create a documentation set, doxygen will generate a Makefile in the
\r
983 # HTML output directory. Running make will produce the docset in that
\r
984 # directory and running "make install" will install the docset in
\r
985 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
\r
987 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
\r
988 # for more information.
\r
990 GENERATE_DOCSET = NO
\r
992 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
\r
993 # feed. A documentation feed provides an umbrella under which multiple
\r
994 # documentation sets from a single provider (such as a company or product suite)
\r
997 DOCSET_FEEDNAME = "Doxygen generated docs"
\r
999 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
\r
1000 # should uniquely identify the documentation set bundle. This should be a
\r
1001 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
\r
1002 # will append .docset to the name.
\r
1004 DOCSET_BUNDLE_ID = org.doxygen.Project
\r
1006 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
\r
1007 # the documentation publisher. This should be a reverse domain-name style
\r
1008 # string, e.g. com.mycompany.MyDocSet.documentation.
\r
1010 DOCSET_PUBLISHER_ID = com.lufa-lib.library.documentation
\r
1012 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
\r
1014 DOCSET_PUBLISHER_NAME = DeanCamera
\r
1016 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
\r
1017 # will be generated that can be used as input for tools like the
\r
1018 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
\r
1019 # of the generated HTML documentation.
\r
1021 GENERATE_HTMLHELP = NO
\r
1023 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
\r
1024 # be used to specify the file name of the resulting .chm file. You
\r
1025 # can add a path in front of the file if the result should not be
\r
1026 # written to the html output directory.
\r
1028 CHM_FILE = ../LUFA.chm
\r
1030 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
\r
1031 # be used to specify the location (absolute path including file name) of
\r
1032 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
\r
1033 # the HTML help compiler on the generated index.hhp.
\r
1037 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
\r
1038 # controls if a separate .chi index file is generated (YES) or that
\r
1039 # it should be included in the master .chm file (NO).
\r
1043 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
\r
1044 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
\r
1047 CHM_INDEX_ENCODING =
\r
1049 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
\r
1050 # controls whether a binary table of contents is generated (YES) or a
\r
1051 # normal table of contents (NO) in the .chm file.
\r
1055 # The TOC_EXPAND flag can be set to YES to add extra items for group members
\r
1056 # to the contents of the HTML help documentation and to the tree view.
\r
1060 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
\r
1061 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
\r
1062 # that can be used as input for Qt's qhelpgenerator to generate a
\r
1063 # Qt Compressed Help (.qch) of the generated HTML documentation.
\r
1067 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
\r
1068 # be used to specify the file name of the resulting .qch file.
\r
1069 # The path specified is relative to the HTML output folder.
\r
1073 # The QHP_NAMESPACE tag specifies the namespace to use when generating
\r
1074 # Qt Help Project output. For more information please see
\r
1075 # http://doc.trolltech.com/qthelpproject.html#namespace
\r
1077 QHP_NAMESPACE = org.doxygen.Project
\r
1079 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
\r
1080 # Qt Help Project output. For more information please see
\r
1081 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
\r
1083 QHP_VIRTUAL_FOLDER = doc
\r
1085 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
\r
1086 # add. For more information please see
\r
1087 # http://doc.trolltech.com/qthelpproject.html#custom-filters
\r
1089 QHP_CUST_FILTER_NAME =
\r
1091 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
\r
1092 # custom filter to add. For more information please see
\r
1093 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
\r
1094 # Qt Help Project / Custom Filters</a>.
\r
1096 QHP_CUST_FILTER_ATTRS =
\r
1098 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
\r
1100 # filter section matches.
\r
1101 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
\r
1102 # Qt Help Project / Filter Attributes</a>.
\r
1104 QHP_SECT_FILTER_ATTRS =
\r
1106 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
\r
1107 # be used to specify the location of Qt's qhelpgenerator.
\r
1108 # If non-empty doxygen will try to run qhelpgenerator on the generated
\r
1113 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
\r
1114 # will be generated, which together with the HTML files, form an Eclipse help
\r
1115 # plugin. To install this plugin and make it available under the help contents
\r
1116 # menu in Eclipse, the contents of the directory containing the HTML and XML
\r
1117 # files needs to be copied into the plugins directory of eclipse. The name of
\r
1118 # the directory within the plugins directory should be the same as
\r
1119 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
\r
1120 # the help appears.
\r
1122 GENERATE_ECLIPSEHELP = NO
\r
1124 # A unique identifier for the eclipse help plugin. When installing the plugin
\r
1125 # the directory name containing the HTML and XML files should also have
\r
1128 ECLIPSE_DOC_ID = org.doxygen.Project
\r
1130 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
\r
1131 # at top of each HTML page. The value NO (the default) enables the index and
\r
1132 # the value YES disables it. Since the tabs have the same information as the
\r
1133 # navigation tree you can set this option to NO if you already set
\r
1134 # GENERATE_TREEVIEW to YES.
\r
1136 DISABLE_INDEX = NO
\r
1138 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
\r
1139 # structure should be generated to display hierarchical information.
\r
1140 # If the tag value is set to YES, a side panel will be generated
\r
1141 # containing a tree-like index structure (just like the one that
\r
1142 # is generated for HTML Help). For this to work a browser that supports
\r
1143 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
\r
1144 # Windows users are probably better off using the HTML help feature.
\r
1145 # Since the tree basically has the same information as the tab index you
\r
1146 # could consider to set DISABLE_INDEX to NO when enabling this option.
\r
1148 GENERATE_TREEVIEW = YES
\r
1150 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
\r
1151 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
\r
1152 # documentation. Note that a value of 0 will completely suppress the enum
\r
1153 # values from appearing in the overview section.
\r
1155 ENUM_VALUES_PER_LINE = 1
\r
1157 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
\r
1158 # and Class Hierarchy pages using a tree view instead of an ordered list.
\r
1160 USE_INLINE_TREES = YES
\r
1162 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
\r
1163 # used to set the initial width (in pixels) of the frame in which the tree
\r
1166 TREEVIEW_WIDTH = 300
\r
1168 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
\r
1169 # links to external symbols imported via tag files in a separate window.
\r
1171 EXT_LINKS_IN_WINDOW = NO
\r
1173 # Use this tag to change the font size of Latex formulas included
\r
1174 # as images in the HTML documentation. The default is 10. Note that
\r
1175 # when you change the font size after a successful doxygen run you need
\r
1176 # to manually remove any form_*.png images from the HTML output directory
\r
1177 # to force them to be regenerated.
\r
1179 FORMULA_FONTSIZE = 10
\r
1181 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
\r
1182 # generated for formulas are transparent PNGs. Transparent PNGs are
\r
1183 # not supported properly for IE 6.0, but are supported on all modern browsers.
\r
1184 # Note that when changing this option you need to delete any form_*.png files
\r
1185 # in the HTML output before the changes have effect.
\r
1187 FORMULA_TRANSPARENT = YES
\r
1189 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
\r
1190 # (see http://www.mathjax.org) which uses client side Javascript for the
\r
1191 # rendering instead of using prerendered bitmaps. Use this if you do not
\r
1192 # have LaTeX installed or if you want to formulas look prettier in the HTML
\r
1193 # output. When enabled you may also need to install MathJax separately and
\r
1194 # configure the path to it using the MATHJAX_RELPATH option.
\r
1198 # When MathJax is enabled you need to specify the location relative to the
\r
1199 # HTML output directory using the MATHJAX_RELPATH option. The destination
\r
1200 # directory should contain the MathJax.js script. For instance, if the mathjax
\r
1201 # directory is located at the same level as the HTML output directory, then
\r
1202 # MATHJAX_RELPATH should be ../mathjax. The default value points to
\r
1203 # the MathJax Content Delivery Network so you can quickly see the result without
\r
1204 # installing MathJax. However, it is strongly recommended to install a local
\r
1205 # copy of MathJax from http://www.mathjax.org before deployment.
\r
1207 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
\r
1209 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
\r
1210 # names that should be enabled during MathJax rendering.
\r
1212 MATHJAX_EXTENSIONS =
\r
1214 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
\r
1215 # for the HTML output. The underlying search engine uses javascript
\r
1216 # and DHTML and should work on any modern browser. Note that when using
\r
1217 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
\r
1218 # (GENERATE_DOCSET) there is already a search function so this one should
\r
1219 # typically be disabled. For large projects the javascript based search engine
\r
1220 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
\r
1222 SEARCHENGINE = YES
\r
1224 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
\r
1225 # implemented using a PHP enabled web server instead of at the web client
\r
1226 # using Javascript. Doxygen will generate the search PHP script and index
\r
1227 # file to put on the web server. The advantage of the server
\r
1228 # based approach is that it scales better to large projects and allows
\r
1229 # full text search. The disadvantages are that it is more difficult to setup
\r
1230 # and does not have live searching capabilities.
\r
1232 SERVER_BASED_SEARCH = NO
\r
1234 #---------------------------------------------------------------------------
\r
1235 # configuration options related to the LaTeX output
\r
1236 #---------------------------------------------------------------------------
\r
1238 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
\r
1239 # generate Latex output.
\r
1241 GENERATE_LATEX = NO
\r
1243 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
\r
1244 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
\r
1245 # put in front of it. If left blank `latex' will be used as the default path.
\r
1247 LATEX_OUTPUT = latex
\r
1249 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
\r
1250 # invoked. If left blank `latex' will be used as the default command name.
\r
1251 # Note that when enabling USE_PDFLATEX this option is only used for
\r
1252 # generating bitmaps for formulas in the HTML output, but not in the
\r
1253 # Makefile that is written to the output directory.
\r
1255 LATEX_CMD_NAME = latex
\r
1257 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
\r
1258 # generate index for LaTeX. If left blank `makeindex' will be used as the
\r
1259 # default command name.
\r
1261 MAKEINDEX_CMD_NAME = makeindex
\r
1263 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
\r
1264 # LaTeX documents. This may be useful for small projects and may help to
\r
1265 # save some trees in general.
\r
1267 COMPACT_LATEX = NO
\r
1269 # The PAPER_TYPE tag can be used to set the paper type that is used
\r
1270 # by the printer. Possible values are: a4, letter, legal and
\r
1271 # executive. If left blank a4wide will be used.
\r
1273 PAPER_TYPE = a4wide
\r
1275 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
\r
1276 # packages that should be included in the LaTeX output.
\r
1280 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
\r
1281 # the generated latex document. The header should contain everything until
\r
1282 # the first chapter. If it is left blank doxygen will generate a
\r
1283 # standard header. Notice: only use this tag if you know what you are doing!
\r
1287 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
\r
1288 # the generated latex document. The footer should contain everything after
\r
1289 # the last chapter. If it is left blank doxygen will generate a
\r
1290 # standard footer. Notice: only use this tag if you know what you are doing!
\r
1294 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
\r
1295 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
\r
1296 # contain links (just like the HTML output) instead of page references
\r
1297 # This makes the output suitable for online browsing using a pdf viewer.
\r
1299 PDF_HYPERLINKS = YES
\r
1301 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
\r
1302 # plain latex in the generated Makefile. Set this option to YES to get a
\r
1303 # higher quality PDF documentation.
\r
1305 USE_PDFLATEX = YES
\r
1307 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
\r
1308 # command to the generated LaTeX files. This will instruct LaTeX to keep
\r
1309 # running if errors occur, instead of asking the user for help.
\r
1310 # This option is also used when generating formulas in HTML.
\r
1312 LATEX_BATCHMODE = NO
\r
1314 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
\r
1315 # include the index chapters (such as File Index, Compound Index, etc.)
\r
1318 LATEX_HIDE_INDICES = NO
\r
1320 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
\r
1321 # source code with syntax highlighting in the LaTeX output.
\r
1322 # Note that which sources are shown also depends on other settings
\r
1323 # such as SOURCE_BROWSER.
\r
1325 LATEX_SOURCE_CODE = NO
\r
1327 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
\r
1328 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
\r
1329 # http://en.wikipedia.org/wiki/BibTeX for more info.
\r
1331 LATEX_BIB_STYLE = plain
\r
1333 #---------------------------------------------------------------------------
\r
1334 # configuration options related to the RTF output
\r
1335 #---------------------------------------------------------------------------
\r
1337 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
\r
1338 # The RTF output is optimized for Word 97 and may not look very pretty with
\r
1339 # other RTF readers or editors.
\r
1343 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
\r
1344 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
\r
1345 # put in front of it. If left blank `rtf' will be used as the default path.
\r
1349 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
\r
1350 # RTF documents. This may be useful for small projects and may help to
\r
1351 # save some trees in general.
\r
1355 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
\r
1356 # will contain hyperlink fields. The RTF file will
\r
1357 # contain links (just like the HTML output) instead of page references.
\r
1358 # This makes the output suitable for online browsing using WORD or other
\r
1359 # programs which support those fields.
\r
1360 # Note: wordpad (write) and others do not support links.
\r
1362 RTF_HYPERLINKS = NO
\r
1364 # Load style sheet definitions from file. Syntax is similar to doxygen's
\r
1365 # config file, i.e. a series of assignments. You only have to provide
\r
1366 # replacements, missing definitions are set to their default value.
\r
1368 RTF_STYLESHEET_FILE =
\r
1370 # Set optional variables used in the generation of an rtf document.
\r
1371 # Syntax is similar to doxygen's config file.
\r
1373 RTF_EXTENSIONS_FILE =
\r
1375 #---------------------------------------------------------------------------
\r
1376 # configuration options related to the man page output
\r
1377 #---------------------------------------------------------------------------
\r
1379 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
\r
1380 # generate man pages
\r
1384 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
\r
1385 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
\r
1386 # put in front of it. If left blank `man' will be used as the default path.
\r
1390 # The MAN_EXTENSION tag determines the extension that is added to
\r
1391 # the generated man pages (default is the subroutine's section .3)
\r
1393 MAN_EXTENSION = .3
\r
1395 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
\r
1396 # then it will generate one additional man file for each entity
\r
1397 # documented in the real man page(s). These additional files
\r
1398 # only source the real man page, but without them the man command
\r
1399 # would be unable to find the correct page. The default is NO.
\r
1403 #---------------------------------------------------------------------------
\r
1404 # configuration options related to the XML output
\r
1405 #---------------------------------------------------------------------------
\r
1407 # If the GENERATE_XML tag is set to YES Doxygen will
\r
1408 # generate an XML file that captures the structure of
\r
1409 # the code including all documentation.
\r
1413 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
\r
1414 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
\r
1415 # put in front of it. If left blank `xml' will be used as the default path.
\r
1419 # The XML_SCHEMA tag can be used to specify an XML schema,
\r
1420 # which can be used by a validating XML parser to check the
\r
1421 # syntax of the XML files.
\r
1425 # The XML_DTD tag can be used to specify an XML DTD,
\r
1426 # which can be used by a validating XML parser to check the
\r
1427 # syntax of the XML files.
\r
1431 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
\r
1432 # dump the program listings (including syntax highlighting
\r
1433 # and cross-referencing information) to the XML output. Note that
\r
1434 # enabling this will significantly increase the size of the XML output.
\r
1436 XML_PROGRAMLISTING = YES
\r
1438 #---------------------------------------------------------------------------
\r
1439 # configuration options for the AutoGen Definitions output
\r
1440 #---------------------------------------------------------------------------
\r
1442 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
\r
1443 # generate an AutoGen Definitions (see autogen.sf.net) file
\r
1444 # that captures the structure of the code including all
\r
1445 # documentation. Note that this feature is still experimental
\r
1446 # and incomplete at the moment.
\r
1448 GENERATE_AUTOGEN_DEF = NO
\r
1450 #---------------------------------------------------------------------------
\r
1451 # configuration options related to the Perl module output
\r
1452 #---------------------------------------------------------------------------
\r
1454 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
\r
1455 # generate a Perl module file that captures the structure of
\r
1456 # the code including all documentation. Note that this
\r
1457 # feature is still experimental and incomplete at the
\r
1460 GENERATE_PERLMOD = NO
\r
1462 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
\r
1463 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
\r
1464 # to generate PDF and DVI output from the Perl module output.
\r
1466 PERLMOD_LATEX = NO
\r
1468 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
\r
1469 # nicely formatted so it can be parsed by a human reader. This is useful
\r
1470 # if you want to understand what is going on. On the other hand, if this
\r
1471 # tag is set to NO the size of the Perl module output will be much smaller
\r
1472 # and Perl will parse it just the same.
\r
1474 PERLMOD_PRETTY = YES
\r
1476 # The names of the make variables in the generated doxyrules.make file
\r
1477 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
\r
1478 # This is useful so different doxyrules.make files included by the same
\r
1479 # Makefile don't overwrite each other's variables.
\r
1481 PERLMOD_MAKEVAR_PREFIX =
\r
1483 #---------------------------------------------------------------------------
\r
1484 # Configuration options related to the preprocessor
\r
1485 #---------------------------------------------------------------------------
\r
1487 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
\r
1488 # evaluate all C-preprocessor directives found in the sources and include
\r
1491 ENABLE_PREPROCESSING = YES
\r
1493 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
\r
1494 # names in the source code. If set to NO (the default) only conditional
\r
1495 # compilation will be performed. Macro expansion can be done in a controlled
\r
1496 # way by setting EXPAND_ONLY_PREDEF to YES.
\r
1498 MACRO_EXPANSION = YES
\r
1500 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
\r
1501 # then the macro expansion is limited to the macros specified with the
\r
1502 # PREDEFINED and EXPAND_AS_DEFINED tags.
\r
1504 EXPAND_ONLY_PREDEF = YES
\r
1506 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
\r
1507 # pointed to by INCLUDE_PATH will be searched when a #include is found.
\r
1509 SEARCH_INCLUDES = YES
\r
1511 # The INCLUDE_PATH tag can be used to specify one or more directories that
\r
1512 # contain include files that are not input files but should be processed by
\r
1513 # the preprocessor.
\r
1517 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
\r
1518 # patterns (like *.h and *.hpp) to filter out the header-files in the
\r
1519 # directories. If left blank, the patterns specified with FILE_PATTERNS will
\r
1522 INCLUDE_FILE_PATTERNS =
\r
1524 # The PREDEFINED tag can be used to specify one or more macro names that
\r
1525 # are defined before the preprocessor is started (similar to the -D option of
\r
1526 # gcc). The argument of the tag is a list of macros of the form: name
\r
1527 # or name=definition (no spaces). If the definition and the = are
\r
1528 # omitted =1 is assumed. To prevent a macro definition from being
\r
1529 # undefined via #undef or recursively expanded use the := operator
\r
1530 # instead of the = operator.
\r
1532 PREDEFINED = __DOXYGEN__ \
\r
1537 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
\r
1538 # this tag can be used to specify a list of macro names that should be expanded.
\r
1539 # The macro definition that is found in the sources will be used.
\r
1540 # Use the PREDEFINED tag if you want to use a different macro definition that
\r
1541 # overrules the definition found in the source code.
\r
1543 EXPAND_AS_DEFINED =
\r
1545 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
\r
1546 # doxygen's preprocessor will remove all references to function-like macros
\r
1547 # that are alone on a line, have an all uppercase name, and do not end with a
\r
1548 # semicolon, because these will confuse the parser if not removed.
\r
1550 SKIP_FUNCTION_MACROS = YES
\r
1552 #---------------------------------------------------------------------------
\r
1553 # Configuration::additions related to external references
\r
1554 #---------------------------------------------------------------------------
\r
1556 # The TAGFILES option can be used to specify one or more tagfiles. For each
\r
1557 # tag file the location of the external documentation should be added. The
\r
1558 # format of a tag file without this location is as follows:
\r
1559 # TAGFILES = file1 file2 ...
\r
1560 # Adding location for the tag files is done as follows:
\r
1561 # TAGFILES = file1=loc1 "file2 = loc2" ...
\r
1562 # where "loc1" and "loc2" can be relative or absolute paths
\r
1563 # or URLs. Note that each tag file must have a unique name (where the name does
\r
1564 # NOT include the path). If a tag file is not located in the directory in which
\r
1565 # doxygen is run, you must also specify the path to the tagfile here.
\r
1569 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
\r
1570 # a tag file that is based on the input files it reads.
\r
1572 GENERATE_TAGFILE = Documentation/LPCUSBlib.tag
\r
1574 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
\r
1575 # in the class index. If set to NO only the inherited external classes
\r
1580 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
\r
1581 # in the modules index. If set to NO, only the current project's groups will
\r
1584 EXTERNAL_GROUPS = NO
\r
1586 # The PERL_PATH should be the absolute path and name of the perl script
\r
1587 # interpreter (i.e. the result of `which perl').
\r
1589 PERL_PATH = /usr/bin/perl
\r
1591 #---------------------------------------------------------------------------
\r
1592 # Configuration options related to the dot tool
\r
1593 #---------------------------------------------------------------------------
\r
1595 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
\r
1596 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
\r
1597 # or super classes. Setting the tag to NO turns the diagrams off. Note that
\r
1598 # this option also works with HAVE_DOT disabled, but it is recommended to
\r
1599 # install and use dot, since it yields more powerful graphs.
\r
1601 CLASS_DIAGRAMS = NO
\r
1603 # You can define message sequence charts within doxygen comments using the \msc
\r
1604 # command. Doxygen will then run the mscgen tool (see
\r
1605 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
\r
1606 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
\r
1607 # the mscgen tool resides. If left empty the tool is assumed to be found in the
\r
1608 # default search path.
\r
1612 # If set to YES, the inheritance and collaboration graphs will hide
\r
1613 # inheritance and usage relations if the target is undocumented
\r
1614 # or is not a class.
\r
1616 HIDE_UNDOC_RELATIONS = YES
\r
1618 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
\r
1619 # available from the path. This tool is part of Graphviz, a graph visualization
\r
1620 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
\r
1621 # have no effect if this option is set to NO (the default)
\r
1625 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
\r
1626 # allowed to run in parallel. When set to 0 (the default) doxygen will
\r
1627 # base this on the number of processors available in the system. You can set it
\r
1628 # explicitly to a value larger than 0 to get control over the balance
\r
1629 # between CPU load and processing speed.
\r
1631 DOT_NUM_THREADS = 0
\r
1633 # By default doxygen will use the Helvetica font for all dot files that
\r
1634 # doxygen generates. When you want a differently looking font you can specify
\r
1635 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
\r
1636 # the font, which can be done by putting it in a standard location or by setting
\r
1637 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
\r
1638 # directory containing the font.
\r
1640 DOT_FONTNAME = FreeSans
\r
1642 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
\r
1643 # The default size is 10pt.
\r
1647 # By default doxygen will tell dot to use the Helvetica font.
\r
1648 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
\r
1649 # set the path where dot can find it.
\r
1653 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
\r
1654 # will generate a graph for each documented class showing the direct and
\r
1655 # indirect inheritance relations. Setting this tag to YES will force the
\r
1656 # CLASS_DIAGRAMS tag to NO.
\r
1660 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
\r
1661 # will generate a graph for each documented class showing the direct and
\r
1662 # indirect implementation dependencies (inheritance, containment, and
\r
1663 # class references variables) of the class with other documented classes.
\r
1665 COLLABORATION_GRAPH = NO
\r
1667 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
\r
1668 # will generate a graph for groups, showing the direct groups dependencies
\r
1670 GROUP_GRAPHS = YES
\r
1672 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
\r
1673 # collaboration diagrams in a style similar to the OMG's Unified Modeling
\r
1678 # If the UML_LOOK tag is enabled, the fields and methods are shown inside
\r
1679 # the class node. If there are many fields or methods and many nodes the
\r
1680 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
\r
1681 # threshold limits the number of items for each type to make the size more
\r
1682 # managable. Set this to 0 for no limit. Note that the threshold may be
\r
1683 # exceeded by 50% before the limit is enforced.
\r
1685 UML_LIMIT_NUM_FIELDS = 10
\r
1687 # If set to YES, the inheritance and collaboration graphs will show the
\r
1688 # relations between templates and their instances.
\r
1690 TEMPLATE_RELATIONS = NO
\r
1692 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
\r
1693 # tags are set to YES then doxygen will generate a graph for each documented
\r
1694 # file showing the direct and indirect include dependencies of the file with
\r
1695 # other documented files.
\r
1697 INCLUDE_GRAPH = YES
\r
1699 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
\r
1700 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
\r
1701 # documented header file showing the documented files that directly or
\r
1702 # indirectly include this file.
\r
1704 INCLUDED_BY_GRAPH = YES
\r
1706 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
\r
1707 # doxygen will generate a call dependency graph for every global function
\r
1708 # or class method. Note that enabling this option will significantly increase
\r
1709 # the time of a run. So in most cases it will be better to enable call graphs
\r
1710 # for selected functions only using the \callgraph command.
\r
1714 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
\r
1715 # doxygen will generate a caller dependency graph for every global function
\r
1716 # or class method. Note that enabling this option will significantly increase
\r
1717 # the time of a run. So in most cases it will be better to enable caller
\r
1718 # graphs for selected functions only using the \callergraph command.
\r
1722 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
\r
1723 # will generate a graphical hierarchy of all classes instead of a textual one.
\r
1725 GRAPHICAL_HIERARCHY = NO
\r
1727 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
\r
1728 # then doxygen will show the dependencies a directory has on other directories
\r
1729 # in a graphical way. The dependency relations are determined by the #include
\r
1730 # relations between the files in the directories.
\r
1732 DIRECTORY_GRAPH = YES
\r
1734 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
\r
1735 # generated by dot. Possible values are svg, png, jpg, or gif.
\r
1736 # If left blank png will be used. If you choose svg you need to set
\r
1737 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
\r
1738 # visible in IE 9+ (other browsers do not have this requirement).
\r
1740 DOT_IMAGE_FORMAT = png
\r
1742 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
\r
1743 # enable generation of interactive SVG images that allow zooming and panning.
\r
1744 # Note that this requires a modern browser other than Internet Explorer.
\r
1745 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
\r
1746 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
\r
1747 # visible. Older versions of IE do not have SVG support.
\r
1749 INTERACTIVE_SVG = NO
\r
1751 # The tag DOT_PATH can be used to specify the path where the dot tool can be
\r
1752 # found. If left blank, it is assumed the dot tool can be found in the path.
\r
1756 # The DOTFILE_DIRS tag can be used to specify one or more directories that
\r
1757 # contain dot files that are included in the documentation (see the
\r
1758 # \dotfile command).
\r
1762 # The MSCFILE_DIRS tag can be used to specify one or more directories that
\r
1763 # contain msc files that are included in the documentation (see the
\r
1764 # \mscfile command).
\r
1768 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
\r
1769 # nodes that will be shown in the graph. If the number of nodes in a graph
\r
1770 # becomes larger than this value, doxygen will truncate the graph, which is
\r
1771 # visualized by representing a node as a red box. Note that doxygen if the
\r
1772 # number of direct children of the root node in a graph is already larger than
\r
1773 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
\r
1774 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
\r
1776 DOT_GRAPH_MAX_NODES = 15
\r
1778 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
\r
1779 # graphs generated by dot. A depth value of 3 means that only nodes reachable
\r
1780 # from the root by following a path via at most 3 edges will be shown. Nodes
\r
1781 # that lay further from the root node will be omitted. Note that setting this
\r
1782 # option to 1 or 2 may greatly reduce the computation time needed for large
\r
1783 # code bases. Also note that the size of a graph can be further restricted by
\r
1784 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
\r
1786 MAX_DOT_GRAPH_DEPTH = 2
\r
1788 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
\r
1789 # background. This is disabled by default, because dot on Windows does not
\r
1790 # seem to support this out of the box. Warning: Depending on the platform used,
\r
1791 # enabling this option may lead to badly anti-aliased labels on the edges of
\r
1792 # a graph (i.e. they become hard to read).
\r
1794 DOT_TRANSPARENT = YES
\r
1796 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
\r
1797 # files in one run (i.e. multiple -o and -T options on the command line). This
\r
1798 # makes dot run faster, but since only newer versions of dot (>1.8.10)
\r
1799 # support this, this feature is disabled by default.
\r
1801 DOT_MULTI_TARGETS = NO
\r
1803 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
\r
1804 # generate a legend page explaining the meaning of the various boxes and
\r
1805 # arrows in the dot generated graphs.
\r
1807 GENERATE_LEGEND = YES
\r
1809 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
\r
1810 # remove the intermediate dot files that are used to generate
\r
1811 # the various graphs.
\r