sdl-ios-xcode: include/doxyfile annotate

annotate include/doxyfile @ 1675:d33dcfc3fde7 SDL-1.3

Overlay functions are being replaced by YUV textures. If the driver doesn't support YUV textures, they can be emulated by backing the texture with an RGB texture and using the software conversion routines. Note that it doesn't make sense to lock a portion of a YV12 texture, since you'd need to return three pixel pointers and pitch values instead of the one that's available through the API. I'm guessing that's one of the reasons DirectX 9 doesn't support this format at all.

author	Sam Lantinga <slouken@libsdl.org>
date	Sun, 11 Jun 2006 07:30:16 +0000
parents	782fd950bd46
children	61d53410eb41

rev	line source
1662 782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1 # Doxyfile 1.4.4
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	2
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	3 # This file describes the settings to be used by the documentation system
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	4 # doxygen (www.doxygen.org) for a project
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	5 #
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	6 # All text after a hash (#) is considered a comment and will be ignored
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	7 # The format is:
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	8 # TAG = value [value, ...]
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	9 # For lists items can also be appended using:
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	10 # TAG += value [value, ...]
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	11 # Values that contain spaces should be placed between quotes (" ")
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	12
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	13 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	14 # Project related configuration options
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	15 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	16
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	18 # by quotes) that should identify the project.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	19
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	20 PROJECT_NAME = SDL
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	21
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	23 # This could be handy for archiving the generated documentation or
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	24 # if some version control system is used.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	25
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	26 PROJECT_NUMBER = 1.3.0
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	27
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	29 # base path where the generated documentation will be put.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	30 # If a relative path is entered, it will be relative to the location
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	31 # where doxygen was started. If left blank the current directory will be used.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	32
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	33 OUTPUT_DIRECTORY = docs
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	34
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	36 # 4096 sub-directories (in 2 levels) under the output directory of each output
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	37 # format and will distribute the generated files over these directories.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	38 # Enabling this option can be useful when feeding doxygen a huge amount of
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	39 # source files, where putting all generated files in the same directory would
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	40 # otherwise cause performance problems for the file system.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	41
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	42 CREATE_SUBDIRS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	43
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	45 # documentation generated by doxygen is written. Doxygen will use this
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	46 # information to generate all constant output in the proper language.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	47 # The default language is English, other supported languages are:
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	52 # Swedish, and Ukrainian.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	53
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	54 OUTPUT_LANGUAGE = English
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	55
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	56 # This tag can be used to specify the encoding used in the generated output.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	57 # The encoding is not always determined by the language that is chosen,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	58 # but also whether or not the output is meant for Windows or non-Windows users.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	60 # forces the Windows encoding (this is the default for the Windows binary),
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	61 # whereas setting the tag to NO uses a Unix-style encoding (the default for
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	62 # all platforms other than Windows).
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	63
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	64 USE_WINDOWS_ENCODING = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	65
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	67 # include brief member descriptions after the members that are listed in
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	68 # the file and class documentation (similar to JavaDoc).
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	69 # Set to NO to disable this.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	70
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	71 BRIEF_MEMBER_DESC = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	72
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	74 # the brief description of a member or function before the detailed description.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	76 # brief descriptions will be completely suppressed.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	77
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	78 REPEAT_BRIEF = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	79
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	80 # This tag implements a quasi-intelligent brief description abbreviator
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	81 # that is used to form the text in various listings. Each string
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	82 # in this list, if found as the leading text of the brief description, will be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	83 # stripped from the text and the result after processing the whole list, is
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	84 # used as the annotated text. Otherwise, the brief description is used as-is.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	85 # If left blank, the following values are used ("$name" is automatically
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	86 # replaced with the name of the entity): "The $name class" "The $name widget"
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	87 # "The $name file" "is" "provides" "specifies" "contains"
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	88 # "represents" "a" "an" "the"
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	89
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	90 ABBREVIATE_BRIEF =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	91
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	93 # Doxygen will generate a detailed section even if there is only a brief
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	94 # description.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	95
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	96 ALWAYS_DETAILED_SEC = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	97
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	99 # inherited members of a class in the documentation of that class as if those
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	100 # members were ordinary class members. Constructors, destructors and assignment
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	101 # operators of the base classes will not be shown.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	102
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	103 INLINE_INHERITED_MEMB = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	104
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	105 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	106 # path before files name in the file list and in the header files. If set
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	107 # to NO the shortest path that makes the file name unique will be used.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	108
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	109 FULL_PATH_NAMES = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	110
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	111 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	112 # can be used to strip a user-defined part of the path. Stripping is
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	113 # only done if one of the specified strings matches the left-hand part of
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	114 # the path. The tag can be used to show relative paths in the file list.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	115 # If left blank the directory from which doxygen is run is used as the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	116 # path to strip.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	117
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	118 STRIP_FROM_PATH =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	119
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	121 # the path mentioned in the documentation of a class, which tells
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	122 # the reader which header file to include in order to use a class.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	123 # If left blank only the name of the header file containing the class
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	124 # definition is used. Otherwise one should specify the include paths that
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	125 # are normally passed to the compiler using the -I flag.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	126
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	127 STRIP_FROM_INC_PATH =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	128
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	129 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	130 # (but less readable) file names. This can be useful is your file systems
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	131 # doesn't support long names like on DOS, Mac, or CD-ROM.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	132
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	133 SHORT_NAMES = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	134
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	135 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	136 # will interpret the first line (until the first dot) of a JavaDoc-style
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	137 # comment as the brief description. If set to NO, the JavaDoc
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	138 # comments will behave just like the Qt-style comments (thus requiring an
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	139 # explicit @brief command for a brief description.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	140
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	141 JAVADOC_AUTOBRIEF = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	142
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	143 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	144 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	145 # comments) as a brief description. This used to be the default behaviour.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	146 # The new default is to treat a multi-line C++ comment block as a detailed
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	147 # description. Set this tag to YES if you prefer the old behaviour instead.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	148
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	149 MULTILINE_CPP_IS_BRIEF = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	150
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	151 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	152 # will output the detailed description near the top, like JavaDoc.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	153 # If set to NO, the detailed description appears after the member
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	154 # documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	155
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	156 DETAILS_AT_TOP = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	157
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	159 # member inherits the documentation from any documented member that it
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	160 # re-implements.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	161
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	162 INHERIT_DOCS = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	163
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	164 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	165 # tag is set to YES, then doxygen will reuse the documentation of the first
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	166 # member in the group (if any) for the other members of the group. By default
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	167 # all members of a group must be documented explicitly.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	168
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	169 DISTRIBUTE_GROUP_DOC = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	170
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	171 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	172 # a new page for each member. If set to NO, the documentation of a member will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	173 # be part of the file/class/namespace that contains it.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	174
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	175 SEPARATE_MEMBER_PAGES = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	176
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	177 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	178 # Doxygen uses this value to replace tabs by spaces in code fragments.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	179
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	180 TAB_SIZE = 8
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	181
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	182 # This tag can be used to specify a number of aliases that acts
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	183 # as commands in the documentation. An alias has the form "name=value".
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	184 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	185 # put the command \sideeffect (or @sideeffect) in the documentation, which
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	186 # will result in a user-defined paragraph with heading "Side Effects:".
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	187 # You can put \n's in the value part of an alias to insert newlines.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	188
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	189 ALIASES =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	190
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	191 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	192 # sources only. Doxygen will then generate output that is more tailored for C.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	193 # For instance, some of the names that are used will be different. The list
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	194 # of all members will be omitted, etc.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	195
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	196 OPTIMIZE_OUTPUT_FOR_C = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	197
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	198 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	199 # only. Doxygen will then generate output that is more tailored for Java.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	200 # For instance, namespaces will be presented as packages, qualified scopes
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	201 # will look different, etc.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	202
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	203 OPTIMIZE_OUTPUT_JAVA = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	204
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	205 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	206 # the same type (for instance a group of public functions) to be put as a
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	207 # subgroup of that type (e.g. under the Public Functions section). Set it to
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	208 # NO to prevent subgrouping. Alternatively, this can be done per class using
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	209 # the \nosubgrouping command.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	210
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	211 SUBGROUPING = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	212
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	213 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	214 # Build related configuration options
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	215 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	216
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	217 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	218 # documentation are documented, even if no documentation was available.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	219 # Private class members and static file members will be hidden unless
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	220 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	221
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	222 EXTRACT_ALL = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	223
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	224 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	225 # will be included in the documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	226
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	227 EXTRACT_PRIVATE = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	228
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	229 # If the EXTRACT_STATIC tag is set to YES all static members of a file
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	230 # will be included in the documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	231
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	232 EXTRACT_STATIC = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	233
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	234 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	235 # defined locally in source files will be included in the documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	236 # If set to NO only classes defined in header files are included.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	237
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	238 EXTRACT_LOCAL_CLASSES = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	239
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	240 # This flag is only useful for Objective-C code. When set to YES local
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	241 # methods, which are defined in the implementation section but not in
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	242 # the interface are included in the documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	243 # If set to NO (the default) only methods in the interface are included.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	244
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	245 EXTRACT_LOCAL_METHODS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	246
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	247 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	248 # undocumented members of documented classes, files or namespaces.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	249 # If set to NO (the default) these members will be included in the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	250 # various overviews, but no documentation section is generated.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	251 # This option has no effect if EXTRACT_ALL is enabled.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	252
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	253 HIDE_UNDOC_MEMBERS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	254
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	255 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	256 # undocumented classes that are normally visible in the class hierarchy.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	257 # If set to NO (the default) these classes will be included in the various
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	258 # overviews. This option has no effect if EXTRACT_ALL is enabled.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	259
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	260 HIDE_UNDOC_CLASSES = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	261
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	262 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	263 # friend (class\|struct\|union) declarations.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	264 # If set to NO (the default) these declarations will be included in the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	265 # documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	266
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	267 HIDE_FRIEND_COMPOUNDS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	268
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	269 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	270 # documentation blocks found inside the body of a function.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	271 # If set to NO (the default) these blocks will be appended to the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	272 # function's detailed documentation block.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	273
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	274 HIDE_IN_BODY_DOCS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	275
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	276 # The INTERNAL_DOCS tag determines if documentation
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	277 # that is typed after a \internal command is included. If the tag is set
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	278 # to NO (the default) then the documentation will be excluded.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	279 # Set it to YES to include the internal documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	280
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	281 INTERNAL_DOCS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	282
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	283 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	284 # file names in lower-case letters. If set to YES upper-case letters are also
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	285 # allowed. This is useful if you have classes or files whose names only differ
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	286 # in case and if your file system supports case sensitive file names. Windows
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	287 # and Mac users are advised to set this option to NO.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	288
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	289 CASE_SENSE_NAMES = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	290
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	291 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	292 # will show members with their full class and namespace scopes in the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	293 # documentation. If set to YES the scope will be hidden.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	294
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	295 HIDE_SCOPE_NAMES = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	296
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	297 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	298 # will put a list of the files that are included by a file in the documentation
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	299 # of that file.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	300
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	301 SHOW_INCLUDE_FILES = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	302
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	303 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	304 # is inserted in the documentation for inline members.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	305
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	306 INLINE_INFO = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	307
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	308 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	309 # will sort the (detailed) documentation of file and class members
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	310 # alphabetically by member name. If set to NO the members will appear in
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	311 # declaration order.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	312
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	313 SORT_MEMBER_DOCS = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	314
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	315 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	316 # brief documentation of file, namespace and class members alphabetically
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	317 # by member name. If set to NO (the default) the members will appear in
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	318 # declaration order.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	319
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	320 SORT_BRIEF_DOCS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	321
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	322 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	323 # sorted by fully-qualified names, including namespaces. If set to
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	324 # NO (the default), the class list will be sorted only by class name,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	325 # not including the namespace part.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	326 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	327 # Note: This option applies only to the class list, not to the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	328 # alphabetical list.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	329
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	330 SORT_BY_SCOPE_NAME = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	331
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	332 # The GENERATE_TODOLIST tag can be used to enable (YES) or
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	333 # disable (NO) the todo list. This list is created by putting \todo
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	334 # commands in the documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	335
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	336 GENERATE_TODOLIST = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	337
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	338 # The GENERATE_TESTLIST tag can be used to enable (YES) or
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	339 # disable (NO) the test list. This list is created by putting \test
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	340 # commands in the documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	341
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	342 GENERATE_TESTLIST = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	343
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	344 # The GENERATE_BUGLIST tag can be used to enable (YES) or
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	345 # disable (NO) the bug list. This list is created by putting \bug
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	346 # commands in the documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	347
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	348 GENERATE_BUGLIST = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	349
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	350 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	351 # disable (NO) the deprecated list. This list is created by putting
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	352 # \deprecated commands in the documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	353
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	354 GENERATE_DEPRECATEDLIST= YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	355
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	356 # The ENABLED_SECTIONS tag can be used to enable conditional
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	357 # documentation sections, marked by \if sectionname ... \endif.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	358
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	359 ENABLED_SECTIONS =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	360
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	361 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	362 # the initial value of a variable or define consists of for it to appear in
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	363 # the documentation. If the initializer consists of more lines than specified
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	364 # here it will be hidden. Use a value of 0 to hide initializers completely.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	365 # The appearance of the initializer of individual variables and defines in the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	366 # documentation can be controlled using \showinitializer or \hideinitializer
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	367 # command in the documentation regardless of this setting.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	368
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	369 MAX_INITIALIZER_LINES = 30
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	370
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	371 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	372 # at the bottom of the documentation of classes and structs. If set to YES the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	373 # list will mention the files that were used to generate the documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	374
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	375 SHOW_USED_FILES = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	376
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	377 # If the sources in your project are distributed over multiple directories
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	378 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	379 # in the documentation. The default is YES.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	380
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	381 SHOW_DIRECTORIES = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	382
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	383 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	384 # doxygen should invoke to get the current version for each file (typically from the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	385 # version control system). Doxygen will invoke the program by executing (via
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	386 # popen()) the command <command> <input-file>, where <command> is the value of
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	387 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	388 # provided by doxygen. Whatever the progam writes to standard output
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	389 # is used as the file version. See the manual for examples.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	390
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	391 FILE_VERSION_FILTER =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	392
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	393 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	394 # configuration options related to warning and progress messages
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	395 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	396
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	397 # The QUIET tag can be used to turn on/off the messages that are generated
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	398 # by doxygen. Possible values are YES and NO. If left blank NO is used.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	399
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	400 QUIET = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	401
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	402 # The WARNINGS tag can be used to turn on/off the warning messages that are
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	403 # generated by doxygen. Possible values are YES and NO. If left blank
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	404 # NO is used.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	405
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	406 WARNINGS = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	407
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	408 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	409 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	410 # automatically be disabled.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	411
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	412 WARN_IF_UNDOCUMENTED = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	413
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	414 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	415 # potential errors in the documentation, such as not documenting some
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	416 # parameters in a documented function, or documenting parameters that
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	417 # don't exist or using markup commands wrongly.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	418
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	419 WARN_IF_DOC_ERROR = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	420
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	421 # This WARN_NO_PARAMDOC option can be abled to get warnings for
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	422 # functions that are documented, but have no documentation for their parameters
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	423 # or return value. If set to NO (the default) doxygen will only warn about
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	424 # wrong or incomplete parameter documentation, but not about the absence of
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	425 # documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	426
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	427 WARN_NO_PARAMDOC = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	428
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	429 # The WARN_FORMAT tag determines the format of the warning messages that
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	430 # doxygen can produce. The string should contain the $file, $line, and $text
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	431 # tags, which will be replaced by the file and line number from which the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	432 # warning originated and the warning text. Optionally the format may contain
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	433 # $version, which will be replaced by the version of the file (if it could
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	434 # be obtained via FILE_VERSION_FILTER)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	435
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	436 WARN_FORMAT = "$file:$line: $text"
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	437
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	438 # The WARN_LOGFILE tag can be used to specify a file to which warning
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	439 # and error messages should be written. If left blank the output is written
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	440 # to stderr.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	441
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	442 WARN_LOGFILE =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	443
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	444 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	445 # configuration options related to the input files
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	446 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	447
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	448 # The INPUT tag can be used to specify the files and/or directories that contain
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	449 # documented source files. You may enter file names like "myfile.cpp" or
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	450 # directories like "/usr/src/myproject". Separate the files or directories
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	451 # with spaces.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	452
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	453 INPUT =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	454
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	455 # If the value of the INPUT tag contains directories, you can use the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	456 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	457 # and *.h) to filter out the source-files in the directories. If left
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	458 # blank the following patterns are tested:
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	459 # .c .cc .cxx .cpp .c++ .java .ii .ixx .ipp .i++ .inl .h .hh .hxx
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	460 # .hpp .h++ .idl .odl .cs .php .php3 .inc .m .mm
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	461
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	462 FILE_PATTERNS =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	463
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	464 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	465 # should be searched for input files as well. Possible values are YES and NO.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	466 # If left blank NO is used.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	467
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	468 RECURSIVE = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	469
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	470 # The EXCLUDE tag can be used to specify files and/or directories that should
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	471 # excluded from the INPUT source files. This way you can easily exclude a
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	472 # subdirectory from a directory tree whose root is specified with the INPUT tag.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	473
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	474 EXCLUDE =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	475
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	476 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	477 # directories that are symbolic links (a Unix filesystem feature) are excluded
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	478 # from the input.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	479
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	480 EXCLUDE_SYMLINKS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	481
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	482 # If the value of the INPUT tag contains directories, you can use the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	483 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	484 # certain files from those directories. Note that the wildcards are matched
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	485 # against the file with absolute path, so to exclude all test directories
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	486 # for example use the pattern /test/
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	487
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	488 EXCLUDE_PATTERNS =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	489
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	490 # The EXAMPLE_PATH tag can be used to specify one or more files or
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	491 # directories that contain example code fragments that are included (see
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	492 # the \include command).
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	493
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	494 EXAMPLE_PATH =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	495
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	496 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	497 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	498 # and *.h) to filter out the source-files in the directories. If left
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	499 # blank all files are included.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	500
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	501 EXAMPLE_PATTERNS =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	502
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	503 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	504 # searched for input files to be used with the \include or \dontinclude
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	505 # commands irrespective of the value of the RECURSIVE tag.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	506 # Possible values are YES and NO. If left blank NO is used.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	507
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	508 EXAMPLE_RECURSIVE = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	509
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	510 # The IMAGE_PATH tag can be used to specify one or more files or
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	511 # directories that contain image that are included in the documentation (see
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	512 # the \image command).
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	513
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	514 IMAGE_PATH =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	515
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	516 # The INPUT_FILTER tag can be used to specify a program that doxygen should
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	517 # invoke to filter for each input file. Doxygen will invoke the filter program
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	518 # by executing (via popen()) the command <filter> <input-file>, where <filter>
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	519 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	520 # input file. Doxygen will then use the output that the filter program writes
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	521 # to standard output. If FILTER_PATTERNS is specified, this tag will be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	522 # ignored.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	523
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	524 INPUT_FILTER =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	525
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	526 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	527 # basis. Doxygen will compare the file name with each pattern and apply the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	528 # filter if there is a match. The filters are a list of the form:
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	529 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	530 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	531 # is applied to all files.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	532
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	533 FILTER_PATTERNS =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	534
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	535 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	536 # INPUT_FILTER) will be used to filter the input files when producing source
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	537 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	538
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	539 FILTER_SOURCE_FILES = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	540
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	541 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	542 # configuration options related to source browsing
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	543 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	544
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	545 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	546 # be generated. Documented entities will be cross-referenced with these sources.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	547 # Note: To get rid of all source code in the generated output, make sure also
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	548 # VERBATIM_HEADERS is set to NO.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	549
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	550 SOURCE_BROWSER = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	551
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	552 # Setting the INLINE_SOURCES tag to YES will include the body
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	553 # of functions and classes directly in the documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	554
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	555 INLINE_SOURCES = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	556
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	557 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	558 # doxygen to hide any special comment blocks from generated source code
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	559 # fragments. Normal C and C++ comments will always remain visible.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	560
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	561 STRIP_CODE_COMMENTS = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	562
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	563 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	564 # then for each documented function all documented
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	565 # functions referencing it will be listed.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	566
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	567 REFERENCED_BY_RELATION = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	568
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	569 # If the REFERENCES_RELATION tag is set to YES (the default)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	570 # then for each documented function all documented entities
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	571 # called/used by that function will be listed.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	572
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	573 REFERENCES_RELATION = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	574
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	575 # If the USE_HTAGS tag is set to YES then the references to source code
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	576 # will point to the HTML generated by the htags(1) tool instead of doxygen
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	577 # built-in source browser. The htags tool is part of GNU's global source
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	578 # tagging system (see http://www.gnu.org/software/global/global.html). You
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	579 # will need version 4.8.6 or higher.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	580
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	581 USE_HTAGS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	582
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	583 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	584 # will generate a verbatim copy of the header file for each class for
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	585 # which an include is specified. Set to NO to disable this.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	586
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	587 VERBATIM_HEADERS = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	588
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	589 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	590 # configuration options related to the alphabetical class index
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	591 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	592
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	593 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	594 # of all compounds will be generated. Enable this if the project
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	595 # contains a lot of classes, structs, unions or interfaces.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	596
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	597 ALPHABETICAL_INDEX = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	598
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	599 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	600 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	601 # in which this list will be split (can be a number in the range [1..20])
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	602
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	603 COLS_IN_ALPHA_INDEX = 5
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	604
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	605 # In case all classes in a project start with a common prefix, all
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	606 # classes will be put under the same header in the alphabetical index.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	607 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	608 # should be ignored while generating the index headers.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	609
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	610 IGNORE_PREFIX =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	611
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	612 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	613 # configuration options related to the HTML output
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	614 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	615
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	616 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	617 # generate HTML output.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	618
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	619 GENERATE_HTML = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	620
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	621 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	622 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	623 # put in front of it. If left blank `html' will be used as the default path.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	624
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	625 HTML_OUTPUT = html
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	626
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	627 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	628 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	629 # doxygen will generate files with .html extension.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	630
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	631 HTML_FILE_EXTENSION = .html
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	632
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	633 # The HTML_HEADER tag can be used to specify a personal HTML header for
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	634 # each generated HTML page. If it is left blank doxygen will generate a
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	635 # standard header.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	636
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	637 HTML_HEADER =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	638
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	639 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	640 # each generated HTML page. If it is left blank doxygen will generate a
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	641 # standard footer.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	642
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	643 HTML_FOOTER =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	644
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	645 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	646 # style sheet that is used by each HTML page. It can be used to
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	647 # fine-tune the look of the HTML output. If the tag is left blank doxygen
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	648 # will generate a default style sheet. Note that doxygen will try to copy
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	649 # the style sheet file to the HTML output directory, so don't put your own
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	650 # stylesheet in the HTML output directory as well, or it will be erased!
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	651
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	652 HTML_STYLESHEET =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	653
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	654 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	655 # files or namespaces will be aligned in HTML using tables. If set to
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	656 # NO a bullet list will be used.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	657
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	658 HTML_ALIGN_MEMBERS = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	659
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	660 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	661 # will be generated that can be used as input for tools like the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	662 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	663 # of the generated HTML documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	664
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	665 GENERATE_HTMLHELP = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	666
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	667 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	668 # be used to specify the file name of the resulting .chm file. You
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	669 # can add a path in front of the file if the result should not be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	670 # written to the html output directory.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	671
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	672 CHM_FILE =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	673
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	674 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	675 # be used to specify the location (absolute path including file name) of
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	676 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	677 # the HTML help compiler on the generated index.hhp.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	678
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	679 HHC_LOCATION =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	680
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	681 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	682 # controls if a separate .chi index file is generated (YES) or that
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	683 # it should be included in the master .chm file (NO).
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	684
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	685 GENERATE_CHI = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	686
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	687 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	688 # controls whether a binary table of contents is generated (YES) or a
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	689 # normal table of contents (NO) in the .chm file.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	690
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	691 BINARY_TOC = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	692
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	693 # The TOC_EXPAND flag can be set to YES to add extra items for group members
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	694 # to the contents of the HTML help documentation and to the tree view.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	695
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	696 TOC_EXPAND = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	697
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	698 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	699 # top of each HTML page. The value NO (the default) enables the index and
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	700 # the value YES disables it.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	701
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	702 DISABLE_INDEX = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	703
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	704 # This tag can be used to set the number of enum values (range [1..20])
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	705 # that doxygen will group on one line in the generated HTML documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	706
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	707 ENUM_VALUES_PER_LINE = 4
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	708
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	709 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	710 # generated containing a tree-like index structure (just like the one that
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	711 # is generated for HTML Help). For this to work a browser that supports
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	712 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	713 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	714 # probably better off using the HTML help feature.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	715
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	716 GENERATE_TREEVIEW = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	717
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	718 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	719 # used to set the initial width (in pixels) of the frame in which the tree
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	720 # is shown.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	721
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	722 TREEVIEW_WIDTH = 250
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	723
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	724 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	725 # configuration options related to the LaTeX output
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	726 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	727
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	728 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	729 # generate Latex output.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	730
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	731 GENERATE_LATEX = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	732
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	733 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	734 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	735 # put in front of it. If left blank `latex' will be used as the default path.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	736
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	737 LATEX_OUTPUT = latex
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	738
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	739 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	740 # invoked. If left blank `latex' will be used as the default command name.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	741
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	742 LATEX_CMD_NAME = latex
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	743
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	744 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	745 # generate index for LaTeX. If left blank `makeindex' will be used as the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	746 # default command name.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	747
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	748 MAKEINDEX_CMD_NAME = makeindex
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	749
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	750 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	751 # LaTeX documents. This may be useful for small projects and may help to
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	752 # save some trees in general.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	753
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	754 COMPACT_LATEX = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	755
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	756 # The PAPER_TYPE tag can be used to set the paper type that is used
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	757 # by the printer. Possible values are: a4, a4wide, letter, legal and
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	758 # executive. If left blank a4wide will be used.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	759
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	760 PAPER_TYPE = a4wide
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	761
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	762 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	763 # packages that should be included in the LaTeX output.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	764
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	765 EXTRA_PACKAGES =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	766
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	767 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	768 # the generated latex document. The header should contain everything until
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	769 # the first chapter. If it is left blank doxygen will generate a
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	770 # standard header. Notice: only use this tag if you know what you are doing!
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	771
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	772 LATEX_HEADER =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	773
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	774 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	775 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	776 # contain links (just like the HTML output) instead of page references
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	777 # This makes the output suitable for online browsing using a pdf viewer.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	778
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	779 PDF_HYPERLINKS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	780
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	781 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	782 # plain latex in the generated Makefile. Set this option to YES to get a
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	783 # higher quality PDF documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	784
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	785 USE_PDFLATEX = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	786
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	787 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	788 # command to the generated LaTeX files. This will instruct LaTeX to keep
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	789 # running if errors occur, instead of asking the user for help.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	790 # This option is also used when generating formulas in HTML.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	791
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	792 LATEX_BATCHMODE = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	793
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	794 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	795 # include the index chapters (such as File Index, Compound Index, etc.)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	796 # in the output.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	797
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	798 LATEX_HIDE_INDICES = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	799
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	800 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	801 # configuration options related to the RTF output
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	802 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	803
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	804 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	805 # The RTF output is optimized for Word 97 and may not look very pretty with
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	806 # other RTF readers or editors.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	807
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	808 GENERATE_RTF = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	809
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	810 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	811 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	812 # put in front of it. If left blank `rtf' will be used as the default path.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	813
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	814 RTF_OUTPUT = rtf
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	815
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	816 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	817 # RTF documents. This may be useful for small projects and may help to
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	818 # save some trees in general.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	819
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	820 COMPACT_RTF = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	821
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	822 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	823 # will contain hyperlink fields. The RTF file will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	824 # contain links (just like the HTML output) instead of page references.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	825 # This makes the output suitable for online browsing using WORD or other
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	826 # programs which support those fields.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	827 # Note: wordpad (write) and others do not support links.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	828
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	829 RTF_HYPERLINKS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	830
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	831 # Load stylesheet definitions from file. Syntax is similar to doxygen's
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	832 # config file, i.e. a series of assignments. You only have to provide
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	833 # replacements, missing definitions are set to their default value.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	834
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	835 RTF_STYLESHEET_FILE =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	836
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	837 # Set optional variables used in the generation of an rtf document.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	838 # Syntax is similar to doxygen's config file.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	839
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	840 RTF_EXTENSIONS_FILE =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	841
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	842 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	843 # configuration options related to the man page output
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	844 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	845
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	846 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	847 # generate man pages
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	848
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	849 GENERATE_MAN = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	850
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	851 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	852 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	853 # put in front of it. If left blank `man' will be used as the default path.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	854
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	855 MAN_OUTPUT = man
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	856
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	857 # The MAN_EXTENSION tag determines the extension that is added to
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	858 # the generated man pages (default is the subroutine's section .3)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	859
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	860 MAN_EXTENSION = .3
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	861
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	862 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	863 # then it will generate one additional man file for each entity
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	864 # documented in the real man page(s). These additional files
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	865 # only source the real man page, but without them the man command
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	866 # would be unable to find the correct page. The default is NO.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	867
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	868 MAN_LINKS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	869
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	870 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	871 # configuration options related to the XML output
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	872 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	873
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	874 # If the GENERATE_XML tag is set to YES Doxygen will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	875 # generate an XML file that captures the structure of
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	876 # the code including all documentation.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	877
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	878 GENERATE_XML = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	879
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	880 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	881 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	882 # put in front of it. If left blank `xml' will be used as the default path.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	883
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	884 XML_OUTPUT = xml
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	885
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	886 # The XML_SCHEMA tag can be used to specify an XML schema,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	887 # which can be used by a validating XML parser to check the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	888 # syntax of the XML files.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	889
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	890 XML_SCHEMA =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	891
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	892 # The XML_DTD tag can be used to specify an XML DTD,
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	893 # which can be used by a validating XML parser to check the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	894 # syntax of the XML files.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	895
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	896 XML_DTD =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	897
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	898 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	899 # dump the program listings (including syntax highlighting
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	900 # and cross-referencing information) to the XML output. Note that
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	901 # enabling this will significantly increase the size of the XML output.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	902
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	903 XML_PROGRAMLISTING = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	904
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	905 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	906 # configuration options for the AutoGen Definitions output
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	907 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	908
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	909 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	910 # generate an AutoGen Definitions (see autogen.sf.net) file
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	911 # that captures the structure of the code including all
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	912 # documentation. Note that this feature is still experimental
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	913 # and incomplete at the moment.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	914
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	915 GENERATE_AUTOGEN_DEF = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	916
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	917 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	918 # configuration options related to the Perl module output
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	919 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	920
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	921 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	922 # generate a Perl module file that captures the structure of
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	923 # the code including all documentation. Note that this
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	924 # feature is still experimental and incomplete at the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	925 # moment.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	926
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	927 GENERATE_PERLMOD = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	928
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	929 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	930 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	931 # to generate PDF and DVI output from the Perl module output.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	932
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	933 PERLMOD_LATEX = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	934
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	935 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	936 # nicely formatted so it can be parsed by a human reader. This is useful
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	937 # if you want to understand what is going on. On the other hand, if this
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	938 # tag is set to NO the size of the Perl module output will be much smaller
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	939 # and Perl will parse it just the same.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	940
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	941 PERLMOD_PRETTY = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	942
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	943 # The names of the make variables in the generated doxyrules.make file
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	944 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	945 # This is useful so different doxyrules.make files included by the same
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	946 # Makefile don't overwrite each other's variables.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	947
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	948 PERLMOD_MAKEVAR_PREFIX =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	949
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	950 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	951 # Configuration options related to the preprocessor
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	952 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	953
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	954 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	955 # evaluate all C-preprocessor directives found in the sources and include
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	956 # files.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	957
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	958 ENABLE_PREPROCESSING = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	959
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	960 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	961 # names in the source code. If set to NO (the default) only conditional
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	962 # compilation will be performed. Macro expansion can be done in a controlled
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	963 # way by setting EXPAND_ONLY_PREDEF to YES.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	964
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	965 MACRO_EXPANSION = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	966
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	967 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	968 # then the macro expansion is limited to the macros specified with the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	969 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	970
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	971 EXPAND_ONLY_PREDEF = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	972
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	973 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	974 # in the INCLUDE_PATH (see below) will be search if a #include is found.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	975
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	976 SEARCH_INCLUDES = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	977
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	978 # The INCLUDE_PATH tag can be used to specify one or more directories that
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	979 # contain include files that are not input files but should be processed by
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	980 # the preprocessor.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	981
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	982 INCLUDE_PATH =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	983
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	984 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	985 # patterns (like .h and .hpp) to filter out the header-files in the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	986 # directories. If left blank, the patterns specified with FILE_PATTERNS will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	987 # be used.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	988
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	989 INCLUDE_FILE_PATTERNS =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	990
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	991 # The PREDEFINED tag can be used to specify one or more macro names that
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	992 # are defined before the preprocessor is started (similar to the -D option of
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	993 # gcc). The argument of the tag is a list of macros of the form: name
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	994 # or name=definition (no spaces). If the definition and the = are
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	995 # omitted =1 is assumed. To prevent a macro definition from being
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	996 # undefined via #undef or recursively expanded use the := operator
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	997 # instead of the = operator.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	998
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	999 PREDEFINED = DOXYGEN_SHOULD_IGNORE_THIS=1 \
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1000 DECLSPEC= SDLCALL=
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1001
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1002 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1003 # this tag can be used to specify a list of macro names that should be expanded.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1004 # The macro definition that is found in the sources will be used.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1005 # Use the PREDEFINED tag if you want to use a different macro definition.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1006
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1007 EXPAND_AS_DEFINED =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1008
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1009 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1010 # doxygen's preprocessor will remove all function-like macros that are alone
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1011 # on a line, have an all uppercase name, and do not end with a semicolon. Such
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1012 # function macros are typically used for boiler-plate code, and will confuse
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1013 # the parser if not removed.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1014
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1015 SKIP_FUNCTION_MACROS = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1016
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1017 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1018 # Configuration::additions related to external references
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1019 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1020
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1021 # The TAGFILES option can be used to specify one or more tagfiles.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1022 # Optionally an initial location of the external documentation
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1023 # can be added for each tagfile. The format of a tag file without
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1024 # this location is as follows:
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1025 # TAGFILES = file1 file2 ...
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1026 # Adding location for the tag files is done as follows:
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1027 # TAGFILES = file1=loc1 "file2 = loc2" ...
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1028 # where "loc1" and "loc2" can be relative or absolute paths or
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1029 # URLs. If a location is present for each tag, the installdox tool
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1030 # does not have to be run to correct the links.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1031 # Note that each tag file must have a unique name
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1032 # (where the name does NOT include the path)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1033 # If a tag file is not located in the directory in which doxygen
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1034 # is run, you must also specify the path to the tagfile here.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1035
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1036 TAGFILES =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1037
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1038 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1039 # a tag file that is based on the input files it reads.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1040
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1041 GENERATE_TAGFILE =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1042
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1043 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1044 # in the class index. If set to NO only the inherited external classes
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1045 # will be listed.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1046
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1047 ALLEXTERNALS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1048
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1049 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1050 # in the modules index. If set to NO, only the current project's groups will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1051 # be listed.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1052
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1053 EXTERNAL_GROUPS = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1054
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1055 # The PERL_PATH should be the absolute path and name of the perl script
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1056 # interpreter (i.e. the result of `which perl').
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1057
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1058 PERL_PATH = /usr/bin/perl
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1059
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1060 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1061 # Configuration options related to the dot tool
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1062 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1063
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1064 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1065 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1066 # or super classes. Setting the tag to NO turns the diagrams off. Note that
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1067 # this option is superseded by the HAVE_DOT option below. This is only a
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1068 # fallback. It is recommended to install and use dot, since it yields more
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1069 # powerful graphs.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1070
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1071 CLASS_DIAGRAMS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1072
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1073 # If set to YES, the inheritance and collaboration graphs will hide
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1074 # inheritance and usage relations if the target is undocumented
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1075 # or is not a class.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1076
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1077 HIDE_UNDOC_RELATIONS = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1078
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1079 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1080 # available from the path. This tool is part of Graphviz, a graph visualization
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1081 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1082 # have no effect if this option is set to NO (the default)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1083
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1084 HAVE_DOT = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1085
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1086 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1087 # will generate a graph for each documented class showing the direct and
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1088 # indirect inheritance relations. Setting this tag to YES will force the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1089 # the CLASS_DIAGRAMS tag to NO.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1090
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1091 CLASS_GRAPH = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1092
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1093 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1094 # will generate a graph for each documented class showing the direct and
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1095 # indirect implementation dependencies (inheritance, containment, and
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1096 # class references variables) of the class with other documented classes.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1097
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1098 COLLABORATION_GRAPH = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1099
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1100 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1101 # will generate a graph for groups, showing the direct groups dependencies
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1102
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1103 GROUP_GRAPHS = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1104
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1105 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1106 # collaboration diagrams in a style similar to the OMG's Unified Modeling
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1107 # Language.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1108
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1109 UML_LOOK = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1110
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1111 # If set to YES, the inheritance and collaboration graphs will show the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1112 # relations between templates and their instances.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1113
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1114 TEMPLATE_RELATIONS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1115
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1116 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1117 # tags are set to YES then doxygen will generate a graph for each documented
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1118 # file showing the direct and indirect include dependencies of the file with
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1119 # other documented files.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1120
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1121 INCLUDE_GRAPH = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1122
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1123 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1124 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1125 # documented header file showing the documented files that directly or
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1126 # indirectly include this file.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1127
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1128 INCLUDED_BY_GRAPH = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1129
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1130 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1131 # generate a call dependency graph for every global function or class method.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1132 # Note that enabling this option will significantly increase the time of a run.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1133 # So in most cases it will be better to enable call graphs for selected
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1134 # functions only using the \callgraph command.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1135
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1136 CALL_GRAPH = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1137
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1138 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1139 # will graphical hierarchy of all classes instead of a textual one.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1140
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1141 GRAPHICAL_HIERARCHY = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1142
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1143 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1144 # then doxygen will show the dependencies a directory has on other directories
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1145 # in a graphical way. The dependency relations are determined by the #include
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1146 # relations between the files in the directories.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1147
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1148 DIRECTORY_GRAPH = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1149
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1150 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1151 # generated by dot. Possible values are png, jpg, or gif
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1152 # If left blank png will be used.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1153
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1154 DOT_IMAGE_FORMAT = png
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1155
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1156 # The tag DOT_PATH can be used to specify the path where the dot tool can be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1157 # found. If left blank, it is assumed the dot tool can be found in the path.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1158
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1159 DOT_PATH =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1160
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1161 # The DOTFILE_DIRS tag can be used to specify one or more directories that
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1162 # contain dot files that are included in the documentation (see the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1163 # \dotfile command).
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1164
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1165 DOTFILE_DIRS =
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1166
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1167 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1168 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1169 # this value, doxygen will try to truncate the graph, so that it fits within
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1170 # the specified constraint. Beware that most browsers cannot cope with very
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1171 # large images.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1172
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1173 MAX_DOT_GRAPH_WIDTH = 1024
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1174
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1175 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1176 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1177 # this value, doxygen will try to truncate the graph, so that it fits within
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1178 # the specified constraint. Beware that most browsers cannot cope with very
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1179 # large images.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1180
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1181 MAX_DOT_GRAPH_HEIGHT = 1024
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1182
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1183 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1184 # graphs generated by dot. A depth value of 3 means that only nodes reachable
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1185 # from the root by following a path via at most 3 edges will be shown. Nodes
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1186 # that lay further from the root node will be omitted. Note that setting this
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1187 # option to 1 or 2 may greatly reduce the computation time needed for large
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1188 # code bases. Also note that a graph may be further truncated if the graph's
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1189 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1190 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1191 # the graph is not depth-constrained.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1192
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1193 MAX_DOT_GRAPH_DEPTH = 0
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1194
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1195 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1196 # background. This is disabled by default, which results in a white background.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1197 # Warning: Depending on the platform used, enabling this option may lead to
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1198 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1199 # read).
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1200
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1201 DOT_TRANSPARENT = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1202
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1203 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1204 # files in one run (i.e. multiple -o and -T options on the command line). This
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1205 # makes dot run faster, but since only newer versions of dot (>1.8.10)
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1206 # support this, this feature is disabled by default.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1207
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1208 DOT_MULTI_TARGETS = NO
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1209
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1210 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1211 # generate a legend page explaining the meaning of the various boxes and
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1212 # arrows in the dot generated graphs.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1213
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1214 GENERATE_LEGEND = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1215
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1216 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1217 # remove the intermediate dot files that are used to generate
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1218 # the various graphs.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1219
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1220 DOT_CLEANUP = YES
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1221
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1222 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1223 # Configuration::additions related to the search engine
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1224 #---------------------------------------------------------------------------
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1225
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1226 # The SEARCHENGINE tag specifies whether or not a search engine should be
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1227 # used. If set to NO the values of all tags below this one will be ignored.
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1228
782fd950bd46 Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1229 SEARCHENGINE = NO

Mercurial > sdl-ios-xcode

annotate include/doxyfile @ 1675:d33dcfc3fde7 SDL-1.3