Nucleo_rtos_basic - 1

Users » valeyev » Code » Nucleo_rtos_basic

Denislam Valeev / Mbed OS Nucleo_rtos_basic

mbed-os/doxyfile_options@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:: valeyev
Date:: Tue Mar 13 07:17:50 2018 +0000
Revision:: 0:e056ac8fecf8

looking for...

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed OS
Created:	13 Mar 2018
Imports:	8
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	0
Followers:	1

mbed-os/doxyfile_options@0:e056ac8fecf8, 2018-03-13 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning