VirtualBox

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

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

*: spelling fixes, thanks Timeless!

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

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