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