blob: 8fbe34e10b87e0e40d5572f1f41e39469e8ae7de [file] [log] [blame]
Shad Ansari2f7f9be2017-06-07 13:34:53 -07001# Doxyfile 1.8.2
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project.
5#
6# All text after a hash (#) is considered a comment and will be ignored.
7# The format is:
8# TAG = value [value, ...]
9# For lists items can also be appended using:
10# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ").
12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
16
17# This tag specifies the encoding used for all characters in the config file
18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING = UTF-8
24
25# The PROJECT_NAME tag is a single word (or sequence of words) that should
26# identify the project. Note that if you do not use Doxywizard you need
27# to put quotes around the project name if it contains spaces.
28
29PROJECT_NAME = "Broadband Adaption Layer"
30
31# The PROJECT_NUMBER tag can be used to enter a project or revision number.
32# This could be handy for archiving the generated documentation or
33# if some version control system is used.
34
35PROJECT_NUMBER = %PROJECT_NUMBER
36
37# Using the PROJECT_BRIEF tag one can provide an optional one line description
38# for a project that appears at the top of each page and should give viewer
39# a quick idea about the purpose of the project. Keep the description short.
40
41PROJECT_BRIEF =
42
43# With the PROJECT_LOGO tag one can specify an logo or icon that is
44# included in the documentation. The maximum height of the logo should not
45# exceed 55 pixels and the maximum width should not exceed 200 pixels.
46# Doxygen will copy the logo to the output directory.
47
48PROJECT_LOGO = "%SRC_DIR/../doxygen/broadcom.png"
49
50# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51# base path where the generated documentation will be put.
52# If a relative path is entered, it will be relative to the location
53# where doxygen was started. If left blank the current directory will be used.
54
55OUTPUT_DIRECTORY = %OUT_DOCS_DIR
56
57# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58# 4096 sub-directories (in 2 levels) under the output directory of each output
59# format and will distribute the generated files over these directories.
60# Enabling this option can be useful when feeding doxygen a huge amount of
61# source files, where putting all generated files in the same directory would
62# otherwise cause performance problems for the file system.
63
64CREATE_SUBDIRS = NO
65
66# The OUTPUT_LANGUAGE tag is used to specify the language in which all
67# documentation generated by doxygen is written. Doxygen will use this
68# information to generate all constant output in the proper language.
69# The default language is English, other supported languages are:
70# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76
77OUTPUT_LANGUAGE = English
78
79# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80# include brief member descriptions after the members that are listed in
81# the file and class documentation (similar to JavaDoc).
82# Set to NO to disable this.
83
84BRIEF_MEMBER_DESC = YES
85
86# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87# the brief description of a member or function before the detailed description.
88# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
89# brief descriptions will be completely suppressed.
90
91REPEAT_BRIEF = YES
92
93# This tag implements a quasi-intelligent brief description abbreviator
94# that is used to form the text in various listings. Each string
95# in this list, if found as the leading text of the brief description, will be
96# stripped from the text and the result after processing the whole list, is
97# used as the annotated text. Otherwise, the brief description is used as-is.
98# If left blank, the following values are used ("$name" is automatically
99# replaced with the name of the entity): "The $name class" "The $name widget"
100# "The $name file" "is" "provides" "specifies" "contains"
101# "represents" "a" "an" "the"
102
103ABBREVIATE_BRIEF =
104
105# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
106# Doxygen will generate a detailed section even if there is only a brief
107# description.
108
109ALWAYS_DETAILED_SEC = NO
110
111# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
112# inherited members of a class in the documentation of that class as if those
113# members were ordinary class members. Constructors, destructors and assignment
114# operators of the base classes will not be shown.
115
116INLINE_INHERITED_MEMB = NO
117
118# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
119# path before files name in the file list and in the header files. If set
120# to NO the shortest path that makes the file name unique will be used.
121
122FULL_PATH_NAMES = NO
123
124# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
125# can be used to strip a user-defined part of the path. Stripping is
126# only done if one of the specified strings matches the left-hand part of
127# the path. The tag can be used to show relative paths in the file list.
128# If left blank the directory from which doxygen is run is used as the
129# path to strip. Note that you specify absolute paths here, but also
130# relative paths, which will be relative from the directory where doxygen is
131# started.
132
133STRIP_FROM_PATH =
134
135# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
136# the path mentioned in the documentation of a class, which tells
137# the reader which header file to include in order to use a class.
138# If left blank only the name of the header file containing the class
139# definition is used. Otherwise one should specify the include paths that
140# are normally passed to the compiler using the -I flag.
141
142STRIP_FROM_INC_PATH =
143
144# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
145# (but less readable) file names. This can be useful if your file system
146# doesn't support long names like on DOS, Mac, or CD-ROM.
147
148SHORT_NAMES = NO
149
150# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
151# will interpret the first line (until the first dot) of a JavaDoc-style
152# comment as the brief description. If set to NO, the JavaDoc
153# comments will behave just like regular Qt-style comments
154# (thus requiring an explicit @brief command for a brief description.)
155
156JAVADOC_AUTOBRIEF = YES
157
158# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
159# interpret the first line (until the first dot) of a Qt-style
160# comment as the brief description. If set to NO, the comments
161# will behave just like regular Qt-style comments (thus requiring
162# an explicit \brief command for a brief description.)
163
164QT_AUTOBRIEF = NO
165
166# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
167# treat a multi-line C++ special comment block (i.e. a block of //! or ///
168# comments) as a brief description. This used to be the default behaviour.
169# The new default is to treat a multi-line C++ comment block as a detailed
170# description. Set this tag to YES if you prefer the old behaviour instead.
171
172MULTILINE_CPP_IS_BRIEF = NO
173
174# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
175# member inherits the documentation from any documented member that it
176# re-implements.
177
178INHERIT_DOCS = YES
179
180# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
181# a new page for each member. If set to NO, the documentation of a member will
182# be part of the file/class/namespace that contains it.
183
184SEPARATE_MEMBER_PAGES = NO
185
186# The TAB_SIZE tag can be used to set the number of spaces in a tab.
187# Doxygen uses this value to replace tabs by spaces in code fragments.
188
189TAB_SIZE = 4
190
191# This tag can be used to specify a number of aliases that acts
192# as commands in the documentation. An alias has the form "name=value".
193# For example adding "sideeffect=\par Side Effects:\n" will allow you to
194# put the command \sideeffect (or @sideeffect) in the documentation, which
195# will result in a user-defined paragraph with heading "Side Effects:".
196# You can put \n's in the value part of an alias to insert newlines.
197
198ALIASES = "TABLE_HDR2{2}=<tr><th>\1</th><th>\2</th></tr>" \
199 "TABLE_ROW2{2}=<tr><td>\1</td><td>\2</td></tr>" \
200 "TABLE_HDR3{3}=<tr><th>\1</th><th>\2</th><th>\3</th></tr>" \
201 "TABLE_ROW3{3}=<tr><td>\1</td><td>\2</td><td>\3</td></tr>" \
202 "TABLE_HDR4{4}=<tr><th>\1</th><th>\2</th><th>\3</th><th>\4</th></tr>" \
203 "TABLE_ROW4{4}=<tr><td>\1</td><td>\2</td><td>\3</td><td>\4</td></tr>" \
204 "TABLE_HDR5{5}=<tr><th>\1</th><th>\2</th><th>\3</th><th>\4</th><th>\5</th></tr>" \
205 "TABLE_ROW5{5}=<tr><td>\1</td><td>\2</td><td>\3</td><td>\4</td><td>\5</td></tr>" \
206 "TABLE_HDR6{6}=<tr><th>\1</th><th>\2</th><th>\3</th><th>\4</th><th>\5</th><th>\6</th></tr>" \
207 "TABLE_ROW6{6}=<tr><td>\1</td><td>\2</td><td>\3</td><td>\4</td><td>\5</td><td>\6</td></tr>" \
208 "TABLE_HDR7{7}=<tr><th>\1</th><th>\2</th><th>\3</th><th>\4</th><th>\5</th><th>\6</th><th>\7</th></tr>" \
209 "TABLE_ROW7{7}=<tr><td>\1</td><td>\2</td><td>\3</td><td>\4</td><td>\5</td><td>\6</td><td>\7</td></tr>"
210
211# This tag can be used to specify a number of word-keyword mappings (TCL only).
212# A mapping has the form "name=value". For example adding
213# "class=itcl::class" will allow you to use the command class in the
214# itcl::class meaning.
215
216TCL_SUBST =
217
218# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
219# sources only. Doxygen will then generate output that is more tailored for C.
220# For instance, some of the names that are used will be different. The list
221# of all members will be omitted, etc.
222
223OPTIMIZE_OUTPUT_FOR_C = YES
224
225# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
226# sources only. Doxygen will then generate output that is more tailored for
227# Java. For instance, namespaces will be presented as packages, qualified
228# scopes will look different, etc.
229
230OPTIMIZE_OUTPUT_JAVA = NO
231
232# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
233# sources only. Doxygen will then generate output that is more tailored for
234# Fortran.
235
236OPTIMIZE_FOR_FORTRAN = NO
237
238# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
239# sources. Doxygen will then generate output that is tailored for
240# VHDL.
241
242OPTIMIZE_OUTPUT_VHDL = NO
243
244# Doxygen selects the parser to use depending on the extension of the files it
245# parses. With this tag you can assign which parser to use for a given
246# extension. Doxygen has a built-in mapping, but you can override or extend it
247# using this tag. The format is ext=language, where ext is a file extension,
248# and language is one of the parsers supported by doxygen: IDL, Java,
249# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
250# C++. For instance to make doxygen treat .inc files as Fortran files (default
251# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
252# that for custom extensions you also need to set FILE_PATTERNS otherwise the
253# files are not read by doxygen.
254
255EXTENSION_MAPPING =
256
257# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
258# comments according to the Markdown format, which allows for more readable
259# documentation. See http://daringfireball.net/projects/markdown/ for details.
260# The output of markdown processing is further processed by doxygen, so you
261# can mix doxygen, HTML, and XML commands with Markdown formatting.
262# Disable only in case of backward compatibilities issues.
263
264MARKDOWN_SUPPORT = YES
265
266# When enabled doxygen tries to link words that correspond to documented classes,
267# or namespaces to their corresponding documentation. Such a link can be
268# prevented in individual cases by by putting a % sign in front of the word or
269# globally by setting AUTOLINK_SUPPORT to NO.
270
271AUTOLINK_SUPPORT = YES
272
273# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
274# to include (a tag file for) the STL sources as input, then you should
275# set this tag to YES in order to let doxygen match functions declarations and
276# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
277# func(std::string) {}). This also makes the inheritance and collaboration
278# diagrams that involve STL classes more complete and accurate.
279
280BUILTIN_STL_SUPPORT = NO
281
282# If you use Microsoft's C++/CLI language, you should set this option to YES to
283# enable parsing support.
284
285CPP_CLI_SUPPORT = NO
286
287# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
288# Doxygen will parse them like normal C++ but will assume all classes use public
289# instead of private inheritance when no explicit protection keyword is present.
290
291SIP_SUPPORT = NO
292
293# For Microsoft's IDL there are propget and propput attributes to indicate getter and setter methods for a property. Setting this option to YES (the default) will make doxygen replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to NO.
294
295IDL_PROPERTY_SUPPORT = YES
296
297# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
298# tag is set to YES, then doxygen will reuse the documentation of the first
299# member in the group (if any) for the other members of the group. By default
300# all members of a group must be documented explicitly.
301
302DISTRIBUTE_GROUP_DOC = NO
303
304# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
305# the same type (for instance a group of public functions) to be put as a
306# subgroup of that type (e.g. under the Public Functions section). Set it to
307# NO to prevent subgrouping. Alternatively, this can be done per class using
308# the \nosubgrouping command.
309
310SUBGROUPING = YES
311
312# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
313# unions are shown inside the group in which they are included (e.g. using
314# @ingroup) instead of on a separate page (for HTML and Man pages) or
315# section (for LaTeX and RTF).
316
317INLINE_GROUPED_CLASSES = NO
318
319# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
320# unions with only public data fields will be shown inline in the documentation
321# of the scope in which they are defined (i.e. file, namespace, or group
322# documentation), provided this scope is documented. If set to NO (the default),
323# structs, classes, and unions are shown on a separate page (for HTML and Man
324# pages) or section (for LaTeX and RTF).
325
326INLINE_SIMPLE_STRUCTS = NO
327
328# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
329# is documented as struct, union, or enum with the name of the typedef. So
330# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
331# with name TypeT. When disabled the typedef will appear as a member of a file,
332# namespace, or class. And the struct will be named TypeS. This can typically
333# be useful for C code in case the coding convention dictates that all compound
334# types are typedef'ed and only the typedef is referenced, never the tag name.
335
336TYPEDEF_HIDES_STRUCT = NO
337
338# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
339# determine which symbols to keep in memory and which to flush to disk.
340# When the cache is full, less often used symbols will be written to disk.
341# For small to medium size projects (<1000 input files) the default value is
342# probably good enough. For larger projects a too small cache size can cause
343# doxygen to be busy swapping symbols to and from disk most of the time
344# causing a significant performance penalty.
345# If the system has enough physical memory increasing the cache will improve the
346# performance by keeping more symbols in memory. Note that the value works on
347# a logarithmic scale so increasing the size by one will roughly double the
348# memory usage. The cache size is given by this formula:
349# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
350# corresponding to a cache size of 2^16 = 65536 symbols.
351
352#SYMBOL_CACHE_SIZE = 0
353
354# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
355# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
356# their name and scope. Since this can be an expensive process and often the
357# same symbol appear multiple times in the code, doxygen keeps a cache of
358# pre-resolved symbols. If the cache is too small doxygen will become slower.
359# If the cache is too large, memory is wasted. The cache size is given by this
360# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
361# corresponding to a cache size of 2^16 = 65536 symbols.
362
363LOOKUP_CACHE_SIZE = 1
364
365#---------------------------------------------------------------------------
366# Build related configuration options
367#---------------------------------------------------------------------------
368
369# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
370# documentation are documented, even if no documentation was available.
371# Private class members and static file members will be hidden unless
372# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
373
374EXTRACT_ALL = NO
375
376# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
377# will be included in the documentation.
378
379EXTRACT_PRIVATE = NO
380
381# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
382# scope will be included in the documentation.
383
384EXTRACT_PACKAGE = NO
385
386# If the EXTRACT_STATIC tag is set to YES all static members of a file
387# will be included in the documentation.
388
389EXTRACT_STATIC = NO
390
391# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
392# defined locally in source files will be included in the documentation.
393# If set to NO only classes defined in header files are included.
394
395EXTRACT_LOCAL_CLASSES = NO
396
397# This flag is only useful for Objective-C code. When set to YES local
398# methods, which are defined in the implementation section but not in
399# the interface are included in the documentation.
400# If set to NO (the default) only methods in the interface are included.
401
402EXTRACT_LOCAL_METHODS = NO
403
404# If this flag is set to YES, the members of anonymous namespaces will be
405# extracted and appear in the documentation as a namespace called
406# 'anonymous_namespace{file}', where file will be replaced with the base
407# name of the file that contains the anonymous namespace. By default
408# anonymous namespaces are hidden.
409
410EXTRACT_ANON_NSPACES = NO
411
412# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
413# undocumented members of documented classes, files or namespaces.
414# If set to NO (the default) these members will be included in the
415# various overviews, but no documentation section is generated.
416# This option has no effect if EXTRACT_ALL is enabled.
417
418HIDE_UNDOC_MEMBERS = YES
419
420# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
421# undocumented classes that are normally visible in the class hierarchy.
422# If set to NO (the default) these classes will be included in the various
423# overviews. This option has no effect if EXTRACT_ALL is enabled.
424
425HIDE_UNDOC_CLASSES = YES
426
427# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
428# friend (class|struct|union) declarations.
429# If set to NO (the default) these declarations will be included in the
430# documentation.
431
432HIDE_FRIEND_COMPOUNDS = NO
433
434# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
435# documentation blocks found inside the body of a function.
436# If set to NO (the default) these blocks will be appended to the
437# function's detailed documentation block.
438
439HIDE_IN_BODY_DOCS = NO
440
441# The INTERNAL_DOCS tag determines if documentation
442# that is typed after a \internal command is included. If the tag is set
443# to NO (the default) then the documentation will be excluded.
444# Set it to YES to include the internal documentation.
445
446INTERNAL_DOCS = NO
447
448# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
449# file names in lower-case letters. If set to YES upper-case letters are also
450# allowed. This is useful if you have classes or files whose names only differ
451# in case and if your file system supports case sensitive file names. Windows
452# and Mac users are advised to set this option to NO.
453
454CASE_SENSE_NAMES = YES
455
456# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
457# will show members with their full class and namespace scopes in the
458# documentation. If set to YES the scope will be hidden.
459
460HIDE_SCOPE_NAMES = NO
461
462# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
463# will put a list of the files that are included by a file in the documentation
464# of that file.
465
466SHOW_INCLUDE_FILES = YES
467
468# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
469# will list include files with double quotes in the documentation
470# rather than with sharp brackets.
471
472FORCE_LOCAL_INCLUDES = NO
473
474# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
475# is inserted in the documentation for inline members.
476
477INLINE_INFO = YES
478
479# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
480# will sort the (detailed) documentation of file and class members
481# alphabetically by member name. If set to NO the members will appear in
482# declaration order.
483
484SORT_MEMBER_DOCS = NO
485
486# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
487# brief documentation of file, namespace and class members alphabetically
488# by member name. If set to NO (the default) the members will appear in
489# declaration order.
490
491SORT_BRIEF_DOCS = NO
492
493# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
494# will sort the (brief and detailed) documentation of class members so that
495# constructors and destructors are listed first. If set to NO (the default)
496# the constructors will appear in the respective orders defined by
497# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
498# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
499# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
500
501SORT_MEMBERS_CTORS_1ST = NO
502
503# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
504# hierarchy of group names into alphabetical order. If set to NO (the default)
505# the group names will appear in their defined order.
506
507SORT_GROUP_NAMES = NO
508
509# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
510# sorted by fully-qualified names, including namespaces. If set to
511# NO (the default), the class list will be sorted only by class name,
512# not including the namespace part.
513# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
514# Note: This option applies only to the class list, not to the
515# alphabetical list.
516
517SORT_BY_SCOPE_NAME = NO
518
519# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
520# do proper type resolution of all parameters of a function it will reject a
521# match between the prototype and the implementation of a member function even
522# if there is only one candidate or it is obvious which candidate to choose
523# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
524# will still accept a match between prototype and implementation in such cases.
525
526STRICT_PROTO_MATCHING = NO
527
528# The GENERATE_TODOLIST tag can be used to enable (YES) or
529# disable (NO) the todo list. This list is created by putting \todo
530# commands in the documentation.
531
532GENERATE_TODOLIST = NO
533
534# The GENERATE_TESTLIST tag can be used to enable (YES) or
535# disable (NO) the test list. This list is created by putting \test
536# commands in the documentation.
537
538GENERATE_TESTLIST = NO
539
540# The GENERATE_BUGLIST tag can be used to enable (YES) or
541# disable (NO) the bug list. This list is created by putting \bug
542# commands in the documentation.
543
544GENERATE_BUGLIST = YES
545
546# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
547# disable (NO) the deprecated list. This list is created by putting
548# \deprecated commands in the documentation.
549
550GENERATE_DEPRECATEDLIST= YES
551
552# The ENABLED_SECTIONS tag can be used to enable conditional
553# documentation sections, marked by \if sectionname ... \endif.
554
555ENABLED_SECTIONS =
556
557# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
558# the initial value of a variable or macro consists of for it to appear in
559# the documentation. If the initializer consists of more lines than specified
560# here it will be hidden. Use a value of 0 to hide initializers completely.
561# The appearance of the initializer of individual variables and macros in the
562# documentation can be controlled using \showinitializer or \hideinitializer
563# command in the documentation regardless of this setting.
564
565MAX_INITIALIZER_LINES = 30
566
567# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
568# at the bottom of the documentation of classes and structs. If set to YES the
569# list will mention the files that were used to generate the documentation.
570
571SHOW_USED_FILES = NO
572
573# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
574# This will remove the Files entry from the Quick Index and from the
575# Folder Tree View (if specified). The default is YES.
576
577SHOW_FILES = NO
578
579# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
580# Namespaces page.
581# This will remove the Namespaces entry from the Quick Index
582# and from the Folder Tree View (if specified). The default is YES.
583
584SHOW_NAMESPACES = YES
585
586# The FILE_VERSION_FILTER tag can be used to specify a program or script that
587# doxygen should invoke to get the current version for each file (typically from
588# the version control system). Doxygen will invoke the program by executing (via
589# popen()) the command <command> <input-file>, where <command> is the value of
590# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
591# provided by doxygen. Whatever the program writes to standard output
592# is used as the file version. See the manual for examples.
593
594FILE_VERSION_FILTER =
595
596# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
597# by doxygen. The layout file controls the global structure of the generated
598# output files in an output format independent way. To create the layout file
599# that represents doxygen's defaults, run doxygen with the -l option.
600# You can optionally specify a file name after the option, if omitted
601# DoxygenLayout.xml will be used as the name of the layout file.
602
603LAYOUT_FILE = %SRC_DIR/../doxygen/DoxygenLayout.xml
604
605
606# The CITE_BIB_FILES tag can be used to specify one or more bib files
607# containing the references data. This must be a list of .bib files. The
608# .bib extension is automatically appended if omitted. Using this command
609# requires the bibtex tool to be installed. See also
610# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
611# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
612# feature you need bibtex and perl available in the search path.
613
614CITE_BIB_FILES =
615
616#---------------------------------------------------------------------------
617# configuration options related to warning and progress messages
618#---------------------------------------------------------------------------
619
620# The QUIET tag can be used to turn on/off the messages that are generated
621# by doxygen. Possible values are YES and NO. If left blank NO is used.
622
623QUIET = NO
624
625# The WARNINGS tag can be used to turn on/off the warning messages that are
626# generated by doxygen. Possible values are YES and NO. If left blank
627# NO is used.
628
629WARNINGS = YES
630
631# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
632# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
633# automatically be disabled.
634
635WARN_IF_UNDOCUMENTED = NO
636
637# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
638# potential errors in the documentation, such as not documenting some
639# parameters in a documented function, or documenting parameters that
640# don't exist or using markup commands wrongly.
641
642WARN_IF_DOC_ERROR = YES
643
644# The WARN_NO_PARAMDOC option can be enabled to get warnings for
645# functions that are documented, but have no documentation for their parameters
646# or return value. If set to NO (the default) doxygen will only warn about
647# wrong or incomplete parameter documentation, but not about the absence of
648# documentation.
649
650WARN_NO_PARAMDOC = YES
651
652# The WARN_FORMAT tag determines the format of the warning messages that
653# doxygen can produce. The string should contain the $file, $line, and $text
654# tags, which will be replaced by the file and line number from which the
655# warning originated and the warning text. Optionally the format may contain
656# $version, which will be replaced by the version of the file (if it could
657# be obtained via FILE_VERSION_FILTER)
658
659WARN_FORMAT = "$file:$line: $text"
660
661# The WARN_LOGFILE tag can be used to specify a file to which warning
662# and error messages should be written. If left blank the output is written
663# to stderr.
664
665WARN_LOGFILE =
666
667#---------------------------------------------------------------------------
668# configuration options related to the input files
669#---------------------------------------------------------------------------
670
671# The INPUT tag can be used to specify the files and/or directories that contain
672# documented source files. You may enter file names like "myfile.cpp" or
673# directories like "/usr/src/myproject". Separate the files or directories
674# with spaces.
675
676INPUT = %SRC_DIR/lib/libbalapi/bal_api.dox \
677 %SRC_DIR/lib/libbalapi/bal_api.h \
678 %MODEL_DIR/model.dox \
679 %SRC_DIR/common/include/bal_obj.h \
680 %SRC_DIR/common/include/bal_objs.h \
681 %MODEL_DIR/bal_model_ids.h \
682 %MODEL_DIR/bal_model_types.h
683
684# This tag can be used to specify the character encoding of the source files
685# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
686# also the default input encoding. Doxygen uses libiconv (or the iconv built
687# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
688# the list of possible encodings.
689
690INPUT_ENCODING = UTF-8
691
692# If the value of the INPUT tag contains directories, you can use the
693# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
694# and *.h) to filter out the source-files in the directories. If left
695# blank the following patterns are tested:
696# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
697# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
698# *.f90 *.f *.for *.vhd *.vhdl
699
700FILE_PATTERNS = *.c *.h *.cpp
701
702# The RECURSIVE tag can be used to turn specify whether or not subdirectories
703# should be searched for input files as well. Possible values are YES and NO.
704# If left blank NO is used.
705
706RECURSIVE = YES
707
708# The EXCLUDE tag can be used to specify files and/or directories that should be
709# excluded from the INPUT source files. This way you can easily exclude a
710# subdirectory from a directory tree whose root is specified with the INPUT tag.
711# Note that relative paths are relative to the directory from which doxygen is
712# run.
713
714EXCLUDE =
715
716# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
717# directories that are symbolic links (a Unix file system feature) are excluded
718# from the input.
719
720EXCLUDE_SYMLINKS = NO
721
722# If the value of the INPUT tag contains directories, you can use the
723# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
724# certain files from those directories. Note that the wildcards are matched
725# against the file with absolute path, so to exclude all test directories
726# for example use the pattern */test/*
727
728EXCLUDE_PATTERNS = */test/* \
729 *Examples*
730
731# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
732# (namespaces, classes, functions, etc.) that should be excluded from the
733# output. The symbol name can be a fully qualified name, a word, or if the
734# wildcard * is used, a substring. Examples: ANamespace, AClass,
735# AClass::ANamespace, ANamespace::*Test
736
737EXCLUDE_SYMBOLS =
738
739# The EXAMPLE_PATH tag can be used to specify one or more files or
740# directories that contain example code fragments that are included (see
741# the \include command).
742
743EXAMPLE_PATH =
744
745# If the value of the EXAMPLE_PATH tag contains directories, you can use the
746# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
747# and *.h) to filter out the source-files in the directories. If left
748# blank all files are included.
749
750EXAMPLE_PATTERNS =
751
752# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
753# searched for input files to be used with the \include or \dontinclude
754# commands irrespective of the value of the RECURSIVE tag.
755# Possible values are YES and NO. If left blank NO is used.
756
757EXAMPLE_RECURSIVE = NO
758
759# The IMAGE_PATH tag can be used to specify one or more files or
760# directories that contain image that are included in the documentation (see
761# the \image command).
762
763IMAGE_PATH =
764
765# The INPUT_FILTER tag can be used to specify a program that doxygen should
766# invoke to filter for each input file. Doxygen will invoke the filter program
767# by executing (via popen()) the command <filter> <input-file>, where <filter>
768# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
769# input file. Doxygen will then use the output that the filter program writes
770# to standard output.
771# If FILTER_PATTERNS is specified, this tag will be
772# ignored.
773
774INPUT_FILTER =
775
776# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
777# basis.
778# Doxygen will compare the file name with each pattern and apply the
779# filter if there is a match.
780# The filters are a list of the form:
781# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
782# info on how filters are used. If FILTER_PATTERNS is empty or if
783# non of the patterns match the file name, INPUT_FILTER is applied.
784
785FILTER_PATTERNS =
786
787# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
788# INPUT_FILTER) will be used to filter the input files when producing source
789# files to browse (i.e. when SOURCE_BROWSER is set to YES).
790
791FILTER_SOURCE_FILES = NO
792
793# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
794# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
795# and it is also possible to disable source filtering for a specific pattern
796# using *.ext= (so without naming a filter). This option only has effect when
797# FILTER_SOURCE_FILES is enabled.
798
799FILTER_SOURCE_PATTERNS =
800
801#---------------------------------------------------------------------------
802# configuration options related to source browsing
803#---------------------------------------------------------------------------
804
805# If the SOURCE_BROWSER tag is set to YES then a list of source files will
806# be generated. Documented entities will be cross-referenced with these sources.
807# Note: To get rid of all source code in the generated output, make sure also
808# VERBATIM_HEADERS is set to NO.
809
810SOURCE_BROWSER = NO
811
812# Setting the INLINE_SOURCES tag to YES will include the body
813# of functions and classes directly in the documentation.
814
815INLINE_SOURCES = NO
816
817# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
818# doxygen to hide any special comment blocks from generated source code
819# fragments. Normal C, C++ and Fortran comments will always remain visible.
820
821STRIP_CODE_COMMENTS = NO
822
823# If the REFERENCED_BY_RELATION tag is set to YES
824# then for each documented function all documented
825# functions referencing it will be listed.
826
827REFERENCED_BY_RELATION = NO
828
829# If the REFERENCES_RELATION tag is set to YES
830# then for each documented function all documented entities
831# called/used by that function will be listed.
832
833REFERENCES_RELATION = NO
834
835# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
836# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
837# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
838# link to the source code.
839# Otherwise they will link to the documentation.
840
841REFERENCES_LINK_SOURCE = YES
842
843# If the USE_HTAGS tag is set to YES then the references to source code
844# will point to the HTML generated by the htags(1) tool instead of doxygen
845# built-in source browser. The htags tool is part of GNU's global source
846# tagging system (see http://www.gnu.org/software/global/global.html). You
847# will need version 4.8.6 or higher.
848
849USE_HTAGS = NO
850
851# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
852# will generate a verbatim copy of the header file for each class for
853# which an include is specified. Set to NO to disable this.
854
855VERBATIM_HEADERS = NO
856
857#---------------------------------------------------------------------------
858# configuration options related to the alphabetical class index
859#---------------------------------------------------------------------------
860
861# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
862# of all compounds will be generated. Enable this if the project
863# contains a lot of classes, structs, unions or interfaces.
864
865ALPHABETICAL_INDEX = YES
866
867# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
868# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
869# in which this list will be split (can be a number in the range [1..20])
870
871COLS_IN_ALPHA_INDEX = 5
872
873# In case all classes in a project start with a common prefix, all
874# classes will be put under the same header in the alphabetical index.
875# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
876# should be ignored while generating the index headers.
877
878IGNORE_PREFIX =
879
880#---------------------------------------------------------------------------
881# configuration options related to the HTML output
882#---------------------------------------------------------------------------
883
884# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
885# generate HTML output.
886
887GENERATE_HTML = YES
888
889# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
890# If a relative path is entered the value of OUTPUT_DIRECTORY will be
891# put in front of it. If left blank `html' will be used as the default path.
892
893HTML_OUTPUT = html
894
895# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
896# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
897# doxygen will generate files with .html extension.
898
899HTML_FILE_EXTENSION = .html
900
901# The HTML_HEADER tag can be used to specify a personal HTML header for
902# each generated HTML page. If it is left blank doxygen will generate a
903# standard header. Note that when using a custom header you are responsible
904# for the proper inclusion of any scripts and style sheets that doxygen
905# needs, which is dependent on the configuration options used.
906# It is advised to generate a default header using "doxygen -w html
907# header.html footer.html stylesheet.css YourConfigFile" and then modify
908# that header. Note that the header is subject to change so you typically
909# have to redo this when upgrading to a newer version of doxygen or when
910# changing the value of configuration settings such as GENERATE_TREEVIEW!
911
912HTML_HEADER = %SRC_DIR/../doxygen/header.html
913
914# The HTML_FOOTER tag can be used to specify a personal HTML footer for
915# each generated HTML page. If it is left blank doxygen will generate a
916# standard footer.
917
918HTML_FOOTER = %SRC_DIR/../doxygen/footer.html
919
920# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
921# style sheet that is used by each HTML page. It can be used to
922# fine-tune the look of the HTML output. If left blank doxygen will
923# generate a default style sheet. Note that it is recommended to use
924# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
925# tag will in the future become obsolete.
926
927HTML_STYLESHEET =
928
929# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
930# user-defined cascading style sheet that is included after the standard
931# style sheets created by doxygen. Using this option one can overrule
932# certain style aspects. This is preferred over using HTML_STYLESHEET
933# since it does not replace the standard style sheet and is therefor more
934# robust against future updates. Doxygen will copy the style sheet file to
935# the output directory.
936
937HTML_EXTRA_STYLESHEET =
938
939# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
940# other source files which should be copied to the HTML output directory. Note
941# that these files will be copied to the base HTML output directory. Use the
942# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
943# files. In the HTML_STYLESHEET file, use the file name only. Also note that
944# the files will be copied as-is; there are no commands or markers available.
945
946HTML_EXTRA_FILES =
947
948# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
949# Doxygen will adjust the colors in the style sheet and background images
950# according to this color. Hue is specified as an angle on a colorwheel,
951# see http://en.wikipedia.org/wiki/Hue for more information.
952# For instance the value 0 represents red, 60 is yellow, 120 is green,
953# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
954# The allowed range is 0 to 359.
955
956HTML_COLORSTYLE_HUE = 220
957
958# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
959# the colors in the HTML output. For a value of 0 the output will use
960# grayscales only. A value of 255 will produce the most vivid colors.
961
962HTML_COLORSTYLE_SAT = 100
963
964# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
965# the luminance component of the colors in the HTML output. Values below
966# 100 gradually make the output lighter, whereas values above 100 make
967# the output darker. The value divided by 100 is the actual gamma applied,
968# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
969# and 100 does not change the gamma.
970
971HTML_COLORSTYLE_GAMMA = 80
972
973# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
974# page will contain the date and time when the page was generated. Setting
975# this to NO can help when comparing the output of multiple runs.
976
977HTML_TIMESTAMP = YES
978
979# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
980# documentation will contain sections that can be hidden and shown after the
981# page has loaded.
982
983HTML_DYNAMIC_SECTIONS = NO
984
985# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
986# entries shown in the various tree structured indices initially; the user
987# can expand and collapse entries dynamically later on. Doxygen will expand
988# the tree to such a level that at most the specified number of entries are
989# visible (unless a fully collapsed tree already exceeds this amount).
990# So setting the number of entries 1 will produce a full collapsed tree by
991# default. 0 is a special value representing an infinite number of entries
992# and will result in a full expanded tree by default.
993
994HTML_INDEX_NUM_ENTRIES = 100
995
996# If the GENERATE_DOCSET tag is set to YES, additional index files
997# will be generated that can be used as input for Apple's Xcode 3
998# integrated development environment, introduced with OSX 10.5 (Leopard).
999# To create a documentation set, doxygen will generate a Makefile in the
1000# HTML output directory. Running make will produce the docset in that
1001# directory and running "make install" will install the docset in
1002# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1003# it at startup.
1004# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1005# for more information.
1006
1007GENERATE_DOCSET = NO
1008
1009# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1010# feed. A documentation feed provides an umbrella under which multiple
1011# documentation sets from a single provider (such as a company or product suite)
1012# can be grouped.
1013
1014DOCSET_FEEDNAME = "Doxygen generated docs"
1015
1016# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1017# should uniquely identify the documentation set bundle. This should be a
1018# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1019# will append .docset to the name.
1020
1021DOCSET_BUNDLE_ID = www.broadcom.com
1022
1023# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
1024# identify the documentation publisher. This should be a reverse domain-name
1025# style string, e.g. com.mycompany.MyDocSet.documentation.
1026
1027DOCSET_PUBLISHER_ID = www.broadcom.com
1028
1029# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1030
1031DOCSET_PUBLISHER_NAME = Broadcom Limited
1032
1033# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1034# will be generated that can be used as input for tools like the
1035# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1036# of the generated HTML documentation.
1037
1038GENERATE_HTMLHELP = NO
1039
1040# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1041# be used to specify the file name of the resulting .chm file. You
1042# can add a path in front of the file if the result should not be
1043# written to the html output directory.
1044
1045CHM_FILE =
1046
1047# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1048# be used to specify the location (absolute path including file name) of
1049# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1050# the HTML help compiler on the generated index.hhp.
1051
1052HHC_LOCATION =
1053
1054# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1055# controls if a separate .chi index file is generated (YES) or that
1056# it should be included in the master .chm file (NO).
1057
1058GENERATE_CHI = NO
1059
1060# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1061# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1062# content.
1063
1064CHM_INDEX_ENCODING =
1065
1066# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1067# controls whether a binary table of contents is generated (YES) or a
1068# normal table of contents (NO) in the .chm file.
1069
1070BINARY_TOC = NO
1071
1072# The TOC_EXPAND flag can be set to YES to add extra items for group members
1073# to the contents of the HTML help documentation and to the tree view.
1074
1075TOC_EXPAND = NO
1076
1077# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1078# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1079# that can be used as input for Qt's qhelpgenerator to generate a
1080# Qt Compressed Help (.qch) of the generated HTML documentation.
1081
1082GENERATE_QHP = NO
1083
1084# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1085# be used to specify the file name of the resulting .qch file.
1086# The path specified is relative to the HTML output folder.
1087
1088QCH_FILE =
1089
1090# The QHP_NAMESPACE tag specifies the namespace to use when generating
1091# Qt Help Project output. For more information please see
1092# http://doc.trolltech.com/qthelpproject.html#namespace
1093
1094QHP_NAMESPACE = org.doxygen.Project
1095
1096# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1097# Qt Help Project output. For more information please see
1098# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1099
1100QHP_VIRTUAL_FOLDER = doc
1101
1102# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1103# add. For more information please see
1104# http://doc.trolltech.com/qthelpproject.html#custom-filters
1105
1106QHP_CUST_FILTER_NAME =
1107
1108# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1109# custom filter to add. For more information please see
1110# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1111# Qt Help Project / Custom Filters</a>.
1112
1113QHP_CUST_FILTER_ATTRS =
1114
1115# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1116# project's
1117# filter section matches.
1118# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1119# Qt Help Project / Filter Attributes</a>.
1120
1121QHP_SECT_FILTER_ATTRS =
1122
1123# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1124# be used to specify the location of Qt's qhelpgenerator.
1125# If non-empty doxygen will try to run qhelpgenerator on the generated
1126# .qhp file.
1127
1128QHG_LOCATION =
1129
1130# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1131# will be generated, which together with the HTML files, form an Eclipse help
1132# plugin. To install this plugin and make it available under the help contents
1133# menu in Eclipse, the contents of the directory containing the HTML and XML
1134# files needs to be copied into the plugins directory of eclipse. The name of
1135# the directory within the plugins directory should be the same as
1136# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1137# the help appears.
1138
1139GENERATE_ECLIPSEHELP = NO
1140
1141# A unique identifier for the eclipse help plugin. When installing the plugin
1142# the directory name containing the HTML and XML files should also have
1143# this name.
1144
1145ECLIPSE_DOC_ID = org.doxygen.Project
1146
1147# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1148# at top of each HTML page. The value NO (the default) enables the index and
1149# the value YES disables it. Since the tabs have the same information as the
1150# navigation tree you can set this option to NO if you already set
1151# GENERATE_TREEVIEW to YES.
1152
1153DISABLE_INDEX = YES
1154
1155# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1156# structure should be generated to display hierarchical information.
1157# If the tag value is set to YES, a side panel will be generated
1158# containing a tree-like index structure (just like the one that
1159# is generated for HTML Help). For this to work a browser that supports
1160# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1161# Windows users are probably better off using the HTML help feature.
1162# Since the tree basically has the same information as the tab index you
1163# could consider to set DISABLE_INDEX to NO when enabling this option.
1164
1165GENERATE_TREEVIEW = YES
1166
1167# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1168# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1169# documentation. Note that a value of 0 will completely suppress the enum
1170# values from appearing in the overview section.
1171
1172ENUM_VALUES_PER_LINE = 4
1173
1174# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1175# used to set the initial width (in pixels) of the frame in which the tree
1176# is shown.
1177
1178TREEVIEW_WIDTH = 250
1179
1180# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1181# links to external symbols imported via tag files in a separate window.
1182
1183EXT_LINKS_IN_WINDOW = NO
1184
1185# Use this tag to change the font size of Latex formulas included
1186# as images in the HTML documentation. The default is 10. Note that
1187# when you change the font size after a successful doxygen run you need
1188# to manually remove any form_*.png images from the HTML output directory
1189# to force them to be regenerated.
1190
1191FORMULA_FONTSIZE = 10
1192
1193# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1194# generated for formulas are transparent PNGs. Transparent PNGs are
1195# not supported properly for IE 6.0, but are supported on all modern browsers.
1196# Note that when changing this option you need to delete any form_*.png files
1197# in the HTML output before the changes have effect.
1198
1199FORMULA_TRANSPARENT = YES
1200
1201# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1202# (see http://www.mathjax.org) which uses client side Javascript for the
1203# rendering instead of using prerendered bitmaps. Use this if you do not
1204# have LaTeX installed or if you want to formulas look prettier in the HTML
1205# output. When enabled you may also need to install MathJax separately and
1206# configure the path to it using the MATHJAX_RELPATH option.
1207
1208USE_MATHJAX = NO
1209
1210# When MathJax is enabled you need to specify the location relative to the
1211# HTML output directory using the MATHJAX_RELPATH option. The destination
1212# directory should contain the MathJax.js script. For instance, if the mathjax
1213# directory is located at the same level as the HTML output directory, then
1214# MATHJAX_RELPATH should be ../mathjax. The default value points to
1215# the MathJax Content Delivery Network so you can quickly see the result without
1216# installing MathJax.
1217# However, it is strongly recommended to install a local
1218# copy of MathJax from http://www.mathjax.org before deployment.
1219
1220MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1221
1222# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1223# names that should be enabled during MathJax rendering.
1224
1225MATHJAX_EXTENSIONS =
1226
1227# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1228# for the HTML output. The underlying search engine uses javascript
1229# and DHTML and should work on any modern browser. Note that when using
1230# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1231# (GENERATE_DOCSET) there is already a search function so this one should
1232# typically be disabled. For large projects the javascript based search engine
1233# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1234
1235SEARCHENGINE = YES
1236
1237# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1238# implemented using a PHP enabled web server instead of at the web client
1239# using Javascript. Doxygen will generate the search PHP script and index
1240# file to put on the web server. The advantage of the server
1241# based approach is that it scales better to large projects and allows
1242# full text search. The disadvantages are that it is more difficult to setup
1243# and does not have live searching capabilities.
1244
1245SERVER_BASED_SEARCH = NO
1246
1247#---------------------------------------------------------------------------
1248# configuration options related to the LaTeX output
1249#---------------------------------------------------------------------------
1250
1251# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1252# generate Latex output.
1253
1254GENERATE_LATEX = NO
1255
1256# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1257# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1258# put in front of it. If left blank `latex' will be used as the default path.
1259
1260LATEX_OUTPUT = latex
1261
1262# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1263# invoked. If left blank `latex' will be used as the default command name.
1264# Note that when enabling USE_PDFLATEX this option is only used for
1265# generating bitmaps for formulas in the HTML output, but not in the
1266# Makefile that is written to the output directory.
1267
1268LATEX_CMD_NAME = latex
1269
1270# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1271# generate index for LaTeX. If left blank `makeindex' will be used as the
1272# default command name.
1273
1274MAKEINDEX_CMD_NAME = makeindex
1275
1276# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1277# LaTeX documents. This may be useful for small projects and may help to
1278# save some trees in general.
1279
1280COMPACT_LATEX = NO
1281
1282# The PAPER_TYPE tag can be used to set the paper type that is used
1283# by the printer. Possible values are: a4, letter, legal and
1284# executive. If left blank a4wide will be used.
1285
1286PAPER_TYPE = a4wide
1287
1288# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1289# packages that should be included in the LaTeX output.
1290
1291EXTRA_PACKAGES =
1292
1293# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1294# the generated latex document. The header should contain everything until
1295# the first chapter. If it is left blank doxygen will generate a
1296# standard header. Notice: only use this tag if you know what you are doing!
1297
1298LATEX_HEADER =
1299
1300# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1301# the generated latex document. The footer should contain everything after
1302# the last chapter. If it is left blank doxygen will generate a
1303# standard footer. Notice: only use this tag if you know what you are doing!
1304
1305LATEX_FOOTER =
1306
1307# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1308# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1309# contain links (just like the HTML output) instead of page references
1310# This makes the output suitable for online browsing using a pdf viewer.
1311
1312PDF_HYPERLINKS = NO
1313
1314# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1315# plain latex in the generated Makefile. Set this option to YES to get a
1316# higher quality PDF documentation.
1317
1318USE_PDFLATEX = NO
1319
1320# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1321# command to the generated LaTeX files. This will instruct LaTeX to keep
1322# running if errors occur, instead of asking the user for help.
1323# This option is also used when generating formulas in HTML.
1324
1325LATEX_BATCHMODE = NO
1326
1327# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1328# include the index chapters (such as File Index, Compound Index, etc.)
1329# in the output.
1330
1331LATEX_HIDE_INDICES = NO
1332
1333# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1334# source code with syntax highlighting in the LaTeX output.
1335# Note that which sources are shown also depends on other settings
1336# such as SOURCE_BROWSER.
1337
1338LATEX_SOURCE_CODE = NO
1339
1340# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1341# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1342# http://en.wikipedia.org/wiki/BibTeX for more info.
1343
1344LATEX_BIB_STYLE = plain
1345
1346#---------------------------------------------------------------------------
1347# configuration options related to the RTF output
1348#---------------------------------------------------------------------------
1349
1350# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1351# The RTF output is optimized for Word 97 and may not look very pretty with
1352# other RTF readers or editors.
1353
1354GENERATE_RTF = NO
1355
1356# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1357# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1358# put in front of it. If left blank `rtf' will be used as the default path.
1359
1360RTF_OUTPUT = rtf
1361
1362# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1363# RTF documents. This may be useful for small projects and may help to
1364# save some trees in general.
1365
1366COMPACT_RTF = NO
1367
1368# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1369# will contain hyperlink fields. The RTF file will
1370# contain links (just like the HTML output) instead of page references.
1371# This makes the output suitable for online browsing using WORD or other
1372# programs which support those fields.
1373# Note: wordpad (write) and others do not support links.
1374
1375RTF_HYPERLINKS = NO
1376
1377# Load style sheet definitions from file. Syntax is similar to doxygen's
1378# config file, i.e. a series of assignments. You only have to provide
1379# replacements, missing definitions are set to their default value.
1380
1381RTF_STYLESHEET_FILE =
1382
1383# Set optional variables used in the generation of an rtf document.
1384# Syntax is similar to doxygen's config file.
1385
1386RTF_EXTENSIONS_FILE =
1387
1388#---------------------------------------------------------------------------
1389# configuration options related to the man page output
1390#---------------------------------------------------------------------------
1391
1392# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1393# generate man pages
1394
1395GENERATE_MAN = NO
1396
1397# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1398# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1399# put in front of it. If left blank `man' will be used as the default path.
1400
1401MAN_OUTPUT = man
1402
1403# The MAN_EXTENSION tag determines the extension that is added to
1404# the generated man pages (default is the subroutine's section .3)
1405
1406MAN_EXTENSION = .3
1407
1408# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1409# then it will generate one additional man file for each entity
1410# documented in the real man page(s). These additional files
1411# only source the real man page, but without them the man command
1412# would be unable to find the correct page. The default is NO.
1413
1414MAN_LINKS = NO
1415
1416#---------------------------------------------------------------------------
1417# configuration options related to the XML output
1418#---------------------------------------------------------------------------
1419
1420# If the GENERATE_XML tag is set to YES Doxygen will
1421# generate an XML file that captures the structure of
1422# the code including all documentation.
1423
1424GENERATE_XML = NO
1425
1426# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1427# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1428# put in front of it. If left blank `xml' will be used as the default path.
1429
1430XML_OUTPUT = xml
1431
1432# The XML_SCHEMA tag can be used to specify an XML schema,
1433# which can be used by a validating XML parser to check the
1434# syntax of the XML files.
1435
1436#XML_SCHEMA =
1437
1438# The XML_DTD tag can be used to specify an XML DTD,
1439# which can be used by a validating XML parser to check the
1440# syntax of the XML files.
1441
1442#XML_DTD =
1443
1444# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1445# dump the program listings (including syntax highlighting
1446# and cross-referencing information) to the XML output. Note that
1447# enabling this will significantly increase the size of the XML output.
1448
1449XML_PROGRAMLISTING = YES
1450
1451#---------------------------------------------------------------------------
1452# configuration options for the AutoGen Definitions output
1453#---------------------------------------------------------------------------
1454
1455# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1456# generate an AutoGen Definitions (see autogen.sf.net) file
1457# that captures the structure of the code including all
1458# documentation. Note that this feature is still experimental
1459# and incomplete at the moment.
1460
1461GENERATE_AUTOGEN_DEF = NO
1462
1463#---------------------------------------------------------------------------
1464# configuration options related to the Perl module output
1465#---------------------------------------------------------------------------
1466
1467# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1468# generate a Perl module file that captures the structure of
1469# the code including all documentation. Note that this
1470# feature is still experimental and incomplete at the
1471# moment.
1472
1473GENERATE_PERLMOD = NO
1474
1475# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1476# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1477# to generate PDF and DVI output from the Perl module output.
1478
1479PERLMOD_LATEX = NO
1480
1481# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1482# nicely formatted so it can be parsed by a human reader.
1483# This is useful
1484# if you want to understand what is going on.
1485# On the other hand, if this
1486# tag is set to NO the size of the Perl module output will be much smaller
1487# and Perl will parse it just the same.
1488
1489PERLMOD_PRETTY = YES
1490
1491# The names of the make variables in the generated doxyrules.make file
1492# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1493# This is useful so different doxyrules.make files included by the same
1494# Makefile don't overwrite each other's variables.
1495
1496PERLMOD_MAKEVAR_PREFIX =
1497
1498#---------------------------------------------------------------------------
1499# Configuration options related to the preprocessor
1500#---------------------------------------------------------------------------
1501
1502# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1503# evaluate all C-preprocessor directives found in the sources and include
1504# files.
1505
1506ENABLE_PREPROCESSING = YES
1507
1508# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1509# names in the source code. If set to NO (the default) only conditional
1510# compilation will be performed. Macro expansion can be done in a controlled
1511# way by setting EXPAND_ONLY_PREDEF to YES.
1512
1513MACRO_EXPANSION = YES
1514
1515# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1516# then the macro expansion is limited to the macros specified with the
1517# PREDEFINED and EXPAND_AS_DEFINED tags.
1518
1519EXPAND_ONLY_PREDEF = YES
1520
1521# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1522# pointed to by INCLUDE_PATH will be searched when a #include is found.
1523
1524SEARCH_INCLUDES = YES
1525
1526# The INCLUDE_PATH tag can be used to specify one or more directories that
1527# contain include files that are not input files but should be processed by
1528# the preprocessor.
1529
1530INCLUDE_PATH =
1531
1532# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1533# patterns (like *.h and *.hpp) to filter out the header-files in the
1534# directories. If left blank, the patterns specified with FILE_PATTERNS will
1535# be used.
1536
1537INCLUDE_FILE_PATTERNS =
1538
1539# The PREDEFINED tag can be used to specify one or more macro names that
1540# are defined before the preprocessor is started (similar to the -D option of
1541# gcc). The argument of the tag is a list of macros of the form: name
1542# or name=definition (no spaces). If the definition and the = are
1543# omitted =1 is assumed. To prevent a macro definition from being
1544# undefined via #undef or recursively expanded use the := operator
1545# instead of the = operator.
1546
1547PREDEFINED = __attribute__(x)= \
1548 __cplusplus
1549
1550# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1551# this tag can be used to specify a list of macro names that should be expanded.
1552# The macro definition that is found in the sources will be used.
1553# Use the PREDEFINED tag if you want to use a different macro definition that
1554# overrules the definition found in the source code.
1555
1556EXPAND_AS_DEFINED =
1557
1558# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1559# doxygen's preprocessor will remove all references to function-like macros
1560# that are alone on a line, have an all uppercase name, and do not end with a
1561# semicolon, because these will confuse the parser if not removed.
1562
1563SKIP_FUNCTION_MACROS = NO
1564
1565#---------------------------------------------------------------------------
1566# Configuration::additions related to external references
1567#---------------------------------------------------------------------------
1568
1569# The TAGFILES option can be used to specify one or more tagfiles. For each
1570# tag file the location of the external documentation should be added. The
1571# format of a tag file without this location is as follows:
1572#
1573# TAGFILES = file1 file2 ...
1574# Adding location for the tag files is done as follows:
1575#
1576# TAGFILES = file1=loc1 "file2 = loc2" ...
1577# where "loc1" and "loc2" can be relative or absolute paths
1578# or URLs. Note that each tag file must have a unique name (where the name does
1579# NOT include the path). If a tag file is not located in the directory in which
1580# doxygen is run, you must also specify the path to the tagfile here.
1581
1582TAGFILES =
1583
1584# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1585# a tag file that is based on the input files it reads.
1586
1587GENERATE_TAGFILE =
1588
1589# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1590# in the class index. If set to NO only the inherited external classes
1591# will be listed.
1592
1593ALLEXTERNALS = NO
1594
1595# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1596# in the modules index. If set to NO, only the current project's groups will
1597# be listed.
1598
1599EXTERNAL_GROUPS = YES
1600
1601# The PERL_PATH should be the absolute path and name of the perl script
1602# interpreter (i.e. the result of `which perl').
1603
1604PERL_PATH = /usr/bin/perl
1605
1606#---------------------------------------------------------------------------
1607# Configuration options related to the dot tool
1608#---------------------------------------------------------------------------
1609
1610# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1611# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1612# or super classes. Setting the tag to NO turns the diagrams off. Note that
1613# this option also works with HAVE_DOT disabled, but it is recommended to
1614# install and use dot, since it yields more powerful graphs.
1615
1616CLASS_DIAGRAMS = YES
1617
1618# You can define message sequence charts within doxygen comments using the \msc
1619# command. Doxygen will then run the mscgen tool (see
1620# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1621# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1622# the mscgen tool resides. If left empty the tool is assumed to be found in the
1623# default search path.
1624
1625MSCGEN_PATH =
1626
1627# If set to YES, the inheritance and collaboration graphs will hide
1628# inheritance and usage relations if the target is undocumented
1629# or is not a class.
1630
1631HIDE_UNDOC_RELATIONS = YES
1632
1633# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1634# available from the path. This tool is part of Graphviz, a graph visualization
1635# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1636# have no effect if this option is set to NO (the default)
1637
1638HAVE_DOT = %HAVE_DOT
1639
1640# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1641# allowed to run in parallel. When set to 0 (the default) doxygen will
1642# base this on the number of processors available in the system. You can set it
1643# explicitly to a value larger than 0 to get control over the balance
1644# between CPU load and processing speed.
1645
1646DOT_NUM_THREADS = 0
1647
1648# By default doxygen will use the Helvetica font for all dot files that
1649# doxygen generates. When you want a differently looking font you can specify
1650# the font name using DOT_FONTNAME. You need to make sure dot is able to find
1651# the font, which can be done by putting it in a standard location or by setting
1652# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1653# directory containing the font.
1654
1655DOT_FONTNAME = Helvetica
1656
1657# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1658# The default size is 10pt.
1659
1660DOT_FONTSIZE = 10
1661
1662# By default doxygen will tell dot to use the Helvetica font.
1663# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1664# set the path where dot can find it.
1665
1666DOT_FONTPATH =
1667
1668# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1669# will generate a graph for each documented class showing the direct and
1670# indirect inheritance relations. Setting this tag to YES will force the
1671# CLASS_DIAGRAMS tag to NO.
1672
1673CLASS_GRAPH = YES
1674
1675# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1676# will generate a graph for each documented class showing the direct and
1677# indirect implementation dependencies (inheritance, containment, and
1678# class references variables) of the class with other documented classes.
1679
1680COLLABORATION_GRAPH = YES
1681
1682# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1683# will generate a graph for groups, showing the direct groups dependencies
1684
1685GROUP_GRAPHS = YES
1686
1687# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1688# collaboration diagrams in a style similar to the OMG's Unified Modeling
1689# Language.
1690
1691UML_LOOK = NO
1692
1693# If the UML_LOOK tag is enabled, the fields and methods are shown inside
1694# the class node. If there are many fields or methods and many nodes the
1695# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1696# threshold limits the number of items for each type to make the size more
1697# managable. Set this to 0 for no limit. Note that the threshold may be
1698# exceeded by 50% before the limit is enforced.
1699
1700UML_LIMIT_NUM_FIELDS = 10
1701
1702# If set to YES, the inheritance and collaboration graphs will show the
1703# relations between templates and their instances.
1704
1705TEMPLATE_RELATIONS = NO
1706
1707# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1708# tags are set to YES then doxygen will generate a graph for each documented
1709# file showing the direct and indirect include dependencies of the file with
1710# other documented files.
1711
1712INCLUDE_GRAPH = YES
1713
1714# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1715# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1716# documented header file showing the documented files that directly or
1717# indirectly include this file.
1718
1719INCLUDED_BY_GRAPH = YES
1720
1721# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1722# doxygen will generate a call dependency graph for every global function
1723# or class method. Note that enabling this option will significantly increase
1724# the time of a run. So in most cases it will be better to enable call graphs
1725# for selected functions only using the \callgraph command.
1726
1727CALL_GRAPH = NO
1728
1729# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1730# doxygen will generate a caller dependency graph for every global function
1731# or class method. Note that enabling this option will significantly increase
1732# the time of a run. So in most cases it will be better to enable caller
1733# graphs for selected functions only using the \callergraph command.
1734
1735CALLER_GRAPH = NO
1736
1737# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1738# will generate a graphical hierarchy of all classes instead of a textual one.
1739
1740GRAPHICAL_HIERARCHY = YES
1741
1742# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
1743# then doxygen will show the dependencies a directory has on other directories
1744# in a graphical way. The dependency relations are determined by the #include
1745# relations between the files in the directories.
1746
1747DIRECTORY_GRAPH = YES
1748
1749# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1750# generated by dot. Possible values are svg, png, jpg, or gif.
1751# If left blank png will be used. If you choose svg you need to set
1752# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1753# visible in IE 9+ (other browsers do not have this requirement).
1754
1755DOT_IMAGE_FORMAT = png
1756
1757# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1758# enable generation of interactive SVG images that allow zooming and panning.
1759# Note that this requires a modern browser other than Internet Explorer.
1760# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1761# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1762# visible. Older versions of IE do not have SVG support.
1763
1764INTERACTIVE_SVG = NO
1765
1766# The tag DOT_PATH can be used to specify the path where the dot tool can be
1767# found. If left blank, it is assumed the dot tool can be found in the path.
1768
1769DOT_PATH =
1770
1771# The DOTFILE_DIRS tag can be used to specify one or more directories that
1772# contain dot files that are included in the documentation (see the
1773# \dotfile command).
1774
1775DOTFILE_DIRS =
1776
1777# The MSCFILE_DIRS tag can be used to specify one or more directories that
1778# contain msc files that are included in the documentation (see the
1779# \mscfile command).
1780
1781MSCFILE_DIRS =
1782
1783# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1784# nodes that will be shown in the graph. If the number of nodes in a graph
1785# becomes larger than this value, doxygen will truncate the graph, which is
1786# visualized by representing a node as a red box. Note that doxygen if the
1787# number of direct children of the root node in a graph is already larger than
1788# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1789# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1790
1791DOT_GRAPH_MAX_NODES = 200
1792
1793# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1794# graphs generated by dot. A depth value of 3 means that only nodes reachable
1795# from the root by following a path via at most 3 edges will be shown. Nodes
1796# that lay further from the root node will be omitted. Note that setting this
1797# option to 1 or 2 may greatly reduce the computation time needed for large
1798# code bases. Also note that the size of a graph can be further restricted by
1799# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1800
1801MAX_DOT_GRAPH_DEPTH = 2
1802
1803# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1804# background. This is disabled by default, because dot on Windows does not
1805# seem to support this out of the box. Warning: Depending on the platform used,
1806# enabling this option may lead to badly anti-aliased labels on the edges of
1807# a graph (i.e. they become hard to read).
1808
1809DOT_TRANSPARENT = NO
1810
1811# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1812# files in one run (i.e. multiple -o and -T options on the command line). This
1813# makes dot run faster, but since only newer versions of dot (>1.8.10)
1814# support this, this feature is disabled by default.
1815
1816DOT_MULTI_TARGETS = NO
1817
1818# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1819# generate a legend page explaining the meaning of the various boxes and
1820# arrows in the dot generated graphs.
1821
1822GENERATE_LEGEND = YES
1823
1824# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1825# remove the intermediate dot files that are used to generate
1826# the various graphs.
1827
1828DOT_CLEANUP = YES