dropbear: libtomcrypt/doc/Doxyfile annotate

annotate libtomcrypt/doc/Doxyfile @ 1930:299f4f19ba19

Add /usr/sbin and /sbin to default root PATH When dropbear is used in a very restricted environment (such as in a initrd), the default user shell is often also very restricted and doesn't take care of setting the PATH so the user ends up with the PATH set by dropbear. Unfortunately, dropbear always sets "/usr/bin:/bin" as default PATH even for the root user which should have /usr/sbin and /sbin too. For a concrete instance of this problem, see the "Remote Unlocking" section in this tutorial: https://paxswill.com/blog/2013/11/04/encrypted-raspberry-pi/ It speaks of a bug in the initramfs script because it's written "blkid" instead of "/sbin/blkid"... this is just because the scripts from the initramfs do not expect to have a PATH without the sbin directories and because dropbear is not setting the PATH appropriately for the root user. I'm thus suggesting to use the attached patch to fix this misbehaviour (I did not test it, but it's easy enough). It might seem anecdotic but multiple Kali users have been bitten by this. From https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=903403

author	Raphael Hertzog <hertzog@debian.org>
date	Mon, 09 Jul 2018 16:27:53 +0200
parents	e9dba7abd939
children

rev	line source
1471 6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1 # Doxyfile 1.8.11
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	3 # This file describes the settings to be used by the documentation system
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	4 # doxygen (www.doxygen.org) for a project.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	5 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	6 # All text after a double hash (##) is considered a comment and is placed in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	7 # front of the TAG it is preceding.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	8 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	9 # All text after a single hash (#) is considered a comment and will be ignored.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	10 # The format is:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	11 # TAG = value [value, ...]
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	12 # For lists, items can also be appended using:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	13 # TAG += value [value, ...]
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	14 # Values that contain spaces should be placed between quotes (\" \").
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	15
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	16 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	17 # Project related configuration options
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	18 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	19
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	20 # This tag specifies the encoding used for all characters in the config file
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	21 # that follow. The default is UTF-8 which is also the encoding used for all text
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	24 # for the list of possible encodings.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	25 # The default value is: UTF-8.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	26
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	27 DOXYFILE_ENCODING = UTF-8
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	28
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	30 # double-quotes, unless you are using Doxywizard) that should identify the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	31 # project for which the documentation is generated. This name is used in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	32 # title of most generated pages and in a few other places.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	33 # The default value is: My Project.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	34
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	35 PROJECT_NAME = LibTomCrypt
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	36
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	38 # could be handy for archiving the generated documentation or if some version
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	39 # control system is used.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	40
1711 e9dba7abd939 Merge libtomcrypt v1.18.2 Matt Johnston <matt@ucc.asn.au> parents: 1471 diff changeset	41 PROJECT_NUMBER=1.18.2
1471 6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	42
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	44 # for a project that appears at the top of each page and should give viewer a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	45 # quick idea about the purpose of the project. Keep the description short.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	46
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	47 PROJECT_BRIEF =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	48
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	50 # in the documentation. The maximum height of the logo should not exceed 55
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	52 # the logo to the output directory.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	53
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	54 PROJECT_LOGO = libtomsm.png
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	55
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	57 # into which the generated documentation will be written. If a relative path is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	58 # entered, it will be relative to the location where doxygen was started. If
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	59 # left blank the current directory will be used.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	60
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	61 OUTPUT_DIRECTORY = doxygen
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	62
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	64 # directories (in 2 levels) under the output directory of each output format and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	65 # will distribute the generated files over these directories. Enabling this
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	66 # option can be useful when feeding doxygen a huge amount of source files, where
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	67 # putting all generated files in the same directory would otherwise causes
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	68 # performance problems for the file system.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	69 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	70
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	71 CREATE_SUBDIRS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	72
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	74 # characters to appear in the names of generated files. If set to NO, non-ASCII
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	76 # U+3044.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	77 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	78
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	79 ALLOW_UNICODE_NAMES = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	80
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	82 # documentation generated by doxygen is written. Doxygen will use this
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	83 # information to generate all constant output in the proper language.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	91 # Ukrainian and Vietnamese.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	92 # The default value is: English.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	93
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	94 OUTPUT_LANGUAGE = English
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	95
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	97 # descriptions after the members that are listed in the file and class
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	98 # documentation (similar to Javadoc). Set to NO to disable this.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	99 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	100
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	101 BRIEF_MEMBER_DESC = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	102
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	104 # description of a member or function before the detailed description
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	105 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	107 # brief descriptions will be completely suppressed.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	108 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	109
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	110 REPEAT_BRIEF = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	111
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	112 # This tag implements a quasi-intelligent brief description abbreviator that is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	113 # used to form the text in various listings. Each string in this list, if found
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	114 # as the leading text of the brief description, will be stripped from the text
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	115 # and the result, after processing the whole list, is used as the annotated
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	116 # text. Otherwise, the brief description is used as-is. If left blank, the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	117 # following values are used ($name is automatically replaced with the name of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	118 # the entity):The $name class, The $name widget, The $name file, is, provides,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	119 # specifies, contains, represents, a, an and the.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	120
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	121 ABBREVIATE_BRIEF =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	122
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	124 # doxygen will generate a detailed section even if there is only a brief
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	125 # description.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	126 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	127
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	128 ALWAYS_DETAILED_SEC = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	129
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	131 # inherited members of a class in the documentation of that class as if those
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	132 # members were ordinary class members. Constructors, destructors and assignment
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	133 # operators of the base classes will not be shown.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	134 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	135
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	136 INLINE_INHERITED_MEMB = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	137
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	138 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	139 # before files name in the file list and in the header files. If set to NO the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	140 # shortest path that makes the file name unique will be used
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	141 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	142
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	143 FULL_PATH_NAMES = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	144
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	146 # Stripping is only done if one of the specified strings matches the left-hand
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	147 # part of the path. The tag can be used to show relative paths in the file list.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	148 # If left blank the directory from which doxygen is run is used as the path to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	149 # strip.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	150 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	151 # Note that you can specify absolute paths here, but also relative paths, which
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	152 # will be relative from the directory where doxygen is started.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	154
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	155 STRIP_FROM_PATH = src
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	156
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	158 # path mentioned in the documentation of a class, which tells the reader which
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	159 # header file to include in order to use a class. If left blank only the name of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	160 # the header file containing the class definition is used. Otherwise one should
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	161 # specify the list of include paths that are normally passed to the compiler
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	162 # using the -I flag.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	163
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	164 STRIP_FROM_INC_PATH = ../src/headers
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	165
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	167 # less readable) file names. This can be useful is your file systems doesn't
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	168 # support long names like on DOS, Mac, or CD-ROM.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	169 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	170
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	171 SHORT_NAMES = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	172
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	174 # first line (until the first dot) of a Javadoc-style comment as the brief
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	176 # style comments (thus requiring an explicit @brief command for a brief
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	177 # description.)
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	178 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	179
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	180 JAVADOC_AUTOBRIEF = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	181
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	183 # line (until the first dot) of a Qt-style comment as the brief description. If
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	185 # requiring an explicit \brief command for a brief description.)
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	186 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	187
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	188 QT_AUTOBRIEF = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	189
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	192 # a brief description. This used to be the default behavior. The new default is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	193 # to treat a multi-line C++ comment block as a detailed description. Set this
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	194 # tag to YES if you prefer the old behavior instead.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	195 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	196 # Note that setting this tag to YES also means that rational rose comments are
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	197 # not recognized any more.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	198 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	199
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	200 MULTILINE_CPP_IS_BRIEF = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	201
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	203 # documentation from any documented member that it re-implements.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	204 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	205
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	206 INHERIT_DOCS = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	207
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	208 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	209 # page for each member. If set to NO, the documentation of a member will be part
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	210 # of the file/class/namespace that contains it.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	211 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	212
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	213 SEPARATE_MEMBER_PAGES = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	214
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	216 # uses this value to replace tabs by spaces in code fragments.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	217 # Minimum value: 1, maximum value: 16, default value: 4.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	218
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	219 TAB_SIZE = 4
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	220
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	221 # This tag can be used to specify a number of aliases that act as commands in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	222 # the documentation. An alias has the form:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	223 # name=value
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	224 # For example adding
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	225 # "sideeffect=@par Side Effects:\n"
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	226 # will allow you to put the command \sideeffect (or @sideeffect) in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	227 # documentation, which will result in a user-defined paragraph with heading
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	228 # "Side Effects:". You can put \n's in the value part of an alias to insert
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	229 # newlines.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	230
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	231 ALIASES =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	232
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	233 # This tag can be used to specify a number of word-keyword mappings (TCL only).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	234 # A mapping has the form "name=value". For example adding "class=itcl::class"
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	235 # will allow you to use the command class in the itcl::class meaning.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	236
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	237 TCL_SUBST =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	238
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	240 # only. Doxygen will then generate output that is more tailored for C. For
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	241 # instance, some of the names that are used will be different. The list of all
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	242 # members will be omitted, etc.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	243 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	244
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	245 OPTIMIZE_OUTPUT_FOR_C = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	246
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	248 # Python sources only. Doxygen will then generate output that is more tailored
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	249 # for that language. For instance, namespaces will be presented as packages,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	250 # qualified scopes will look different, etc.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	251 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	252
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	253 OPTIMIZE_OUTPUT_JAVA = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	254
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	256 # sources. Doxygen will then generate output that is tailored for Fortran.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	257 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	258
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	259 OPTIMIZE_FOR_FORTRAN = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	260
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	262 # sources. Doxygen will then generate output that is tailored for VHDL.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	263 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	264
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	265 OPTIMIZE_OUTPUT_VHDL = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	266
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	267 # Doxygen selects the parser to use depending on the extension of the files it
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	268 # parses. With this tag you can assign which parser to use for a given
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	269 # extension. Doxygen has a built-in mapping, but you can override or extend it
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	270 # using this tag. The format is ext=language, where ext is a file extension, and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	273 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	274 # Fortran. In the later case the parser tries to guess whether the code is fixed
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	275 # or free formatted code, this is the default for Fortran type files), VHDL. For
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	276 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	277 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	278 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	279 # Note: For files without extension you can use no_extension as a placeholder.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	280 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	282 # the files are not read by doxygen.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	283
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	284 EXTENSION_MAPPING =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	285
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	287 # according to the Markdown format, which allows for more readable
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	288 # documentation. See http://daringfireball.net/projects/markdown/ for details.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	289 # The output of markdown processing is further processed by doxygen, so you can
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	290 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	291 # case of backward compatibilities issues.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	292 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	293
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	294 MARKDOWN_SUPPORT = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	295
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	296 # When enabled doxygen tries to link words that correspond to documented
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	297 # classes, or namespaces to their corresponding documentation. Such a link can
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	298 # be prevented in individual cases by putting a % sign in front of the word or
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	299 # globally by setting AUTOLINK_SUPPORT to NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	300 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	301
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	302 AUTOLINK_SUPPORT = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	303
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	304 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	305 # to include (a tag file for) the STL sources as input, then you should set this
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	306 # tag to YES in order to let doxygen match functions declarations and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	307 # definitions whose arguments contain STL classes (e.g. func(std::string);
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	308 # versus func(std::string) {}). This also make the inheritance and collaboration
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	309 # diagrams that involve STL classes more complete and accurate.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	310 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	311
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	312 BUILTIN_STL_SUPPORT = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	313
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	314 # If you use Microsoft's C++/CLI language, you should set this option to YES to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	315 # enable parsing support.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	316 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	317
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	318 CPP_CLI_SUPPORT = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	319
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	320 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	321 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	322 # will parse them like normal C++ but will assume all classes use public instead
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	323 # of private inheritance when no explicit protection keyword is present.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	324 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	325
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	326 SIP_SUPPORT = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	327
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	328 # For Microsoft's IDL there are propget and propput attributes to indicate
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	329 # getter and setter methods for a property. Setting this option to YES will make
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	330 # doxygen to replace the get and set methods by a property in the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	331 # This will only work if the methods are indeed getting or setting a simple
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	332 # type. If this is not the case, or you want to show the methods anyway, you
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	333 # should set this option to NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	334 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	335
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	336 IDL_PROPERTY_SUPPORT = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	337
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	339 # tag is set to YES then doxygen will reuse the documentation of the first
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	340 # member in the group (if any) for the other members of the group. By default
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	341 # all members of a group must be documented explicitly.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	342 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	343
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	344 DISTRIBUTE_GROUP_DOC = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	345
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	346 # If one adds a struct or class to a group and this option is enabled, then also
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	347 # any nested class or struct is added to the same group. By default this option
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	348 # is disabled and one has to add nested compounds explicitly via \ingroup.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	349 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	350
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	351 GROUP_NESTED_COMPOUNDS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	352
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	353 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	354 # (for instance a group of public functions) to be put as a subgroup of that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	355 # type (e.g. under the Public Functions section). Set it to NO to prevent
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	356 # subgrouping. Alternatively, this can be done per class using the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	357 # \nosubgrouping command.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	358 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	359
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	360 SUBGROUPING = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	361
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	362 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	363 # are shown inside the group in which they are included (e.g. using \ingroup)
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	364 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	365 # and RTF).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	366 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	367 # Note that this feature does not work in combination with
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	368 # SEPARATE_MEMBER_PAGES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	369 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	370
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	371 INLINE_GROUPED_CLASSES = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	372
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	373 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	374 # with only public data fields or simple typedef fields will be shown inline in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	375 # the documentation of the scope in which they are defined (i.e. file,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	376 # namespace, or group documentation), provided this scope is documented. If set
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	377 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	378 # Man pages) or section (for LaTeX and RTF).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	379 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	380
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	381 INLINE_SIMPLE_STRUCTS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	382
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	383 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	384 # enum is documented as struct, union, or enum with the name of the typedef. So
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	385 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	386 # with name TypeT. When disabled the typedef will appear as a member of a file,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	387 # namespace, or class. And the struct will be named TypeS. This can typically be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	388 # useful for C code in case the coding convention dictates that all compound
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	389 # types are typedef'ed and only the typedef is referenced, never the tag name.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	390 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	391
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	392 TYPEDEF_HIDES_STRUCT = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	393
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	394 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	395 # cache is used to resolve symbols given their name and scope. Since this can be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	396 # an expensive process and often the same symbol appears multiple times in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	397 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	398 # doxygen will become slower. If the cache is too large, memory is wasted. The
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	399 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	400 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	401 # symbols. At the end of a run doxygen will report the cache usage and suggest
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	402 # the optimal cache size from a speed point of view.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	403 # Minimum value: 0, maximum value: 9, default value: 0.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	404
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	405 LOOKUP_CACHE_SIZE = 0
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	406
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	407 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	408 # Build related configuration options
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	409 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	410
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	411 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	412 # documentation are documented, even if no documentation was available. Private
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	413 # class members and static file members will be hidden unless the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	414 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	415 # Note: This will also disable the warnings about undocumented members that are
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	416 # normally produced when WARNINGS is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	417 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	418
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	419 EXTRACT_ALL = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	420
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	421 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	422 # be included in the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	423 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	424
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	425 EXTRACT_PRIVATE = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	426
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	427 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	428 # scope will be included in the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	429 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	430
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	431 EXTRACT_PACKAGE = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	432
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	433 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	434 # included in the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	435 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	436
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	437 EXTRACT_STATIC = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	438
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	439 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	440 # locally in source files will be included in the documentation. If set to NO,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	441 # only classes defined in header files are included. Does not have any effect
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	442 # for Java sources.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	443 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	444
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	445 EXTRACT_LOCAL_CLASSES = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	446
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	447 # This flag is only useful for Objective-C code. If set to YES, local methods,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	448 # which are defined in the implementation section but not in the interface are
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	449 # included in the documentation. If set to NO, only methods in the interface are
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	450 # included.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	451 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	452
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	453 EXTRACT_LOCAL_METHODS = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	454
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	455 # If this flag is set to YES, the members of anonymous namespaces will be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	456 # extracted and appear in the documentation as a namespace called
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	457 # 'anonymous_namespace{file}', where file will be replaced with the base name of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	458 # the file that contains the anonymous namespace. By default anonymous namespace
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	459 # are hidden.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	460 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	461
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	462 EXTRACT_ANON_NSPACES = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	463
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	464 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	465 # undocumented members inside documented classes or files. If set to NO these
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	466 # members will be included in the various overviews, but no documentation
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	467 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	468 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	469
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	470 HIDE_UNDOC_MEMBERS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	471
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	472 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	473 # undocumented classes that are normally visible in the class hierarchy. If set
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	474 # to NO, these classes will be included in the various overviews. This option
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	475 # has no effect if EXTRACT_ALL is enabled.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	476 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	477
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	478 HIDE_UNDOC_CLASSES = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	479
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	480 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	481 # (class\|struct\|union) declarations. If set to NO, these declarations will be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	482 # included in the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	483 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	484
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	485 HIDE_FRIEND_COMPOUNDS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	486
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	487 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	488 # documentation blocks found inside the body of a function. If set to NO, these
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	489 # blocks will be appended to the function's detailed documentation block.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	490 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	491
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	492 HIDE_IN_BODY_DOCS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	493
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	494 # The INTERNAL_DOCS tag determines if documentation that is typed after a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	495 # \internal command is included. If the tag is set to NO then the documentation
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	496 # will be excluded. Set it to YES to include the internal documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	497 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	498
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	499 INTERNAL_DOCS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	500
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	501 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	502 # names in lower-case letters. If set to YES, upper-case letters are also
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	503 # allowed. This is useful if you have classes or files whose names only differ
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	504 # in case and if your file system supports case sensitive file names. Windows
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	505 # and Mac users are advised to set this option to NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	506 # The default value is: system dependent.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	507
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	508 CASE_SENSE_NAMES = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	509
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	510 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	511 # their full class and namespace scopes in the documentation. If set to YES, the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	512 # scope will be hidden.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	513 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	514
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	515 HIDE_SCOPE_NAMES = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	516
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	517 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	518 # append additional text to a page's title, such as Class Reference. If set to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	519 # YES the compound reference will be hidden.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	520 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	521
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	522 HIDE_COMPOUND_REFERENCE= NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	523
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	524 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	525 # the files that are included by a file in the documentation of that file.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	526 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	527
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	528 SHOW_INCLUDE_FILES = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	529
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	530 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	531 # grouped member an include statement to the documentation, telling the reader
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	532 # which file to include in order to use the member.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	533 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	534
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	535 SHOW_GROUPED_MEMB_INC = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	536
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	537 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	538 # files with double quotes in the documentation rather than with sharp brackets.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	539 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	540
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	541 FORCE_LOCAL_INCLUDES = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	542
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	543 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	544 # documentation for inline members.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	545 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	546
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	547 INLINE_INFO = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	548
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	549 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	550 # (detailed) documentation of file and class members alphabetically by member
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	551 # name. If set to NO, the members will appear in declaration order.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	552 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	553
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	554 SORT_MEMBER_DOCS = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	555
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	556 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	557 # descriptions of file, namespace and class members alphabetically by member
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	558 # name. If set to NO, the members will appear in declaration order. Note that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	559 # this will also influence the order of the classes in the class list.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	560 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	561
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	562 SORT_BRIEF_DOCS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	563
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	564 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	565 # (brief and detailed) documentation of class members so that constructors and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	566 # destructors are listed first. If set to NO the constructors will appear in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	567 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	568 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	569 # member documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	570 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	571 # detailed member documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	572 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	573
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	574 SORT_MEMBERS_CTORS_1ST = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	575
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	576 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	577 # of group names into alphabetical order. If set to NO the group names will
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	578 # appear in their defined order.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	579 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	580
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	581 SORT_GROUP_NAMES = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	582
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	583 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	584 # fully-qualified names, including namespaces. If set to NO, the class list will
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	585 # be sorted only by class name, not including the namespace part.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	586 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	587 # Note: This option applies only to the class list, not to the alphabetical
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	588 # list.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	589 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	590
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	591 SORT_BY_SCOPE_NAME = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	592
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	593 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	594 # type resolution of all parameters of a function it will reject a match between
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	595 # the prototype and the implementation of a member function even if there is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	596 # only one candidate or it is obvious which candidate to choose by doing a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	597 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	598 # accept a match between prototype and implementation in such cases.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	599 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	600
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	601 STRICT_PROTO_MATCHING = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	602
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	603 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	604 # list. This list is created by putting \todo commands in the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	605 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	606
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	607 GENERATE_TODOLIST = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	608
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	609 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	610 # list. This list is created by putting \test commands in the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	611 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	612
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	613 GENERATE_TESTLIST = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	614
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	615 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	616 # list. This list is created by putting \bug commands in the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	617 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	618
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	619 GENERATE_BUGLIST = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	620
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	621 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	622 # the deprecated list. This list is created by putting \deprecated commands in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	623 # the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	624 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	625
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	626 GENERATE_DEPRECATEDLIST= YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	627
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	628 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	629 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	630 # ... \endcond blocks.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	631
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	632 ENABLED_SECTIONS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	633
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	634 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	635 # initial value of a variable or macro / define can have for it to appear in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	636 # documentation. If the initializer consists of more lines than specified here
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	637 # it will be hidden. Use a value of 0 to hide initializers completely. The
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	638 # appearance of the value of individual variables and macros / defines can be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	639 # controlled using \showinitializer or \hideinitializer command in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	640 # documentation regardless of this setting.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	641 # Minimum value: 0, maximum value: 10000, default value: 30.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	642
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	643 MAX_INITIALIZER_LINES = 30
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	644
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	645 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	646 # the bottom of the documentation of classes and structs. If set to YES, the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	647 # list will mention the files that were used to generate the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	648 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	649
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	650 SHOW_USED_FILES = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	651
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	652 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	653 # will remove the Files entry from the Quick Index and from the Folder Tree View
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	654 # (if specified).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	655 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	656
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	657 SHOW_FILES = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	658
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	659 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	660 # page. This will remove the Namespaces entry from the Quick Index and from the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	661 # Folder Tree View (if specified).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	662 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	663
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	664 SHOW_NAMESPACES = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	665
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	666 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	667 # doxygen should invoke to get the current version for each file (typically from
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	668 # the version control system). Doxygen will invoke the program by executing (via
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	669 # popen()) the command command input-file, where command is the value of the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	670 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	671 # by doxygen. Whatever the program writes to standard output is used as the file
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	672 # version. For an example see the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	673
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	674 FILE_VERSION_FILTER =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	675
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	676 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	677 # by doxygen. The layout file controls the global structure of the generated
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	678 # output files in an output format independent way. To create the layout file
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	679 # that represents doxygen's defaults, run doxygen with the -l option. You can
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	680 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	681 # will be used as the name of the layout file.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	682 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	683 # Note that if you run doxygen from a directory containing a file called
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	684 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	685 # tag is left empty.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	686
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	687 LAYOUT_FILE =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	688
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	689 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	690 # the reference definitions. This must be a list of .bib files. The .bib
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	691 # extension is automatically appended if omitted. This requires the bibtex tool
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	692 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	693 # For LaTeX the style of the bibliography can be controlled using
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	694 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	695 # search path. See also \cite for info how to create references.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	696
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	697 CITE_BIB_FILES =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	698
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	699 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	700 # Configuration options related to warning and progress messages
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	701 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	702
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	703 # The QUIET tag can be used to turn on/off the messages that are generated to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	704 # standard output by doxygen. If QUIET is set to YES this implies that the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	705 # messages are off.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	706 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	707
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	708 QUIET = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	709
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	710 # The WARNINGS tag can be used to turn on/off the warning messages that are
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	711 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	712 # this implies that the warnings are on.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	713 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	714 # Tip: Turn warnings on while writing the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	715 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	716
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	717 WARNINGS = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	718
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	719 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	720 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	721 # will automatically be disabled.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	722 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	723
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	724 WARN_IF_UNDOCUMENTED = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	725
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	726 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	727 # potential errors in the documentation, such as not documenting some parameters
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	728 # in a documented function, or documenting parameters that don't exist or using
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	729 # markup commands wrongly.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	730 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	731
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	732 WARN_IF_DOC_ERROR = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	733
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	734 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	735 # are documented, but have no documentation for their parameters or return
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	736 # value. If set to NO, doxygen will only warn about wrong or incomplete
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	737 # parameter documentation, but not about the absence of documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	738 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	739
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	740 WARN_NO_PARAMDOC = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	741
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	742 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	743 # a warning is encountered.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	744 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	745
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	746 WARN_AS_ERROR = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	747
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	748 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	749 # can produce. The string should contain the $file, $line, and $text tags, which
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	750 # will be replaced by the file and line number from which the warning originated
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	751 # and the warning text. Optionally the format may contain $version, which will
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	752 # be replaced by the version of the file (if it could be obtained via
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	753 # FILE_VERSION_FILTER)
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	754 # The default value is: $file:$line: $text.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	755
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	756 WARN_FORMAT = "$file:$line: $text"
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	757
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	758 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	759 # messages should be written. If left blank the output is written to standard
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	760 # error (stderr).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	761
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	762 WARN_LOGFILE =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	763
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	764 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	765 # Configuration options related to the input files
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	766 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	767
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	768 # The INPUT tag is used to specify the files and/or directories that contain
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	769 # documented source files. You may enter file names like myfile.cpp or
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	770 # directories like /usr/src/myproject. Separate the files or directories with
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	771 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	772 # Note: If this tag is empty the current directory is searched.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	773
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	774 INPUT = ../src/
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	775
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	776 # This tag can be used to specify the character encoding of the source files
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	777 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	778 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	779 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	780 # possible encodings.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	781 # The default value is: UTF-8.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	782
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	783 INPUT_ENCODING = UTF-8
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	784
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	785 # If the value of the INPUT tag contains directories, you can use the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	786 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	787 # *.h) to filter out the source-files in the directories.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	788 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	789 # Note that for custom extensions or not directly supported extensions you also
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	790 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	791 # read by doxygen.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	792 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	793 # If left blank the following patterns are tested:.c, .cc, .cxx, .cpp,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	794 # .c++, .java, .ii, .ixx, .ipp, .i++, .inl, .idl, .ddl, .odl, *.h,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	795 # .hh, .hxx, .hpp, .h++, .cs, .d, .php, .php4, .php5, .phtml, *.inc,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	796 # .m, .markdown, .md, .mm, .dox, .py, .pyw, .f90, .f, .for, *.tcl,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	797 # .vhd, .vhdl, .ucf, .qsf, .as and .js.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	798
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	799 FILE_PATTERNS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	800
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	801 # The RECURSIVE tag can be used to specify whether or not subdirectories should
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	802 # be searched for input files as well.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	803 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	804
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	805 RECURSIVE = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	806
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	807 # The EXCLUDE tag can be used to specify files and/or directories that should be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	808 # excluded from the INPUT source files. This way you can easily exclude a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	809 # subdirectory from a directory tree whose root is specified with the INPUT tag.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	810 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	811 # Note that relative paths are relative to the directory from which doxygen is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	812 # run.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	813
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	814 EXCLUDE =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	815
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	816 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	817 # directories that are symbolic links (a Unix file system feature) are excluded
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	818 # from the input.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	819 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	820
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	821 EXCLUDE_SYMLINKS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	822
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	823 # If the value of the INPUT tag contains directories, you can use the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	824 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	825 # certain files from those directories.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	826 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	827 # Note that the wildcards are matched against the file with absolute path, so to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	828 # exclude all test directories for example use the pattern /test/
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	829
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	830 EXCLUDE_PATTERNS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	831
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	832 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	833 # (namespaces, classes, functions, etc.) that should be excluded from the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	834 # output. The symbol name can be a fully qualified name, a word, or if the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	835 # wildcard * is used, a substring. Examples: ANamespace, AClass,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	836 # AClass::ANamespace, ANamespace::*Test
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	837 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	838 # Note that the wildcards are matched against the file with absolute path, so to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	839 # exclude all test directories use the pattern /test/
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	840
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	841 EXCLUDE_SYMBOLS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	842
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	843 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	844 # that contain example code fragments that are included (see the \include
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	845 # command).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	846
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	847 EXAMPLE_PATH =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	848
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	849 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	850 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	851 # *.h) to filter out the source-files in the directories. If left blank all
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	852 # files are included.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	853
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	854 EXAMPLE_PATTERNS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	855
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	856 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	857 # searched for input files to be used with the \include or \dontinclude commands
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	858 # irrespective of the value of the RECURSIVE tag.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	859 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	860
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	861 EXAMPLE_RECURSIVE = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	862
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	863 # The IMAGE_PATH tag can be used to specify one or more files or directories
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	864 # that contain images that are to be included in the documentation (see the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	865 # \image command).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	866
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	867 IMAGE_PATH =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	868
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	869 # The INPUT_FILTER tag can be used to specify a program that doxygen should
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	870 # invoke to filter for each input file. Doxygen will invoke the filter program
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	871 # by executing (via popen()) the command:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	872 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	873 # <filter> <input-file>
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	874 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	875 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	876 # name of an input file. Doxygen will then use the output that the filter
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	877 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	878 # will be ignored.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	879 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	880 # Note that the filter must not add or remove lines; it is applied before the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	881 # code is scanned, but not when the output code is generated. If lines are added
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	882 # or removed, the anchors will not be placed correctly.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	883 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	884 # Note that for custom extensions or not directly supported extensions you also
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	885 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	886 # properly processed by doxygen.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	887
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	888 INPUT_FILTER =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	889
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	890 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	891 # basis. Doxygen will compare the file name with each pattern and apply the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	892 # filter if there is a match. The filters are a list of the form: pattern=filter
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	893 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	894 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	895 # patterns match the file name, INPUT_FILTER is applied.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	896 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	897 # Note that for custom extensions or not directly supported extensions you also
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	898 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	899 # properly processed by doxygen.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	900
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	901 FILTER_PATTERNS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	902
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	903 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	904 # INPUT_FILTER) will also be used to filter the input files that are used for
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	905 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	906 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	907
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	908 FILTER_SOURCE_FILES = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	909
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	910 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	911 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	912 # it is also possible to disable source filtering for a specific pattern using
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	913 # *.ext= (so without naming a filter).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	914 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	915
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	916 FILTER_SOURCE_PATTERNS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	917
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	918 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	919 # is part of the input, its contents will be placed on the main page
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	920 # (index.html). This can be useful if you have a project on for instance GitHub
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	921 # and want to reuse the introduction page also for the doxygen output.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	922
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	923 USE_MDFILE_AS_MAINPAGE =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	924
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	925 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	926 # Configuration options related to source browsing
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	927 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	928
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	929 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	930 # generated. Documented entities will be cross-referenced with these sources.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	931 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	932 # Note: To get rid of all source code in the generated output, make sure that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	933 # also VERBATIM_HEADERS is set to NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	934 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	935
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	936 SOURCE_BROWSER = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	937
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	938 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	939 # classes and enums directly into the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	940 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	941
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	942 INLINE_SOURCES = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	943
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	944 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	945 # special comment blocks from generated source code fragments. Normal C, C++ and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	946 # Fortran comments will always remain visible.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	947 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	948
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	949 STRIP_CODE_COMMENTS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	950
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	951 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	952 # function all documented functions referencing it will be listed.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	953 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	954
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	955 REFERENCED_BY_RELATION = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	956
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	957 # If the REFERENCES_RELATION tag is set to YES then for each documented function
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	958 # all documented entities called/used by that function will be listed.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	959 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	960
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	961 REFERENCES_RELATION = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	962
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	963 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	964 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	965 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	966 # link to the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	967 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	968
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	969 REFERENCES_LINK_SOURCE = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	970
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	971 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	972 # source code will show a tooltip with additional information such as prototype,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	973 # brief description and links to the definition and documentation. Since this
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	974 # will make the HTML file larger and loading of large files a bit slower, you
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	975 # can opt to disable this feature.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	976 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	977 # This tag requires that the tag SOURCE_BROWSER is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	978
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	979 SOURCE_TOOLTIPS = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	980
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	981 # If the USE_HTAGS tag is set to YES then the references to source code will
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	982 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	983 # source browser. The htags tool is part of GNU's global source tagging system
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	984 # (see http://www.gnu.org/software/global/global.html). You will need version
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	985 # 4.8.6 or higher.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	986 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	987 # To use it do the following:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	988 # - Install the latest version of global
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	989 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	990 # - Make sure the INPUT points to the root of the source tree
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	991 # - Run doxygen as normal
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	992 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	993 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	994 # tools must be available from the command line (i.e. in the search path).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	995 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	996 # The result: instead of the source browser generated by doxygen, the links to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	997 # source code will now point to the output of htags.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	998 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	999 # This tag requires that the tag SOURCE_BROWSER is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1000
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1001 USE_HTAGS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1002
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1003 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1004 # verbatim copy of the header file for each class for which an include is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1005 # specified. Set to NO to disable this.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1006 # See also: Section \class.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1007 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1008
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1009 VERBATIM_HEADERS = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1010
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1011 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1012 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1013 # cost of reduced performance. This can be particularly helpful with template
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1014 # rich C++ code for which doxygen's built-in parser lacks the necessary type
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1015 # information.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1016 # Note: The availability of this option depends on whether or not doxygen was
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1017 # generated with the -Duse-libclang=ON option for CMake.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1018 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1019
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1020 CLANG_ASSISTED_PARSING = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1021
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1022 # If clang assisted parsing is enabled you can provide the compiler with command
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1023 # line options that you would normally use when invoking the compiler. Note that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1024 # the include paths will already be set by doxygen for the files and directories
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1025 # specified with INPUT and INCLUDE_PATH.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1026 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1027
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1028 CLANG_OPTIONS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1029
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1030 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1031 # Configuration options related to the alphabetical class index
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1032 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1033
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1034 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1035 # compounds will be generated. Enable this if the project contains a lot of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1036 # classes, structs, unions or interfaces.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1037 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1038
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1039 ALPHABETICAL_INDEX = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1040
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1041 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1042 # which the alphabetical index list will be split.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1043 # Minimum value: 1, maximum value: 20, default value: 5.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1044 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1045
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1046 COLS_IN_ALPHA_INDEX = 5
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1047
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1048 # In case all classes in a project start with a common prefix, all classes will
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1049 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1050 # can be used to specify a prefix (or a list of prefixes) that should be ignored
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1051 # while generating the index headers.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1052 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1053
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1054 IGNORE_PREFIX =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1055
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1056 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1057 # Configuration options related to the HTML output
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1058 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1059
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1060 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1061 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1062
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1063 GENERATE_HTML = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1064
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1065 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1066 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1067 # it.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1068 # The default directory is: html.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1069 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1070
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1071 HTML_OUTPUT = html
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1072
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1073 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1074 # generated HTML page (for example: .htm, .php, .asp).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1075 # The default value is: .html.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1076 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1077
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1078 HTML_FILE_EXTENSION = .html
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1079
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1080 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1081 # each generated HTML page. If the tag is left blank doxygen will generate a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1082 # standard header.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1083 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1084 # To get valid HTML the header file that includes any scripts and style sheets
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1085 # that doxygen needs, which is dependent on the configuration options used (e.g.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1086 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1087 # default header using
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1088 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1089 # YourConfigFile
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1090 # and then modify the file new_header.html. See also section "Doxygen usage"
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1091 # for information on how to generate the default header that doxygen normally
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1092 # uses.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1093 # Note: The header is subject to change so you typically have to regenerate the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1094 # default header when upgrading to a newer version of doxygen. For a description
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1095 # of the possible markers and block names see the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1096 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1097
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1098 HTML_HEADER =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1099
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1100 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1101 # generated HTML page. If the tag is left blank doxygen will generate a standard
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1102 # footer. See HTML_HEADER for more information on how to generate a default
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1103 # footer and what special commands can be used inside the footer. See also
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1104 # section "Doxygen usage" for information on how to generate the default footer
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1105 # that doxygen normally uses.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1106 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1107
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1108 HTML_FOOTER =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1109
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1110 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1111 # sheet that is used by each HTML page. It can be used to fine-tune the look of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1112 # the HTML output. If left blank doxygen will generate a default style sheet.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1113 # See also section "Doxygen usage" for information on how to generate the style
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1114 # sheet that doxygen normally uses.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1115 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1116 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1117 # obsolete.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1118 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1119
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1120 HTML_STYLESHEET =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1121
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1122 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1123 # cascading style sheets that are included after the standard style sheets
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1124 # created by doxygen. Using this option one can overrule certain style aspects.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1125 # This is preferred over using HTML_STYLESHEET since it does not replace the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1126 # standard style sheet and is therefore more robust against future updates.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1127 # Doxygen will copy the style sheet files to the output directory.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1128 # Note: The order of the extra style sheet files is of importance (e.g. the last
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1129 # style sheet in the list overrules the setting of the previous ones in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1130 # list). For an example see the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1131 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1132
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1133 HTML_EXTRA_STYLESHEET =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1134
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1135 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1136 # other source files which should be copied to the HTML output directory. Note
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1137 # that these files will be copied to the base HTML output directory. Use the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1138 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1139 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1140 # files will be copied as-is; there are no commands or markers available.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1141 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1142
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1143 HTML_EXTRA_FILES =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1144
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1145 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1146 # will adjust the colors in the style sheet and background images according to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1147 # this color. Hue is specified as an angle on a colorwheel, see
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1148 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1149 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1150 # purple, and 360 is red again.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1151 # Minimum value: 0, maximum value: 359, default value: 220.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1152 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1153
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1154 HTML_COLORSTYLE_HUE = 220
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1155
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1156 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1157 # in the HTML output. For a value of 0 the output will use grayscales only. A
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1158 # value of 255 will produce the most vivid colors.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1159 # Minimum value: 0, maximum value: 255, default value: 100.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1160 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1161
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1162 HTML_COLORSTYLE_SAT = 100
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1163
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1164 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1165 # luminance component of the colors in the HTML output. Values below 100
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1166 # gradually make the output lighter, whereas values above 100 make the output
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1167 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1168 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1169 # change the gamma.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1170 # Minimum value: 40, maximum value: 240, default value: 80.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1171 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1172
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1173 HTML_COLORSTYLE_GAMMA = 80
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1174
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1175 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1176 # page will contain the date and time when the page was generated. Setting this
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1177 # to YES can help to show when doxygen was last run and thus if the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1178 # documentation is up to date.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1179 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1180 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1181
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1182 HTML_TIMESTAMP = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1183
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1184 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1185 # documentation will contain sections that can be hidden and shown after the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1186 # page has loaded.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1187 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1188 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1189
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1190 HTML_DYNAMIC_SECTIONS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1191
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1192 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1193 # shown in the various tree structured indices initially; the user can expand
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1194 # and collapse entries dynamically later on. Doxygen will expand the tree to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1195 # such a level that at most the specified number of entries are visible (unless
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1196 # a fully collapsed tree already exceeds this amount). So setting the number of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1197 # entries 1 will produce a full collapsed tree by default. 0 is a special value
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1198 # representing an infinite number of entries and will result in a full expanded
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1199 # tree by default.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1200 # Minimum value: 0, maximum value: 9999, default value: 100.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1201 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1202
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1203 HTML_INDEX_NUM_ENTRIES = 100
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1204
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1205 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1206 # generated that can be used as input for Apple's Xcode 3 integrated development
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1207 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1208 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1209 # Makefile in the HTML output directory. Running make will produce the docset in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1210 # that directory and running make install will install the docset in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1211 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1212 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1213 # for more information.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1214 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1215 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1216
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1217 GENERATE_DOCSET = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1218
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1219 # This tag determines the name of the docset feed. A documentation feed provides
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1220 # an umbrella under which multiple documentation sets from a single provider
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1221 # (such as a company or product suite) can be grouped.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1222 # The default value is: Doxygen generated docs.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1223 # This tag requires that the tag GENERATE_DOCSET is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1224
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1225 DOCSET_FEEDNAME = "Doxygen generated docs"
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1226
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1227 # This tag specifies a string that should uniquely identify the documentation
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1228 # set bundle. This should be a reverse domain-name style string, e.g.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1229 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1230 # The default value is: org.doxygen.Project.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1231 # This tag requires that the tag GENERATE_DOCSET is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1232
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1233 DOCSET_BUNDLE_ID = org.doxygen.Project
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1234
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1235 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1236 # the documentation publisher. This should be a reverse domain-name style
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1237 # string, e.g. com.mycompany.MyDocSet.documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1238 # The default value is: org.doxygen.Publisher.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1239 # This tag requires that the tag GENERATE_DOCSET is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1240
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1241 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1242
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1243 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1244 # The default value is: Publisher.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1245 # This tag requires that the tag GENERATE_DOCSET is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1246
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1247 DOCSET_PUBLISHER_NAME = Publisher
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1248
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1249 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1250 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1251 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1252 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1253 # Windows.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1254 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1255 # The HTML Help Workshop contains a compiler that can convert all HTML output
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1256 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1257 # files are now used as the Windows 98 help format, and will replace the old
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1258 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1259 # HTML files also contain an index, a table of contents, and you can search for
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1260 # words in the documentation. The HTML workshop also contains a viewer for
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1261 # compressed HTML files.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1262 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1263 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1264
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1265 GENERATE_HTMLHELP = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1266
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1267 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1268 # file. You can add a path in front of the file if the result should not be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1269 # written to the html output directory.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1270 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1271
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1272 CHM_FILE =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1273
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1274 # The HHC_LOCATION tag can be used to specify the location (absolute path
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1275 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1276 # doxygen will try to run the HTML help compiler on the generated index.hhp.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1277 # The file has to be specified with full path.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1278 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1279
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1280 HHC_LOCATION =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1281
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1282 # The GENERATE_CHI flag controls if a separate .chi index file is generated
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1283 # (YES) or that it should be included in the master .chm file (NO).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1284 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1285 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1286
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1287 GENERATE_CHI = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1288
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1289 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1290 # and project file content.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1291 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1292
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1293 CHM_INDEX_ENCODING =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1294
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1295 # The BINARY_TOC flag controls whether a binary table of contents is generated
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1296 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1297 # enables the Previous and Next buttons.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1298 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1299 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1300
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1301 BINARY_TOC = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1302
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1303 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1304 # the table of contents of the HTML help documentation and to the tree view.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1305 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1306 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1307
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1308 TOC_EXPAND = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1309
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1310 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1311 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1312 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1313 # (.qch) of the generated HTML documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1314 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1315 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1316
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1317 GENERATE_QHP = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1318
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1319 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1320 # the file name of the resulting .qch file. The path specified is relative to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1321 # the HTML output folder.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1322 # This tag requires that the tag GENERATE_QHP is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1323
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1324 QCH_FILE =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1325
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1326 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1327 # Project output. For more information please see Qt Help Project / Namespace
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1328 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1329 # The default value is: org.doxygen.Project.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1330 # This tag requires that the tag GENERATE_QHP is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1331
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1332 QHP_NAMESPACE = org.doxygen.Project
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1333
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1334 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1335 # Help Project output. For more information please see Qt Help Project / Virtual
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1336 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1337 # folders).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1338 # The default value is: doc.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1339 # This tag requires that the tag GENERATE_QHP is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1340
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1341 QHP_VIRTUAL_FOLDER = doc
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1342
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1343 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1344 # filter to add. For more information please see Qt Help Project / Custom
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1345 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1346 # filters).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1347 # This tag requires that the tag GENERATE_QHP is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1348
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1349 QHP_CUST_FILTER_NAME =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1350
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1351 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1352 # custom filter to add. For more information please see Qt Help Project / Custom
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1353 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1354 # filters).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1355 # This tag requires that the tag GENERATE_QHP is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1356
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1357 QHP_CUST_FILTER_ATTRS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1358
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1359 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1360 # project's filter section matches. Qt Help Project / Filter Attributes (see:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1361 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1362 # This tag requires that the tag GENERATE_QHP is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1363
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1364 QHP_SECT_FILTER_ATTRS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1365
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1366 # The QHG_LOCATION tag can be used to specify the location of Qt's
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1367 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1368 # generated .qhp file.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1369 # This tag requires that the tag GENERATE_QHP is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1370
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1371 QHG_LOCATION =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1372
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1373 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1374 # generated, together with the HTML files, they form an Eclipse help plugin. To
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1375 # install this plugin and make it available under the help contents menu in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1376 # Eclipse, the contents of the directory containing the HTML and XML files needs
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1377 # to be copied into the plugins directory of eclipse. The name of the directory
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1378 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1379 # After copying Eclipse needs to be restarted before the help appears.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1380 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1381 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1382
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1383 GENERATE_ECLIPSEHELP = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1384
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1385 # A unique identifier for the Eclipse help plugin. When installing the plugin
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1386 # the directory name containing the HTML and XML files should also have this
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1387 # name. Each documentation set should have its own identifier.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1388 # The default value is: org.doxygen.Project.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1389 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1390
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1391 ECLIPSE_DOC_ID = org.doxygen.Project
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1392
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1393 # If you want full control over the layout of the generated HTML pages it might
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1394 # be necessary to disable the index and replace it with your own. The
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1395 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1396 # of each HTML page. A value of NO enables the index and the value YES disables
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1397 # it. Since the tabs in the index contain the same information as the navigation
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1398 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1399 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1400 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1401
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1402 DISABLE_INDEX = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1403
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1404 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1405 # structure should be generated to display hierarchical information. If the tag
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1406 # value is set to YES, a side panel will be generated containing a tree-like
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1407 # index structure (just like the one that is generated for HTML Help). For this
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1408 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1409 # (i.e. any modern browser). Windows users are probably better off using the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1410 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1411 # further fine-tune the look of the index. As an example, the default style
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1412 # sheet generated by doxygen has an example that shows how to put an image at
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1413 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1414 # the same information as the tab index, you could consider setting
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1415 # DISABLE_INDEX to YES when enabling this option.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1416 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1417 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1418
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1419 GENERATE_TREEVIEW = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1420
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1421 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1422 # doxygen will group on one line in the generated HTML documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1423 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1424 # Note that a value of 0 will completely suppress the enum values from appearing
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1425 # in the overview section.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1426 # Minimum value: 0, maximum value: 20, default value: 4.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1427 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1428
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1429 ENUM_VALUES_PER_LINE = 1
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1430
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1431 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1432 # to set the initial width (in pixels) of the frame in which the tree is shown.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1433 # Minimum value: 0, maximum value: 1500, default value: 250.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1434 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1435
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1436 TREEVIEW_WIDTH = 250
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1437
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1438 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1439 # external symbols imported via tag files in a separate window.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1440 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1441 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1442
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1443 EXT_LINKS_IN_WINDOW = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1444
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1445 # Use this tag to change the font size of LaTeX formulas included as images in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1446 # the HTML documentation. When you change the font size after a successful
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1447 # doxygen run you need to manually remove any form_*.png images from the HTML
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1448 # output directory to force them to be regenerated.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1449 # Minimum value: 8, maximum value: 50, default value: 10.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1450 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1451
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1452 FORMULA_FONTSIZE = 10
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1453
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1454 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1455 # generated for formulas are transparent PNGs. Transparent PNGs are not
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1456 # supported properly for IE 6.0, but are supported on all modern browsers.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1457 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1458 # Note that when changing this option you need to delete any form_*.png files in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1459 # the HTML output directory before the changes have effect.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1460 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1461 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1462
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1463 FORMULA_TRANSPARENT = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1464
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1465 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1466 # http://www.mathjax.org) which uses client side Javascript for the rendering
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1467 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1468 # installed or if you want to formulas look prettier in the HTML output. When
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1469 # enabled you may also need to install MathJax separately and configure the path
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1470 # to it using the MATHJAX_RELPATH option.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1471 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1472 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1473
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1474 USE_MATHJAX = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1475
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1476 # When MathJax is enabled you can set the default output format to be used for
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1477 # the MathJax output. See the MathJax site (see:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1478 # http://docs.mathjax.org/en/latest/output.html) for more details.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1479 # Possible values are: HTML-CSS (which is slower, but has the best
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1480 # compatibility), NativeMML (i.e. MathML) and SVG.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1481 # The default value is: HTML-CSS.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1482 # This tag requires that the tag USE_MATHJAX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1483
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1484 MATHJAX_FORMAT = HTML-CSS
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1485
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1486 # When MathJax is enabled you need to specify the location relative to the HTML
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1487 # output directory using the MATHJAX_RELPATH option. The destination directory
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1488 # should contain the MathJax.js script. For instance, if the mathjax directory
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1489 # is located at the same level as the HTML output directory, then
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1490 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1491 # Content Delivery Network so you can quickly see the result without installing
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1492 # MathJax. However, it is strongly recommended to install a local copy of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1493 # MathJax from http://www.mathjax.org before deployment.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1494 # The default value is: http://cdn.mathjax.org/mathjax/latest.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1495 # This tag requires that the tag USE_MATHJAX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1496
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1497 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1498
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1499 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1500 # extension names that should be enabled during MathJax rendering. For example
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1501 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1502 # This tag requires that the tag USE_MATHJAX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1503
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1504 MATHJAX_EXTENSIONS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1505
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1506 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1507 # of code that will be used on startup of the MathJax code. See the MathJax site
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1508 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1509 # example see the documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1510 # This tag requires that the tag USE_MATHJAX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1511
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1512 MATHJAX_CODEFILE =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1513
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1514 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1515 # the HTML output. The underlying search engine uses javascript and DHTML and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1516 # should work on any modern browser. Note that when using HTML help
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1517 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1518 # there is already a search function so this one should typically be disabled.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1519 # For large projects the javascript based search engine can be slow, then
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1520 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1521 # search using the keyboard; to jump to the search box use <access key> + S
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1522 # (what the <access key> is depends on the OS and browser, but it is typically
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1523 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1524 # key> to jump into the search results window, the results can be navigated
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1525 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1526 # the search. The filter options can be selected when the cursor is inside the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1527 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1528 # to select a filter and <Enter> or <escape> to activate or cancel the filter
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1529 # option.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1530 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1531 # This tag requires that the tag GENERATE_HTML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1532
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1533 SEARCHENGINE = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1534
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1535 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1536 # implemented using a web server instead of a web client using Javascript. There
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1537 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1538 # setting. When disabled, doxygen will generate a PHP script for searching and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1539 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1540 # and searching needs to be provided by external tools. See the section
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1541 # "External Indexing and Searching" for details.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1542 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1543 # This tag requires that the tag SEARCHENGINE is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1544
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1545 SERVER_BASED_SEARCH = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1546
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1547 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1548 # script for searching. Instead the search results are written to an XML file
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1549 # which needs to be processed by an external indexer. Doxygen will invoke an
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1550 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1551 # search results.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1552 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1553 # Doxygen ships with an example indexer (doxyindexer) and search engine
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1554 # (doxysearch.cgi) which are based on the open source search engine library
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1555 # Xapian (see: http://xapian.org/).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1556 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1557 # See the section "External Indexing and Searching" for details.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1558 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1559 # This tag requires that the tag SEARCHENGINE is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1560
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1561 EXTERNAL_SEARCH = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1562
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1563 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1564 # which will return the search results when EXTERNAL_SEARCH is enabled.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1565 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1566 # Doxygen ships with an example indexer (doxyindexer) and search engine
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1567 # (doxysearch.cgi) which are based on the open source search engine library
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1568 # Xapian (see: http://xapian.org/). See the section "External Indexing and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1569 # Searching" for details.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1570 # This tag requires that the tag SEARCHENGINE is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1571
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1572 SEARCHENGINE_URL =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1573
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1574 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1575 # search data is written to a file for indexing by an external tool. With the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1576 # SEARCHDATA_FILE tag the name of this file can be specified.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1577 # The default file is: searchdata.xml.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1578 # This tag requires that the tag SEARCHENGINE is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1579
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1580 SEARCHDATA_FILE = searchdata.xml
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1581
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1582 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1583 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1584 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1585 # projects and redirect the results back to the right project.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1586 # This tag requires that the tag SEARCHENGINE is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1587
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1588 EXTERNAL_SEARCH_ID =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1589
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1590 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1591 # projects other than the one defined by this configuration file, but that are
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1592 # all added to the same external search index. Each project needs to have a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1593 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1594 # to a relative location where the documentation can be found. The format is:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1595 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1596 # This tag requires that the tag SEARCHENGINE is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1597
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1598 EXTRA_SEARCH_MAPPINGS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1599
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1600 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1601 # Configuration options related to the LaTeX output
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1602 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1603
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1604 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1605 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1606
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1607 GENERATE_LATEX = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1608
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1609 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1610 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1611 # it.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1612 # The default directory is: latex.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1613 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1614
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1615 LATEX_OUTPUT = latex
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1616
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1617 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1618 # invoked.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1619 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1620 # Note that when enabling USE_PDFLATEX this option is only used for generating
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1621 # bitmaps for formulas in the HTML output, but not in the Makefile that is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1622 # written to the output directory.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1623 # The default file is: latex.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1624 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1625
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1626 LATEX_CMD_NAME = latex
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1627
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1628 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1629 # index for LaTeX.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1630 # The default file is: makeindex.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1631 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1632
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1633 MAKEINDEX_CMD_NAME = makeindex
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1634
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1635 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1636 # documents. This may be useful for small projects and may help to save some
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1637 # trees in general.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1638 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1639 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1640
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1641 COMPACT_LATEX = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1642
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1643 # The PAPER_TYPE tag can be used to set the paper type that is used by the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1644 # printer.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1645 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1646 # 14 inches) and executive (7.25 x 10.5 inches).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1647 # The default value is: a4.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1648 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1649
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1650 PAPER_TYPE = a4wide
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1651
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1652 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1653 # that should be included in the LaTeX output. The package can be specified just
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1654 # by its name or with the correct syntax as to be used with the LaTeX
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1655 # \usepackage command. To get the times font for instance you can specify :
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1656 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1657 # To use the option intlimits with the amsmath package you can specify:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1658 # EXTRA_PACKAGES=[intlimits]{amsmath}
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1659 # If left blank no extra packages will be included.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1660 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1661
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1662 EXTRA_PACKAGES =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1663
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1664 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1665 # generated LaTeX document. The header should contain everything until the first
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1666 # chapter. If it is left blank doxygen will generate a standard header. See
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1667 # section "Doxygen usage" for information on how to let doxygen write the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1668 # default header to a separate file.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1669 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1670 # Note: Only use a user-defined header if you know what you are doing! The
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1671 # following commands have a special meaning inside the header: $title,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1672 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1673 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1674 # string, for the replacement values of the other commands the user is referred
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1675 # to HTML_HEADER.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1676 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1677
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1678 LATEX_HEADER =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1679
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1680 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1681 # generated LaTeX document. The footer should contain everything after the last
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1682 # chapter. If it is left blank doxygen will generate a standard footer. See
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1683 # LATEX_HEADER for more information on how to generate a default footer and what
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1684 # special commands can be used inside the footer.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1685 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1686 # Note: Only use a user-defined footer if you know what you are doing!
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1687 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1688
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1689 LATEX_FOOTER =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1690
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1691 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1692 # LaTeX style sheets that are included after the standard style sheets created
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1693 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1694 # will copy the style sheet files to the output directory.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1695 # Note: The order of the extra style sheet files is of importance (e.g. the last
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1696 # style sheet in the list overrules the setting of the previous ones in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1697 # list).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1698 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1699
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1700 LATEX_EXTRA_STYLESHEET =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1701
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1702 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1703 # other source files which should be copied to the LATEX_OUTPUT output
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1704 # directory. Note that the files will be copied as-is; there are no commands or
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1705 # markers available.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1706 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1707
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1708 LATEX_EXTRA_FILES =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1709
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1710 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1711 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1712 # contain links (just like the HTML output) instead of page references. This
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1713 # makes the output suitable for online browsing using a PDF viewer.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1714 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1715 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1716
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1717 PDF_HYPERLINKS = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1718
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1719 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1720 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1721 # higher quality PDF documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1722 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1723 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1724
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1725 USE_PDFLATEX = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1726
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1727 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1728 # command to the generated LaTeX files. This will instruct LaTeX to keep running
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1729 # if errors occur, instead of asking the user for help. This option is also used
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1730 # when generating formulas in HTML.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1731 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1732 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1733
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1734 LATEX_BATCHMODE = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1735
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1736 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1737 # index chapters (such as File Index, Compound Index, etc.) in the output.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1738 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1739 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1740
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1741 LATEX_HIDE_INDICES = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1742
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1743 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1744 # code with syntax highlighting in the LaTeX output.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1745 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1746 # Note that which sources are shown also depends on other settings such as
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1747 # SOURCE_BROWSER.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1748 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1749 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1750
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1751 LATEX_SOURCE_CODE = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1752
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1753 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1754 # bibliography, e.g. plainnat, or ieeetr. See
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1755 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1756 # The default value is: plain.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1757 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1758
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1759 LATEX_BIB_STYLE = plain
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1760
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1761 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1762 # page will contain the date and time when the page was generated. Setting this
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1763 # to NO can help when comparing the output of multiple runs.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1764 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1765 # This tag requires that the tag GENERATE_LATEX is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1766
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1767 LATEX_TIMESTAMP = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1768
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1769 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1770 # Configuration options related to the RTF output
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1771 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1772
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1773 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1774 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1775 # readers/editors.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1776 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1777
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1778 GENERATE_RTF = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1779
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1780 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1781 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1782 # it.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1783 # The default directory is: rtf.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1784 # This tag requires that the tag GENERATE_RTF is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1785
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1786 RTF_OUTPUT = rtf
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1787
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1788 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1789 # documents. This may be useful for small projects and may help to save some
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1790 # trees in general.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1791 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1792 # This tag requires that the tag GENERATE_RTF is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1793
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1794 COMPACT_RTF = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1795
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1796 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1797 # contain hyperlink fields. The RTF file will contain links (just like the HTML
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1798 # output) instead of page references. This makes the output suitable for online
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1799 # browsing using Word or some other Word compatible readers that support those
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1800 # fields.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1801 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1802 # Note: WordPad (write) and others do not support links.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1803 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1804 # This tag requires that the tag GENERATE_RTF is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1805
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1806 RTF_HYPERLINKS = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1807
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1808 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1809 # file, i.e. a series of assignments. You only have to provide replacements,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1810 # missing definitions are set to their default value.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1811 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1812 # See also section "Doxygen usage" for information on how to generate the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1813 # default style sheet that doxygen normally uses.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1814 # This tag requires that the tag GENERATE_RTF is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1815
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1816 RTF_STYLESHEET_FILE =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1817
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1818 # Set optional variables used in the generation of an RTF document. Syntax is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1819 # similar to doxygen's config file. A template extensions file can be generated
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1820 # using doxygen -e rtf extensionFile.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1821 # This tag requires that the tag GENERATE_RTF is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1822
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1823 RTF_EXTENSIONS_FILE =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1824
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1825 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1826 # with syntax highlighting in the RTF output.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1827 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1828 # Note that which sources are shown also depends on other settings such as
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1829 # SOURCE_BROWSER.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1830 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1831 # This tag requires that the tag GENERATE_RTF is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1832
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1833 RTF_SOURCE_CODE = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1834
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1835 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1836 # Configuration options related to the man page output
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1837 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1838
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1839 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1840 # classes and files.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1841 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1842
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1843 GENERATE_MAN = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1844
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1845 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1846 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1847 # it. A directory man3 will be created inside the directory specified by
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1848 # MAN_OUTPUT.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1849 # The default directory is: man.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1850 # This tag requires that the tag GENERATE_MAN is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1851
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1852 MAN_OUTPUT = man
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1853
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1854 # The MAN_EXTENSION tag determines the extension that is added to the generated
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1855 # man pages. In case the manual section does not start with a number, the number
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1856 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1857 # optional.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1858 # The default value is: .3.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1859 # This tag requires that the tag GENERATE_MAN is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1860
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1861 MAN_EXTENSION = .3
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1862
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1863 # The MAN_SUBDIR tag determines the name of the directory created within
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1864 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1865 # MAN_EXTENSION with the initial . removed.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1866 # This tag requires that the tag GENERATE_MAN is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1867
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1868 MAN_SUBDIR =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1869
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1870 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1871 # will generate one additional man file for each entity documented in the real
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1872 # man page(s). These additional files only source the real man page, but without
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1873 # them the man command would be unable to find the correct page.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1874 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1875 # This tag requires that the tag GENERATE_MAN is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1876
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1877 MAN_LINKS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1878
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1879 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1880 # Configuration options related to the XML output
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1881 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1882
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1883 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1884 # captures the structure of the code including all documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1885 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1886
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1887 GENERATE_XML = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1888
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1889 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1890 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1891 # it.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1892 # The default directory is: xml.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1893 # This tag requires that the tag GENERATE_XML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1894
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1895 XML_OUTPUT = xml
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1896
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1897 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1898 # listings (including syntax highlighting and cross-referencing information) to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1899 # the XML output. Note that enabling this will significantly increase the size
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1900 # of the XML output.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1901 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1902 # This tag requires that the tag GENERATE_XML is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1903
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1904 XML_PROGRAMLISTING = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1905
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1906 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1907 # Configuration options related to the DOCBOOK output
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1908 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1909
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1910 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1911 # that can be used to generate PDF.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1912 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1913
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1914 GENERATE_DOCBOOK = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1915
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1916 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1917 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1918 # front of it.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1919 # The default directory is: docbook.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1920 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1921
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1922 DOCBOOK_OUTPUT = docbook
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1923
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1924 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1925 # program listings (including syntax highlighting and cross-referencing
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1926 # information) to the DOCBOOK output. Note that enabling this will significantly
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1927 # increase the size of the DOCBOOK output.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1928 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1929 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1930
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1931 DOCBOOK_PROGRAMLISTING = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1932
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1933 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1934 # Configuration options for the AutoGen Definitions output
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1935 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1936
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1937 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1938 # AutoGen Definitions (see http://autogen.sf.net) file that captures the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1939 # structure of the code including all documentation. Note that this feature is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1940 # still experimental and incomplete at the moment.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1941 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1942
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1943 GENERATE_AUTOGEN_DEF = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1944
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1945 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1946 # Configuration options related to the Perl module output
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1947 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1948
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1949 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1950 # file that captures the structure of the code including all documentation.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1951 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1952 # Note that this feature is still experimental and incomplete at the moment.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1953 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1954
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1955 GENERATE_PERLMOD = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1956
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1957 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1958 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1959 # output from the Perl module output.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1960 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1961 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1962
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1963 PERLMOD_LATEX = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1964
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1965 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1966 # formatted so it can be parsed by a human reader. This is useful if you want to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1967 # understand what is going on. On the other hand, if this tag is set to NO, the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1968 # size of the Perl module output will be much smaller and Perl will parse it
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1969 # just the same.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1970 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1971 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1972
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1973 PERLMOD_PRETTY = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1974
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1975 # The names of the make variables in the generated doxyrules.make file are
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1976 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1977 # so different doxyrules.make files included by the same Makefile don't
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1978 # overwrite each other's variables.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1979 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1980
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1981 PERLMOD_MAKEVAR_PREFIX =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1982
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1983 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1984 # Configuration options related to the preprocessor
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1985 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1986
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1987 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1988 # C-preprocessor directives found in the sources and include files.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1989 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1990
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1991 ENABLE_PREPROCESSING = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1992
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1993 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1994 # in the source code. If set to NO, only conditional compilation will be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1995 # performed. Macro expansion can be done in a controlled way by setting
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1996 # EXPAND_ONLY_PREDEF to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1997 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1998 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1999
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2000 MACRO_EXPANSION = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2001
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2002 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2003 # the macro expansion is limited to the macros specified with the PREDEFINED and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2004 # EXPAND_AS_DEFINED tags.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2005 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2006 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2007
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2008 EXPAND_ONLY_PREDEF = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2009
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2010 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2011 # INCLUDE_PATH will be searched if a #include is found.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2012 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2013 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2014
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2015 SEARCH_INCLUDES = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2016
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2017 # The INCLUDE_PATH tag can be used to specify one or more directories that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2018 # contain include files that are not input files but should be processed by the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2019 # preprocessor.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2020 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2021
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2022 INCLUDE_PATH = ../src/headers
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2023
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2024 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2025 # patterns (like .h and .hpp) to filter out the header-files in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2026 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2027 # used.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2028 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2029
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2030 INCLUDE_FILE_PATTERNS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2031
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2032 # The PREDEFINED tag can be used to specify one or more macro names that are
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2033 # defined before the preprocessor is started (similar to the -D option of e.g.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2034 # gcc). The argument of the tag is a list of macros of the form: name or
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2035 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2036 # is assumed. To prevent a macro definition from being undefined via #undef or
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2037 # recursively expanded use the := operator instead of the = operator.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2038 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2039
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2040 PREDEFINED = LTC_SOURCE \
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2041 LTM_DESC \
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2042 GMP_DESC \
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2043 TFM_DESC
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2044
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2045 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2046 # tag can be used to specify a list of macro names that should be expanded. The
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2047 # macro definition that is found in the sources will be used. Use the PREDEFINED
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2048 # tag if you want to use a different macro definition that overrules the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2049 # definition found in the source code.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2050 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2051
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2052 EXPAND_AS_DEFINED =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2053
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2054 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2055 # remove all references to function-like macros that are alone on a line, have
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2056 # an all uppercase name, and do not end with a semicolon. Such function macros
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2057 # are typically used for boiler-plate code, and will confuse the parser if not
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2058 # removed.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2059 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2060 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2061
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2062 SKIP_FUNCTION_MACROS = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2063
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2064 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2065 # Configuration options related to external references
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2066 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2067
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2068 # The TAGFILES tag can be used to specify one or more tag files. For each tag
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2069 # file the location of the external documentation should be added. The format of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2070 # a tag file without this location is as follows:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2071 # TAGFILES = file1 file2 ...
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2072 # Adding location for the tag files is done as follows:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2073 # TAGFILES = file1=loc1 "file2 = loc2" ...
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2074 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2075 # section "Linking to external documentation" for more information about the use
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2076 # of tag files.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2077 # Note: Each tag file must have a unique name (where the name does NOT include
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2078 # the path). If a tag file is not located in the directory in which doxygen is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2079 # run, you must also specify the path to the tagfile here.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2080
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2081 TAGFILES =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2082
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2083 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2084 # tag file that is based on the input files it reads. See section "Linking to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2085 # external documentation" for more information about the usage of tag files.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2086
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2087 GENERATE_TAGFILE =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2088
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2089 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2090 # the class index. If set to NO, only the inherited external classes will be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2091 # listed.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2092 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2093
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2094 ALLEXTERNALS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2095
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2096 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2097 # in the modules index. If set to NO, only the current project's groups will be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2098 # listed.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2099 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2100
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2101 EXTERNAL_GROUPS = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2102
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2103 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2104 # the related pages index. If set to NO, only the current project's pages will
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2105 # be listed.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2106 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2107
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2108 EXTERNAL_PAGES = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2109
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2110 # The PERL_PATH should be the absolute path and name of the perl script
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2111 # interpreter (i.e. the result of 'which perl').
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2112 # The default file (with absolute path) is: /usr/bin/perl.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2113
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2114 PERL_PATH = /usr/bin/perl
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2115
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2116 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2117 # Configuration options related to the dot tool
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2118 #---------------------------------------------------------------------------
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2119
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2120 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2121 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2122 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2123 # disabled, but it is recommended to install and use dot, since it yields more
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2124 # powerful graphs.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2125 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2126
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2127 CLASS_DIAGRAMS = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2128
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2129 # You can define message sequence charts within doxygen comments using the \msc
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2130 # command. Doxygen will then run the mscgen tool (see:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2131 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2132 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2133 # the mscgen tool resides. If left empty the tool is assumed to be found in the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2134 # default search path.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2135
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2136 MSCGEN_PATH =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2137
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2138 # You can include diagrams made with dia in doxygen documentation. Doxygen will
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2139 # then run dia to produce the diagram and insert it in the documentation. The
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2140 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2141 # If left empty dia is assumed to be found in the default search path.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2142
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2143 DIA_PATH =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2144
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2145 # If set to YES the inheritance and collaboration graphs will hide inheritance
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2146 # and usage relations if the target is undocumented or is not a class.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2147 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2148
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2149 HIDE_UNDOC_RELATIONS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2150
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2151 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2152 # available from the path. This tool is part of Graphviz (see:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2153 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2154 # Bell Labs. The other options in this section have no effect if this option is
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2155 # set to NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2156 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2157
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2158 HAVE_DOT = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2159
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2160 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2161 # to run in parallel. When set to 0 doxygen will base this on the number of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2162 # processors available in the system. You can set it explicitly to a value
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2163 # larger than 0 to get control over the balance between CPU load and processing
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2164 # speed.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2165 # Minimum value: 0, maximum value: 32, default value: 0.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2166 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2167
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2168 DOT_NUM_THREADS = 0
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2169
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2170 # When you want a differently looking font in the dot files that doxygen
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2171 # generates you can specify the font name using DOT_FONTNAME. You need to make
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2172 # sure dot is able to find the font, which can be done by putting it in a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2173 # standard location or by setting the DOTFONTPATH environment variable or by
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2174 # setting DOT_FONTPATH to the directory containing the font.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2175 # The default value is: Helvetica.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2176 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2177
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2178 DOT_FONTNAME = Helvetica
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2179
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2180 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2181 # dot graphs.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2182 # Minimum value: 4, maximum value: 24, default value: 10.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2183 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2184
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2185 DOT_FONTSIZE = 10
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2186
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2187 # By default doxygen will tell dot to use the default font as specified with
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2188 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2189 # the path where dot can find it using this tag.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2190 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2191
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2192 DOT_FONTPATH =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2193
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2194 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2195 # each documented class showing the direct and indirect inheritance relations.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2196 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2197 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2198 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2199
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2200 CLASS_GRAPH = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2201
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2202 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2203 # graph for each documented class showing the direct and indirect implementation
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2204 # dependencies (inheritance, containment, and class references variables) of the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2205 # class with other documented classes.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2206 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2207 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2208
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2209 COLLABORATION_GRAPH = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2210
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2211 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2212 # groups, showing the direct groups dependencies.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2213 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2214 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2215
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2216 GROUP_GRAPHS = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2217
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2218 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2219 # collaboration diagrams in a style similar to the OMG's Unified Modeling
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2220 # Language.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2221 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2222 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2223
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2224 UML_LOOK = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2225
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2226 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2227 # class node. If there are many fields or methods and many nodes the graph may
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2228 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2229 # number of items for each type to make the size more manageable. Set this to 0
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2230 # for no limit. Note that the threshold may be exceeded by 50% before the limit
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2231 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2232 # but if the number exceeds 15, the total amount of fields shown is limited to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2233 # 10.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2234 # Minimum value: 0, maximum value: 100, default value: 10.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2235 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2236
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2237 UML_LIMIT_NUM_FIELDS = 10
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2238
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2239 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2240 # collaboration graphs will show the relations between templates and their
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2241 # instances.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2242 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2243 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2244
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2245 TEMPLATE_RELATIONS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2246
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2247 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2248 # YES then doxygen will generate a graph for each documented file showing the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2249 # direct and indirect include dependencies of the file with other documented
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2250 # files.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2251 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2252 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2253
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2254 INCLUDE_GRAPH = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2255
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2256 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2257 # set to YES then doxygen will generate a graph for each documented file showing
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2258 # the direct and indirect include dependencies of the file with other documented
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2259 # files.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2260 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2261 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2262
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2263 INCLUDED_BY_GRAPH = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2264
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2265 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2266 # dependency graph for every global function or class method.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2267 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2268 # Note that enabling this option will significantly increase the time of a run.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2269 # So in most cases it will be better to enable call graphs for selected
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2270 # functions only using the \callgraph command. Disabling a call graph can be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2271 # accomplished by means of the command \hidecallgraph.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2272 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2273 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2274
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2275 CALL_GRAPH = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2276
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2277 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2278 # dependency graph for every global function or class method.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2279 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2280 # Note that enabling this option will significantly increase the time of a run.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2281 # So in most cases it will be better to enable caller graphs for selected
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2282 # functions only using the \callergraph command. Disabling a caller graph can be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2283 # accomplished by means of the command \hidecallergraph.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2284 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2285 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2286
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2287 CALLER_GRAPH = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2288
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2289 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2290 # hierarchy of all classes instead of a textual one.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2291 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2292 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2293
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2294 GRAPHICAL_HIERARCHY = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2295
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2296 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2297 # dependencies a directory has on other directories in a graphical way. The
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2298 # dependency relations are determined by the #include relations between the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2299 # files in the directories.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2300 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2301 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2302
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2303 DIRECTORY_GRAPH = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2304
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2305 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2306 # generated by dot. For an explanation of the image formats see the section
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2307 # output formats in the documentation of the dot tool (Graphviz (see:
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2308 # http://www.graphviz.org/)).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2309 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2310 # to make the SVG files visible in IE 9+ (other browsers do not have this
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2311 # requirement).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2312 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2313 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2314 # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2315 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2316 # png:gdiplus:gdiplus.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2317 # The default value is: png.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2318 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2319
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2320 DOT_IMAGE_FORMAT = png
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2321
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2322 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2323 # enable generation of interactive SVG images that allow zooming and panning.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2324 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2325 # Note that this requires a modern browser other than Internet Explorer. Tested
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2326 # and working are Firefox, Chrome, Safari, and Opera.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2327 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2328 # the SVG files visible. Older versions of IE do not have SVG support.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2329 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2330 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2331
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2332 INTERACTIVE_SVG = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2333
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2334 # The DOT_PATH tag can be used to specify the path where the dot tool can be
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2335 # found. If left blank, it is assumed the dot tool can be found in the path.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2336 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2337
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2338 DOT_PATH =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2339
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2340 # The DOTFILE_DIRS tag can be used to specify one or more directories that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2341 # contain dot files that are included in the documentation (see the \dotfile
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2342 # command).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2343 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2344
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2345 DOTFILE_DIRS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2346
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2347 # The MSCFILE_DIRS tag can be used to specify one or more directories that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2348 # contain msc files that are included in the documentation (see the \mscfile
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2349 # command).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2350
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2351 MSCFILE_DIRS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2352
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2353 # The DIAFILE_DIRS tag can be used to specify one or more directories that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2354 # contain dia files that are included in the documentation (see the \diafile
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2355 # command).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2356
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2357 DIAFILE_DIRS =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2358
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2359 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2360 # path where java can find the plantuml.jar file. If left blank, it is assumed
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2361 # PlantUML is not used or called during a preprocessing step. Doxygen will
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2362 # generate a warning when it encounters a \startuml command in this case and
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2363 # will not generate output for the diagram.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2364
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2365 PLANTUML_JAR_PATH =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2366
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2367 # When using plantuml, the specified paths are searched for files specified by
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2368 # the !include statement in a plantuml block.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2369
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2370 PLANTUML_INCLUDE_PATH =
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2371
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2372 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2373 # that will be shown in the graph. If the number of nodes in a graph becomes
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2374 # larger than this value, doxygen will truncate the graph, which is visualized
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2375 # by representing a node as a red box. Note that doxygen if the number of direct
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2376 # children of the root node in a graph is already larger than
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2377 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2378 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2379 # Minimum value: 0, maximum value: 10000, default value: 50.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2380 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2381
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2382 DOT_GRAPH_MAX_NODES = 500
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2383
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2384 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2385 # generated by dot. A depth value of 3 means that only nodes reachable from the
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2386 # root by following a path via at most 3 edges will be shown. Nodes that lay
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2387 # further from the root node will be omitted. Note that setting this option to 1
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2388 # or 2 may greatly reduce the computation time needed for large code bases. Also
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2389 # note that the size of a graph can be further restricted by
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2390 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2391 # Minimum value: 0, maximum value: 1000, default value: 0.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2392 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2393
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2394 MAX_DOT_GRAPH_DEPTH = 5
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2395
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2396 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2397 # background. This is disabled by default, because dot on Windows does not seem
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2398 # to support this out of the box.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2399 #
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2400 # Warning: Depending on the platform used, enabling this option may lead to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2401 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2402 # read).
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2403 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2404 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2405
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2406 DOT_TRANSPARENT = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2407
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2408 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2409 # files in one run (i.e. multiple -o and -T options on the command line). This
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2410 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2411 # this, this feature is disabled by default.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2412 # The default value is: NO.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2413 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2414
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2415 DOT_MULTI_TARGETS = NO
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2416
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2417 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2418 # explaining the meaning of the various boxes and arrows in the dot generated
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2419 # graphs.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2420 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2421 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2422
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2423 GENERATE_LEGEND = YES
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2424
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2425 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2426 # files that are used to generate the various graphs.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2427 # The default value is: YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2428 # This tag requires that the tag HAVE_DOT is set to YES.
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2429
6dba84798cd5 Update to libtomcrypt 1.18.1, merged with Dropbear changes Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2430 DOT_CLEANUP = YES

Mercurial > dropbear

annotate libtomcrypt/doc/Doxyfile @ 1930:299f4f19ba19