sdl-ios-xcode: include/doxyfile annotate

annotate include/doxyfile @ 5092:327f181542f1

Include windows.h in a single point in the source, so we can be consistent about the definition of UNICODE and have core utility functions for Windows that all modules can share. I think this also fixes the bug relating to non-latin characters in filenames, since UNICODE wasn't defined in SDL_rwops.c

author	Sam Lantinga <slouken@libsdl.org>
date	Mon, 24 Jan 2011 21:20:30 -0800
parents	61d53410eb41
children	30da7089dcb4

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

Mercurial > sdl-ios-xcode

annotate include/doxyfile @ 5092:327f181542f1