# This file describes the settings to be used by the documentation system

# doxygen (www.doxygen.org) for a project

#

# All text after a hash (#) is considered a comment and will be ignored

# The format is:

#       TAG = value [value, ...]

# For lists items can also be appended using:

#       TAG += value [value, ...]

# Values that contain spaces should be placed between quotes (" ")

#---------------------------------------------------------------------------

# Project related configuration options

#---------------------------------------------------------------------------

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 

# by quotes) that should identify the project.

PROJECT_NAME           = SDL

# 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         = 1.3.0

# 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.

# 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 

# format and will distribute the generated files over these directories. 

# Enabling this option can be useful when feeding doxygen a huge amount of 

# source files, where putting all generated files in the same directory would 

# otherwise cause performance problems for the file system.

# The OUTPUT_LANGUAGE tag is used to specify the language in which all 

# documentation generated by doxygen is written. Doxygen will use this 

# information to generate all constant output in the proper language. 

# The default language is English, other supported languages are: 

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). 

# Set to NO to disable this.

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. 

# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 

# brief descriptions will be completely suppressed.

REPEAT_BRIEF           = YES

# This tag implements a quasi-intelligent brief description abbreviator 

# that is used to form the text in various listings. Each string 

# in this list, if found as the leading text of the brief description, will be 

# stripped from the text and the result after processing the whole list, is 

# used as the annotated text. Otherwise, the brief description is used as-is. 

# If left blank, the following values are used ("$name" is automatically 

# replaced with the name of the entity): "The $name class" "The $name widget" 

# "The $name file" "is" "provides" "specifies" "contains" 

# "represents" "a" "an" "the"

# 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 

# description.

# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 

# inherited members of a class in the documentation of that class as if those 

# members were ordinary class members. Constructors, destructors and assignment 

# operators of the base classes will not be shown.

INLINE_INHERITED_MEMB  = NO

# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 

# path before files name in the file list and in the header files. If set 

# to NO the shortest path that makes the file name unique will be used.

FULL_PATH_NAMES        = YES

# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 

# can be used to strip a user-defined part of the path. Stripping is 

# only done if one of the specified strings matches the left-hand part of 

# 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 strip.

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 

# the path mentioned in the documentation of a class, which tells 

# the reader which header file to include in order to use a class. 

# If left blank only the name of the header file containing the class 

# definition is used. Otherwise one should specify the include paths that 

# are normally passed to the compiler using the -I flag.

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 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 

JAVADOC_AUTOBRIEF      = NO

# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 

# treat a multi-line C++ special comment block (i.e. a block of //! or /// 

# comments) as a brief description. This used to be the default behaviour. 

# The new default is to treat a multi-line C++ comment block as a detailed 

# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 

# member inherits the documentation from any documented member that it 

# re-implements.

INHERIT_DOCS           = YES

# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 

# a new page for each member. If set to NO, the documentation of a member will 

# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  = NO

# 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

# 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". 

# For example adding "sideeffect=\par Side Effects:\n" 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.

# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 

# sources only. Doxygen will then generate output that is more tailored for C. 

# For instance, some of the names that are used will be different. The list 

# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = YES

OPTIMIZE_OUTPUT_JAVA   = NO

# Set the SUBGROUPING tag to YES (the default) 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 

# the \nosubgrouping command.

SUBGROUPING            = YES

#---------------------------------------------------------------------------

# Build related configuration options

#---------------------------------------------------------------------------

# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 

# documentation are documented, even if no documentation was available. 

# Private class members and static file members will be hidden unless 

# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 

# will be included in the documentation.

# If the EXTRACT_STATIC tag is set to YES all static members of a file 

# will be included in the documentation.

# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 

# defined locally in source files will be included in the documentation. 

# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

# This flag is only useful for Objective-C code. When set to YES local 

# methods, which are defined in the implementation section but not in 

# the interface are included in the documentation. 

# If set to NO (the default) only methods in the interface are included.

# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 

# undocumented members of documented classes, files or namespaces. 

# If set to NO (the default) these members will be included in the 

# various overviews, but no documentation section is generated. 

# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 

# undocumented classes that are normally visible in the class hierarchy. 

# If set to NO (the default) these classes will be included in the various 

# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 

# friend (class|struct|union) declarations. 

# If set to NO (the default) these declarations will be included in the 

# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 

# documentation blocks found inside the body of a function. 

# If set to NO (the default) these blocks will be appended to the 

# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

# The INTERNAL_DOCS tag determines if documentation 

# that is typed after a \internal command is included. If the tag is set 

# to NO (the default) then the documentation will be excluded. 

# Set it to YES to include the internal documentation.

# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 

# file names in lower-case letters. If set to YES upper-case letters are also 

# allowed. This is useful if you have classes or files whose names only differ 

# in case and if your file system supports case sensitive file names. Windows 

# and Mac users are advised to set this option to NO.

# 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 

# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 

# will put a list of the files that are included by a file in the documentation 

# of that file.

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.

INLINE_INFO            = YES

# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 

# will sort the (detailed) documentation of file and class members 

# alphabetically by member name. If set to NO the members will appear in 

# declaration order.

SORT_MEMBER_DOCS       = YES

# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 

# brief documentation of file, namespace and class members alphabetically 

# by member name. If set to NO (the default) the members will appear in 

# declaration order.

SORT_BRIEF_DOCS        = 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, 

# not including the namespace part. 

# Note: This option applies only to the class list, not to the 

# alphabetical list.

SORT_BY_SCOPE_NAME     = 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.

GENERATE_TODOLIST      = YES

# The GENERATE_TESTLIST tag can be used to enable (YES) or 

# disable (NO) the test list. This list is created by putting \test 

# commands in the documentation.

GENERATE_TESTLIST      = YES

# The GENERATE_BUGLIST tag can be used to enable (YES) or 

# disable (NO) the bug list. This list is created by putting \bug 

# commands in the documentation.

GENERATE_BUGLIST       = YES

# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 

# disable (NO) the deprecated list. This list is created by putting 

# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

# The ENABLED_SECTIONS tag can be used to enable conditional 

# documentation sections, marked by \if sectionname ... \endif.

ENABLED_SECTIONS       = 

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 

# 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 defines in the 

# documentation can be controlled using \showinitializer or \hideinitializer 

# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

# If the sources in your project are distributed over multiple directories 

# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 

SHOW_DIRECTORIES       = YES

# The FILE_VERSION_FILTER tag can be used to specify a program or script that 

# 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 

# is used as the file version. See the manual for examples.

FILE_VERSION_FILTER    =