Commit 4b47fd6c authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Updated the Doxyfile and corrected the doxygen documentation tags that raised...

Updated the Doxyfile and corrected the doxygen documentation tags that raised warnings. Build is now cleaner.


Former-commit-id: 5ca3a6d2612545e910dc0a74f3df5ed043c05ee9
parent 3b09f3ec
# Doxyfile 1.6.3 # Doxyfile 1.8.9.1
# This file describes the settings to be used by the documentation system # This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project # doxygen (www.doxygen.org) for a project.
# #
# All text after a hash (#) is considered a comment and will be ignored # All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be ignored.
# The format is: # The format is:
# TAG = value [value, ...] # TAG = value [value, ...]
# For lists items can also be appended using: # For lists, items can also be appended using:
# TAG += value [value, ...] # TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ") # Values that contain spaces should be placed between quotes (\" \").
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Project related configuration options # Project related configuration options
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the config file # 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 # that follow. The default is UTF-8 which is also the encoding used for all text
# text before the first occurrence of this tag. Doxygen uses libiconv (or the # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
# iconv built into libc) for the transcoding. See # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
# http://www.gnu.org/software/libiconv for the list of possible encodings. # for the list of possible encodings.
# The default value is: UTF-8.
DOXYFILE_ENCODING = UTF-8 DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# by quotes) that should identify the project. # double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = @PACKAGE_NAME@ PROJECT_NAME = @PACKAGE_NAME@
# The PROJECT_NUMBER tag can be used to enter a project or revision number. # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# This could be handy for archiving the generated documentation or # could be handy for archiving the generated documentation or if some version
# if some version control system is used. # control system is used.
PROJECT_NUMBER = @PACKAGE_VERSION@ PROJECT_NUMBER = @PACKAGE_VERSION@
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # Using the PROJECT_BRIEF tag one can provide an optional one line description
# base path where the generated documentation will be put. # for a project that appears at the top of each page and should give viewer a
# If a relative path is entered, it will be relative to the location # quick idea about the purpose of the project. Keep the description short.
# where doxygen was started. If left blank the current directory will be used.
PROJECT_BRIEF = "SPH With Inter-dependent Fine-grained Tasking - \
Cosmological hydrodynamical code"
# With the PROJECT_LOGO tag one can specify a logo or an 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 =
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. 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 = . OUTPUT_DIRECTORY = .
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# 4096 sub-directories (in 2 levels) under the output directory of each output # directories (in 2 levels) under the output directory of each output format and
# format and will distribute the generated files over these directories. # will distribute the generated files over these directories. Enabling this
# Enabling this option can be useful when feeding doxygen a huge amount of # option can be useful when feeding doxygen a huge amount of source files, where
# source files, where putting all generated files in the same directory would # putting all generated files in the same directory would otherwise causes
# otherwise cause performance problems for the file system. # performance problems for the file system.
# The default value is: NO.
CREATE_SUBDIRS = NO CREATE_SUBDIRS = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
# documentation generated by doxygen is written. Doxygen will use this # characters to appear in the names of generated files. If set to NO, non-ASCII
# information to generate all constant output in the proper language. # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
# The default language is English, other supported languages are: # U+3044.
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, # The default value is: NO.
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English ALLOW_UNICODE_NAMES = NO
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, # The OUTPUT_LANGUAGE tag is used to specify the language in which all
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. # documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.
OUTPUT_LANGUAGE = English OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
# include brief member descriptions after the members that are listed in # descriptions after the members that are listed in the file and class
# the file and class documentation (similar to JavaDoc). # documentation (similar to Javadoc). Set to NO to disable this.
# Set to NO to disable this. # The default value is: YES.
BRIEF_MEMBER_DESC = YES BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
# the brief description of a member or function before the detailed description. # description of a member or function before the detailed description
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the #
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed. # brief descriptions will be completely suppressed.
# The default value is: YES.
REPEAT_BRIEF = YES REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator # This tag implements a quasi-intelligent brief description abbreviator that is
# that is used to form the text in various listings. Each string # used to form the text in various listings. Each string in this list, if found
# in this list, if found as the leading text of the brief description, will be # as the leading text of the brief description, will be stripped from the text
# stripped from the text and the result after processing the whole list, is # and the result, after processing the whole list, is used as the annotated
# used as the annotated text. Otherwise, the brief description is used as-is. # text. Otherwise, the brief description is used as-is. If left blank, the
# If left blank, the following values are used ("$name" is automatically # following values are used ($name is automatically replaced with the name of
# replaced with the name of the entity): "The $name class" "The $name widget" # the entity):The $name class, The $name widget, The $name file, is, provides,
# "The $name file" "is" "provides" "specifies" "contains" # specifies, contains, represents, a, an and the.
# "represents" "a" "an" "the"
ABBREVIATE_BRIEF = ABBREVIATE_BRIEF =
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # 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 # doxygen will generate a detailed section even if there is only a brief
# description. # description.
# The default value is: NO.
ALWAYS_DETAILED_SEC = NO ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # 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 # inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment # members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown. # operators of the base classes will not be shown.
# The default value is: NO.
INLINE_INHERITED_MEMB = NO INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
# path before files name in the file list and in the header files. If set # before files name in the file list and in the header files. If set to NO the
# to NO the shortest path that makes the file name unique will be used. # shortest path that makes the file name unique will be used
# The default value is: YES.
FULL_PATH_NAMES = YES FULL_PATH_NAMES = YES
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# can be used to strip a user-defined part of the path. Stripping is # Stripping is only done if one of the specified strings matches the left-hand
# only done if one of the specified strings matches the left-hand part of # part of the path. The tag can be used to show relative paths in the file list.
# the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to
# If left blank the directory from which doxygen is run is used as the # strip.
# path to strip. #
# Note that you can specify absolute paths here, but also relative paths, which
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
STRIP_FROM_PATH = STRIP_FROM_PATH =
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# the path mentioned in the documentation of a class, which tells # path mentioned in the documentation of a class, which tells the reader which
# the reader which header file to include in order to use a class. # header file to include in order to use a class. If left blank only the name of
# If left blank only the name of the header file containing the class # the header file containing the class definition is used. Otherwise one should
# definition is used. Otherwise one should specify the include paths that # specify the list of include paths that are normally passed to the compiler
# are normally passed to the compiler using the -I flag. # using the -I flag.
STRIP_FROM_INC_PATH = STRIP_FROM_INC_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# (but less readable) file names. This can be useful is your file systems # less readable) file names. This can be useful is your file systems doesn't
# doesn't support long names like on DOS, Mac, or CD-ROM. # support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.
SHORT_NAMES = NO SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# will interpret the first line (until the first dot) of a JavaDoc-style # first line (until the first dot) of a Javadoc-style comment as the brief
# comment as the brief description. If set to NO, the JavaDoc # description. If set to NO, the Javadoc-style will behave just like regular Qt-
# comments will behave just like regular Qt-style comments # style comments (thus requiring an explicit @brief command for a brief
# (thus requiring an explicit @brief command for a brief description.) # description.)
# The default value is: NO.
JAVADOC_AUTOBRIEF = NO JAVADOC_AUTOBRIEF = NO
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# interpret the first line (until the first dot) of a Qt-style # line (until the first dot) of a Qt-style comment as the brief description. If
# comment as the brief description. If set to NO, the comments # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# will behave just like regular Qt-style comments (thus requiring # requiring an explicit \brief command for a brief description.)
# an explicit \brief command for a brief description.) # The default value is: NO.
QT_AUTOBRIEF = NO QT_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# treat a multi-line C++ special comment block (i.e. a block of //! or /// # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
# comments) as a brief description. This used to be the default behaviour. # a brief description. This used to be the default behavior. The new default is
# The new default is to treat a multi-line C++ comment block as a detailed # to treat a multi-line C++ comment block as a detailed description. Set this
# description. Set this tag to YES if you prefer the old behaviour instead. # tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.
MULTILINE_CPP_IS_BRIEF = NO MULTILINE_CPP_IS_BRIEF = NO
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# member inherits the documentation from any documented member that it # documentation from any documented member that it re-implements.
# re-implements. # The default value is: YES.
INHERIT_DOCS = YES INHERIT_DOCS = YES
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
# a new page for each member. If set to NO, the documentation of a member will # page for each member. If set to NO, the documentation of a member will be part
# be part of the file/class/namespace that contains it. # of the file/class/namespace that contains it.
# The default value is: NO.
SEPARATE_MEMBER_PAGES = NO SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab. # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# Doxygen uses this value to replace tabs by spaces in code fragments. # uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.
TAB_SIZE = 8 TAB_SIZE = 8
# This tag can be used to specify a number of aliases that acts # This tag can be used to specify a number of aliases that act as commands in
# as commands in the documentation. An alias has the form "name=value". # the documentation. An alias has the form:
# For example adding "sideeffect=\par Side Effects:\n" will allow you to # name=value
# put the command \sideeffect (or @sideeffect) in the documentation, which # For example adding
# will result in a user-defined paragraph with heading "Side Effects:". # "sideeffect=@par Side Effects:\n"
# You can put \n's in the value part of an alias to insert newlines. # will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
ALIASES = ALIASES =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # This tag can be used to specify a number of word-keyword mappings (TCL only).
# sources only. Doxygen will then generate output that is more tailored for C. # A mapping has the form "name=value". For example adding "class=itcl::class"
# For instance, some of the names that are used will be different. The list # will allow you to use the command class in the itcl::class meaning.
# of all members will be omitted, etc.
TCL_SUBST =
# 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.
# The default value is: NO.
OPTIMIZE_OUTPUT_FOR_C = YES OPTIMIZE_OUTPUT_FOR_C = YES
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# sources only. Doxygen will then generate output that is more tailored for # Python sources only. Doxygen will then generate output that is more tailored
# Java. For instance, namespaces will be presented as packages, qualified # for that language. For instance, namespaces will be presented as packages,
# scopes will look different, etc. # qualified scopes will look different, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # 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 # sources. Doxygen will then generate output that is tailored for Fortran.
# Fortran. # The default value is: NO.
OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for # sources. Doxygen will then generate output that is tailored for VHDL.
# VHDL. # The default value is: NO.
OPTIMIZE_OUTPUT_VHDL = NO OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the files it parses. # Doxygen selects the parser to use depending on the extension of the files it
# With this tag you can assign which parser to use for a given extension. # parses. With this tag you can assign which parser to use for a given
# Doxygen has a built-in mapping, but you can override or extend it using this tag. # extension. Doxygen has a built-in mapping, but you can override or extend it
# The format is ext=language, where ext is a file extension, and language is one of # using this tag. The format is ext=language, where ext is a file extension, and
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
# use: inc=Fortran f=C. Note that for custom extensions you also need to set # Fortran. In the later case the parser tries to guess whether the code is fixed
# FILE_PATTERNS otherwise the files are not read by doxygen. # or free formatted code, this is the default for Fortran type files), VHDL. For
# instance to make doxygen treat .inc files as Fortran files (default is PHP),
EXTENSION_MAPPING = # and .f files as C (default is Fortran), use: inc=Fortran f=C.
#
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # Note: For files without extension you can use no_extension as a placeholder.
# 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 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # the files are not read by doxygen.
# func(std::string) {}). This also make the inheritance and collaboration
EXTENSION_MAPPING =
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.
MARKDOWN_SUPPORT = YES
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by putting a % sign in front of the word or
# globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.
AUTOLINK_SUPPORT = YES
# 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);
# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate. # diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
BUILTIN_STL_SUPPORT = NO BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to # If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support. # enable parsing support.
# The default value is: NO.
CPP_CLI_SUPPORT = NO CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# Doxygen will parse them like normal C++ but will assume all classes use public # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
# instead of private inheritance when no explicit protection keyword is present. # will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
SIP_SUPPORT = NO SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate getter # For Microsoft's IDL there are propget and propput attributes to indicate
# and setter methods for a property. Setting this option to YES (the default) # getter and setter methods for a property. Setting this option to YES will make
# will make doxygen to replace the get and set methods by a property in the # doxygen to replace the get and set methods by a property in the documentation.
# documentation. This will only work if the methods are indeed getting or # This will only work if the methods are indeed getting or setting a simple
# setting a simple type. If this is not the case, or you want to show the # type. If this is not the case, or you want to show the methods anyway, you
# methods anyway, you should set this option to NO. # should set this option to NO.
# The default value is: YES.
IDL_PROPERTY_SUPPORT = YES IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # 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 # 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 # member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly. # all members of a group must be documented explicitly.
# The default value is: NO.
DISTRIBUTE_GROUP_DOC = NO DISTRIBUTE_GROUP_DOC = NO
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of # Set the SUBGROUPING tag to YES to allow class member groups of the same type
# the same type (for instance a group of public functions) to be put as a # (for instance a group of public functions) to be put as a subgroup of that
# subgroup of that type (e.g. under the Public Functions section). Set it to # type (e.g. under the Public Functions section). Set it to NO to prevent
# NO to prevent subgrouping. Alternatively, this can be done per class using # subgrouping. Alternatively, this can be done per class using the
# the \nosubgrouping command. # \nosubgrouping command.
# The default value is: YES.
SUBGROUPING = YES SUBGROUPING = YES
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# is documented as struct, union, or enum with the name of the typedef. So # are shown inside the group in which they are included (e.g. using \ingroup)
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# with name TypeT. When disabled the typedef will appear as a member of a file, # and RTF).
# 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 # Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
INLINE_GROUPED_CLASSES = NO
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
# the documentation of the scope in which they are defined (i.e. file,
# namespace, or group documentation), provided this scope is documented. If set
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
INLINE_SIMPLE_STRUCTS = NO
# When TYPEDEF_HIDES_STRUCT tag 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. # types are typedef'ed and only the typedef is referenced, never the tag name.
# The default value is: NO.
TYPEDEF_HIDES_STRUCT = NO TYPEDEF_HIDES_STRUCT = NO
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# determine which symbols to keep in memory and which to flush to disk. # cache is used to resolve symbols given their name and scope. Since this can be
# When the cache is full, less often used symbols will be written to disk. # an expensive process and often the same symbol appears multiple times in the
# For small to medium size projects (<1000 input files) the default value is # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# probably good enough. For larger projects a too small cache size can cause # doxygen will become slower. If the cache is too large, memory is wasted. The
# doxygen to be busy swapping symbols to and from disk most of the time # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# causing a significant performance penality. # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# If the system has enough physical memory increasing the cache will improve the # symbols. At the end of a run doxygen will report the cache usage and suggest
# performance by keeping more symbols in memory. Note that the value works on # the optimal cache size from a speed point of view.
# a logarithmic scale so increasing the size by one will rougly double the # Minimum value: 0, maximum value: 9, default value: 0.
# 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, LOOKUP_CACHE_SIZE = 0
# corresponding to a cache size of 2^16 = 65536 symbols
SYMBOL_CACHE_SIZE = 0
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Build related configuration options # Build related configuration options
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
# documentation are documented, even if no documentation was available. # documentation are documented, even if no documentation was available. Private
# Private class members and static file members will be hidden unless # class members and static file members will be hidden unless the
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
EXTRACT_ALL = YES EXTRACT_ALL = YES
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class