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