VirtualBox

source: vbox/trunk/src/VBox/Runtime/Doxyfile@ 25659

Last change on this file since 25659 was 25645, checked in by vboxsync, 15 years ago

IPRT,DoxyFile.Core: Mopped up the errors in the IPRT doxygen run.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 58.8 KB
Line 
1# Doxyfile 1.5.6
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 a sequence of words surrounded
26# by quotes) that should identify the project.
27
28PROJECT_NAME = IPRT
29
30# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31# This could be handy for archiving the generated documentation or
32# if some version control system is used.
33
34PROJECT_NUMBER =
35
36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37# base path where the generated documentation will be put.
38# If a relative path is entered, it will be relative to the location
39# where doxygen was started. If left blank the current directory will be used.
40
41#OUTPUT_DIRECTORY =
42
43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44# 4096 sub-directories (in 2 levels) under the output directory of each output
45# format and will distribute the generated files over these directories.
46# Enabling this option can be useful when feeding doxygen a huge amount of
47# source files, where putting all generated files in the same directory would
48# otherwise cause performance problems for the file system.
49
50CREATE_SUBDIRS = NO
51
52# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53# documentation generated by doxygen is written. Doxygen will use this
54# information to generate all constant output in the proper language.
55# The default language is English, other supported languages are:
56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
61# and Ukrainian.
62
63OUTPUT_LANGUAGE = English
64
65# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66# include brief member descriptions after the members that are listed in
67# the file and class documentation (similar to JavaDoc).
68# Set to NO to disable this.
69
70BRIEF_MEMBER_DESC = YES
71
72# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73# the brief description of a member or function before the detailed description.
74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75# brief descriptions will be completely suppressed.
76
77REPEAT_BRIEF = YES
78
79# This tag implements a quasi-intelligent brief description abbreviator
80# that is used to form the text in various listings. Each string
81# in this list, if found as the leading text of the brief description, will be
82# stripped from the text and the result after processing the whole list, is
83# used as the annotated text. Otherwise, the brief description is used as-is.
84# If left blank, the following values are used ("$name" is automatically
85# replaced with the name of the entity): "The $name class" "The $name widget"
86# "The $name file" "is" "provides" "specifies" "contains"
87# "represents" "a" "an" "the"
88
89ABBREVIATE_BRIEF =
90
91# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92# Doxygen will generate a detailed section even if there is only a brief
93# description.
94
95ALWAYS_DETAILED_SEC = NO
96
97# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98# inherited members of a class in the documentation of that class as if those
99# members were ordinary class members. Constructors, destructors and assignment
100# operators of the base classes will not be shown.
101
102INLINE_INHERITED_MEMB = NO
103
104# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105# path before files name in the file list and in the header files. If set
106# to NO the shortest path that makes the file name unique will be used.
107
108FULL_PATH_NAMES = NO
109
110# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111# can be used to strip a user-defined part of the path. Stripping is
112# only done if one of the specified strings matches the left-hand part of
113# the path. The tag can be used to show relative paths in the file list.
114# If left blank the directory from which doxygen is run is used as the
115# path to strip.
116
117STRIP_FROM_PATH =
118
119# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120# the path mentioned in the documentation of a class, which tells
121# the reader which header file to include in order to use a class.
122# If left blank only the name of the header file containing the class
123# definition is used. Otherwise one should specify the include paths that
124# are normally passed to the compiler using the -I flag.
125
126STRIP_FROM_INC_PATH =
127
128# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129# (but less readable) file names. This can be useful is your file systems
130# doesn't support long names like on DOS, Mac, or CD-ROM.
131
132SHORT_NAMES = NO
133
134# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135# will interpret the first line (until the first dot) of a JavaDoc-style
136# comment as the brief description. If set to NO, the JavaDoc
137# comments will behave just like regular Qt-style comments
138# (thus requiring an explicit @brief command for a brief description.)
139
140JAVADOC_AUTOBRIEF = YES
141
142# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143# interpret the first line (until the first dot) of a Qt-style
144# comment as the brief description. If set to NO, the comments
145# will behave just like regular Qt-style comments (thus requiring
146# an explicit \brief command for a brief description.)
147
148QT_AUTOBRIEF = NO
149
150# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151# treat a multi-line C++ special comment block (i.e. a block of //! or ///
152# comments) as a brief description. This used to be the default behaviour.
153# The new default is to treat a multi-line C++ comment block as a detailed
154# description. Set this tag to YES if you prefer the old behaviour instead.
155
156MULTILINE_CPP_IS_BRIEF = NO
157
158# If the DETAILS_AT_TOP tag is set to YES then Doxygen
159# will output the detailed description near the top, like JavaDoc.
160# If set to NO, the detailed description appears after the member
161# documentation.
162
163DETAILS_AT_TOP = NO
164
165# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
166# member inherits the documentation from any documented member that it
167# re-implements.
168
169INHERIT_DOCS = YES
170
171# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
172# a new page for each member. If set to NO, the documentation of a member will
173# be part of the file/class/namespace that contains it.
174
175SEPARATE_MEMBER_PAGES = NO
176
177# The TAB_SIZE tag can be used to set the number of spaces in a tab.
178# Doxygen uses this value to replace tabs by spaces in code fragments.
179
180TAB_SIZE = 4
181
182# This tag can be used to specify a number of aliases that acts
183# as commands in the documentation. An alias has the form "name=value".
184# For example adding "sideeffect=\par Side Effects:\n" will allow you to
185# put the command \sideeffect (or @sideeffect) in the documentation, which
186# will result in a user-defined paragraph with heading "Side Effects:".
187# You can put \n's in the value part of an alias to insert newlines.
188
189ALIASES = \
190 "note=@remark" \
191
192# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
193# sources only. Doxygen will then generate output that is more tailored for C.
194# For instance, some of the names that are used will be different. The list
195# of all members will be omitted, etc.
196
197OPTIMIZE_OUTPUT_FOR_C = YES
198
199# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
200# sources only. Doxygen will then generate output that is more tailored for
201# Java. For instance, namespaces will be presented as packages, qualified
202# scopes will look different, etc.
203
204OPTIMIZE_OUTPUT_JAVA = NO
205
206# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
207# sources only. Doxygen will then generate output that is more tailored for
208# Fortran.
209
210OPTIMIZE_FOR_FORTRAN = NO
211
212# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
213# sources. Doxygen will then generate output that is tailored for
214# VHDL.
215
216OPTIMIZE_OUTPUT_VHDL = NO
217
218# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
219# to include (a tag file for) the STL sources as input, then you should
220# set this tag to YES in order to let doxygen match functions declarations and
221# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
222# func(std::string) {}). This also make the inheritance and collaboration
223# diagrams that involve STL classes more complete and accurate.
224
225BUILTIN_STL_SUPPORT = NO
226
227# If you use Microsoft's C++/CLI language, you should set this option to YES to
228# enable parsing support.
229
230CPP_CLI_SUPPORT = NO
231
232# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
233# Doxygen will parse them like normal C++ but will assume all classes use public
234# instead of private inheritance when no explicit protection keyword is present.
235
236SIP_SUPPORT = NO
237
238# For Microsoft's IDL there are propget and propput attributes to indicate getter
239# and setter methods for a property. Setting this option to YES (the default)
240# will make doxygen to replace the get and set methods by a property in the
241# documentation. This will only work if the methods are indeed getting or
242# setting a simple type. If this is not the case, or you want to show the
243# methods anyway, you should set this option to NO.
244
245IDL_PROPERTY_SUPPORT = YES
246
247# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
248# tag is set to YES, then doxygen will reuse the documentation of the first
249# member in the group (if any) for the other members of the group. By default
250# all members of a group must be documented explicitly.
251
252DISTRIBUTE_GROUP_DOC = NO
253
254# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
255# the same type (for instance a group of public functions) to be put as a
256# subgroup of that type (e.g. under the Public Functions section). Set it to
257# NO to prevent subgrouping. Alternatively, this can be done per class using
258# the \nosubgrouping command.
259
260SUBGROUPING = YES
261
262# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
263# is documented as struct, union, or enum with the name of the typedef. So
264# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
265# with name TypeT. When disabled the typedef will appear as a member of a file,
266# namespace, or class. And the struct will be named TypeS. This can typically
267# be useful for C code in case the coding convention dictates that all compound
268# types are typedef'ed and only the typedef is referenced, never the tag name.
269
270TYPEDEF_HIDES_STRUCT = NO
271
272#---------------------------------------------------------------------------
273# Build related configuration options
274#---------------------------------------------------------------------------
275
276# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
277# documentation are documented, even if no documentation was available.
278# Private class members and static file members will be hidden unless
279# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
280
281EXTRACT_ALL = YES
282
283# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
284# will be included in the documentation.
285
286EXTRACT_PRIVATE = YES
287
288# If the EXTRACT_STATIC tag is set to YES all static members of a file
289# will be included in the documentation.
290
291EXTRACT_STATIC = YES
292
293# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
294# defined locally in source files will be included in the documentation.
295# If set to NO only classes defined in header files are included.
296
297EXTRACT_LOCAL_CLASSES = YES
298
299# This flag is only useful for Objective-C code. When set to YES local
300# methods, which are defined in the implementation section but not in
301# the interface are included in the documentation.
302# If set to NO (the default) only methods in the interface are included.
303
304EXTRACT_LOCAL_METHODS = NO
305
306# If this flag is set to YES, the members of anonymous namespaces will be
307# extracted and appear in the documentation as a namespace called
308# 'anonymous_namespace{file}', where file will be replaced with the base
309# name of the file that contains the anonymous namespace. By default
310# anonymous namespace are hidden.
311
312EXTRACT_ANON_NSPACES = NO
313
314# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
315# undocumented members of documented classes, files or namespaces.
316# If set to NO (the default) these members will be included in the
317# various overviews, but no documentation section is generated.
318# This option has no effect if EXTRACT_ALL is enabled.
319
320HIDE_UNDOC_MEMBERS = NO
321
322# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
323# undocumented classes that are normally visible in the class hierarchy.
324# If set to NO (the default) these classes will be included in the various
325# overviews. This option has no effect if EXTRACT_ALL is enabled.
326
327HIDE_UNDOC_CLASSES = NO
328
329# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
330# friend (class|struct|union) declarations.
331# If set to NO (the default) these declarations will be included in the
332# documentation.
333
334HIDE_FRIEND_COMPOUNDS = NO
335
336# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
337# documentation blocks found inside the body of a function.
338# If set to NO (the default) these blocks will be appended to the
339# function's detailed documentation block.
340
341HIDE_IN_BODY_DOCS = NO
342
343# The INTERNAL_DOCS tag determines if documentation
344# that is typed after a \internal command is included. If the tag is set
345# to NO (the default) then the documentation will be excluded.
346# Set it to YES to include the internal documentation.
347
348INTERNAL_DOCS = YES
349
350# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
351# file names in lower-case letters. If set to YES upper-case letters are also
352# allowed. This is useful if you have classes or files whose names only differ
353# in case and if your file system supports case sensitive file names. Windows
354# and Mac users are advised to set this option to NO.
355
356CASE_SENSE_NAMES = NO
357
358# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
359# will show members with their full class and namespace scopes in the
360# documentation. If set to YES the scope will be hidden.
361
362HIDE_SCOPE_NAMES = NO
363
364# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
365# will put a list of the files that are included by a file in the documentation
366# of that file.
367
368SHOW_INCLUDE_FILES = YES
369
370# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
371# is inserted in the documentation for inline members.
372
373INLINE_INFO = YES
374
375# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
376# will sort the (detailed) documentation of file and class members
377# alphabetically by member name. If set to NO the members will appear in
378# declaration order.
379
380SORT_MEMBER_DOCS = YES
381
382# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
383# brief documentation of file, namespace and class members alphabetically
384# by member name. If set to NO (the default) the members will appear in
385# declaration order.
386
387SORT_BRIEF_DOCS = NO
388
389# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
390# hierarchy of group names into alphabetical order. If set to NO (the default)
391# the group names will appear in their defined order.
392
393SORT_GROUP_NAMES = NO
394
395# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
396# sorted by fully-qualified names, including namespaces. If set to
397# NO (the default), the class list will be sorted only by class name,
398# not including the namespace part.
399# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
400# Note: This option applies only to the class list, not to the
401# alphabetical list.
402
403SORT_BY_SCOPE_NAME = NO
404
405# The GENERATE_TODOLIST tag can be used to enable (YES) or
406# disable (NO) the todo list. This list is created by putting \todo
407# commands in the documentation.
408
409GENERATE_TODOLIST = YES
410
411# The GENERATE_TESTLIST tag can be used to enable (YES) or
412# disable (NO) the test list. This list is created by putting \test
413# commands in the documentation.
414
415GENERATE_TESTLIST = YES
416
417# The GENERATE_BUGLIST tag can be used to enable (YES) or
418# disable (NO) the bug list. This list is created by putting \bug
419# commands in the documentation.
420
421GENERATE_BUGLIST = YES
422
423# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
424# disable (NO) the deprecated list. This list is created by putting
425# \deprecated commands in the documentation.
426
427GENERATE_DEPRECATEDLIST= YES
428
429# The ENABLED_SECTIONS tag can be used to enable conditional
430# documentation sections, marked by \if sectionname ... \endif.
431
432ENABLED_SECTIONS =
433
434# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
435# the initial value of a variable or define consists of for it to appear in
436# the documentation. If the initializer consists of more lines than specified
437# here it will be hidden. Use a value of 0 to hide initializers completely.
438# The appearance of the initializer of individual variables and defines in the
439# documentation can be controlled using \showinitializer or \hideinitializer
440# command in the documentation regardless of this setting.
441
442MAX_INITIALIZER_LINES = 30
443
444# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
445# at the bottom of the documentation of classes and structs. If set to YES the
446# list will mention the files that were used to generate the documentation.
447
448SHOW_USED_FILES = YES
449
450# If the sources in your project are distributed over multiple directories
451# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
452# in the documentation. The default is NO.
453
454SHOW_DIRECTORIES = NO
455
456# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
457# This will remove the Files entry from the Quick Index and from the
458# Folder Tree View (if specified). The default is YES.
459
460SHOW_FILES = YES
461
462# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
463# Namespaces page. This will remove the Namespaces entry from the Quick Index
464# and from the Folder Tree View (if specified). The default is YES.
465
466SHOW_NAMESPACES = YES
467
468# The FILE_VERSION_FILTER tag can be used to specify a program or script that
469# doxygen should invoke to get the current version for each file (typically from
470# the version control system). Doxygen will invoke the program by executing (via
471# popen()) the command <command> <input-file>, where <command> is the value of
472# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
473# provided by doxygen. Whatever the program writes to standard output
474# is used as the file version. See the manual for examples.
475
476FILE_VERSION_FILTER =
477
478#---------------------------------------------------------------------------
479# configuration options related to warning and progress messages
480#---------------------------------------------------------------------------
481
482# The QUIET tag can be used to turn on/off the messages that are generated
483# by doxygen. Possible values are YES and NO. If left blank NO is used.
484
485QUIET = YES
486
487# The WARNINGS tag can be used to turn on/off the warning messages that are
488# generated by doxygen. Possible values are YES and NO. If left blank
489# NO is used.
490
491WARNINGS = YES
492
493# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
494# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
495# automatically be disabled.
496
497WARN_IF_UNDOCUMENTED = YES
498
499# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
500# potential errors in the documentation, such as not documenting some
501# parameters in a documented function, or documenting parameters that
502# don't exist or using markup commands wrongly.
503
504WARN_IF_DOC_ERROR = YES
505
506# This WARN_NO_PARAMDOC option can be abled to get warnings for
507# functions that are documented, but have no documentation for their parameters
508# or return value. If set to NO (the default) doxygen will only warn about
509# wrong or incomplete parameter documentation, but not about the absence of
510# documentation.
511
512WARN_NO_PARAMDOC = NO
513
514# The WARN_FORMAT tag determines the format of the warning messages that
515# doxygen can produce. The string should contain the $file, $line, and $text
516# tags, which will be replaced by the file and line number from which the
517# warning originated and the warning text. Optionally the format may contain
518# $version, which will be replaced by the version of the file (if it could
519# be obtained via FILE_VERSION_FILTER)
520
521WARN_FORMAT = "$file:$line: $text"
522
523# The WARN_LOGFILE tag can be used to specify a file to which warning
524# and error messages should be written. If left blank the output is written
525# to stderr.
526
527#WARN_LOGFILE =
528
529#---------------------------------------------------------------------------
530# configuration options related to the input files
531#---------------------------------------------------------------------------
532
533# The INPUT tag can be used to specify the files and/or directories that contain
534# documented source files. You may enter file names like "myfile.cpp" or
535# directories like "/usr/src/myproject". Separate the files or directories
536# with spaces.
537
538#INPUT =
539
540# This tag can be used to specify the character encoding of the source files
541# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
542# also the default input encoding. Doxygen uses libiconv (or the iconv built
543# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
544# the list of possible encodings.
545
546INPUT_ENCODING = UTF-8
547
548# If the value of the INPUT tag contains directories, you can use the
549# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
550# and *.h) to filter out the source-files in the directories. If left
551# blank the following patterns are tested:
552# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
553# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
554
555#FILE_PATTERNS =
556
557
558
559# The RECURSIVE tag can be used to turn specify whether or not subdirectories
560# should be searched for input files as well. Possible values are YES and NO.
561# If left blank NO is used.
562
563RECURSIVE = NO
564
565# The EXCLUDE tag can be used to specify files and/or directories that should
566# excluded from the INPUT source files. This way you can easily exclude a
567# subdirectory from a directory tree whose root is specified with the INPUT tag.
568
569EXCLUDE =
570
571# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
572# directories that are symbolic links (a Unix filesystem feature) are excluded
573# from the input.
574
575EXCLUDE_SYMLINKS = NO
576
577# If the value of the INPUT tag contains directories, you can use the
578# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
579# certain files from those directories. Note that the wildcards are matched
580# against the file with absolute path, so to exclude all test directories
581# for example use the pattern */test/*
582
583EXCLUDE_PATTERNS =
584
585# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
586# (namespaces, classes, functions, etc.) that should be excluded from the
587# output. The symbol name can be a fully qualified name, a word, or if the
588# wildcard * is used, a substring. Examples: ANamespace, AClass,
589# AClass::ANamespace, ANamespace::*Test
590
591EXCLUDE_SYMBOLS =
592
593# The EXAMPLE_PATH tag can be used to specify one or more files or
594# directories that contain example code fragments that are included (see
595# the \include command).
596
597EXAMPLE_PATH =
598
599# If the value of the EXAMPLE_PATH tag contains directories, you can use the
600# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
601# and *.h) to filter out the source-files in the directories. If left
602# blank all files are included.
603
604EXAMPLE_PATTERNS =
605
606# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
607# searched for input files to be used with the \include or \dontinclude
608# commands irrespective of the value of the RECURSIVE tag.
609# Possible values are YES and NO. If left blank NO is used.
610
611EXAMPLE_RECURSIVE = NO
612
613# The IMAGE_PATH tag can be used to specify one or more files or
614# directories that contain image that are included in the documentation (see
615# the \image command).
616
617IMAGE_PATH =
618
619# The INPUT_FILTER tag can be used to specify a program that doxygen should
620# invoke to filter for each input file. Doxygen will invoke the filter program
621# by executing (via popen()) the command <filter> <input-file>, where <filter>
622# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
623# input file. Doxygen will then use the output that the filter program writes
624# to standard output. If FILTER_PATTERNS is specified, this tag will be
625# ignored.
626
627INPUT_FILTER =
628
629# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
630# basis. Doxygen will compare the file name with each pattern and apply the
631# filter if there is a match. The filters are a list of the form:
632# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
633# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
634# is applied to all files.
635
636FILTER_PATTERNS =
637
638# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
639# INPUT_FILTER) will be used to filter the input files when producing source
640# files to browse (i.e. when SOURCE_BROWSER is set to YES).
641
642FILTER_SOURCE_FILES = NO
643
644#---------------------------------------------------------------------------
645# configuration options related to source browsing
646#---------------------------------------------------------------------------
647
648# If the SOURCE_BROWSER tag is set to YES then a list of source files will
649# be generated. Documented entities will be cross-referenced with these sources.
650# Note: To get rid of all source code in the generated output, make sure also
651# VERBATIM_HEADERS is set to NO.
652
653SOURCE_BROWSER = NO
654
655# Setting the INLINE_SOURCES tag to YES will include the body
656# of functions and classes directly in the documentation.
657
658INLINE_SOURCES = NO
659
660# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
661# doxygen to hide any special comment blocks from generated source code
662# fragments. Normal C and C++ comments will always remain visible.
663
664STRIP_CODE_COMMENTS = NO
665
666# If the REFERENCED_BY_RELATION tag is set to YES
667# then for each documented function all documented
668# functions referencing it will be listed.
669
670REFERENCED_BY_RELATION = YES
671
672# If the REFERENCES_RELATION tag is set to YES
673# then for each documented function all documented entities
674# called/used by that function will be listed.
675
676REFERENCES_RELATION = YES
677
678# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
679# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
680# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
681# link to the source code. Otherwise they will link to the documentstion.
682
683REFERENCES_LINK_SOURCE = YES
684
685# If the USE_HTAGS tag is set to YES then the references to source code
686# will point to the HTML generated by the htags(1) tool instead of doxygen
687# built-in source browser. The htags tool is part of GNU's global source
688# tagging system (see http://www.gnu.org/software/global/global.html). You
689# will need version 4.8.6 or higher.
690
691USE_HTAGS = NO
692
693# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
694# will generate a verbatim copy of the header file for each class for
695# which an include is specified. Set to NO to disable this.
696
697VERBATIM_HEADERS = YES
698
699#---------------------------------------------------------------------------
700# configuration options related to the alphabetical class index
701#---------------------------------------------------------------------------
702
703# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
704# of all compounds will be generated. Enable this if the project
705# contains a lot of classes, structs, unions or interfaces.
706
707ALPHABETICAL_INDEX = NO
708
709# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
710# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
711# in which this list will be split (can be a number in the range [1..20])
712
713COLS_IN_ALPHA_INDEX = 5
714
715# In case all classes in a project start with a common prefix, all
716# classes will be put under the same header in the alphabetical index.
717# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
718# should be ignored while generating the index headers.
719
720IGNORE_PREFIX =
721
722#---------------------------------------------------------------------------
723# configuration options related to the HTML output
724#---------------------------------------------------------------------------
725
726# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
727# generate HTML output.
728
729GENERATE_HTML = YES
730
731# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
732# If a relative path is entered the value of OUTPUT_DIRECTORY will be
733# put in front of it. If left blank `html' will be used as the default path.
734
735HTML_OUTPUT = html
736
737# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
738# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
739# doxygen will generate files with .html extension.
740
741HTML_FILE_EXTENSION = .html
742
743# The HTML_HEADER tag can be used to specify a personal HTML header for
744# each generated HTML page. If it is left blank doxygen will generate a
745# standard header.
746
747HTML_HEADER =
748
749# The HTML_FOOTER tag can be used to specify a personal HTML footer for
750# each generated HTML page. If it is left blank doxygen will generate a
751# standard footer.
752
753HTML_FOOTER =
754
755# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
756# style sheet that is used by each HTML page. It can be used to
757# fine-tune the look of the HTML output. If the tag is left blank doxygen
758# will generate a default style sheet. Note that doxygen will try to copy
759# the style sheet file to the HTML output directory, so don't put your own
760# stylesheet in the HTML output directory as well, or it will be erased!
761
762HTML_STYLESHEET =
763
764# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
765# files or namespaces will be aligned in HTML using tables. If set to
766# NO a bullet list will be used.
767
768HTML_ALIGN_MEMBERS = YES
769
770# If the GENERATE_HTMLHELP tag is set to YES, additional index files
771# will be generated that can be used as input for tools like the
772# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
773# of the generated HTML documentation.
774
775GENERATE_HTMLHELP = NO
776
777# If the GENERATE_DOCSET tag is set to YES, additional index files
778# will be generated that can be used as input for Apple's Xcode 3
779# integrated development environment, introduced with OSX 10.5 (Leopard).
780# To create a documentation set, doxygen will generate a Makefile in the
781# HTML output directory. Running make will produce the docset in that
782# directory and running "make install" will install the docset in
783# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
784# it at startup.
785
786GENERATE_DOCSET = NO
787
788# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
789# feed. A documentation feed provides an umbrella under which multiple
790# documentation sets from a single provider (such as a company or product suite)
791# can be grouped.
792
793DOCSET_FEEDNAME = "Doxygen generated docs"
794
795# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
796# should uniquely identify the documentation set bundle. This should be a
797# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
798# will append .docset to the name.
799
800DOCSET_BUNDLE_ID = org.doxygen.Project
801
802# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
803# documentation will contain sections that can be hidden and shown after the
804# page has loaded. For this to work a browser that supports
805# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
806# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
807
808HTML_DYNAMIC_SECTIONS = NO
809
810# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
811# be used to specify the file name of the resulting .chm file. You
812# can add a path in front of the file if the result should not be
813# written to the html output directory.
814
815CHM_FILE =
816
817# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
818# be used to specify the location (absolute path including file name) of
819# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
820# the HTML help compiler on the generated index.hhp.
821
822HHC_LOCATION =
823
824# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
825# controls if a separate .chi index file is generated (YES) or that
826# it should be included in the master .chm file (NO).
827
828GENERATE_CHI = NO
829
830# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
831# is used to encode HtmlHelp index (hhk), content (hhc) and project file
832# content.
833
834CHM_INDEX_ENCODING =
835
836# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
837# controls whether a binary table of contents is generated (YES) or a
838# normal table of contents (NO) in the .chm file.
839
840BINARY_TOC = NO
841
842# The TOC_EXPAND flag can be set to YES to add extra items for group members
843# to the contents of the HTML help documentation and to the tree view.
844
845TOC_EXPAND = NO
846
847# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
848# top of each HTML page. The value NO (the default) enables the index and
849# the value YES disables it.
850
851DISABLE_INDEX = YES
852
853# This tag can be used to set the number of enum values (range [1..20])
854# that doxygen will group on one line in the generated HTML documentation.
855
856ENUM_VALUES_PER_LINE = 4
857
858# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
859# structure should be generated to display hierarchical information.
860# If the tag value is set to FRAME, a side panel will be generated
861# containing a tree-like index structure (just like the one that
862# is generated for HTML Help). For this to work a browser that supports
863# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
864# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
865# probably better off using the HTML help feature. Other possible values
866# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
867# and Class Hiererachy pages using a tree view instead of an ordered list;
868# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
869# disables this behavior completely. For backwards compatibility with previous
870# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
871# respectively.
872
873GENERATE_TREEVIEW = YES
874
875# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
876# used to set the initial width (in pixels) of the frame in which the tree
877# is shown.
878
879TREEVIEW_WIDTH = 250
880
881# Use this tag to change the font size of Latex formulas included
882# as images in the HTML documentation. The default is 10. Note that
883# when you change the font size after a successful doxygen run you need
884# to manually remove any form_*.png images from the HTML output directory
885# to force them to be regenerated.
886
887FORMULA_FONTSIZE = 10
888
889#---------------------------------------------------------------------------
890# configuration options related to the LaTeX output
891#---------------------------------------------------------------------------
892
893# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
894# generate Latex output.
895
896GENERATE_LATEX = NO
897
898# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
899# If a relative path is entered the value of OUTPUT_DIRECTORY will be
900# put in front of it. If left blank `latex' will be used as the default path.
901
902LATEX_OUTPUT = latex
903
904# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
905# invoked. If left blank `latex' will be used as the default command name.
906
907LATEX_CMD_NAME = latex
908
909# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
910# generate index for LaTeX. If left blank `makeindex' will be used as the
911# default command name.
912
913MAKEINDEX_CMD_NAME = makeindex
914
915# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
916# LaTeX documents. This may be useful for small projects and may help to
917# save some trees in general.
918
919COMPACT_LATEX = NO
920
921# The PAPER_TYPE tag can be used to set the paper type that is used
922# by the printer. Possible values are: a4, a4wide, letter, legal and
923# executive. If left blank a4wide will be used.
924
925PAPER_TYPE = a4wide
926
927# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
928# packages that should be included in the LaTeX output.
929
930EXTRA_PACKAGES =
931
932# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
933# the generated latex document. The header should contain everything until
934# the first chapter. If it is left blank doxygen will generate a
935# standard header. Notice: only use this tag if you know what you are doing!
936
937LATEX_HEADER =
938
939# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
940# is prepared for conversion to pdf (using ps2pdf). The pdf file will
941# contain links (just like the HTML output) instead of page references
942# This makes the output suitable for online browsing using a pdf viewer.
943
944PDF_HYPERLINKS = NO
945
946# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
947# plain latex in the generated Makefile. Set this option to YES to get a
948# higher quality PDF documentation.
949
950USE_PDFLATEX = NO
951
952# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
953# command to the generated LaTeX files. This will instruct LaTeX to keep
954# running if errors occur, instead of asking the user for help.
955# This option is also used when generating formulas in HTML.
956
957LATEX_BATCHMODE = NO
958
959# If LATEX_HIDE_INDICES is set to YES then doxygen will not
960# include the index chapters (such as File Index, Compound Index, etc.)
961# in the output.
962
963LATEX_HIDE_INDICES = NO
964
965#---------------------------------------------------------------------------
966# configuration options related to the RTF output
967#---------------------------------------------------------------------------
968
969# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
970# The RTF output is optimized for Word 97 and may not look very pretty with
971# other RTF readers or editors.
972
973GENERATE_RTF = NO
974
975# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
976# If a relative path is entered the value of OUTPUT_DIRECTORY will be
977# put in front of it. If left blank `rtf' will be used as the default path.
978
979RTF_OUTPUT = rtf
980
981# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
982# RTF documents. This may be useful for small projects and may help to
983# save some trees in general.
984
985COMPACT_RTF = NO
986
987# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
988# will contain hyperlink fields. The RTF file will
989# contain links (just like the HTML output) instead of page references.
990# This makes the output suitable for online browsing using WORD or other
991# programs which support those fields.
992# Note: wordpad (write) and others do not support links.
993
994RTF_HYPERLINKS = NO
995
996# Load stylesheet definitions from file. Syntax is similar to doxygen's
997# config file, i.e. a series of assignments. You only have to provide
998# replacements, missing definitions are set to their default value.
999
1000RTF_STYLESHEET_FILE =
1001
1002# Set optional variables used in the generation of an rtf document.
1003# Syntax is similar to doxygen's config file.
1004
1005RTF_EXTENSIONS_FILE =
1006
1007#---------------------------------------------------------------------------
1008# configuration options related to the man page output
1009#---------------------------------------------------------------------------
1010
1011# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1012# generate man pages
1013
1014GENERATE_MAN = NO
1015
1016# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1017# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1018# put in front of it. If left blank `man' will be used as the default path.
1019
1020MAN_OUTPUT = man
1021
1022# The MAN_EXTENSION tag determines the extension that is added to
1023# the generated man pages (default is the subroutine's section .3)
1024
1025MAN_EXTENSION = .3
1026
1027# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1028# then it will generate one additional man file for each entity
1029# documented in the real man page(s). These additional files
1030# only source the real man page, but without them the man command
1031# would be unable to find the correct page. The default is NO.
1032
1033MAN_LINKS = NO
1034
1035#---------------------------------------------------------------------------
1036# configuration options related to the XML output
1037#---------------------------------------------------------------------------
1038
1039# If the GENERATE_XML tag is set to YES Doxygen will
1040# generate an XML file that captures the structure of
1041# the code including all documentation.
1042
1043GENERATE_XML = NO
1044
1045# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1046# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1047# put in front of it. If left blank `xml' will be used as the default path.
1048
1049XML_OUTPUT = xml
1050
1051# The XML_SCHEMA tag can be used to specify an XML schema,
1052# which can be used by a validating XML parser to check the
1053# syntax of the XML files.
1054
1055XML_SCHEMA =
1056
1057# The XML_DTD tag can be used to specify an XML DTD,
1058# which can be used by a validating XML parser to check the
1059# syntax of the XML files.
1060
1061XML_DTD =
1062
1063# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1064# dump the program listings (including syntax highlighting
1065# and cross-referencing information) to the XML output. Note that
1066# enabling this will significantly increase the size of the XML output.
1067
1068XML_PROGRAMLISTING = YES
1069
1070#---------------------------------------------------------------------------
1071# configuration options for the AutoGen Definitions output
1072#---------------------------------------------------------------------------
1073
1074# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1075# generate an AutoGen Definitions (see autogen.sf.net) file
1076# that captures the structure of the code including all
1077# documentation. Note that this feature is still experimental
1078# and incomplete at the moment.
1079
1080GENERATE_AUTOGEN_DEF = NO
1081
1082#---------------------------------------------------------------------------
1083# configuration options related to the Perl module output
1084#---------------------------------------------------------------------------
1085
1086# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1087# generate a Perl module file that captures the structure of
1088# the code including all documentation. Note that this
1089# feature is still experimental and incomplete at the
1090# moment.
1091
1092GENERATE_PERLMOD = NO
1093
1094# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1095# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1096# to generate PDF and DVI output from the Perl module output.
1097
1098PERLMOD_LATEX = NO
1099
1100# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1101# nicely formatted so it can be parsed by a human reader. This is useful
1102# if you want to understand what is going on. On the other hand, if this
1103# tag is set to NO the size of the Perl module output will be much smaller
1104# and Perl will parse it just the same.
1105
1106PERLMOD_PRETTY = YES
1107
1108# The names of the make variables in the generated doxyrules.make file
1109# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1110# This is useful so different doxyrules.make files included by the same
1111# Makefile don't overwrite each other's variables.
1112
1113PERLMOD_MAKEVAR_PREFIX =
1114
1115#---------------------------------------------------------------------------
1116# Configuration options related to the preprocessor
1117#---------------------------------------------------------------------------
1118
1119# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1120# evaluate all C-preprocessor directives found in the sources and include
1121# files.
1122
1123ENABLE_PREPROCESSING = YES
1124
1125# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1126# names in the source code. If set to NO (the default) only conditional
1127# compilation will be performed. Macro expansion can be done in a controlled
1128# way by setting EXPAND_ONLY_PREDEF to YES.
1129
1130MACRO_EXPANSION = YES
1131
1132# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1133# then the macro expansion is limited to the macros specified with the
1134# PREDEFINED and EXPAND_AS_DEFINED tags.
1135
1136EXPAND_ONLY_PREDEF = YES
1137
1138# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1139# in the INCLUDE_PATH (see below) will be search if a #include is found.
1140
1141SEARCH_INCLUDES = YES
1142
1143# The INCLUDE_PATH tag can be used to specify one or more directories that
1144# contain include files that are not input files but should be processed by
1145# the preprocessor.
1146
1147#INCLUDE_PATH =
1148
1149# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1150# patterns (like *.h and *.hpp) to filter out the header-files in the
1151# directories. If left blank, the patterns specified with FILE_PATTERNS will
1152# be used.
1153
1154#INCLUDE_FILE_PATTERNS =
1155
1156# The PREDEFINED tag can be used to specify one or more macro names that
1157# are defined before the preprocessor is started (similar to the -D option of
1158# gcc). The argument of the tag is a list of macros of the form: name
1159# or name=definition (no spaces). If the definition and the = are
1160# omitted =1 is assumed. To prevent a macro definition from being
1161# undefined via #undef or recursively expanded use the := operator
1162# instead of the = operator.
1163
1164PREDEFINED = \
1165 DOXYGEN_RUNNING \
1166 RT_C_DECLS_END= \
1167 RT_C_DECLS_BEGIN= \
1168 VBOX=1 \
1169 RT_STRICT=1 \
1170 __cplusplus=1 \
1171 RTCALL= \
1172 ARCH_BITS=HC_ARCH_BITS \
1173 R3_ARCH_BITS=HC_ARCH_BITS \
1174 R0_ARCH_BITS=HC_ARCH_BITS \
1175 RTDECL(type)=type \
1176 RT_EXPORT_SYMBOL(name)= \
1177 \
1178 "DECLINLINE(type)=inline type" \
1179 DECL_FORCE_INLINE(type)=DECLINLINE(type) \
1180 \
1181 AssertCompile(expr) \
1182 AssertCompileSize(a,b) \
1183 AssertCompileSizeAlignment(a,b) \
1184 AssertCompileMemberSizeAlignment(a,b,c) \
1185 AssertCompileMemberAlignment(a,b,c) \
1186 AssertCompileMemberOffset(a,b,c) \
1187 AssertCompile2MemberOffsets(a,b,c) \
1188 \
1189
1190# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1191# this tag can be used to specify a list of macro names that should be expanded.
1192# The macro definition that is found in the sources will be used.
1193# Use the PREDEFINED tag if you want to use a different macro definition.
1194
1195EXPAND_AS_DEFINED = \
1196 ARCH_BITS \
1197 GC_ARCH_BITS \
1198 HC_ARCH_BITS \
1199 R3_ARCH_BITS \
1200 R0_ARCH_BITS \
1201 \
1202 GCTYPE \
1203 GCPTRTYPE \
1204 HCPTRTYPE \
1205 R0PTRTYPE \
1206 R3PTRTYPE \
1207 R3R0PTRTYPE \
1208 \
1209 DECLEXPORT \
1210 DECLIMPORT \
1211 DECLHIDDEN \
1212 DECLASM \
1213 DECLASMTYPE \
1214 DECLCALLBACK \
1215 DECLCALLBACKMEMBER \
1216 DECLHCCALLBACKMEMBER \
1217 DECLRCCALLBACKMEMBER \
1218 DECLR3CALLBACKMEMBER \
1219 DECLR0CALLBACKMEMBER \
1220 RTR3DECL \
1221 RTR0DECL \
1222 RTGCDECL \
1223 RTDECL \
1224 RTDATADECL \
1225 KAVL_FN \
1226 \
1227 CTXSUFF \
1228 OTHERCTXSUFF \
1229 CTXMID \
1230 OTHERCTXMID \
1231 \
1232 RT_SRC_POS \
1233 RT_SRC_POS_ARGS \
1234 RT_SRC_POS_DECL
1235
1236
1237# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1238# doxygen's preprocessor will remove all function-like macros that are alone
1239# on a line, have an all uppercase name, and do not end with a semicolon. Such
1240# function macros are typically used for boiler-plate code, and will confuse
1241# the parser if not removed.
1242
1243#SKIP_FUNCTION_MACROS = YES
1244
1245#---------------------------------------------------------------------------
1246# Configuration::additions related to external references
1247#---------------------------------------------------------------------------
1248
1249# The TAGFILES option can be used to specify one or more tagfiles.
1250# Optionally an initial location of the external documentation
1251# can be added for each tagfile. The format of a tag file without
1252# this location is as follows:
1253# TAGFILES = file1 file2 ...
1254# Adding location for the tag files is done as follows:
1255# TAGFILES = file1=loc1 "file2 = loc2" ...
1256# where "loc1" and "loc2" can be relative or absolute paths or
1257# URLs. If a location is present for each tag, the installdox tool
1258# does not have to be run to correct the links.
1259# Note that each tag file must have a unique name
1260# (where the name does NOT include the path)
1261# If a tag file is not located in the directory in which doxygen
1262# is run, you must also specify the path to the tagfile here.
1263
1264TAGFILES =
1265
1266# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1267# a tag file that is based on the input files it reads.
1268
1269GENERATE_TAGFILE =
1270
1271# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1272# in the class index. If set to NO only the inherited external classes
1273# will be listed.
1274
1275ALLEXTERNALS = NO
1276
1277# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1278# in the modules index. If set to NO, only the current project's groups will
1279# be listed.
1280
1281EXTERNAL_GROUPS = YES
1282
1283# The PERL_PATH should be the absolute path and name of the perl script
1284# interpreter (i.e. the result of `which perl').
1285
1286PERL_PATH = /usr/bin/perl
1287
1288#---------------------------------------------------------------------------
1289# Configuration options related to the dot tool
1290#---------------------------------------------------------------------------
1291
1292# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1293# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1294# or super classes. Setting the tag to NO turns the diagrams off. Note that
1295# this option is superseded by the HAVE_DOT option below. This is only a
1296# fallback. It is recommended to install and use dot, since it yields more
1297# powerful graphs.
1298
1299CLASS_DIAGRAMS = YES
1300
1301# You can define message sequence charts within doxygen comments using the \msc
1302# command. Doxygen will then run the mscgen tool (see
1303# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1304# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1305# the mscgen tool resides. If left empty the tool is assumed to be found in the
1306# default search path.
1307
1308MSCGEN_PATH =
1309
1310# If set to YES, the inheritance and collaboration graphs will hide
1311# inheritance and usage relations if the target is undocumented
1312# or is not a class.
1313
1314HIDE_UNDOC_RELATIONS = YES
1315
1316# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1317# available from the path. This tool is part of Graphviz, a graph visualization
1318# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1319# have no effect if this option is set to NO (the default)
1320
1321HAVE_DOT = NO
1322
1323# By default doxygen will write a font called FreeSans.ttf to the output
1324# directory and reference it in all dot files that doxygen generates. This
1325# font does not include all possible unicode characters however, so when you need
1326# these (or just want a differently looking font) you can specify the font name
1327# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1328# which can be done by putting it in a standard location or by setting the
1329# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1330# containing the font.
1331
1332DOT_FONTNAME = FreeSans
1333
1334# By default doxygen will tell dot to use the output directory to look for the
1335# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1336# different font using DOT_FONTNAME you can set the path where dot
1337# can find it using this tag.
1338
1339DOT_FONTPATH =
1340
1341# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1342# will generate a graph for each documented class showing the direct and
1343# indirect inheritance relations. Setting this tag to YES will force the
1344# the CLASS_DIAGRAMS tag to NO.
1345
1346CLASS_GRAPH = YES
1347
1348# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1349# will generate a graph for each documented class showing the direct and
1350# indirect implementation dependencies (inheritance, containment, and
1351# class references variables) of the class with other documented classes.
1352
1353COLLABORATION_GRAPH = YES
1354
1355# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1356# will generate a graph for groups, showing the direct groups dependencies
1357
1358GROUP_GRAPHS = YES
1359
1360# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1361# collaboration diagrams in a style similar to the OMG's Unified Modeling
1362# Language.
1363
1364UML_LOOK = YES
1365
1366# If set to YES, the inheritance and collaboration graphs will show the
1367# relations between templates and their instances.
1368
1369TEMPLATE_RELATIONS = YES
1370
1371# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1372# tags are set to YES then doxygen will generate a graph for each documented
1373# file showing the direct and indirect include dependencies of the file with
1374# other documented files.
1375
1376INCLUDE_GRAPH = YES
1377
1378# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1379# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1380# documented header file showing the documented files that directly or
1381# indirectly include this file.
1382
1383INCLUDED_BY_GRAPH = YES
1384
1385# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1386# doxygen will generate a call dependency graph for every global function
1387# or class method. Note that enabling this option will significantly increase
1388# the time of a run. So in most cases it will be better to enable call graphs
1389# for selected functions only using the \callgraph command.
1390
1391CALL_GRAPH = YES
1392
1393# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1394# doxygen will generate a caller dependency graph for every global function
1395# or class method. Note that enabling this option will significantly increase
1396# the time of a run. So in most cases it will be better to enable caller
1397# graphs for selected functions only using the \callergraph command.
1398
1399CALLER_GRAPH = NO
1400
1401# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1402# will graphical hierarchy of all classes instead of a textual one.
1403
1404GRAPHICAL_HIERARCHY = YES
1405
1406# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1407# then doxygen will show the dependencies a directory has on other directories
1408# in a graphical way. The dependency relations are determined by the #include
1409# relations between the files in the directories.
1410
1411DIRECTORY_GRAPH = YES
1412
1413# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1414# generated by dot. Possible values are png, jpg, or gif
1415# If left blank png will be used.
1416
1417DOT_IMAGE_FORMAT = png
1418
1419# The tag DOT_PATH can be used to specify the path where the dot tool can be
1420# found. If left blank, it is assumed the dot tool can be found in the path.
1421
1422DOT_PATH =
1423
1424# The DOTFILE_DIRS tag can be used to specify one or more directories that
1425# contain dot files that are included in the documentation (see the
1426# \dotfile command).
1427
1428DOTFILE_DIRS =
1429
1430# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1431# nodes that will be shown in the graph. If the number of nodes in a graph
1432# becomes larger than this value, doxygen will truncate the graph, which is
1433# visualized by representing a node as a red box. Note that doxygen if the
1434# number of direct children of the root node in a graph is already larger than
1435# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1436# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1437
1438DOT_GRAPH_MAX_NODES = 50
1439
1440# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1441# graphs generated by dot. A depth value of 3 means that only nodes reachable
1442# from the root by following a path via at most 3 edges will be shown. Nodes
1443# that lay further from the root node will be omitted. Note that setting this
1444# option to 1 or 2 may greatly reduce the computation time needed for large
1445# code bases. Also note that the size of a graph can be further restricted by
1446# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1447
1448MAX_DOT_GRAPH_DEPTH = 0
1449
1450# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1451# background. This is enabled by default, which results in a transparent
1452# background. Warning: Depending on the platform used, enabling this option
1453# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1454# become hard to read).
1455
1456DOT_TRANSPARENT = YES
1457
1458# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1459# files in one run (i.e. multiple -o and -T options on the command line). This
1460# makes dot run faster, but since only newer versions of dot (>1.8.10)
1461# support this, this feature is disabled by default.
1462
1463DOT_MULTI_TARGETS = NO
1464
1465# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1466# generate a legend page explaining the meaning of the various boxes and
1467# arrows in the dot generated graphs.
1468
1469GENERATE_LEGEND = YES
1470
1471# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1472# remove the intermediate dot files that are used to generate
1473# the various graphs.
1474
1475DOT_CLEANUP = YES
1476
1477#---------------------------------------------------------------------------
1478# Configuration::additions related to the search engine
1479#---------------------------------------------------------------------------
1480
1481# The SEARCHENGINE tag specifies whether or not a search engine should be
1482# used. If set to NO the values of all tags below this one will be ignored.
1483
1484SEARCHENGINE = NO
1485
1486#
1487# The next bit is generated by the Makefile.
1488#
1489
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette