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