source: CLRX/CLRadeonExtender/trunk/Doxyfile.in @ 4652

Last change on this file since 4652 was 3382, checked in by matszpk, 21 months ago

CLRadeonExtender: Doxygen: Add info about callOnce and OnceFlag?.

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