dropbear: Doxyfile annotate

annotate Doxyfile @ 381:999a5eb4ed10 libtomcrypt-dropbear

propagate from branch 'au.asn.ucc.matt.ltc.orig' (head 52840647ac7f5c707c3bd158d119a15734a7ef28) to branch 'au.asn.ucc.matt.ltc.dropbear' (head 20dccfc09627970a312d77fb41dc2970b62689c3)

author	Matt Johnston <matt@ucc.asn.au>
date	Thu, 11 Jan 2007 02:39:21 +0000
parents	d5faf4814ddb
children

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

Mercurial > dropbear

annotate Doxyfile @ 381:999a5eb4ed10 libtomcrypt-dropbear