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