Example_RTOS - Rtos API example

Users » marcozecchini » Code » Example_RTOS

Rtos API example

mbed-os/doxyfile_options@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:: marcozecchini
Date:: Sat Feb 23 12:13:36 2019 +0000
Revision:: 0:9fca2b23d0ba

final commit

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed OS
Created:	23 Feb 2019
Imports:	43
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	0
Followers:	1

mbed-os/doxyfile_options@0:9fca2b23d0ba, 2019-02-23 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning