04_RTOS_Embebidos - Entrega 3er corte - sistemas embebidos

Users » Bethory » Code » 04_RTOS_Embebidos

Daniel Vizcaya / Mbed OS 04_RTOS_Embebidos

Entrega 3er corte - sistemas embebidos

mbed-os/doxyfile_options@1:fcdb45ee95b9, 2018-05-30 (annotated)

Committer:: Bethory
Date:: Wed May 30 04:46:28 2018 +0000
Revision:: 1:fcdb45ee95b9
Parent:: 0:6ad07c9019fd

Entrega Final

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed OS
Created:	30 May 2018
Imports:	7
Forks:	0
Commits:	2
Dependents:	0
Dependencies:	0
Followers:	1

mbed-os/doxyfile_options@1:fcdb45ee95b9, 2018-05-30 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning