Michael Bruck <mbruck@digenius.de>: sys/select.h must preceed windows.h.
[openocd.git] / Doxyfile
1 # Doxyfile 1.5.5
2
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
5 #
6 # All text after a hash (#) is considered a comment and will be ignored
7 # The format is:
8 # TAG = value [value, ...]
9 # For lists items can also be appended using:
10 # TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
12
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
16
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23 DOXYFILE_ENCODING = UTF-8
24
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
27
28 PROJECT_NAME = OpenOCD
29
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
32 # if some version control system is used.
33
34 PROJECT_NUMBER =
35
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
40
41 OUTPUT_DIRECTORY =
42
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
49
50 CREATE_SUBDIRS = NO
51
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 # documentation generated by doxygen is written. Doxygen will use this
54 # information to generate all constant output in the proper language.
55 # The default language is English, other supported languages are:
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
61 # and Ukrainian.
62
63 OUTPUT_LANGUAGE = English
64
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66 # include brief member descriptions after the members that are listed in
67 # the file and class documentation (similar to JavaDoc).
68 # Set to NO to disable this.
69
70 BRIEF_MEMBER_DESC = YES
71
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73 # the brief description of a member or function before the detailed description.
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75 # brief descriptions will be completely suppressed.
76
77 REPEAT_BRIEF = YES
78
79 # This tag implements a quasi-intelligent brief description abbreviator
80 # that is used to form the text in various listings. Each string
81 # in this list, if found as the leading text of the brief description, will be
82 # stripped from the text and the result after processing the whole list, is
83 # used as the annotated text. Otherwise, the brief description is used as-is.
84 # If left blank, the following values are used ("$name" is automatically
85 # replaced with the name of the entity): "The $name class" "The $name widget"
86 # "The $name file" "is" "provides" "specifies" "contains"
87 # "represents" "a" "an" "the"
88
89 ABBREVIATE_BRIEF =
90
91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92 # Doxygen will generate a detailed section even if there is only a brief
93 # description.
94
95 ALWAYS_DETAILED_SEC = NO
96
97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98 # inherited members of a class in the documentation of that class as if those
99 # members were ordinary class members. Constructors, destructors and assignment
100 # operators of the base classes will not be shown.
101
102 INLINE_INHERITED_MEMB = YES
103
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105 # path before files name in the file list and in the header files. If set
106 # to NO the shortest path that makes the file name unique will be used.
107
108 FULL_PATH_NAMES = NO
109
110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111 # can be used to strip a user-defined part of the path. Stripping is
112 # only done if one of the specified strings matches the left-hand part of
113 # the path. The tag can be used to show relative paths in the file list.
114 # If left blank the directory from which doxygen is run is used as the
115 # path to strip.
116
117 STRIP_FROM_PATH =
118
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120 # the path mentioned in the documentation of a class, which tells
121 # the reader which header file to include in order to use a class.
122 # If left blank only the name of the header file containing the class
123 # definition is used. Otherwise one should specify the include paths that
124 # are normally passed to the compiler using the -I flag.
125
126 STRIP_FROM_INC_PATH =
127
128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129 # (but less readable) file names. This can be useful is your file systems
130 # doesn't support long names like on DOS, Mac, or CD-ROM.
131
132 SHORT_NAMES = NO
133
134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135 # will interpret the first line (until the first dot) of a JavaDoc-style
136 # comment as the brief description. If set to NO, the JavaDoc
137 # comments will behave just like regular Qt-style comments
138 # (thus requiring an explicit @brief command for a brief description.)
139
140 JAVADOC_AUTOBRIEF = YES
141
142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143 # interpret the first line (until the first dot) of a Qt-style
144 # comment as the brief description. If set to NO, the comments
145 # will behave just like regular Qt-style comments (thus requiring
146 # an explicit \brief command for a brief description.)
147
148 QT_AUTOBRIEF = NO
149
150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
152 # comments) as a brief description. This used to be the default behaviour.
153 # The new default is to treat a multi-line C++ comment block as a detailed
154 # description. Set this tag to YES if you prefer the old behaviour instead.
155
156 MULTILINE_CPP_IS_BRIEF = NO
157
158 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
159 # will output the detailed description near the top, like JavaDoc.
160 # If set to NO, the detailed description appears after the member
161 # documentation.
162
163 DETAILS_AT_TOP = YES
164
165 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
166 # member inherits the documentation from any documented member that it
167 # re-implements.
168
169 INHERIT_DOCS = YES
170
171 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
172 # a new page for each member. If set to NO, the documentation of a member will
173 # be part of the file/class/namespace that contains it.
174
175 SEPARATE_MEMBER_PAGES = NO
176
177 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
178 # Doxygen uses this value to replace tabs by spaces in code fragments.
179
180 TAB_SIZE = 4
181
182 # This tag can be used to specify a number of aliases that acts
183 # as commands in the documentation. An alias has the form "name=value".
184 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
185 # put the command \sideeffect (or @sideeffect) in the documentation, which
186 # will result in a user-defined paragraph with heading "Side Effects:".
187 # You can put \n's in the value part of an alias to insert newlines.
188
189 ALIASES =
190
191 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
192 # sources only. Doxygen will then generate output that is more tailored for C.
193 # For instance, some of the names that are used will be different. The list
194 # of all members will be omitted, etc.
195
196 OPTIMIZE_OUTPUT_FOR_C = NO
197
198 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
199 # sources only. Doxygen will then generate output that is more tailored for
200 # Java. For instance, namespaces will be presented as packages, qualified
201 # scopes will look different, etc.
202
203 OPTIMIZE_OUTPUT_JAVA = NO
204
205 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
206 # sources only. Doxygen will then generate output that is more tailored for
207 # Fortran.
208
209 OPTIMIZE_FOR_FORTRAN = NO
210
211 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
212 # sources. Doxygen will then generate output that is tailored for
213 # VHDL.
214
215 OPTIMIZE_OUTPUT_VHDL = NO
216
217 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
218 # to include (a tag file for) the STL sources as input, then you should
219 # set this tag to YES in order to let doxygen match functions declarations and
220 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
221 # func(std::string) {}). This also make the inheritance and collaboration
222 # diagrams that involve STL classes more complete and accurate.
223
224 BUILTIN_STL_SUPPORT = NO
225
226 # If you use Microsoft's C++/CLI language, you should set this option to YES to
227 # enable parsing support.
228
229 CPP_CLI_SUPPORT = NO
230
231 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
232 # Doxygen will parse them like normal C++ but will assume all classes use public
233 # instead of private inheritance when no explicit protection keyword is present.
234
235 SIP_SUPPORT = NO
236
237 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
238 # tag is set to YES, then doxygen will reuse the documentation of the first
239 # member in the group (if any) for the other members of the group. By default
240 # all members of a group must be documented explicitly.
241
242 DISTRIBUTE_GROUP_DOC = NO
243
244 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
245 # the same type (for instance a group of public functions) to be put as a
246 # subgroup of that type (e.g. under the Public Functions section). Set it to
247 # NO to prevent subgrouping. Alternatively, this can be done per class using
248 # the \nosubgrouping command.
249
250 SUBGROUPING = YES
251
252 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
253 # is documented as struct, union, or enum with the name of the typedef. So
254 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
255 # with name TypeT. When disabled the typedef will appear as a member of a file,
256 # namespace, or class. And the struct will be named TypeS. This can typically
257 # be useful for C code in case the coding convention dictates that all compound
258 # types are typedef'ed and only the typedef is referenced, never the tag name.
259
260 TYPEDEF_HIDES_STRUCT = NO
261
262 #---------------------------------------------------------------------------
263 # Build related configuration options
264 #---------------------------------------------------------------------------
265
266 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
267 # documentation are documented, even if no documentation was available.
268 # Private class members and static file members will be hidden unless
269 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
270
271 EXTRACT_ALL = YES
272
273 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
274 # will be included in the documentation.
275
276 EXTRACT_PRIVATE = NO
277
278 # If the EXTRACT_STATIC tag is set to YES all static members of a file
279 # will be included in the documentation.
280
281 EXTRACT_STATIC = YES
282
283 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
284 # defined locally in source files will be included in the documentation.
285 # If set to NO only classes defined in header files are included.
286
287 EXTRACT_LOCAL_CLASSES = YES
288
289 # This flag is only useful for Objective-C code. When set to YES local
290 # methods, which are defined in the implementation section but not in
291 # the interface are included in the documentation.
292 # If set to NO (the default) only methods in the interface are included.
293
294 EXTRACT_LOCAL_METHODS = NO
295
296 # If this flag is set to YES, the members of anonymous namespaces will be
297 # extracted and appear in the documentation as a namespace called
298 # 'anonymous_namespace{file}', where file will be replaced with the base
299 # name of the file that contains the anonymous namespace. By default
300 # anonymous namespace are hidden.
301
302 EXTRACT_ANON_NSPACES = NO
303
304 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
305 # undocumented members of documented classes, files or namespaces.
306 # If set to NO (the default) these members will be included in the
307 # various overviews, but no documentation section is generated.
308 # This option has no effect if EXTRACT_ALL is enabled.
309
310 HIDE_UNDOC_MEMBERS = NO
311
312 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
313 # undocumented classes that are normally visible in the class hierarchy.
314 # If set to NO (the default) these classes will be included in the various
315 # overviews. This option has no effect if EXTRACT_ALL is enabled.
316
317 HIDE_UNDOC_CLASSES = NO
318
319 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
320 # friend (class|struct|union) declarations.
321 # If set to NO (the default) these declarations will be included in the
322 # documentation.
323
324 HIDE_FRIEND_COMPOUNDS = NO
325
326 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
327 # documentation blocks found inside the body of a function.
328 # If set to NO (the default) these blocks will be appended to the
329 # function's detailed documentation block.
330
331 HIDE_IN_BODY_DOCS = NO
332
333 # The INTERNAL_DOCS tag determines if documentation
334 # that is typed after a \internal command is included. If the tag is set
335 # to NO (the default) then the documentation will be excluded.
336 # Set it to YES to include the internal documentation.
337
338 INTERNAL_DOCS = NO
339
340 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
341 # file names in lower-case letters. If set to YES upper-case letters are also
342 # allowed. This is useful if you have classes or files whose names only differ
343 # in case and if your file system supports case sensitive file names. Windows
344 # and Mac users are advised to set this option to NO.
345
346 CASE_SENSE_NAMES = YES
347
348 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
349 # will show members with their full class and namespace scopes in the
350 # documentation. If set to YES the scope will be hidden.
351
352 HIDE_SCOPE_NAMES = NO
353
354 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
355 # will put a list of the files that are included by a file in the documentation
356 # of that file.
357
358 SHOW_INCLUDE_FILES = YES
359
360 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
361 # is inserted in the documentation for inline members.
362
363 INLINE_INFO = YES
364
365 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
366 # will sort the (detailed) documentation of file and class members
367 # alphabetically by member name. If set to NO the members will appear in
368 # declaration order.
369
370 SORT_MEMBER_DOCS = YES
371
372 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
373 # brief documentation of file, namespace and class members alphabetically
374 # by member name. If set to NO (the default) the members will appear in
375 # declaration order.
376
377 SORT_BRIEF_DOCS = NO
378
379 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
380 # hierarchy of group names into alphabetical order. If set to NO (the default)
381 # the group names will appear in their defined order.
382
383 SORT_GROUP_NAMES = NO
384
385 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
386 # sorted by fully-qualified names, including namespaces. If set to
387 # NO (the default), the class list will be sorted only by class name,
388 # not including the namespace part.
389 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
390 # Note: This option applies only to the class list, not to the
391 # alphabetical list.
392
393 SORT_BY_SCOPE_NAME = NO
394
395 # The GENERATE_TODOLIST tag can be used to enable (YES) or
396 # disable (NO) the todo list. This list is created by putting \todo
397 # commands in the documentation.
398
399 GENERATE_TODOLIST = YES
400
401 # The GENERATE_TESTLIST tag can be used to enable (YES) or
402 # disable (NO) the test list. This list is created by putting \test
403 # commands in the documentation.
404
405 GENERATE_TESTLIST = YES
406
407 # The GENERATE_BUGLIST tag can be used to enable (YES) or
408 # disable (NO) the bug list. This list is created by putting \bug
409 # commands in the documentation.
410
411 GENERATE_BUGLIST = YES
412
413 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
414 # disable (NO) the deprecated list. This list is created by putting
415 # \deprecated commands in the documentation.
416
417 GENERATE_DEPRECATEDLIST= YES
418
419 # The ENABLED_SECTIONS tag can be used to enable conditional
420 # documentation sections, marked by \if sectionname ... \endif.
421
422 ENABLED_SECTIONS =
423
424 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
425 # the initial value of a variable or define consists of for it to appear in
426 # the documentation. If the initializer consists of more lines than specified
427 # here it will be hidden. Use a value of 0 to hide initializers completely.
428 # The appearance of the initializer of individual variables and defines in the
429 # documentation can be controlled using \showinitializer or \hideinitializer
430 # command in the documentation regardless of this setting.
431
432 MAX_INITIALIZER_LINES = 30
433
434 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
435 # at the bottom of the documentation of classes and structs. If set to YES the
436 # list will mention the files that were used to generate the documentation.
437
438 SHOW_USED_FILES = YES
439
440 # If the sources in your project are distributed over multiple directories
441 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
442 # in the documentation. The default is NO.
443
444 SHOW_DIRECTORIES = YES
445
446 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
447 # doxygen should invoke to get the current version for each file (typically from
448 # the version control system). Doxygen will invoke the program by executing (via
449 # popen()) the command <command> <input-file>, where <command> is the value of
450 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
451 # provided by doxygen. Whatever the program writes to standard output
452 # is used as the file version. See the manual for examples.
453
454 FILE_VERSION_FILTER =
455
456 #---------------------------------------------------------------------------
457 # configuration options related to warning and progress messages
458 #---------------------------------------------------------------------------
459
460 # The QUIET tag can be used to turn on/off the messages that are generated
461 # by doxygen. Possible values are YES and NO. If left blank NO is used.
462
463 QUIET = NO
464
465 # The WARNINGS tag can be used to turn on/off the warning messages that are
466 # generated by doxygen. Possible values are YES and NO. If left blank
467 # NO is used.
468
469 WARNINGS = YES
470
471 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
472 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
473 # automatically be disabled.
474
475 WARN_IF_UNDOCUMENTED = YES
476
477 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
478 # potential errors in the documentation, such as not documenting some
479 # parameters in a documented function, or documenting parameters that
480 # don't exist or using markup commands wrongly.
481
482 WARN_IF_DOC_ERROR = YES
483
484 # This WARN_NO_PARAMDOC option can be abled to get warnings for
485 # functions that are documented, but have no documentation for their parameters
486 # or return value. If set to NO (the default) doxygen will only warn about
487 # wrong or incomplete parameter documentation, but not about the absence of
488 # documentation.
489
490 WARN_NO_PARAMDOC = NO
491
492 # The WARN_FORMAT tag determines the format of the warning messages that
493 # doxygen can produce. The string should contain the $file, $line, and $text
494 # tags, which will be replaced by the file and line number from which the
495 # warning originated and the warning text. Optionally the format may contain
496 # $version, which will be replaced by the version of the file (if it could
497 # be obtained via FILE_VERSION_FILTER)
498
499 WARN_FORMAT = "$file:$line: $text "
500
501 # The WARN_LOGFILE tag can be used to specify a file to which warning
502 # and error messages should be written. If left blank the output is written
503 # to stderr.
504
505 WARN_LOGFILE =
506
507 #---------------------------------------------------------------------------
508 # configuration options related to the input files
509 #---------------------------------------------------------------------------
510
511 # The INPUT tag can be used to specify the files and/or directories that contain
512 # documented source files. You may enter file names like "myfile.cpp" or
513 # directories like "/usr/src/myproject". Separate the files or directories
514 # with spaces.
515
516 INPUT = src
517
518 # This tag can be used to specify the character encoding of the source files
519 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
520 # also the default input encoding. Doxygen uses libiconv (or the iconv built
521 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
522 # the list of possible encodings.
523
524 INPUT_ENCODING = UTF-8
525
526 # If the value of the INPUT tag contains directories, you can use the
527 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
528 # and *.h) to filter out the source-files in the directories. If left
529 # blank the following patterns are tested:
530 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
531 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
532
533 FILE_PATTERNS = *.h \
534 *.c
535
536 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
537 # should be searched for input files as well. Possible values are YES and NO.
538 # If left blank NO is used.
539
540 RECURSIVE = YES
541
542 # The EXCLUDE tag can be used to specify files and/or directories that should
543 # excluded from the INPUT source files. This way you can easily exclude a
544 # subdirectory from a directory tree whose root is specified with the INPUT tag.
545
546 EXCLUDE =
547
548 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
549 # directories that are symbolic links (a Unix filesystem feature) are excluded
550 # from the input.
551
552 EXCLUDE_SYMLINKS = NO
553
554 # If the value of the INPUT tag contains directories, you can use the
555 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
556 # certain files from those directories. Note that the wildcards are matched
557 # against the file with absolute path, so to exclude all test directories
558 # for example use the pattern */test/*
559
560 EXCLUDE_PATTERNS =
561
562 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
563 # (namespaces, classes, functions, etc.) that should be excluded from the
564 # output. The symbol name can be a fully qualified name, a word, or if the
565 # wildcard * is used, a substring. Examples: ANamespace, AClass,
566 # AClass::ANamespace, ANamespace::*Test
567
568 EXCLUDE_SYMBOLS =
569
570 # The EXAMPLE_PATH tag can be used to specify one or more files or
571 # directories that contain example code fragments that are included (see
572 # the \include command).
573
574 EXAMPLE_PATH =
575
576 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
577 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
578 # and *.h) to filter out the source-files in the directories. If left
579 # blank all files are included.
580
581 EXAMPLE_PATTERNS =
582
583 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
584 # searched for input files to be used with the \include or \dontinclude
585 # commands irrespective of the value of the RECURSIVE tag.
586 # Possible values are YES and NO. If left blank NO is used.
587
588 EXAMPLE_RECURSIVE = NO
589
590 # The IMAGE_PATH tag can be used to specify one or more files or
591 # directories that contain image that are included in the documentation (see
592 # the \image command).
593
594 IMAGE_PATH =
595
596 # The INPUT_FILTER tag can be used to specify a program that doxygen should
597 # invoke to filter for each input file. Doxygen will invoke the filter program
598 # by executing (via popen()) the command <filter> <input-file>, where <filter>
599 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
600 # input file. Doxygen will then use the output that the filter program writes
601 # to standard output. If FILTER_PATTERNS is specified, this tag will be
602 # ignored.
603
604 INPUT_FILTER =
605
606 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
607 # basis. Doxygen will compare the file name with each pattern and apply the
608 # filter if there is a match. The filters are a list of the form:
609 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
610 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
611 # is applied to all files.
612
613 FILTER_PATTERNS =
614
615 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
616 # INPUT_FILTER) will be used to filter the input files when producing source
617 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
618
619 FILTER_SOURCE_FILES = NO
620
621 #---------------------------------------------------------------------------
622 # configuration options related to source browsing
623 #---------------------------------------------------------------------------
624
625 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
626 # be generated. Documented entities will be cross-referenced with these sources.
627 # Note: To get rid of all source code in the generated output, make sure also
628 # VERBATIM_HEADERS is set to NO.
629
630 SOURCE_BROWSER = YES
631
632 # Setting the INLINE_SOURCES tag to YES will include the body
633 # of functions and classes directly in the documentation.
634
635 INLINE_SOURCES = YES
636
637 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
638 # doxygen to hide any special comment blocks from generated source code
639 # fragments. Normal C and C++ comments will always remain visible.
640
641 STRIP_CODE_COMMENTS = YES
642
643 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
644 # then for each documented function all documented
645 # functions referencing it will be listed.
646
647 REFERENCED_BY_RELATION = YES
648
649 # If the REFERENCES_RELATION tag is set to YES (the default)
650 # then for each documented function all documented entities
651 # called/used by that function will be listed.
652
653 REFERENCES_RELATION = YES
654
655 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
656 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
657 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
658 # link to the source code. Otherwise they will link to the documentstion.
659
660 REFERENCES_LINK_SOURCE = YES
661
662 # If the USE_HTAGS tag is set to YES then the references to source code
663 # will point to the HTML generated by the htags(1) tool instead of doxygen
664 # built-in source browser. The htags tool is part of GNU's global source
665 # tagging system (see http://www.gnu.org/software/global/global.html). You
666 # will need version 4.8.6 or higher.
667
668 USE_HTAGS = NO
669
670 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
671 # will generate a verbatim copy of the header file for each class for
672 # which an include is specified. Set to NO to disable this.
673
674 VERBATIM_HEADERS = YES
675
676 #---------------------------------------------------------------------------
677 # configuration options related to the alphabetical class index
678 #---------------------------------------------------------------------------
679
680 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
681 # of all compounds will be generated. Enable this if the project
682 # contains a lot of classes, structs, unions or interfaces.
683
684 ALPHABETICAL_INDEX = YES
685
686 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
687 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
688 # in which this list will be split (can be a number in the range [1..20])
689
690 COLS_IN_ALPHA_INDEX = 5
691
692 # In case all classes in a project start with a common prefix, all
693 # classes will be put under the same header in the alphabetical index.
694 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
695 # should be ignored while generating the index headers.
696
697 IGNORE_PREFIX =
698
699 #---------------------------------------------------------------------------
700 # configuration options related to the HTML output
701 #---------------------------------------------------------------------------
702
703 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
704 # generate HTML output.
705
706 GENERATE_HTML = YES
707
708 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
709 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
710 # put in front of it. If left blank `html' will be used as the default path.
711
712 HTML_OUTPUT = doxygen
713
714 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
715 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
716 # doxygen will generate files with .html extension.
717
718 HTML_FILE_EXTENSION = .html
719
720 # The HTML_HEADER tag can be used to specify a personal HTML header for
721 # each generated HTML page. If it is left blank doxygen will generate a
722 # standard header.
723
724 HTML_HEADER =
725
726 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
727 # each generated HTML page. If it is left blank doxygen will generate a
728 # standard footer.
729
730 HTML_FOOTER =
731
732 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
733 # style sheet that is used by each HTML page. It can be used to
734 # fine-tune the look of the HTML output. If the tag is left blank doxygen
735 # will generate a default style sheet. Note that doxygen will try to copy
736 # the style sheet file to the HTML output directory, so don't put your own
737 # stylesheet in the HTML output directory as well, or it will be erased!
738
739 HTML_STYLESHEET =
740
741 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
742 # files or namespaces will be aligned in HTML using tables. If set to
743 # NO a bullet list will be used.
744
745 HTML_ALIGN_MEMBERS = YES
746
747 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
748 # will be generated that can be used as input for tools like the
749 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
750 # of the generated HTML documentation.
751
752 GENERATE_HTMLHELP = NO
753
754 # If the GENERATE_DOCSET tag is set to YES, additional index files
755 # will be generated that can be used as input for Apple's Xcode 3
756 # integrated development environment, introduced with OSX 10.5 (Leopard).
757 # To create a documentation set, doxygen will generate a Makefile in the
758 # HTML output directory. Running make will produce the docset in that
759 # directory and running "make install" will install the docset in
760 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
761 # it at startup.
762
763 GENERATE_DOCSET = NO
764
765 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
766 # feed. A documentation feed provides an umbrella under which multiple
767 # documentation sets from a single provider (such as a company or product suite)
768 # can be grouped.
769
770 DOCSET_FEEDNAME = "Doxygen generated docs"
771
772 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
773 # should uniquely identify the documentation set bundle. This should be a
774 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
775 # will append .docset to the name.
776
777 DOCSET_BUNDLE_ID = org.doxygen.Project
778
779 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
780 # documentation will contain sections that can be hidden and shown after the
781 # page has loaded. For this to work a browser that supports
782 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
783 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
784
785 HTML_DYNAMIC_SECTIONS = NO
786
787 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
788 # be used to specify the file name of the resulting .chm file. You
789 # can add a path in front of the file if the result should not be
790 # written to the html output directory.
791
792 CHM_FILE =
793
794 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
795 # be used to specify the location (absolute path including file name) of
796 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
797 # the HTML help compiler on the generated index.hhp.
798
799 HHC_LOCATION =
800
801 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
802 # controls if a separate .chi index file is generated (YES) or that
803 # it should be included in the master .chm file (NO).
804
805 GENERATE_CHI = NO
806
807 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
808 # controls whether a binary table of contents is generated (YES) or a
809 # normal table of contents (NO) in the .chm file.
810
811 BINARY_TOC = NO
812
813 # The TOC_EXPAND flag can be set to YES to add extra items for group members
814 # to the contents of the HTML help documentation and to the tree view.
815
816 TOC_EXPAND = NO
817
818 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
819 # top of each HTML page. The value NO (the default) enables the index and
820 # the value YES disables it.
821
822 DISABLE_INDEX = NO
823
824 # This tag can be used to set the number of enum values (range [1..20])
825 # that doxygen will group on one line in the generated HTML documentation.
826
827 ENUM_VALUES_PER_LINE = 4
828
829 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
830 # generated containing a tree-like index structure (just like the one that
831 # is generated for HTML Help). For this to work a browser that supports
832 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
833 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
834 # probably better off using the HTML help feature.
835
836 GENERATE_TREEVIEW = YES
837
838 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
839 # used to set the initial width (in pixels) of the frame in which the tree
840 # is shown.
841
842 TREEVIEW_WIDTH = 250
843
844 #---------------------------------------------------------------------------
845 # configuration options related to the LaTeX output
846 #---------------------------------------------------------------------------
847
848 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
849 # generate Latex output.
850
851 GENERATE_LATEX = NO
852
853 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
854 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
855 # put in front of it. If left blank `latex' will be used as the default path.
856
857 LATEX_OUTPUT = latex
858
859 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
860 # invoked. If left blank `latex' will be used as the default command name.
861
862 LATEX_CMD_NAME = latex
863
864 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
865 # generate index for LaTeX. If left blank `makeindex' will be used as the
866 # default command name.
867
868 MAKEINDEX_CMD_NAME = makeindex
869
870 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
871 # LaTeX documents. This may be useful for small projects and may help to
872 # save some trees in general.
873
874 COMPACT_LATEX = NO
875
876 # The PAPER_TYPE tag can be used to set the paper type that is used
877 # by the printer. Possible values are: a4, a4wide, letter, legal and
878 # executive. If left blank a4wide will be used.
879
880 PAPER_TYPE = a4wide
881
882 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
883 # packages that should be included in the LaTeX output.
884
885 EXTRA_PACKAGES =
886
887 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
888 # the generated latex document. The header should contain everything until
889 # the first chapter. If it is left blank doxygen will generate a
890 # standard header. Notice: only use this tag if you know what you are doing!
891
892 LATEX_HEADER =
893
894 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
895 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
896 # contain links (just like the HTML output) instead of page references
897 # This makes the output suitable for online browsing using a pdf viewer.
898
899 PDF_HYPERLINKS = NO
900
901 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
902 # plain latex in the generated Makefile. Set this option to YES to get a
903 # higher quality PDF documentation.
904
905 USE_PDFLATEX = NO
906
907 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
908 # command to the generated LaTeX files. This will instruct LaTeX to keep
909 # running if errors occur, instead of asking the user for help.
910 # This option is also used when generating formulas in HTML.
911
912 LATEX_BATCHMODE = NO
913
914 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
915 # include the index chapters (such as File Index, Compound Index, etc.)
916 # in the output.
917
918 LATEX_HIDE_INDICES = NO
919
920 #---------------------------------------------------------------------------
921 # configuration options related to the RTF output
922 #---------------------------------------------------------------------------
923
924 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
925 # The RTF output is optimized for Word 97 and may not look very pretty with
926 # other RTF readers or editors.
927
928 GENERATE_RTF = NO
929
930 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
931 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
932 # put in front of it. If left blank `rtf' will be used as the default path.
933
934 RTF_OUTPUT = rtf
935
936 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
937 # RTF documents. This may be useful for small projects and may help to
938 # save some trees in general.
939
940 COMPACT_RTF = NO
941
942 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
943 # will contain hyperlink fields. The RTF file will
944 # contain links (just like the HTML output) instead of page references.
945 # This makes the output suitable for online browsing using WORD or other
946 # programs which support those fields.
947 # Note: wordpad (write) and others do not support links.
948
949 RTF_HYPERLINKS = NO
950
951 # Load stylesheet definitions from file. Syntax is similar to doxygen's
952 # config file, i.e. a series of assignments. You only have to provide
953 # replacements, missing definitions are set to their default value.
954
955 RTF_STYLESHEET_FILE =
956
957 # Set optional variables used in the generation of an rtf document.
958 # Syntax is similar to doxygen's config file.
959
960 RTF_EXTENSIONS_FILE =
961
962 #---------------------------------------------------------------------------
963 # configuration options related to the man page output
964 #---------------------------------------------------------------------------
965
966 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
967 # generate man pages
968
969 GENERATE_MAN = NO
970
971 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
972 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
973 # put in front of it. If left blank `man' will be used as the default path.
974
975 MAN_OUTPUT = man
976
977 # The MAN_EXTENSION tag determines the extension that is added to
978 # the generated man pages (default is the subroutine's section .3)
979
980 MAN_EXTENSION = .3
981
982 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
983 # then it will generate one additional man file for each entity
984 # documented in the real man page(s). These additional files
985 # only source the real man page, but without them the man command
986 # would be unable to find the correct page. The default is NO.
987
988 MAN_LINKS = NO
989
990 #---------------------------------------------------------------------------
991 # configuration options related to the XML output
992 #---------------------------------------------------------------------------
993
994 # If the GENERATE_XML tag is set to YES Doxygen will
995 # generate an XML file that captures the structure of
996 # the code including all documentation.
997
998 GENERATE_XML = NO
999
1000 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1001 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1002 # put in front of it. If left blank `xml' will be used as the default path.
1003
1004 XML_OUTPUT = xml
1005
1006 # The XML_SCHEMA tag can be used to specify an XML schema,
1007 # which can be used by a validating XML parser to check the
1008 # syntax of the XML files.
1009
1010 XML_SCHEMA =
1011
1012 # The XML_DTD tag can be used to specify an XML DTD,
1013 # which can be used by a validating XML parser to check the
1014 # syntax of the XML files.
1015
1016 XML_DTD =
1017
1018 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1019 # dump the program listings (including syntax highlighting
1020 # and cross-referencing information) to the XML output. Note that
1021 # enabling this will significantly increase the size of the XML output.
1022
1023 XML_PROGRAMLISTING = YES
1024
1025 #---------------------------------------------------------------------------
1026 # configuration options for the AutoGen Definitions output
1027 #---------------------------------------------------------------------------
1028
1029 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1030 # generate an AutoGen Definitions (see autogen.sf.net) file
1031 # that captures the structure of the code including all
1032 # documentation. Note that this feature is still experimental
1033 # and incomplete at the moment.
1034
1035 GENERATE_AUTOGEN_DEF = NO
1036
1037 #---------------------------------------------------------------------------
1038 # configuration options related to the Perl module output
1039 #---------------------------------------------------------------------------
1040
1041 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1042 # generate a Perl module file that captures the structure of
1043 # the code including all documentation. Note that this
1044 # feature is still experimental and incomplete at the
1045 # moment.
1046
1047 GENERATE_PERLMOD = NO
1048
1049 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1050 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1051 # to generate PDF and DVI output from the Perl module output.
1052
1053 PERLMOD_LATEX = NO
1054
1055 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1056 # nicely formatted so it can be parsed by a human reader. This is useful
1057 # if you want to understand what is going on. On the other hand, if this
1058 # tag is set to NO the size of the Perl module output will be much smaller
1059 # and Perl will parse it just the same.
1060
1061 PERLMOD_PRETTY = YES
1062
1063 # The names of the make variables in the generated doxyrules.make file
1064 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1065 # This is useful so different doxyrules.make files included by the same
1066 # Makefile don't overwrite each other's variables.
1067
1068 PERLMOD_MAKEVAR_PREFIX =
1069
1070 #---------------------------------------------------------------------------
1071 # Configuration options related to the preprocessor
1072 #---------------------------------------------------------------------------
1073
1074 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1075 # evaluate all C-preprocessor directives found in the sources and include
1076 # files.
1077
1078 ENABLE_PREPROCESSING = YES
1079
1080 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1081 # names in the source code. If set to NO (the default) only conditional
1082 # compilation will be performed. Macro expansion can be done in a controlled
1083 # way by setting EXPAND_ONLY_PREDEF to YES.
1084
1085 MACRO_EXPANSION = NO
1086
1087 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1088 # then the macro expansion is limited to the macros specified with the
1089 # PREDEFINED and EXPAND_AS_DEFINED tags.
1090
1091 EXPAND_ONLY_PREDEF = NO
1092
1093 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1094 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1095
1096 SEARCH_INCLUDES = YES
1097
1098 # The INCLUDE_PATH tag can be used to specify one or more directories that
1099 # contain include files that are not input files but should be processed by
1100 # the preprocessor.
1101
1102 INCLUDE_PATH = src/target \
1103 src/pld \
1104 src/xsvf \
1105 src/jtag \
1106 src/flash \
1107 src/flash/at91sam7x \
1108 src/helper \
1109 src/server
1110
1111 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1112 # patterns (like *.h and *.hpp) to filter out the header-files in the
1113 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1114 # be used.
1115
1116 INCLUDE_FILE_PATTERNS = *.h
1117
1118 # The PREDEFINED tag can be used to specify one or more macro names that
1119 # are defined before the preprocessor is started (similar to the -D option of
1120 # gcc). The argument of the tag is a list of macros of the form: name
1121 # or name=definition (no spaces). If the definition and the = are
1122 # omitted =1 is assumed. To prevent a macro definition from being
1123 # undefined via #undef or recursively expanded use the := operator
1124 # instead of the = operator.
1125
1126 PREDEFINED =
1127
1128 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1129 # this tag can be used to specify a list of macro names that should be expanded.
1130 # The macro definition that is found in the sources will be used.
1131 # Use the PREDEFINED tag if you want to use a different macro definition.
1132
1133 EXPAND_AS_DEFINED =
1134
1135 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1136 # doxygen's preprocessor will remove all function-like macros that are alone
1137 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1138 # function macros are typically used for boiler-plate code, and will confuse
1139 # the parser if not removed.
1140
1141 SKIP_FUNCTION_MACROS = YES
1142
1143 #---------------------------------------------------------------------------
1144 # Configuration::additions related to external references
1145 #---------------------------------------------------------------------------
1146
1147 # The TAGFILES option can be used to specify one or more tagfiles.
1148 # Optionally an initial location of the external documentation
1149 # can be added for each tagfile. The format of a tag file without
1150 # this location is as follows:
1151 # TAGFILES = file1 file2 ...
1152 # Adding location for the tag files is done as follows:
1153 # TAGFILES = file1=loc1 "file2 = loc2" ...
1154 # where "loc1" and "loc2" can be relative or absolute paths or
1155 # URLs. If a location is present for each tag, the installdox tool
1156 # does not have to be run to correct the links.
1157 # Note that each tag file must have a unique name
1158 # (where the name does NOT include the path)
1159 # If a tag file is not located in the directory in which doxygen
1160 # is run, you must also specify the path to the tagfile here.
1161
1162 TAGFILES =
1163
1164 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1165 # a tag file that is based on the input files it reads.
1166
1167 GENERATE_TAGFILE =
1168
1169 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1170 # in the class index. If set to NO only the inherited external classes
1171 # will be listed.
1172
1173 ALLEXTERNALS = NO
1174
1175 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1176 # in the modules index. If set to NO, only the current project's groups will
1177 # be listed.
1178
1179 EXTERNAL_GROUPS = YES
1180
1181 # The PERL_PATH should be the absolute path and name of the perl script
1182 # interpreter (i.e. the result of `which perl').
1183
1184 PERL_PATH = /usr/bin/perl
1185
1186 #---------------------------------------------------------------------------
1187 # Configuration options related to the dot tool
1188 #---------------------------------------------------------------------------
1189
1190 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1191 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1192 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1193 # this option is superseded by the HAVE_DOT option below. This is only a
1194 # fallback. It is recommended to install and use dot, since it yields more
1195 # powerful graphs.
1196
1197 CLASS_DIAGRAMS = YES
1198
1199 # You can define message sequence charts within doxygen comments using the \msc
1200 # command. Doxygen will then run the mscgen tool (see
1201 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1202 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1203 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1204 # default search path.
1205
1206 MSCGEN_PATH =
1207
1208 # If set to YES, the inheritance and collaboration graphs will hide
1209 # inheritance and usage relations if the target is undocumented
1210 # or is not a class.
1211
1212 HIDE_UNDOC_RELATIONS = YES
1213
1214 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1215 # available from the path. This tool is part of Graphviz, a graph visualization
1216 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1217 # have no effect if this option is set to NO (the default)
1218
1219 HAVE_DOT = NO
1220
1221 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1222 # will generate a graph for each documented class showing the direct and
1223 # indirect inheritance relations. Setting this tag to YES will force the
1224 # the CLASS_DIAGRAMS tag to NO.
1225
1226 CLASS_GRAPH = YES
1227
1228 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1229 # will generate a graph for each documented class showing the direct and
1230 # indirect implementation dependencies (inheritance, containment, and
1231 # class references variables) of the class with other documented classes.
1232
1233 COLLABORATION_GRAPH = YES
1234
1235 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1236 # will generate a graph for groups, showing the direct groups dependencies
1237
1238 GROUP_GRAPHS = YES
1239
1240 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1241 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1242 # Language.
1243
1244 UML_LOOK = NO
1245
1246 # If set to YES, the inheritance and collaboration graphs will show the
1247 # relations between templates and their instances.
1248
1249 TEMPLATE_RELATIONS = YES
1250
1251 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1252 # tags are set to YES then doxygen will generate a graph for each documented
1253 # file showing the direct and indirect include dependencies of the file with
1254 # other documented files.
1255
1256 INCLUDE_GRAPH = YES
1257
1258 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1259 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1260 # documented header file showing the documented files that directly or
1261 # indirectly include this file.
1262
1263 INCLUDED_BY_GRAPH = YES
1264
1265 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1266 # doxygen will generate a call dependency graph for every global function
1267 # or class method. Note that enabling this option will significantly increase
1268 # the time of a run. So in most cases it will be better to enable call graphs
1269 # for selected functions only using the \callgraph command.
1270
1271 CALL_GRAPH = NO
1272
1273 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1274 # doxygen will generate a caller dependency graph for every global function
1275 # or class method. Note that enabling this option will significantly increase
1276 # the time of a run. So in most cases it will be better to enable caller
1277 # graphs for selected functions only using the \callergraph command.
1278
1279 CALLER_GRAPH = NO
1280
1281 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1282 # will graphical hierarchy of all classes instead of a textual one.
1283
1284 GRAPHICAL_HIERARCHY = YES
1285
1286 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1287 # then doxygen will show the dependencies a directory has on other directories
1288 # in a graphical way. The dependency relations are determined by the #include
1289 # relations between the files in the directories.
1290
1291 DIRECTORY_GRAPH = YES
1292
1293 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1294 # generated by dot. Possible values are png, jpg, or gif
1295 # If left blank png will be used.
1296
1297 DOT_IMAGE_FORMAT = png
1298
1299 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1300 # found. If left blank, it is assumed the dot tool can be found in the path.
1301
1302 DOT_PATH =
1303
1304 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1305 # contain dot files that are included in the documentation (see the
1306 # \dotfile command).
1307
1308 DOTFILE_DIRS =
1309
1310 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1311 # nodes that will be shown in the graph. If the number of nodes in a graph
1312 # becomes larger than this value, doxygen will truncate the graph, which is
1313 # visualized by representing a node as a red box. Note that doxygen if the
1314 # number of direct children of the root node in a graph is already larger than
1315 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1316 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1317
1318 DOT_GRAPH_MAX_NODES = 50
1319
1320 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1321 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1322 # from the root by following a path via at most 3 edges will be shown. Nodes
1323 # that lay further from the root node will be omitted. Note that setting this
1324 # option to 1 or 2 may greatly reduce the computation time needed for large
1325 # code bases. Also note that the size of a graph can be further restricted by
1326 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1327
1328 MAX_DOT_GRAPH_DEPTH = 0
1329
1330 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1331 # background. This is enabled by default, which results in a transparent
1332 # background. Warning: Depending on the platform used, enabling this option
1333 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1334 # become hard to read).
1335
1336 DOT_TRANSPARENT = NO
1337
1338 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1339 # files in one run (i.e. multiple -o and -T options on the command line). This
1340 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1341 # support this, this feature is disabled by default.
1342
1343 DOT_MULTI_TARGETS = NO
1344
1345 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1346 # generate a legend page explaining the meaning of the various boxes and
1347 # arrows in the dot generated graphs.
1348
1349 GENERATE_LEGEND = YES
1350
1351 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1352 # remove the intermediate dot files that are used to generate
1353 # the various graphs.
1354
1355 DOT_CLEANUP = YES
1356
1357 #---------------------------------------------------------------------------
1358 # Configuration::additions related to the search engine
1359 #---------------------------------------------------------------------------
1360
1361 # The SEARCHENGINE tag specifies whether or not a search engine should be
1362 # used. If set to NO the values of all tags below this one will be ignored.
1363
1364 SEARCHENGINE = NO

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)