Changeset 18629 in vbox

Timestamp:

Apr 2, 2009 12:09:47 PM (16 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

45545

Message:

backed out r45404 as it messes up the file, manual merge of the doxygen updates please.

File:

: 1 edited

trunk/src/VBox/Runtime/Doxyfile (modified) (41 diffs)

Legend:

: Unmodified
: Added
: Removed

trunk/src/VBox/Runtime/Doxyfile

-              r18538
+              r18629
 # Doxyfile 1.5.6
+# Doxyfile 1.3.7
 # This file describes the settings to be used by the documentation system
 …
 #---------------------------------------------------------------------------
-# This tag specifies the encoding used for all characters in the config file
-# that follow. The default is UTF-8 which is also the encoding used for all
-# text before the first occurrence of this tag. Doxygen uses libiconv (or the
-# iconv built into libc) for the transcoding. See
-# http://www.gnu.org/software/libiconv for the list of possible encodings.
-DOXYFILE_ENCODING      = UTF-8
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
 # by quotes) that should identify the project.
 …
 # where doxygen was started. If left blank the current directory will be used.
 OUTPUT_DIRECTORY       =
+#OUTPUT_DIRECTORY       =
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
 # 4096 sub-directories (in 2 levels) under the output directory of each output
+# 2 levels of 10 sub-directories under the output directory of each output
 # format and will distribute the generated files over these directories.
 # Enabling this option can be useful when feeding doxygen a huge amount of
 # source files, where putting all generated files in the same directory would
 # otherwise cause performance problems for the file system.
+# Enabling this option can be useful when feeding doxygen a huge amount of source
+# files, where putting all generated files in the same directory would otherwise
+# cause performance problems for the file system.
 CREATE_SUBDIRS         = NO
 …
 # information to generate all constant output in the proper language.
 # The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
+# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
+# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
+# and Ukrainian.
+# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
+# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
+# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese,
+# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
 OUTPUT_LANGUAGE        = English
+# This tag can be used to specify the encoding used in the generated output.
+# The encoding is not always determined by the language that is chosen,
+# but also whether or not the output is meant for Windows or non-Windows users.
+# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
+# forces the Windows encoding (this is the default for the Windows binary),
+# whereas setting the tag to NO uses a Unix-style encoding (the default for
+# all platforms other than Windows).
+# USE_WINDOWS_ENCODING   = YES
 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
 …
 # that is used to form the text in various listings. Each string
 # in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+# stripped from the text and the result after processing the whole list, is used
+# as the annotated text. Otherwise, the brief description is used as-is. If left
+# blank, the following values are used ("$name" is automatically replaced with the
+# name of the entity): "The $name class" "The $name widget" "The $name file"
+# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
 ABBREVIATE_BRIEF       =
 …
 ALWAYS_DETAILED_SEC    = NO
 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
 # inherited members of a class in the documentation of that class as if those
 # members were ordinary class members. Constructors, destructors and assignment
 # operators of the base classes will not be shown.
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
+# members of a class in the documentation of that class as if those members were
+# ordinary class members. Constructors, destructors and assignment operators of
+# the base classes will not be shown.
 INLINE_INHERITED_MEMB  = NO
 …
 # will interpret the first line (until the first dot) of a JavaDoc-style
 # comment as the brief description. If set to NO, the JavaDoc
 # comments will behave just like regular Qt-style comments
 # (thus requiring an explicit @brief command for a brief description.)
+# comments will behave just like the Qt-style comments (thus requiring an
+# explicit @brief command for a brief description.
 JAVADOC_AUTOBRIEF      = YES
-# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
-# interpret the first line (until the first dot) of a Qt-style
-# comment as the brief description. If set to NO, the comments
-# will behave just like regular Qt-style comments (thus requiring
-# an explicit \brief command for a brief description.)
-QT_AUTOBRIEF           = NO
 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
 …
 INHERIT_DOCS           = YES
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+SEPARATE_MEMBER_PAGES  = NO
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+DISTRIBUTE_GROUP_DOC   = NO
 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
 …
 # You can put \n's in the value part of an alias to insert newlines.
+ALIASES                = "note=@remark"
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+ALIASES                = \
+    "note=@remark" \
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C.
 # For instance, some of the names that are used will be different. The list
 # of all members will be omitted, etc.
 …
 OPTIMIZE_OUTPUT_FOR_C  = YES
 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
 # sources only. Doxygen will then generate output that is more tailored for
 # Java. For instance, namespaces will be presented as packages, qualified
 # scopes will look different, etc.
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
+# only. Doxygen will then generate output that is more tailored for Java.
+# For instance, namespaces will be presented as packages, qualified scopes
+# will look different, etc.
 OPTIMIZE_OUTPUT_JAVA   = NO
-# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
-# sources only. Doxygen will then generate output that is more tailored for
-# Fortran.
-OPTIMIZE_FOR_FORTRAN   = NO
-# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
-# sources. Doxygen will then generate output that is tailored for
-# VHDL.
-OPTIMIZE_OUTPUT_VHDL   = NO
-# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
-# to include (a tag file for) the STL sources as input, then you should
-# set this tag to YES in order to let doxygen match functions declarations and
-# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
-# func(std::string) {}). This also make the inheritance and collaboration
-# diagrams that involve STL classes more complete and accurate.
-BUILTIN_STL_SUPPORT    = NO
-# If you use Microsoft's C++/CLI language, you should set this option to YES to
-# enable parsing support.
-CPP_CLI_SUPPORT        = NO
-# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
-# Doxygen will parse them like normal C++ but will assume all classes use public
-# instead of private inheritance when no explicit protection keyword is present.
-SIP_SUPPORT            = NO
-# For Microsoft's IDL there are propget and propput attributes to indicate getter
-# and setter methods for a property. Setting this option to YES (the default)
-# will make doxygen to replace the get and set methods by a property in the
-# documentation. This will only work if the methods are indeed getting or
-# setting a simple type. If this is not the case, or you want to show the
-# methods anyway, you should set this option to NO.
-IDL_PROPERTY_SUPPORT   = YES
-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
-# tag is set to YES, then doxygen will reuse the documentation of the first
-# member in the group (if any) for the other members of the group. By default
-# all members of a group must be documented explicitly.
-DISTRIBUTE_GROUP_DOC   = NO
 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
 …
 SUBGROUPING            = YES
-# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
-# is documented as struct, union, or enum with the name of the typedef. So
-# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
-# with name TypeT. When disabled the typedef will appear as a member of a file,
-# namespace, or class. And the struct will be named TypeS. This can typically
-# be useful for C code in case the coding convention dictates that all compound
-# types are typedef'ed and only the typedef is referenced, never the tag name.
-TYPEDEF_HIDES_STRUCT   = NO
 #---------------------------------------------------------------------------
 # Build related configuration options
 …
 EXTRACT_LOCAL_METHODS  = NO
-# If this flag is set to YES, the members of anonymous namespaces will be
-# extracted and appear in the documentation as a namespace called
-# 'anonymous_namespace{file}', where file will be replaced with the base
-# name of the file that contains the anonymous namespace. By default
-# anonymous namespace are hidden.
-EXTRACT_ANON_NSPACES   = NO
 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
 …
 # allowed. This is useful if you have classes or files whose names only differ
 # in case and if your file system supports case sensitive file names. Windows
 # and Mac users are advised to set this option to NO.
+# users are advised to set this option to NO.
 CASE_SENSE_NAMES       = NO
 …
 SORT_BRIEF_DOCS        = NO
-# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
-# hierarchy of group names into alphabetical order. If set to NO (the default)
-# the group names will appear in their defined order.
-SORT_GROUP_NAMES       = NO
 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
 …
 SHOW_USED_FILES        = YES
-# If the sources in your project are distributed over multiple directories
-# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
-# in the documentation. The default is NO.
-SHOW_DIRECTORIES       = NO
-# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
-# This will remove the Files entry from the Quick Index and from the
-# Folder Tree View (if specified). The default is YES.
-SHOW_FILES             = YES
-# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
-# Namespaces page.  This will remove the Namespaces entry from the Quick Index
-# and from the Folder Tree View (if specified). The default is YES.
-SHOW_NAMESPACES        = YES
-# The FILE_VERSION_FILTER tag can be used to specify a program or script that
-# doxygen should invoke to get the current version for each file (typically from
-# the version control system). Doxygen will invoke the program by executing (via
-# popen()) the command <command> <input-file>, where <command> is the value of
-# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
-# provided by doxygen. Whatever the program writes to standard output
-# is used as the file version. See the manual for examples.
-FILE_VERSION_FILTER    =
 #---------------------------------------------------------------------------
 # configuration options related to warning and progress messages
 …
 WARN_IF_DOC_ERROR      = YES
-# This WARN_NO_PARAMDOC option can be abled to get warnings for
-# functions that are documented, but have no documentation for their parameters
-# or return value. If set to NO (the default) doxygen will only warn about
-# wrong or incomplete parameter documentation, but not about the absence of
-# documentation.
-WARN_NO_PARAMDOC       = NO
 # The WARN_FORMAT tag determines the format of the warning messages that
 # doxygen can produce. The string should contain the $file, $line, and $text
 # tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+# warning originated and the warning text.
 WARN_FORMAT            = "$file:$line: $text"
 …
 # to stderr.
 WARN_LOGFILE           =
+#WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 …
 # with spaces.
+INPUT                  =
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+INPUT_ENCODING         = UTF-8
+#INPUT                  =
 # If the value of the INPUT tag contains directories, you can use the
 …
 # and *.h) to filter out the source-files in the directories. If left
 # blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
+FILE_PATTERNS          =
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
+# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
+#FILE_PATTERNS          =
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
 …
 EXCLUDE                =
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
+# that are symbolic links (a Unix filesystem feature) are excluded from the input.
 EXCLUDE_SYMLINKS       = NO
 …
 # If the value of the INPUT tag contains directories, you can use the
 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+# certain files from those directories.
 EXCLUDE_PATTERNS       =
-# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
-# (namespaces, classes, functions, etc.) that should be excluded from the
-# output. The symbol name can be a fully qualified name, a word, or if the
-# wildcard * is used, a substring. Examples: ANamespace, AClass,
-# AClass::ANamespace, ANamespace::*Test
-EXCLUDE_SYMBOLS        =
 # The EXAMPLE_PATH tag can be used to specify one or more files or
 …
 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
 # input file. Doxygen will then use the output that the filter program writes
+# to standard output.  If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+# to standard output.
 INPUT_FILTER           =
-# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
-# basis.  Doxygen will compare the file name with each pattern and apply the
-# filter if there is a match.  The filters are a list of the form:
-# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
-# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
-# is applied to all files.
-FILTER_PATTERNS        =
 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
 …
 STRIP_CODE_COMMENTS    = NO
 # If the REFERENCED_BY_RELATION tag is set to YES
+# If the REFERENCED_BY_RELATION tag is set to YES (the default)
 # then for each documented function all documented
 # functions referencing it will be listed.
 …
 REFERENCED_BY_RELATION = YES
 # If the REFERENCES_RELATION tag is set to YES
+# If the REFERENCES_RELATION tag is set to YES (the default)
 # then for each documented function all documented entities
 # called/used by that function will be listed.
 REFERENCES_RELATION    = YES
-# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
-# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
-# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
-# link to the source code.  Otherwise they will link to the documentstion.
-REFERENCES_LINK_SOURCE = YES
-# If the USE_HTAGS tag is set to YES then the references to source code
-# will point to the HTML generated by the htags(1) tool instead of doxygen
-# built-in source browser. The htags tool is part of GNU's global source
-# tagging system (see http://www.gnu.org/software/global/global.html). You
-# will need version 4.8.6 or higher.
-USE_HTAGS              = NO
 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
 …
 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
 # will be generated that can be used as input for tools like the
 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
 # of the generated HTML documentation.
 GENERATE_HTMLHELP      = NO
-# If the GENERATE_DOCSET tag is set to YES, additional index files
-# will be generated that can be used as input for Apple's Xcode 3
-# integrated development environment, introduced with OSX 10.5 (Leopard).
-# To create a documentation set, doxygen will generate a Makefile in the
-# HTML output directory. Running make will produce the docset in that
-# directory and running "make install" will install the docset in
-# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
-# it at startup.
-GENERATE_DOCSET        = NO
-# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
-# feed. A documentation feed provides an umbrella under which multiple
-# documentation sets from a single provider (such as a company or product suite)
-# can be grouped.
-DOCSET_FEEDNAME        = "Doxygen generated docs"
-# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
-# should uniquely identify the documentation set bundle. This should be a
-# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
-# will append .docset to the name.
-DOCSET_BUNDLE_ID       = org.doxygen.Project
-# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
-# documentation will contain sections that can be hidden and shown after the
-# page has loaded. For this to work a browser that supports
-# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
-# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
-HTML_DYNAMIC_SECTIONS  = NO
 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
 …
 GENERATE_CHI           = NO
-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
-# is used to encode HtmlHelp index (hhk), content (hhc) and project file
-# content.
-CHM_INDEX_ENCODING     =
 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
 # controls whether a binary table of contents is generated (YES) or a
 …
 ENUM_VALUES_PER_LINE   = 4
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to FRAME, a side panel will be generated
+# containing a tree-like index structure (just like the one that
+# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
+# generated containing a tree-like index structure (just like the one that
 # is generated for HTML Help). For this to work a browser that supports
 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
+# probably better off using the HTML help feature. Other possible values
+# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
+# and Class Hiererachy pages using a tree view instead of an ordered list;
+# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
+# disables this behavior completely. For backwards compatibility with previous
+# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
+# respectively.
+# probably better off using the HTML help feature.
 GENERATE_TREEVIEW      = YES
 …
 TREEVIEW_WIDTH         = 250
-# Use this tag to change the font size of Latex formulas included
-# as images in the HTML documentation. The default is 10. Note that
-# when you change the font size after a successful doxygen run you need
-# to manually remove any form_*.png images from the HTML output directory
-# to force them to be regenerated.
-FORMULA_FONTSIZE       = 10
 #---------------------------------------------------------------------------
 …
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
 # then the macro expansion is limited to the macros specified with the
 # PREDEFINED and EXPAND_AS_DEFINED tags.
+# PREDEFINED and EXPAND_AS_PREDEFINED tags.
 EXPAND_ONLY_PREDEF     = YES
 …
 # the preprocessor.
 INCLUDE_PATH           =
+#INCLUDE_PATH           =
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
 …
 # be used.
 INCLUDE_FILE_PATTERNS  =
+#INCLUDE_FILE_PATTERNS  =
 # The PREDEFINED tag can be used to specify one or more macro names that
 …
 # gcc). The argument of the tag is a list of macros of the form: name
 # or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+PREDEFINED             = DOXYGEN_RUNNING \
+                         __DOXYGEN__ \
+                         __END_DECLS= \
+                         __BEGIN_DECLS= \
+                         VBOX=1 \
+                         RT_STRICT=1 \
+                         __cplusplus=1 \
+                         RTCALL= \
+                         ARCH_BITS=HC_ARCH_BITS \
+                         R3_ARCH_BITS=HC_ARCH_BITS \
+                         R0_ARCH_BITS=HC_ARCH_BITS \
+                         RTDECL(type)=type
+# omitted =1 is assumed.
+PREDEFINED             = DOXYGEN_RUNNING __DOXYGEN__ \
+    __END_DECLS=  \
+    __BEGIN_DECLS=  \
+    VBOX=1 \
+    RT_STRICT=1 \
+    __cplusplus=1 \
+    RTCALL= \
+    ARCH_BITS=HC_ARCH_BITS \
+    R3_ARCH_BITS=HC_ARCH_BITS \
+    R0_ARCH_BITS=HC_ARCH_BITS \
+    RTDECL(type)=type \
+#    DECLCALLBACK(type)=type
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 …
 # Use the PREDEFINED tag if you want to use a different macro definition.
+EXPAND_AS_DEFINED      = ARCH_BITS \
+                         GC_ARCH_BITS \
+                         HC_ARCH_BITS \
+                         R3_ARCH_BITS \
+                         R0_ARCH_BITS \
+                         GCTYPE \
+                         GCPTRTYPE \
+                         HCPTRTYPE \
+                         R0PTRTYPE \
+                         R3PTRTYPE \
+                         R3R0PTRTYPE \
+                         DECLEXPORT \
+                         DECLIMPORT \
+                         DECLASM \
+                         DECLASMTYPE \
+                         DECLCALLBACK \
+                         DECLCALLBACKMEMBER \
+                         DECLHCCALLBACKMEMBER \
+                         DECLRCCALLBACKMEMBER \
+                         DECLR3CALLBACKMEMBER \
+                         DECLR0CALLBACKMEMBER \
+                         DECLINLINE \
+                         RTR3DECL \
+                         RTR0DECL \
+                         RTGCDECL \
+                         RTDECL \
+                         RTDATADECL \
+                         KAVL_FN \
+                         CTXSUFF \
+                         OTHERCTXSUFF \
+                         CTXMID \
+                         OTHERCTXMID
+EXPAND_AS_DEFINED      = \
+    ARCH_BITS \
+    GC_ARCH_BITS \
+    HC_ARCH_BITS \
+    R3_ARCH_BITS \
+    R0_ARCH_BITS \
+    \
+    GCTYPE \
+    GCPTRTYPE \
+    HCPTRTYPE \
+    R0PTRTYPE \
+    R3PTRTYPE \
+    R3R0PTRTYPE \
+    \
+    DECLEXPORT \
+    DECLIMPORT \
+    DECLASM \
+    DECLASMTYPE \
+    DECLCALLBACK \
+    DECLCALLBACKMEMBER \
+    DECLHCCALLBACKMEMBER \
+    DECLRCCALLBACKMEMBER \
+    DECLR3CALLBACKMEMBER \
+    DECLR0CALLBACKMEMBER \
+    DECLINLINE \
+    RTR3DECL \
+    RTR0DECL \
+    RTGCDECL \
+    RTDECL \
+    RTDATADECL \
+    KAVL_FN \
+    \
+    CTXSUFF \
+    OTHERCTXSUFF \
+    CTXMID \
+    OTHERCTXMID \
 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
 # doxygen's preprocessor will remove all function-like macros that are alone
 # on a line, have an all uppercase name, and do not end with a semicolon. Such
 # function macros are typically used for boiler-plate code, and will confuse
 # the parser if not removed.
 SKIP_FUNCTION_MACROS   = YES
+# function macros are typically used for boiler-plate code, and will confuse the
+# parser if not removed.
+#SKIP_FUNCTION_MACROS   = YES
 #---------------------------------------------------------------------------
 …
 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option is superseded by the HAVE_DOT option below. This is only a
+# fallback. It is recommended to install and use dot, since it yields more
+# powerful graphs.
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
+# super classes. Setting the tag to NO turns the diagrams off. Note that this
+# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
+# recommended to install and use dot, since it yields more powerful graphs.
 CLASS_DIAGRAMS         = YES
-# You can define message sequence charts within doxygen comments using the \msc
-# command. Doxygen will then run the mscgen tool (see
-# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
-# documentation. The MSCGEN_PATH tag allows you to specify the directory where
-# the mscgen tool resides. If left empty the tool is assumed to be found in the
-# default search path.
-MSCGEN_PATH            =
 # If set to YES, the inheritance and collaboration graphs will hide
 …
 HAVE_DOT               = NO
-# By default doxygen will write a font called FreeSans.ttf to the output
-# directory and reference it in all dot files that doxygen generates. This
-# font does not include all possible unicode characters however, so when you need
-# these (or just want a differently looking font) you can specify the font name
-# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
-# which can be done by putting it in a standard location or by setting the
-# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
-# containing the font.
-DOT_FONTNAME           = FreeSans
-# By default doxygen will tell dot to use the output directory to look for the
-# FreeSans.ttf font (which doxygen will put there itself). If you specify a
-# different font using DOT_FONTNAME you can set the path where dot
-# can find it using this tag.
-DOT_FONTPATH           =
 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
 # will generate a graph for each documented class showing the direct and
 …
 COLLABORATION_GRAPH    = YES
-# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
-# will generate a graph for groups, showing the direct groups dependencies
-GROUP_GRAPHS           = YES
 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
 # collaboration diagrams in a style similar to the OMG's Unified Modeling
 …
 INCLUDED_BY_GRAPH      = YES
 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
 # doxygen will generate a call dependency graph for every global function
 # or class method. Note that enabling this option will significantly increase
 # the time of a run. So in most cases it will be better to enable call graphs
 # for selected functions only using the \callgraph command.
+# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
+# generate a call dependency graph for every global function or class method.
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable call graphs for selected
+# functions only using the \callgraph command.
 CALL_GRAPH             = YES
-# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
-# doxygen will generate a caller dependency graph for every global function
-# or class method. Note that enabling this option will significantly increase
-# the time of a run. So in most cases it will be better to enable caller
-# graphs for selected functions only using the \callergraph command.
-CALLER_GRAPH           = NO
 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
 …
 GRAPHICAL_HIERARCHY    = YES
-# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
-# then doxygen will show the dependencies a directory has on other directories
-# in a graphical way. The dependency relations are determined by the #include
-# relations between the files in the directories.
-DIRECTORY_GRAPH        = YES
 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
 …
 # The tag DOT_PATH can be used to specify the path where the dot tool can be
 # found. If left blank, it is assumed the dot tool can be found in the path.
+# found. If left blank, it is assumed the dot tool can be found on the path.
 DOT_PATH               =
 …
 DOTFILE_DIRS           =
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# nodes that will be shown in the graph. If the number of nodes in a graph
+# becomes larger than this value, doxygen will truncate the graph, which is
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+DOT_GRAPH_MAX_NODES    = 50
+# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
+# (in pixels) of the graphs generated by dot. If a graph becomes larger than
+# this value, doxygen will try to truncate the graph, so that it fits within
+# the specified constraint. Beware that most browsers cannot cope with very
+# large images.
+MAX_DOT_GRAPH_WIDTH    = 1024
+# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
+# (in pixels) of the graphs generated by dot. If a graph becomes larger than
+# this value, doxygen will try to truncate the graph, so that it fits within
+# the specified constraint. Beware that most browsers cannot cope with very
+# large images.
+MAX_DOT_GRAPH_HEIGHT   = 1024
 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
 # graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+# from the root by following a path via at most 3 edges will be shown. Nodes that
+# lay further from the root node will be omitted. Note that setting this option to
+# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
+# note that a graph may be further truncated if the graph's image dimensions are
+# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
+# If 0 is used for the depth value (the default), the graph is not depth-constrained.
 MAX_DOT_GRAPH_DEPTH    = 0
-# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
-# background. This is enabled by default, which results in a transparent
-# background. Warning: Depending on the platform used, enabling this option
-# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
-# become hard to read).
-DOT_TRANSPARENT        = YES
-# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
-# files in one run (i.e. multiple -o and -T options on the command line). This
-# makes dot run faster, but since only newer versions of dot (>1.8.10)
-# support this, this feature is disabled by default.
-DOT_MULTI_TARGETS      = NO
 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
 …
 SEARCHENGINE           = NO
+#
+# The next bit is generated by the Makefile.
+#

Note: See TracChangeset for help on using the changeset viewer.

Changeset 18629 in vbox

Legend:

trunk/src/VBox/Runtime/Doxyfile

Download in other formats: