| Index: third_party/libvpx/source/libvpx/libs.doxy_template
|
| diff --git a/ppapi/cpp/documentation/Doxyfile b/third_party/libvpx/source/libvpx/libs.doxy_template
|
| similarity index 61%
|
| copy from ppapi/cpp/documentation/Doxyfile
|
| copy to third_party/libvpx/source/libvpx/libs.doxy_template
|
| index ac862da1792c56399a211da22cd7dccead484937..5a8f847280e1054002fa8a44c88b180de890dd82 100644
|
| --- a/ppapi/cpp/documentation/Doxyfile
|
| +++ b/third_party/libvpx/source/libvpx/libs.doxy_template
|
| @@ -1,8 +1,15 @@
|
| -# Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
| -# Use of this source code is governed by a BSD-style license that can be
|
| -# found in the LICENSE file.
|
| +##
|
| +## Copyright (c) 2010 The WebM project authors. All Rights Reserved.
|
| +##
|
| +## Use of this source code is governed by a BSD-style license
|
| +## that can be found in the LICENSE file in the root of the source
|
| +## tree. An additional intellectual property rights grant can be found
|
| +## in the file PATENTS. All contributing project authors may
|
| +## be found in the AUTHORS file in the root of the source tree.
|
| +##
|
|
|
| -# Doxyfile 1.7.4
|
| +
|
| +# Doxyfile 1.5.4
|
|
|
| # This file describes the settings to be used by the documentation system
|
| # doxygen (www.doxygen.org) for a project
|
| @@ -18,44 +25,25 @@
|
| # Project related configuration options
|
| #---------------------------------------------------------------------------
|
|
|
| -# 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.
|
| +# 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.
|
|
|
| -PROJECT_NAME =
|
| -
|
| -# The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
| -# This could be handy for archiving the generated documentation or
|
| -# if some version control system is used.
|
| -
|
| -PROJECT_NUMBER =
|
| -
|
| -# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
| -# for a project that appears at the top of each page and should give viewer
|
| -# a quick idea about the purpose of the project. Keep the description short.
|
| -
|
| -PROJECT_BRIEF =
|
| -
|
| -# With the PROJECT_LOGO tag one can specify an logo or icon that is
|
| -# included in the documentation. The maximum height of the logo should not
|
| -# exceed 55 pixels and the maximum width should not exceed 200 pixels.
|
| -# Doxygen will copy the logo to the output directory.
|
| -
|
| -PROJECT_LOGO =
|
| +PROJECT_NAME = "WebM Codec SDK"
|
|
|
| # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
| # base path where the generated documentation will be put.
|
| # If a relative path is entered, it will be relative to the location
|
| # where doxygen was started. If left blank the current directory will be used.
|
|
|
| -OUTPUT_DIRECTORY = PepperCPPRefDocs
|
| +OUTPUT_DIRECTORY = docs
|
|
|
| # 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
|
| @@ -71,20 +59,19 @@ 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, Esperanto, 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, Serbian-Cyrillic, Slovak,
|
| -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
|
| +# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
|
| +# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
|
| +# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
|
| +# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
|
|
|
| OUTPUT_LANGUAGE = English
|
|
|
| # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
|
| # include brief member descriptions after the members that are listed in
|
| -# the file and class documentation (similar to JavaDoc).
|
| +# the file and class documentation (similar to java_doc).
|
| # Set to NO to disable this.
|
|
|
| -BRIEF_MEMBER_DESC = NO
|
| +BRIEF_MEMBER_DESC = YES
|
|
|
| # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
|
| # the brief description of a member or function before the detailed description.
|
| @@ -103,17 +90,7 @@ REPEAT_BRIEF = YES
|
| # "The $name file" "is" "provides" "specifies" "contains"
|
| # "represents" "a" "an" "the"
|
|
|
| -ABBREVIATE_BRIEF = "The $name class" \
|
| - "The $name widget" \
|
| - "The $name file" \
|
| - is \
|
| - provides \
|
| - specifies \
|
| - contains \
|
| - represents \
|
| - a \
|
| - an \
|
| - the
|
| +ABBREVIATE_BRIEF =
|
|
|
| # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
|
| # Doxygen will generate a detailed section even if there is only a brief
|
| @@ -153,18 +130,18 @@ STRIP_FROM_PATH =
|
| STRIP_FROM_INC_PATH =
|
|
|
| # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
|
| -# (but less readable) file names. This can be useful if your file system
|
| +# (but less readable) file names. This can be useful is your file systems
|
| # doesn't support long names like on DOS, Mac, or CD-ROM.
|
|
|
| SHORT_NAMES = NO
|
|
|
| # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
|
| -# will interpret the first line (until the first dot) of a JavaDoc-style
|
| -# comment as the brief description. If set to NO, the JavaDoc
|
| +# will interpret the first line (until the first dot) of a java_doc-style
|
| +# comment as the brief description. If set to NO, the java_doc
|
| # comments will behave just like regular Qt-style comments
|
| # (thus requiring an explicit @brief command for a brief description.)
|
|
|
| -JAVADOC_AUTOBRIEF = YES
|
| +JAVADOC_AUTOBRIEF = NO
|
|
|
| # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
|
| # interpret the first line (until the first dot) of a Qt-style
|
| @@ -197,7 +174,7 @@ SEPARATE_MEMBER_PAGES = NO
|
| # The TAB_SIZE tag can be used to set the number of spaces in a tab.
|
| # Doxygen uses this value to replace tabs by spaces in code fragments.
|
|
|
| -TAB_SIZE = 8
|
| +TAB_SIZE = 4
|
|
|
| # This tag can be used to specify a number of aliases that acts
|
| # as commands in the documentation. An alias has the form "name=value".
|
| @@ -213,44 +190,20 @@ ALIASES =
|
| # 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 = NO
|
| +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.
|
| +# 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
|
| -
|
| -# Doxygen selects the parser to use depending on the extension of the files it
|
| -# parses. With this tag you can assign which parser to use for a given extension.
|
| -# Doxygen has a built-in mapping, but you can override or extend it using this
|
| -# tag. The format is ext=language, where ext is a file extension, and language
|
| -# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
|
| -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
|
| -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
|
| -# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
|
| -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
|
| -
|
| -EXTENSION_MAPPING =
|
| -
|
| -# 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
|
| +# 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 makes the inheritance and collaboration
|
| +# func(std::string) {}). This also make the inheritance and collaboration
|
| # diagrams that involve STL classes more complete and accurate.
|
|
|
| BUILTIN_STL_SUPPORT = NO
|
| @@ -266,15 +219,6 @@ CPP_CLI_SUPPORT = NO
|
|
|
| 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 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
|
| @@ -282,7 +226,7 @@ IDL_PROPERTY_SUPPORT = YES
|
|
|
| DISTRIBUTE_GROUP_DOC = NO
|
|
|
| -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
|
| +# Set the SUBGROUPING tag to YES (the defqault) to allow class member groups of
|
| # the same type (for instance a group of public functions) to be put as a
|
| # subgroup of that type (e.g. under the Public Functions section). Set it to
|
| # NO to prevent subgrouping. Alternatively, this can be done per class using
|
| @@ -290,39 +234,16 @@ DISTRIBUTE_GROUP_DOC = NO
|
|
|
| SUBGROUPING = YES
|
|
|
| -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
|
| -# unions are shown inside the group in which they are included (e.g. using
|
| -# @ingroup) instead of on a separate page (for HTML and Man pages) or
|
| -# section (for LaTeX and RTF).
|
| -
|
| -INLINE_GROUPED_CLASSES = NO
|
| -
|
| -# 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.
|
| +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is
|
| +# documented as struct with the name of the typedef. So
|
| +# typedef struct type_s {} type_t, will appear in the documentation as a struct
|
| +# with name type_t. When disabled the typedef will appear as a member of a file,
|
| +# namespace, or class. And the struct will be named type_s. This can typically
|
| +# be useful for C code where the coding convention is that all structs are
|
| +# typedef'ed and only the typedef is referenced never the struct's name.
|
|
|
| TYPEDEF_HIDES_STRUCT = NO
|
|
|
| -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
|
| -# determine which symbols to keep in memory and which to flush to disk.
|
| -# When the cache is full, less often used symbols will be written to disk.
|
| -# For small to medium size projects (<1000 input files) the default value is
|
| -# probably good enough. For larger projects a too small cache size can cause
|
| -# doxygen to be busy swapping symbols to and from disk most of the time
|
| -# causing a significant performance penalty.
|
| -# If the system has enough physical memory increasing the cache will improve the
|
| -# performance by keeping more symbols in memory. Note that the value works on
|
| -# a logarithmic scale so increasing the size by one will roughly double the
|
| -# memory usage. The cache size is given by this formula:
|
| -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
|
| -# corresponding to a cache size of 2^16 = 65536 symbols
|
| -
|
| -SYMBOL_CACHE_SIZE = 0
|
| -
|
| #---------------------------------------------------------------------------
|
| # Build related configuration options
|
| #---------------------------------------------------------------------------
|
| @@ -332,7 +253,7 @@ SYMBOL_CACHE_SIZE = 0
|
| # Private class members and static file members will be hidden unless
|
| # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
|
|
|
| -EXTRACT_ALL = YES
|
| +EXTRACT_ALL = NO
|
|
|
| # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
|
| # will be included in the documentation.
|
| @@ -357,11 +278,10 @@ EXTRACT_LOCAL_CLASSES = YES
|
|
|
| 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 namespaces are hidden.
|
| +# 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
|
|
|
| @@ -407,7 +327,7 @@ INTERNAL_DOCS = NO
|
| # in case and if your file system supports case sensitive file names. Windows
|
| # and Mac users are advised to set this option to NO.
|
|
|
| -CASE_SENSE_NAMES = NO
|
| +CASE_SENSE_NAMES = YES
|
|
|
| # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
|
| # will show members with their full class and namespace scopes in the
|
| @@ -419,13 +339,7 @@ HIDE_SCOPE_NAMES = NO
|
| # will put a list of the files that are included by a file in the documentation
|
| # of that file.
|
|
|
| -SHOW_INCLUDE_FILES = NO
|
| -
|
| -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
|
| -# will list include files with double quotes in the documentation
|
| -# rather than with sharp brackets.
|
| -
|
| -FORCE_LOCAL_INCLUDES = NO
|
| +SHOW_INCLUDE_FILES = YES
|
|
|
| # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
|
| # is inserted in the documentation for inline members.
|
| @@ -437,7 +351,7 @@ INLINE_INFO = YES
|
| # alphabetically by member name. If set to NO the members will appear in
|
| # declaration order.
|
|
|
| -SORT_MEMBER_DOCS = YES
|
| +SORT_MEMBER_DOCS = NO
|
|
|
| # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
|
| # brief documentation of file, namespace and class members alphabetically
|
| @@ -446,22 +360,6 @@ SORT_MEMBER_DOCS = YES
|
|
|
| SORT_BRIEF_DOCS = NO
|
|
|
| -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
|
| -# will sort the (brief and detailed) documentation of class members so that
|
| -# constructors and destructors are listed first. If set to NO (the default)
|
| -# the constructors will appear in the respective orders defined by
|
| -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
|
| -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
|
| -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
|
| -
|
| -SORT_MEMBERS_CTORS_1ST = 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
|
| # sorted by fully-qualified names, including namespaces. If set to
|
| # NO (the default), the class list will be sorted only by class name,
|
| @@ -472,15 +370,6 @@ SORT_GROUP_NAMES = NO
|
|
|
| SORT_BY_SCOPE_NAME = NO
|
|
|
| -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
|
| -# do proper type resolution of all parameters of a function it will reject a
|
| -# match between the prototype and the implementation of a member function even
|
| -# if there is only one candidate or it is obvious which candidate to choose
|
| -# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
|
| -# will still accept a match between prototype and implementation in such cases.
|
| -
|
| -STRICT_PROTO_MATCHING = NO
|
| -
|
| # The GENERATE_TODOLIST tag can be used to enable (YES) or
|
| # disable (NO) the todo list. This list is created by putting \todo
|
| # commands in the documentation.
|
| @@ -511,14 +400,14 @@ GENERATE_DEPRECATEDLIST= YES
|
| ENABLED_SECTIONS =
|
|
|
| # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
|
| -# the initial value of a variable or macro consists of for it to appear in
|
| +# the initial value of a variable or define consists of for it to appear in
|
| # the documentation. If the initializer consists of more lines than specified
|
| # here it will be hidden. Use a value of 0 to hide initializers completely.
|
| -# The appearance of the initializer of individual variables and macros in the
|
| +# The appearance of the initializer of individual variables and defines in the
|
| # documentation can be controlled using \showinitializer or \hideinitializer
|
| # command in the documentation regardless of this setting.
|
|
|
| -MAX_INITIALIZER_LINES = 27
|
| +MAX_INITIALIZER_LINES = 30
|
|
|
| # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
|
| # at the bottom of the documentation of classes and structs. If set to YES the
|
| @@ -526,27 +415,9 @@ MAX_INITIALIZER_LINES = 27
|
|
|
| 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
|
| +# 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
|
| @@ -554,15 +425,6 @@ SHOW_NAMESPACES = YES
|
|
|
| FILE_VERSION_FILTER =
|
|
|
| -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
|
| -# by doxygen. The layout file controls the global structure of the generated
|
| -# output files in an output format independent way. The create the layout file
|
| -# that represents doxygen's defaults, run doxygen with the -l option.
|
| -# You can optionally specify a file name after the option, if omitted
|
| -# DoxygenLayout.xml will be used as the name of the layout file.
|
| -
|
| -LAYOUT_FILE = ./documentation/DoxygenLayout.xml
|
| -
|
| #---------------------------------------------------------------------------
|
| # configuration options related to warning and progress messages
|
| #---------------------------------------------------------------------------
|
| @@ -570,7 +432,7 @@ LAYOUT_FILE = ./documentation/DoxygenLayout.xml
|
| # The QUIET tag can be used to turn on/off the messages that are generated
|
| # by doxygen. Possible values are YES and NO. If left blank NO is used.
|
|
|
| -QUIET = NO
|
| +QUIET = YES
|
|
|
| # The WARNINGS tag can be used to turn on/off the warning messages that are
|
| # generated by doxygen. Possible values are YES and NO. If left blank
|
| @@ -591,7 +453,7 @@ WARN_IF_UNDOCUMENTED = YES
|
|
|
| WARN_IF_DOC_ERROR = YES
|
|
|
| -# The WARN_NO_PARAMDOC option can be enabled to get warnings for
|
| +# 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
|
| @@ -623,14 +485,12 @@ WARN_LOGFILE =
|
| # directories like "/usr/src/myproject". Separate the files or directories
|
| # with spaces.
|
|
|
| -INPUT = . \
|
| - ./documentation
|
| +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.
|
| +# 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
|
|
|
| @@ -638,12 +498,10 @@ INPUT_ENCODING = UTF-8
|
| # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
| # and *.h) to filter out the source-files in the directories. If left
|
| # blank the following patterns are tested:
|
| -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
|
| -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
|
| -# *.f90 *.f *.for *.vhd *.vhdl
|
| +# *.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 = *.h \
|
| - *.dox
|
| +FILE_PATTERNS =
|
|
|
| # The RECURSIVE tag can be used to turn specify whether or not subdirectories
|
| # should be searched for input files as well. Possible values are YES and NO.
|
| @@ -658,7 +516,7 @@ RECURSIVE = NO
|
| EXCLUDE =
|
|
|
| # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
|
| -# directories that are symbolic links (a Unix file system feature) are excluded
|
| +# directories that are symbolic links (a Unix filesystem feature) are excluded
|
| # from the input.
|
|
|
| EXCLUDE_SYMLINKS = NO
|
| @@ -669,13 +527,12 @@ EXCLUDE_SYMLINKS = NO
|
| # against the file with absolute path, so to exclude all test directories
|
| # for example use the pattern */test/*
|
|
|
| -EXCLUDE_PATTERNS = _*.h
|
| +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
|
| +# (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 =
|
|
|
| @@ -690,7 +547,7 @@ EXAMPLE_PATH =
|
| # and *.h) to filter out the source-files in the directories. If left
|
| # blank all files are included.
|
|
|
| -EXAMPLE_PATTERNS = *
|
| +EXAMPLE_PATTERNS =
|
|
|
| # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
|
| # searched for input files to be used with the \include or \dontinclude
|
| @@ -703,7 +560,7 @@ EXAMPLE_RECURSIVE = NO
|
| # directories that contain image that are included in the documentation (see
|
| # the \image command).
|
|
|
| -IMAGE_PATH = ./documentation/images-dox
|
| +IMAGE_PATH =
|
|
|
| # The INPUT_FILTER tag can be used to specify a program that doxygen should
|
| # invoke to filter for each input file. Doxygen will invoke the filter program
|
| @@ -719,8 +576,8 @@ INPUT_FILTER =
|
| # 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 or if
|
| -# non of the patterns match the file name, INPUT_FILTER is applied.
|
| +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
|
| +# is applied to all files.
|
|
|
| FILTER_PATTERNS =
|
|
|
| @@ -730,14 +587,6 @@ FILTER_PATTERNS =
|
|
|
| FILTER_SOURCE_FILES = NO
|
|
|
| -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
|
| -# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
|
| -# and it is also possible to disable source filtering for a specific pattern
|
| -# using *.ext= (so without naming a filter). This option only has effect when
|
| -# FILTER_SOURCE_FILES is enabled.
|
| -
|
| -FILTER_SOURCE_PATTERNS =
|
| -
|
| #---------------------------------------------------------------------------
|
| # configuration options related to source browsing
|
| #---------------------------------------------------------------------------
|
| @@ -745,7 +594,9 @@ FILTER_SOURCE_PATTERNS =
|
| # If the SOURCE_BROWSER tag is set to YES then a list of source files will
|
| # be generated. Documented entities will be cross-referenced with these sources.
|
| # Note: To get rid of all source code in the generated output, make sure also
|
| -# VERBATIM_HEADERS is set to NO.
|
| +# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
|
| +# then you must also enable this option. If you don't then doxygen will produce
|
| +# a warning and turn it on anyway
|
|
|
| SOURCE_BROWSER = NO
|
|
|
| @@ -760,22 +611,22 @@ INLINE_SOURCES = NO
|
|
|
| STRIP_CODE_COMMENTS = YES
|
|
|
| -# 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 = NO
|
| +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 = NO
|
| +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 documentation.
|
| +# link to the source code. Otherwise they will link to the documentstion.
|
|
|
| REFERENCES_LINK_SOURCE = YES
|
|
|
| @@ -791,7 +642,7 @@ USE_HTAGS = NO
|
| # will generate a verbatim copy of the header file for each class for
|
| # which an include is specified. Set to NO to disable this.
|
|
|
| -VERBATIM_HEADERS = NO
|
| +VERBATIM_HEADERS = YES
|
|
|
| #---------------------------------------------------------------------------
|
| # configuration options related to the alphabetical class index
|
| @@ -839,22 +690,15 @@ HTML_FILE_EXTENSION = .html
|
|
|
| # The HTML_HEADER tag can be used to specify a personal HTML header for
|
| # each generated HTML page. If it is left blank doxygen will generate a
|
| -# standard header. Note that when using a custom header you are responsible
|
| -# for the proper inclusion of any scripts and style sheets that doxygen
|
| -# needs, which is dependent on the configuration options used.
|
| -# It is adviced to generate a default header using "doxygen -w html
|
| -# header.html footer.html stylesheet.css YourConfigFile" and then modify
|
| -# that header. Note that the header is subject to change so you typically
|
| -# have to redo this when upgrading to a newer version of doxygen or when
|
| -# changing the value of configuration settings such as GENERATE_TREEVIEW!
|
| +# standard header.
|
|
|
| -HTML_HEADER = documentation/header.html
|
| +HTML_HEADER =
|
|
|
| # The HTML_FOOTER tag can be used to specify a personal HTML footer for
|
| # each generated HTML page. If it is left blank doxygen will generate a
|
| # standard footer.
|
|
|
| -HTML_FOOTER = documentation/footer.html
|
| +HTML_FOOTER =
|
|
|
| # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
|
| # style sheet that is used by each HTML page. It can be used to
|
| @@ -863,106 +707,23 @@ HTML_FOOTER = documentation/footer.html
|
| # the style sheet file to the HTML output directory, so don't put your own
|
| # stylesheet in the HTML output directory as well, or it will be erased!
|
|
|
| -HTML_STYLESHEET = documentation/stylesheet.css
|
| -
|
| -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
|
| -# other source files which should be copied to the HTML output directory. Note
|
| -# that these files will be copied to the base HTML output directory. Use the
|
| -# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
|
| -# files. In the HTML_STYLESHEET file, use the file name only. Also note that
|
| -# the files will be copied as-is; there are no commands or markers available.
|
| -
|
| -HTML_EXTRA_FILES =
|
| -
|
| -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
|
| -# Doxygen will adjust the colors in the stylesheet and background images
|
| -# according to this color. Hue is specified as an angle on a colorwheel,
|
| -# see http://en.wikipedia.org/wiki/Hue for more information.
|
| -# For instance the value 0 represents red, 60 is yellow, 120 is green,
|
| -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
|
| -# The allowed range is 0 to 359.
|
| -
|
| -HTML_COLORSTYLE_HUE = 217
|
| +HTML_STYLESHEET =
|
|
|
| -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
|
| -# the colors in the HTML output. For a value of 0 the output will use
|
| -# grayscales only. A value of 255 will produce the most vivid colors.
|
| -
|
| -HTML_COLORSTYLE_SAT = 100
|
| -
|
| -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
|
| -# the luminance component of the colors in the HTML output. Values below
|
| -# 100 gradually make the output lighter, whereas values above 100 make
|
| -# the output darker. The value divided by 100 is the actual gamma applied,
|
| -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
|
| -# and 100 does not change the gamma.
|
| -
|
| -HTML_COLORSTYLE_GAMMA = 80
|
| -
|
| -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
|
| -# page will contain the date and time when the page was generated. Setting
|
| -# this to NO can help when comparing the output of multiple runs.
|
| -
|
| -HTML_TIMESTAMP = YES
|
| -
|
| -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
|
| -# files or namespaces will be aligned in HTML using tables. If set to
|
| -# NO a bullet list will be used.
|
| +# 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 compressed HTML help file (.chm)
|
| +# of the generated HTML documentation.
|
|
|
| -HTML_ALIGN_MEMBERS = YES
|
| +GENERATE_HTMLHELP = NO
|
|
|
| # 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
|
| +# java_script 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_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.
|
| -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
|
| -# for more information.
|
| -
|
| -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
|
| -
|
| -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
|
| -# the documentation publisher. This should be a reverse domain-name style
|
| -# string, e.g. com.mycompany.MyDocSet.documentation.
|
| -
|
| -DOCSET_PUBLISHER_ID = org.doxygen.Publisher
|
| -
|
| -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
|
| -
|
| -DOCSET_PUBLISHER_NAME = Publisher
|
| -
|
| -# 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)
|
| -# of the generated HTML documentation.
|
| -
|
| -GENERATE_HTMLHELP = NO
|
| -
|
| # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
|
| # be used to specify the file name of the resulting .chm file. You
|
| # can add a path in front of the file if the result should not be
|
| @@ -983,12 +744,6 @@ HHC_LOCATION =
|
|
|
| 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
|
| # normal table of contents (NO) in the .chm file.
|
| @@ -1000,232 +755,83 @@ BINARY_TOC = NO
|
|
|
| TOC_EXPAND = NO
|
|
|
| -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
|
| -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
|
| -# that can be used as input for Qt's qhelpgenerator to generate a
|
| -# Qt Compressed Help (.qch) of the generated HTML documentation.
|
| -
|
| -GENERATE_QHP = NO
|
| -
|
| -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
|
| -# be used to specify the file name of the resulting .qch file.
|
| -# The path specified is relative to the HTML output folder.
|
| -
|
| -QCH_FILE =
|
| -
|
| -# The QHP_NAMESPACE tag specifies the namespace to use when generating
|
| -# Qt Help Project output. For more information please see
|
| -# http://doc.trolltech.com/qthelpproject.html#namespace
|
| -
|
| -QHP_NAMESPACE = org.doxygen.Project
|
| -
|
| -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
|
| -# Qt Help Project output. For more information please see
|
| -# http://doc.trolltech.com/qthelpproject.html#virtual-folders
|
| -
|
| -QHP_VIRTUAL_FOLDER = doc
|
| -
|
| -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
|
| -# add. For more information please see
|
| -# http://doc.trolltech.com/qthelpproject.html#custom-filters
|
| -
|
| -QHP_CUST_FILTER_NAME =
|
| -
|
| -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
|
| -# custom filter to add. For more information please see
|
| -# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
|
| -# Qt Help Project / Custom Filters</a>.
|
| -
|
| -QHP_CUST_FILTER_ATTRS =
|
| -
|
| -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
|
| -# project's
|
| -# filter section matches.
|
| -# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
|
| -# Qt Help Project / Filter Attributes</a>.
|
| -
|
| -QHP_SECT_FILTER_ATTRS =
|
| -
|
| -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
|
| -# be used to specify the location of Qt's qhelpgenerator.
|
| -# If non-empty doxygen will try to run qhelpgenerator on the generated
|
| -# .qhp file.
|
| -
|
| -QHG_LOCATION =
|
| -
|
| -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
|
| -# will be generated, which together with the HTML files, form an Eclipse help
|
| -# plugin. To install this plugin and make it available under the help contents
|
| -# menu in Eclipse, the contents of the directory containing the HTML and XML
|
| -# files needs to be copied into the plugins directory of eclipse. The name of
|
| -# the directory within the plugins directory should be the same as
|
| -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
|
| -# the help appears.
|
| -
|
| -GENERATE_ECLIPSEHELP = NO
|
| -
|
| -# A unique identifier for the eclipse help plugin. When installing the plugin
|
| -# the directory name containing the HTML and XML files should also have
|
| -# this name.
|
| -
|
| -ECLIPSE_DOC_ID = org.doxygen.Project
|
| -
|
| # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
|
| # top of each HTML page. The value NO (the default) enables the index and
|
| # the value YES disables it.
|
|
|
| DISABLE_INDEX = NO
|
|
|
| -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
|
| -# (range [0,1..20]) that doxygen will group on one line in the generated HTML
|
| -# documentation. Note that a value of 0 will completely suppress the enum
|
| -# values from appearing in the overview section.
|
| +# This tag can be used to set the number of enum values (range [1..20])
|
| +# that doxygen will group on one line in the generated HTML documentation.
|
|
|
| -ENUM_VALUES_PER_LINE = 0
|
| +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 YES, 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 (i.e. any modern browser).
|
| -# Windows users are probably better off using the HTML help feature.
|
| +# java_script, 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.
|
|
|
| GENERATE_TREEVIEW = NO
|
|
|
| -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
|
| -# and Class Hierarchy pages using a tree view instead of an ordered list.
|
| -
|
| -USE_INLINE_TREES = NO
|
| -
|
| # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
|
| # used to set the initial width (in pixels) of the frame in which the tree
|
| # is shown.
|
|
|
| -TREEVIEW_WIDTH = 251
|
| -
|
| -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
|
| -# links to external symbols imported via tag files in a separate window.
|
| -
|
| -EXT_LINKS_IN_WINDOW = NO
|
| -
|
| -# 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
|
| -
|
| -# Use the FORMULA_TRANPARENT tag to determine whether or not the images
|
| -# generated for formulas are transparent PNGs. Transparent PNGs are
|
| -# not supported properly for IE 6.0, but are supported on all modern browsers.
|
| -# Note that when changing this option you need to delete any form_*.png files
|
| -# in the HTML output before the changes have effect.
|
| -
|
| -FORMULA_TRANSPARENT = YES
|
| -
|
| -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
|
| -# (see http://www.mathjax.org) which uses client side Javascript for the
|
| -# rendering instead of using prerendered bitmaps. Use this if you do not
|
| -# have LaTeX installed or if you want to formulas look prettier in the HTML
|
| -# output. When enabled you also need to install MathJax separately and
|
| -# configure the path to it using the MATHJAX_RELPATH option.
|
| -
|
| -USE_MATHJAX = NO
|
| -
|
| -# When MathJax is enabled you need to specify the location relative to the
|
| -# HTML output directory using the MATHJAX_RELPATH option. The destination
|
| -# directory should contain the MathJax.js script. For instance, if the mathjax
|
| -# directory is located at the same level as the HTML output directory, then
|
| -# MATHJAX_RELPATH should be ../mathjax. The default value points to the
|
| -# mathjax.org site, so you can quickly see the result without installing
|
| -# MathJax, but it is strongly recommended to install a local copy of MathJax
|
| -# before deployment.
|
| -
|
| -MATHJAX_RELPATH = http://www.mathjax.org/mathjax
|
| -
|
| -# When the SEARCHENGINE tag is enabled doxygen will generate a search box
|
| -# for the HTML output. The underlying search engine uses javascript
|
| -# and DHTML and should work on any modern browser. Note that when using
|
| -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
|
| -# (GENERATE_DOCSET) there is already a search function so this one should
|
| -# typically be disabled. For large projects the javascript based search engine
|
| -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
|
| -
|
| -SEARCHENGINE = NO
|
| -
|
| -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
|
| -# implemented using a PHP enabled web server instead of at the web client
|
| -# using Javascript. Doxygen will generate the search PHP script and index
|
| -# file to put on the web server. The advantage of the server
|
| -# based approach is that it scales better to large projects and allows
|
| -# full text search. The disadvantages are that it is more difficult to setup
|
| -# and does not have live searching capabilities.
|
| -
|
| -SERVER_BASED_SEARCH = NO
|
| +TREEVIEW_WIDTH = 250
|
|
|
| #---------------------------------------------------------------------------
|
| -# configuration options related to the LaTeX output
|
| +# configuration options related to the la_te_x output
|
| #---------------------------------------------------------------------------
|
|
|
| # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
|
| # generate Latex output.
|
|
|
| -GENERATE_LATEX = NO
|
| +GENERATE_LATEX = YES
|
|
|
| -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
|
| +# The LATEX_OUTPUT tag is used to specify where the la_te_x docs will be put.
|
| # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
| # put in front of it. If left blank `latex' will be used as the default path.
|
|
|
| LATEX_OUTPUT = latex
|
|
|
| -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
| +# The LATEX_CMD_NAME tag can be used to specify the la_te_x command name to be
|
| # invoked. If left blank `latex' will be used as the default command name.
|
| -# Note that when enabling USE_PDFLATEX this option is only used for
|
| -# generating bitmaps for formulas in the HTML output, but not in the
|
| -# Makefile that is written to the output directory.
|
|
|
| LATEX_CMD_NAME = latex
|
|
|
| # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
|
| -# generate index for LaTeX. If left blank `makeindex' will be used as the
|
| +# generate index for la_te_x. If left blank `makeindex' will be used as the
|
| # default command name.
|
|
|
| MAKEINDEX_CMD_NAME = makeindex
|
|
|
| # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
|
| -# LaTeX documents. This may be useful for small projects and may help to
|
| +# la_te_x documents. This may be useful for small projects and may help to
|
| # save some trees in general.
|
|
|
| -COMPACT_LATEX = NO
|
| +COMPACT_LATEX = YES
|
|
|
| # The PAPER_TYPE tag can be used to set the paper type that is used
|
| -# by the printer. Possible values are: a4, letter, legal and
|
| +# by the printer. Possible values are: a4, a4wide, letter, legal and
|
| # executive. If left blank a4wide will be used.
|
|
|
| -PAPER_TYPE = a4wide
|
| +PAPER_TYPE = letter
|
|
|
| -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
|
| -# packages that should be included in the LaTeX output.
|
| +# The EXTRA_PACKAGES tag can be to specify one or more names of la_te_x
|
| +# packages that should be included in the la_te_x output.
|
|
|
| EXTRA_PACKAGES =
|
|
|
| -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
|
| +# The LATEX_HEADER tag can be used to specify a personal la_te_x header for
|
| # the generated latex document. The header should contain everything until
|
| # the first chapter. If it is left blank doxygen will generate a
|
| # standard header. Notice: only use this tag if you know what you are doing!
|
|
|
| LATEX_HEADER =
|
|
|
| -# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
|
| -# the generated latex document. The footer should contain everything after
|
| -# the last chapter. If it is left blank doxygen will generate a
|
| -# standard footer. Notice: only use this tag if you know what you are doing!
|
| -
|
| -LATEX_FOOTER =
|
| -
|
| -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
|
| +# If the PDF_HYPERLINKS tag is set to YES, the la_te_x that is generated
|
| # is prepared for conversion to pdf (using ps2pdf). The pdf file will
|
| # contain links (just like the HTML output) instead of page references
|
| # This makes the output suitable for online browsing using a pdf viewer.
|
| @@ -1239,7 +845,7 @@ PDF_HYPERLINKS = YES
|
| USE_PDFLATEX = YES
|
|
|
| # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
|
| -# command to the generated LaTeX files. This will instruct LaTeX to keep
|
| +# command to the generated la_te_x files. This will instruct la_te_x to keep
|
| # running if errors occur, instead of asking the user for help.
|
| # This option is also used when generating formulas in HTML.
|
|
|
| @@ -1251,13 +857,6 @@ LATEX_BATCHMODE = NO
|
|
|
| LATEX_HIDE_INDICES = NO
|
|
|
| -# If LATEX_SOURCE_CODE is set to YES then doxygen will include
|
| -# source code with syntax highlighting in the LaTeX output.
|
| -# Note that which sources are shown also depends on other settings
|
| -# such as SOURCE_BROWSER.
|
| -
|
| -LATEX_SOURCE_CODE = NO
|
| -
|
| #---------------------------------------------------------------------------
|
| # configuration options related to the RTF output
|
| #---------------------------------------------------------------------------
|
| @@ -1326,7 +925,7 @@ MAN_EXTENSION = .3
|
| # only source the real man page, but without them the man command
|
| # would be unable to find the correct page. The default is NO.
|
|
|
| -MAN_LINKS = NO
|
| +MAN_LINKS = YES
|
|
|
| #---------------------------------------------------------------------------
|
| # configuration options related to the XML output
|
| @@ -1364,11 +963,11 @@ XML_DTD =
|
| XML_PROGRAMLISTING = YES
|
|
|
| #---------------------------------------------------------------------------
|
| -# configuration options for the AutoGen Definitions output
|
| +# configuration options for the auto_gen Definitions output
|
| #---------------------------------------------------------------------------
|
|
|
| # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
|
| -# generate an AutoGen Definitions (see autogen.sf.net) file
|
| +# generate an auto_gen Definitions (see autogen.sf.net) file
|
| # that captures the structure of the code including all
|
| # documentation. Note that this feature is still experimental
|
| # and incomplete at the moment.
|
| @@ -1388,7 +987,7 @@ GENERATE_AUTOGEN_DEF = NO
|
| GENERATE_PERLMOD = NO
|
|
|
| # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
|
| -# the necessary Makefile rules, Perl scripts and LaTeX code to be able
|
| +# the necessary Makefile rules, Perl scripts and la_te_x code to be able
|
| # to generate PDF and DVI output from the Perl module output.
|
|
|
| PERLMOD_LATEX = NO
|
| @@ -1429,10 +1028,10 @@ MACRO_EXPANSION = YES
|
| # then the macro expansion is limited to the macros specified with the
|
| # PREDEFINED and EXPAND_AS_DEFINED tags.
|
|
|
| -EXPAND_ONLY_PREDEF = YES
|
| +EXPAND_ONLY_PREDEF = NO
|
|
|
| # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
|
| -# pointed to by INCLUDE_PATH will be searched when a #include is found.
|
| +# in the INCLUDE_PATH (see below) will be search if a #include is found.
|
|
|
| SEARCH_INCLUDES = YES
|
|
|
| @@ -1447,7 +1046,7 @@ INCLUDE_PATH =
|
| # directories. If left blank, the patterns specified with FILE_PATTERNS will
|
| # be used.
|
|
|
| -INCLUDE_FILE_PATTERNS =
|
| +INCLUDE_FILE_PATTERNS = *.h
|
|
|
| # The PREDEFINED tag can be used to specify one or more macro names that
|
| # are defined before the preprocessor is started (similar to the -D option of
|
| @@ -1457,28 +1056,20 @@ INCLUDE_FILE_PATTERNS =
|
| # undefined via #undef or recursively expanded use the := operator
|
| # instead of the = operator.
|
|
|
| -PREDEFINED = __native_client__ \
|
| - DOXYGEN_SHOULD_SKIP_THIS \
|
| - __attribute__(x)= \
|
| - EXTERN_C_BEGIN= \
|
| - EXTERN_C_END= \
|
| - PP_COMPILE_ASSERT_SIZE_IN_BYTES= \
|
| - PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES= \
|
| - PP_INLINE= \
|
| - PP_EXPORT
|
| +PREDEFINED =
|
|
|
| # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
|
| # this tag can be used to specify a list of macro names that should be expanded.
|
| # The macro definition that is found in the sources will be used.
|
| -# Use the PREDEFINED tag if you want to use a different macro definition that
|
| -# overrules the definition found in the source code.
|
| +# Use the PREDEFINED tag if you want to use a different macro definition.
|
|
|
| EXPAND_AS_DEFINED =
|
|
|
| # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
|
| -# doxygen's preprocessor will remove all references to function-like macros
|
| -# that are alone on a line, have an all uppercase name, and do not end with a
|
| -# semicolon, because these will confuse the parser if not removed.
|
| +# 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
|
|
|
| @@ -1530,19 +1121,19 @@ PERL_PATH = /usr/bin/perl
|
| #---------------------------------------------------------------------------
|
|
|
| # 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
|
| +# generate a inheritance diagram (in HTML, RTF and la_te_x) for classes with base
|
| # or super classes. Setting the tag to NO turns the diagrams off. Note that
|
| -# this option also works with HAVE_DOT disabled, but it is recommended to
|
| -# install and use dot, since it yields more powerful graphs.
|
| +# 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 = NO
|
| +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.
|
| +# 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 =
|
|
|
| @@ -1557,37 +1148,7 @@ HIDE_UNDOC_RELATIONS = YES
|
| # toolkit from AT&T and Lucent Bell Labs. The other options in this section
|
| # have no effect if this option is set to NO (the default)
|
|
|
| -HAVE_DOT = YES
|
| -
|
| -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
|
| -# allowed to run in parallel. When set to 0 (the default) doxygen will
|
| -# base this on the number of processors available in the system. You can set it
|
| -# explicitly to a value larger than 0 to get control over the balance
|
| -# between CPU load and processing speed.
|
| -
|
| -DOT_NUM_THREADS = 4
|
| -
|
| -# By default doxygen will write a font called Helvetica to the output
|
| -# directory and reference it in all dot files that doxygen generates.
|
| -# When you want a differently looking font you can specify the font name
|
| -# using DOT_FONTNAME. You 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.ttf
|
| -
|
| -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
|
| -# The default size is 10pt.
|
| -
|
| -DOT_FONTSIZE = 10
|
| -
|
| -# 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 =
|
| +HAVE_DOT = NO
|
|
|
| # 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
|
| @@ -1601,12 +1162,12 @@ CLASS_GRAPH = YES
|
| # indirect implementation dependencies (inheritance, containment, and
|
| # class references variables) of the class with other documented classes.
|
|
|
| -COLLABORATION_GRAPH = NO
|
| +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 = NO
|
| +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
|
| @@ -1633,24 +1194,24 @@ INCLUDE_GRAPH = YES
|
|
|
| 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, SOURCE_BROWSER 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 = NO
|
|
|
| -# 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.
|
| +# If the CALLER_GRAPH, SOURCE_BROWSER 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
|
| -# will generate a graphical hierarchy of all classes instead of a textual one.
|
| +# will graphical hierarchy of all classes instead of a textual one.
|
|
|
| GRAPHICAL_HIERARCHY = YES
|
|
|
| @@ -1662,7 +1223,7 @@ GRAPHICAL_HIERARCHY = YES
|
| DIRECTORY_GRAPH = YES
|
|
|
| # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
| -# generated by dot. Possible values are svg, png, jpg, or gif.
|
| +# generated by dot. Possible values are png, jpg, or gif
|
| # If left blank png will be used.
|
|
|
| DOT_IMAGE_FORMAT = png
|
| @@ -1670,7 +1231,7 @@ DOT_IMAGE_FORMAT = png
|
| # 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.
|
|
|
| -DOT_PATH = /usr/local/graphviz-2.14/bin
|
| +DOT_PATH =
|
|
|
| # The DOTFILE_DIRS tag can be used to specify one or more directories that
|
| # contain dot files that are included in the documentation (see the
|
| @@ -1678,21 +1239,15 @@ DOT_PATH = /usr/local/graphviz-2.14/bin
|
|
|
| DOTFILE_DIRS =
|
|
|
| -# The MSCFILE_DIRS tag can be used to specify one or more directories that
|
| -# contain msc files that are included in the documentation (see the
|
| -# \mscfile command).
|
| -
|
| -MSCFILE_DIRS =
|
| -
|
| -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
|
| +# The MAX_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
|
| +# 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
|
| +# MAX_DOT_GRAPH_NOTES 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 = 57
|
| +DOT_GRAPH_MAX_NODES = 50
|
|
|
| # 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
|
| @@ -1702,13 +1257,13 @@ DOT_GRAPH_MAX_NODES = 57
|
| # 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.
|
|
|
| -MAX_DOT_GRAPH_DEPTH = 1000
|
| +MAX_DOT_GRAPH_DEPTH = 0
|
|
|
| # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
|
| -# background. This is disabled by default, because dot on Windows does not
|
| -# seem to support this out of the box. 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).
|
| +# background. This is disabled by default, which results in a white 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
|
|
|
| @@ -1730,3 +1285,12 @@ GENERATE_LEGEND = YES
|
| # the various graphs.
|
|
|
| DOT_CLEANUP = YES
|
| +
|
| +#---------------------------------------------------------------------------
|
| +# Configuration::additions related to the search engine
|
| +#---------------------------------------------------------------------------
|
| +
|
| +# The SEARCHENGINE tag specifies whether or not a search engine should be
|
| +# used. If set to NO the values of all tags below this one will be ignored.
|
| +
|
| +SEARCHENGINE = NO
|
|
|