BLE_API - adaptation for book and plug demo

Bkap » Code » BLE_API

adaptation for book and plug demo

Fork of BLE_API by Bluetooth Low Energy

ble.doxyfile@1184:246cbece99c2, 2016-04-06 (annotated)

Committer:: vcoubard
Date:: Wed Apr 06 19:15:37 2016 +0100
Revision:: 1184:246cbece99c2
Parent:: 1134:d540a48f650d

Synchronized with git rev fb1acf57

Author: Vincent Coubard

Improve doxygen documentation:

- enable macro expansion

- set JAVADOC_AUTOBRIEF to YES

- add an alias for experimental tag

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	17 May 2018
Imports:	1
Forks:	0
Commits:	1210
Dependents:	1
Dependencies:	0
Followers:	3

This repository is Public (Unlisted).

ble.doxyfile@1184:246cbece99c2, 2016-04-06 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning