VirtualBox

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

最後變更 在這個檔案從29027是 26226,由 vboxsync 提交於 15 年 前

s/RTGCDECL/RTGCDECL/g

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

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