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