DAPLink Reset - Repostiory containing DAPLink source code with Re…

Arrow » Code » DAPLink Reset

Repostiory containing DAPLink source code with Reset Pin workaround for HANI_IOT board.

Upstream: https://github.com/ARMmbed/DAPLink

docs/Doxyfile@0:01f31e923fe2, 2020-04-07 (annotated)

Committer:: Pawel Zarembski
Date:: Tue Apr 07 12:55:42 2020 +0200
Revision:: 0:01f31e923fe2

hani: DAPLink with reset workaround

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	07 Apr 2020
Imports:	6
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	0
Followers:	12

docs/Doxyfile@0:01f31e923fe2, 2020-04-07 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning