BBR_1Ebene - BBR 1 Ebene

Users » borlanic » Code » BBR_1Ebene

BBR 1 Ebene

mbed-os/doxyfile_options@0:fbdae7e6d805, 2018-05-14 (annotated)

Committer:: borlanic
Date:: Mon May 14 11:29:06 2018 +0000
Revision:: 0:fbdae7e6d805

BBR

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed OS
Created:	14 May 2018
Imports:	0
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	0
Followers:	3

mbed-os/doxyfile_options@0:fbdae7e6d805, 2018-05-14 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning