VirtualBox

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

最後變更 在這個檔案從41999是 36507,由 vboxsync 提交於 14 年 前

Doxyfile.*: Fixed ALIASES.

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

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