BaBoRo1 - Erste version der Software für der Prototyp

BA » Code » BaBoRo1

Erste version der Software für der Prototyp

mbed-os/doxyfile_options@4:75df35ef4fb6, 2018-03-30 (annotated)

Committer:: borlanic
Date:: Fri Mar 30 14:07:05 2018 +0000
Revision:: 4:75df35ef4fb6
Parent:: 0:380207fcb5c1

commentar

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed OS
Created:	29 Mar 2018
Imports:	22
Forks:	0
Commits:	5
Dependents:	0
Dependencies:	0
Followers:	6

mbed-os/doxyfile_options@4:75df35ef4fb6, 2018-03-30 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning