simple-mbed-cloud-client

Users » MACRUM » Code » simple-mbed-cloud-client

Toyomasa Watarai / simple-mbed-cloud-client

mbed-cloud-client/mbed-coap/doxygen/libcoap_doxy@0:276e7a263c35, 2018-07-02 (annotated)

Committer:: MACRUM
Date:: Mon Jul 02 06:30:39 2018 +0000
Revision:: 0:276e7a263c35

Initial commit

Who changed what in which revision?

User	Revision	Line number	New contents of line
MACRUM	0:276e7a263c35	1	# Doxyfile 1.8.2
MACRUM	0:276e7a263c35	2
MACRUM	0:276e7a263c35	3	# This file describes the settings to be used by the documentation system
MACRUM	0:276e7a263c35	4	# doxygen (www.doxygen.org) for a project
MACRUM	0:276e7a263c35	5	#
MACRUM	0:276e7a263c35	6	# All text after a hash (#) is considered a comment and will be ignored
MACRUM	0:276e7a263c35	7	# The format is:
MACRUM	0:276e7a263c35	8	# TAG = value [value, ...]
MACRUM	0:276e7a263c35	9	# For lists items can also be appended using:
MACRUM	0:276e7a263c35	10	# TAG += value [value, ...]
MACRUM	0:276e7a263c35	11	# Values that contain spaces should be placed between quotes (" ")
MACRUM	0:276e7a263c35	12
MACRUM	0:276e7a263c35	13	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	14	# Project related configuration options
MACRUM	0:276e7a263c35	15	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	16
MACRUM	0:276e7a263c35	17	# This tag specifies the encoding used for all characters in the config file
MACRUM	0:276e7a263c35	18	# that follow. The default is UTF-8 which is also the encoding used for all
MACRUM	0:276e7a263c35	19	# text before the first occurrence of this tag. Doxygen uses libiconv (or the
MACRUM	0:276e7a263c35	20	# iconv built into libc) for the transcoding. See
MACRUM	0:276e7a263c35	21	# http://www.gnu.org/software/libiconv for the list of possible encodings.
MACRUM	0:276e7a263c35	22
MACRUM	0:276e7a263c35	23	DOXYFILE_ENCODING = UTF-8
MACRUM	0:276e7a263c35	24
MACRUM	0:276e7a263c35	25	# The PROJECT_NAME tag is a single word (or sequence of words) that should
MACRUM	0:276e7a263c35	26	# identify the project. Note that if you do not use Doxywizard you need
MACRUM	0:276e7a263c35	27	# to put quotes around the project name if it contains spaces.
MACRUM	0:276e7a263c35	28
MACRUM	0:276e7a263c35	29	PROJECT_NAME = libcoap
MACRUM	0:276e7a263c35	30
MACRUM	0:276e7a263c35	31	# The PROJECT_NUMBER tag can be used to enter a project or revision number.
MACRUM	0:276e7a263c35	32	# This could be handy for archiving the generated documentation or
MACRUM	0:276e7a263c35	33	# if some version control system is used.
MACRUM	0:276e7a263c35	34
MACRUM	0:276e7a263c35	35	PROJECT_NUMBER =
MACRUM	0:276e7a263c35	36
MACRUM	0:276e7a263c35	37	# Using the PROJECT_BRIEF tag one can provide an optional one line description
MACRUM	0:276e7a263c35	38	# for a project that appears at the top of each page and should give viewer
MACRUM	0:276e7a263c35	39	# a quick idea about the purpose of the project. Keep the description short.
MACRUM	0:276e7a263c35	40
MACRUM	0:276e7a263c35	41	PROJECT_BRIEF = "CoAP C library"
MACRUM	0:276e7a263c35	42
MACRUM	0:276e7a263c35	43	# With the PROJECT_LOGO tag one can specify an logo or icon that is
MACRUM	0:276e7a263c35	44	# included in the documentation. The maximum height of the logo should not
MACRUM	0:276e7a263c35	45	# exceed 55 pixels and the maximum width should not exceed 200 pixels.
MACRUM	0:276e7a263c35	46	# Doxygen will copy the logo to the output directory.
MACRUM	0:276e7a263c35	47
MACRUM	0:276e7a263c35	48	PROJECT_LOGO =
MACRUM	0:276e7a263c35	49
MACRUM	0:276e7a263c35	50	# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
MACRUM	0:276e7a263c35	51	# base path where the generated documentation will be put.
MACRUM	0:276e7a263c35	52	# If a relative path is entered, it will be relative to the location
MACRUM	0:276e7a263c35	53	# where doxygen was started. If left blank the current directory will be used.
MACRUM	0:276e7a263c35	54
MACRUM	0:276e7a263c35	55	OUTPUT_DIRECTORY = ../docs
MACRUM	0:276e7a263c35	56
MACRUM	0:276e7a263c35	57	# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
MACRUM	0:276e7a263c35	58	# 4096 sub-directories (in 2 levels) under the output directory of each output
MACRUM	0:276e7a263c35	59	# format and will distribute the generated files over these directories.
MACRUM	0:276e7a263c35	60	# Enabling this option can be useful when feeding doxygen a huge amount of
MACRUM	0:276e7a263c35	61	# source files, where putting all generated files in the same directory would
MACRUM	0:276e7a263c35	62	# otherwise cause performance problems for the file system.
MACRUM	0:276e7a263c35	63
MACRUM	0:276e7a263c35	64	CREATE_SUBDIRS = NO
MACRUM	0:276e7a263c35	65
MACRUM	0:276e7a263c35	66	# The OUTPUT_LANGUAGE tag is used to specify the language in which all
MACRUM	0:276e7a263c35	67	# documentation generated by doxygen is written. Doxygen will use this
MACRUM	0:276e7a263c35	68	# information to generate all constant output in the proper language.
MACRUM	0:276e7a263c35	69	# The default language is English, other supported languages are:
MACRUM	0:276e7a263c35	70	# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
MACRUM	0:276e7a263c35	71	# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
MACRUM	0:276e7a263c35	72	# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
MACRUM	0:276e7a263c35	73	# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
MACRUM	0:276e7a263c35	74	# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
MACRUM	0:276e7a263c35	75	# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
MACRUM	0:276e7a263c35	76
MACRUM	0:276e7a263c35	77	OUTPUT_LANGUAGE = English
MACRUM	0:276e7a263c35	78
MACRUM	0:276e7a263c35	79	# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
MACRUM	0:276e7a263c35	80	# include brief member descriptions after the members that are listed in
MACRUM	0:276e7a263c35	81	# the file and class documentation (similar to JavaDoc).
MACRUM	0:276e7a263c35	82	# Set to NO to disable this.
MACRUM	0:276e7a263c35	83
MACRUM	0:276e7a263c35	84	BRIEF_MEMBER_DESC = YES
MACRUM	0:276e7a263c35	85
MACRUM	0:276e7a263c35	86	# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
MACRUM	0:276e7a263c35	87	# the brief description of a member or function before the detailed description.
MACRUM	0:276e7a263c35	88	# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
MACRUM	0:276e7a263c35	89	# brief descriptions will be completely suppressed.
MACRUM	0:276e7a263c35	90
MACRUM	0:276e7a263c35	91	REPEAT_BRIEF = YES
MACRUM	0:276e7a263c35	92
MACRUM	0:276e7a263c35	93	# This tag implements a quasi-intelligent brief description abbreviator
MACRUM	0:276e7a263c35	94	# that is used to form the text in various listings. Each string
MACRUM	0:276e7a263c35	95	# in this list, if found as the leading text of the brief description, will be
MACRUM	0:276e7a263c35	96	# stripped from the text and the result after processing the whole list, is
MACRUM	0:276e7a263c35	97	# used as the annotated text. Otherwise, the brief description is used as-is.
MACRUM	0:276e7a263c35	98	# If left blank, the following values are used ("$name" is automatically
MACRUM	0:276e7a263c35	99	# replaced with the name of the entity): "The $name class" "The $name widget"
MACRUM	0:276e7a263c35	100	# "The $name file" "is" "provides" "specifies" "contains"
MACRUM	0:276e7a263c35	101	# "represents" "a" "an" "the"
MACRUM	0:276e7a263c35	102
MACRUM	0:276e7a263c35	103	ABBREVIATE_BRIEF = "The $name class" \
MACRUM	0:276e7a263c35	104	"The $name widget" \
MACRUM	0:276e7a263c35	105	"The $name file" \
MACRUM	0:276e7a263c35	106	is \
MACRUM	0:276e7a263c35	107	provides \
MACRUM	0:276e7a263c35	108	specifies \
MACRUM	0:276e7a263c35	109	contains \
MACRUM	0:276e7a263c35	110	represents \
MACRUM	0:276e7a263c35	111	a \
MACRUM	0:276e7a263c35	112	an \
MACRUM	0:276e7a263c35	113	the
MACRUM	0:276e7a263c35	114
MACRUM	0:276e7a263c35	115	# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
MACRUM	0:276e7a263c35	116	# Doxygen will generate a detailed section even if there is only a brief
MACRUM	0:276e7a263c35	117	# description.
MACRUM	0:276e7a263c35	118
MACRUM	0:276e7a263c35	119	ALWAYS_DETAILED_SEC = NO
MACRUM	0:276e7a263c35	120
MACRUM	0:276e7a263c35	121	# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
MACRUM	0:276e7a263c35	122	# inherited members of a class in the documentation of that class as if those
MACRUM	0:276e7a263c35	123	# members were ordinary class members. Constructors, destructors and assignment
MACRUM	0:276e7a263c35	124	# operators of the base classes will not be shown.
MACRUM	0:276e7a263c35	125
MACRUM	0:276e7a263c35	126	INLINE_INHERITED_MEMB = NO
MACRUM	0:276e7a263c35	127
MACRUM	0:276e7a263c35	128	# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
MACRUM	0:276e7a263c35	129	# path before files name in the file list and in the header files. If set
MACRUM	0:276e7a263c35	130	# to NO the shortest path that makes the file name unique will be used.
MACRUM	0:276e7a263c35	131
MACRUM	0:276e7a263c35	132	FULL_PATH_NAMES = NO
MACRUM	0:276e7a263c35	133
MACRUM	0:276e7a263c35	134	# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
MACRUM	0:276e7a263c35	135	# can be used to strip a user-defined part of the path. Stripping is
MACRUM	0:276e7a263c35	136	# only done if one of the specified strings matches the left-hand part of
MACRUM	0:276e7a263c35	137	# the path. The tag can be used to show relative paths in the file list.
MACRUM	0:276e7a263c35	138	# If left blank the directory from which doxygen is run is used as the
MACRUM	0:276e7a263c35	139	# path to strip. Note that you specify absolute paths here, but also
MACRUM	0:276e7a263c35	140	# relative paths, which will be relative from the directory where doxygen is
MACRUM	0:276e7a263c35	141	# started.
MACRUM	0:276e7a263c35	142
MACRUM	0:276e7a263c35	143	STRIP_FROM_PATH =
MACRUM	0:276e7a263c35	144
MACRUM	0:276e7a263c35	145	# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
MACRUM	0:276e7a263c35	146	# the path mentioned in the documentation of a class, which tells
MACRUM	0:276e7a263c35	147	# the reader which header file to include in order to use a class.
MACRUM	0:276e7a263c35	148	# If left blank only the name of the header file containing the class
MACRUM	0:276e7a263c35	149	# definition is used. Otherwise one should specify the include paths that
MACRUM	0:276e7a263c35	150	# are normally passed to the compiler using the -I flag.
MACRUM	0:276e7a263c35	151
MACRUM	0:276e7a263c35	152	STRIP_FROM_INC_PATH =
MACRUM	0:276e7a263c35	153
MACRUM	0:276e7a263c35	154	# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
MACRUM	0:276e7a263c35	155	# (but less readable) file names. This can be useful if your file system
MACRUM	0:276e7a263c35	156	# doesn't support long names like on DOS, Mac, or CD-ROM.
MACRUM	0:276e7a263c35	157
MACRUM	0:276e7a263c35	158	SHORT_NAMES = NO
MACRUM	0:276e7a263c35	159
MACRUM	0:276e7a263c35	160	# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
MACRUM	0:276e7a263c35	161	# will interpret the first line (until the first dot) of a JavaDoc-style
MACRUM	0:276e7a263c35	162	# comment as the brief description. If set to NO, the JavaDoc
MACRUM	0:276e7a263c35	163	# comments will behave just like regular Qt-style comments
MACRUM	0:276e7a263c35	164	# (thus requiring an explicit @brief command for a brief description.)
MACRUM	0:276e7a263c35	165
MACRUM	0:276e7a263c35	166	JAVADOC_AUTOBRIEF = NO
MACRUM	0:276e7a263c35	167
MACRUM	0:276e7a263c35	168	# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
MACRUM	0:276e7a263c35	169	# interpret the first line (until the first dot) of a Qt-style
MACRUM	0:276e7a263c35	170	# comment as the brief description. If set to NO, the comments
MACRUM	0:276e7a263c35	171	# will behave just like regular Qt-style comments (thus requiring
MACRUM	0:276e7a263c35	172	# an explicit \brief command for a brief description.)
MACRUM	0:276e7a263c35	173
MACRUM	0:276e7a263c35	174	QT_AUTOBRIEF = NO
MACRUM	0:276e7a263c35	175
MACRUM	0:276e7a263c35	176	# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
MACRUM	0:276e7a263c35	177	# treat a multi-line C++ special comment block (i.e. a block of //! or ///
MACRUM	0:276e7a263c35	178	# comments) as a brief description. This used to be the default behaviour.
MACRUM	0:276e7a263c35	179	# The new default is to treat a multi-line C++ comment block as a detailed
MACRUM	0:276e7a263c35	180	# description. Set this tag to YES if you prefer the old behaviour instead.
MACRUM	0:276e7a263c35	181
MACRUM	0:276e7a263c35	182	MULTILINE_CPP_IS_BRIEF = NO
MACRUM	0:276e7a263c35	183
MACRUM	0:276e7a263c35	184	# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
MACRUM	0:276e7a263c35	185	# member inherits the documentation from any documented member that it
MACRUM	0:276e7a263c35	186	# re-implements.
MACRUM	0:276e7a263c35	187
MACRUM	0:276e7a263c35	188	INHERIT_DOCS = YES
MACRUM	0:276e7a263c35	189
MACRUM	0:276e7a263c35	190	# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
MACRUM	0:276e7a263c35	191	# a new page for each member. If set to NO, the documentation of a member will
MACRUM	0:276e7a263c35	192	# be part of the file/class/namespace that contains it.
MACRUM	0:276e7a263c35	193
MACRUM	0:276e7a263c35	194	SEPARATE_MEMBER_PAGES = NO
MACRUM	0:276e7a263c35	195
MACRUM	0:276e7a263c35	196	# The TAB_SIZE tag can be used to set the number of spaces in a tab.
MACRUM	0:276e7a263c35	197	# Doxygen uses this value to replace tabs by spaces in code fragments.
MACRUM	0:276e7a263c35	198
MACRUM	0:276e7a263c35	199	TAB_SIZE = 16
MACRUM	0:276e7a263c35	200
MACRUM	0:276e7a263c35	201	# This tag can be used to specify a number of aliases that acts
MACRUM	0:276e7a263c35	202	# as commands in the documentation. An alias has the form "name=value".
MACRUM	0:276e7a263c35	203	# For example adding "sideeffect=\par Side Effects:\n" will allow you to
MACRUM	0:276e7a263c35	204	# put the command \sideeffect (or @sideeffect) in the documentation, which
MACRUM	0:276e7a263c35	205	# will result in a user-defined paragraph with heading "Side Effects:".
MACRUM	0:276e7a263c35	206	# You can put \n's in the value part of an alias to insert newlines.
MACRUM	0:276e7a263c35	207
MACRUM	0:276e7a263c35	208	ALIASES =
MACRUM	0:276e7a263c35	209
MACRUM	0:276e7a263c35	210	# This tag can be used to specify a number of word-keyword mappings (TCL only).
MACRUM	0:276e7a263c35	211	# A mapping has the form "name=value". For example adding
MACRUM	0:276e7a263c35	212	# "class=itcl::class" will allow you to use the command class in the
MACRUM	0:276e7a263c35	213	# itcl::class meaning.
MACRUM	0:276e7a263c35	214
MACRUM	0:276e7a263c35	215	TCL_SUBST =
MACRUM	0:276e7a263c35	216
MACRUM	0:276e7a263c35	217	# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
MACRUM	0:276e7a263c35	218	# sources only. Doxygen will then generate output that is more tailored for C.
MACRUM	0:276e7a263c35	219	# For instance, some of the names that are used will be different. The list
MACRUM	0:276e7a263c35	220	# of all members will be omitted, etc.
MACRUM	0:276e7a263c35	221
MACRUM	0:276e7a263c35	222	OPTIMIZE_OUTPUT_FOR_C = YES
MACRUM	0:276e7a263c35	223
MACRUM	0:276e7a263c35	224	# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
MACRUM	0:276e7a263c35	225	# sources only. Doxygen will then generate output that is more tailored for
MACRUM	0:276e7a263c35	226	# Java. For instance, namespaces will be presented as packages, qualified
MACRUM	0:276e7a263c35	227	# scopes will look different, etc.
MACRUM	0:276e7a263c35	228
MACRUM	0:276e7a263c35	229	OPTIMIZE_OUTPUT_JAVA = NO
MACRUM	0:276e7a263c35	230
MACRUM	0:276e7a263c35	231	# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
MACRUM	0:276e7a263c35	232	# sources only. Doxygen will then generate output that is more tailored for
MACRUM	0:276e7a263c35	233	# Fortran.
MACRUM	0:276e7a263c35	234
MACRUM	0:276e7a263c35	235	OPTIMIZE_FOR_FORTRAN = NO
MACRUM	0:276e7a263c35	236
MACRUM	0:276e7a263c35	237	# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
MACRUM	0:276e7a263c35	238	# sources. Doxygen will then generate output that is tailored for
MACRUM	0:276e7a263c35	239	# VHDL.
MACRUM	0:276e7a263c35	240
MACRUM	0:276e7a263c35	241	OPTIMIZE_OUTPUT_VHDL = NO
MACRUM	0:276e7a263c35	242
MACRUM	0:276e7a263c35	243	# Doxygen selects the parser to use depending on the extension of the files it
MACRUM	0:276e7a263c35	244	# parses. With this tag you can assign which parser to use for a given
MACRUM	0:276e7a263c35	245	# extension. Doxygen has a built-in mapping, but you can override or extend it
MACRUM	0:276e7a263c35	246	# using this tag. The format is ext=language, where ext is a file extension,
MACRUM	0:276e7a263c35	247	# and language is one of the parsers supported by doxygen: IDL, Java,
MACRUM	0:276e7a263c35	248	# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
MACRUM	0:276e7a263c35	249	# C++. For instance to make doxygen treat .inc files as Fortran files (default
MACRUM	0:276e7a263c35	250	# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
MACRUM	0:276e7a263c35	251	# that for custom extensions you also need to set FILE_PATTERNS otherwise the
MACRUM	0:276e7a263c35	252	# files are not read by doxygen.
MACRUM	0:276e7a263c35	253
MACRUM	0:276e7a263c35	254	EXTENSION_MAPPING =
MACRUM	0:276e7a263c35	255
MACRUM	0:276e7a263c35	256	# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
MACRUM	0:276e7a263c35	257	# comments according to the Markdown format, which allows for more readable
MACRUM	0:276e7a263c35	258	# documentation. See http://daringfireball.net/projects/markdown/ for details.
MACRUM	0:276e7a263c35	259	# The output of markdown processing is further processed by doxygen, so you
MACRUM	0:276e7a263c35	260	# can mix doxygen, HTML, and XML commands with Markdown formatting.
MACRUM	0:276e7a263c35	261	# Disable only in case of backward compatibilities issues.
MACRUM	0:276e7a263c35	262
MACRUM	0:276e7a263c35	263	MARKDOWN_SUPPORT = YES
MACRUM	0:276e7a263c35	264
MACRUM	0:276e7a263c35	265	# When enabled doxygen tries to link words that correspond to documented classes,
MACRUM	0:276e7a263c35	266	# or namespaces to their corresponding documentation. Such a link can be
MACRUM	0:276e7a263c35	267	# prevented in individual cases by by putting a % sign in front of the word or
MACRUM	0:276e7a263c35	268	# globally by setting AUTOLINK_SUPPORT to NO.
MACRUM	0:276e7a263c35	269
MACRUM	0:276e7a263c35	270	AUTOLINK_SUPPORT = YES
MACRUM	0:276e7a263c35	271
MACRUM	0:276e7a263c35	272	# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
MACRUM	0:276e7a263c35	273	# to include (a tag file for) the STL sources as input, then you should
MACRUM	0:276e7a263c35	274	# set this tag to YES in order to let doxygen match functions declarations and
MACRUM	0:276e7a263c35	275	# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
MACRUM	0:276e7a263c35	276	# func(std::string) {}). This also makes the inheritance and collaboration
MACRUM	0:276e7a263c35	277	# diagrams that involve STL classes more complete and accurate.
MACRUM	0:276e7a263c35	278
MACRUM	0:276e7a263c35	279	BUILTIN_STL_SUPPORT = NO
MACRUM	0:276e7a263c35	280
MACRUM	0:276e7a263c35	281	# If you use Microsoft's C++/CLI language, you should set this option to YES to
MACRUM	0:276e7a263c35	282	# enable parsing support.
MACRUM	0:276e7a263c35	283
MACRUM	0:276e7a263c35	284	CPP_CLI_SUPPORT = NO
MACRUM	0:276e7a263c35	285
MACRUM	0:276e7a263c35	286	# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
MACRUM	0:276e7a263c35	287	# Doxygen will parse them like normal C++ but will assume all classes use public
MACRUM	0:276e7a263c35	288	# instead of private inheritance when no explicit protection keyword is present.
MACRUM	0:276e7a263c35	289
MACRUM	0:276e7a263c35	290	SIP_SUPPORT = NO
MACRUM	0:276e7a263c35	291
MACRUM	0:276e7a263c35	292	# For Microsoft's IDL there are propget and propput attributes to indicate
MACRUM	0:276e7a263c35	293	# getter and setter methods for a property. Setting this option to YES (the
MACRUM	0:276e7a263c35	294	# default) will make doxygen replace the get and set methods by a property in
MACRUM	0:276e7a263c35	295	# the documentation. This will only work if the methods are indeed getting or
MACRUM	0:276e7a263c35	296	# setting a simple type. If this is not the case, or you want to show the
MACRUM	0:276e7a263c35	297	# methods anyway, you should set this option to NO.
MACRUM	0:276e7a263c35	298
MACRUM	0:276e7a263c35	299	IDL_PROPERTY_SUPPORT = YES
MACRUM	0:276e7a263c35	300
MACRUM	0:276e7a263c35	301	# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
MACRUM	0:276e7a263c35	302	# tag is set to YES, then doxygen will reuse the documentation of the first
MACRUM	0:276e7a263c35	303	# member in the group (if any) for the other members of the group. By default
MACRUM	0:276e7a263c35	304	# all members of a group must be documented explicitly.
MACRUM	0:276e7a263c35	305
MACRUM	0:276e7a263c35	306	DISTRIBUTE_GROUP_DOC = NO
MACRUM	0:276e7a263c35	307
MACRUM	0:276e7a263c35	308	# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
MACRUM	0:276e7a263c35	309	# the same type (for instance a group of public functions) to be put as a
MACRUM	0:276e7a263c35	310	# subgroup of that type (e.g. under the Public Functions section). Set it to
MACRUM	0:276e7a263c35	311	# NO to prevent subgrouping. Alternatively, this can be done per class using
MACRUM	0:276e7a263c35	312	# the \nosubgrouping command.
MACRUM	0:276e7a263c35	313
MACRUM	0:276e7a263c35	314	SUBGROUPING = YES
MACRUM	0:276e7a263c35	315
MACRUM	0:276e7a263c35	316	# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
MACRUM	0:276e7a263c35	317	# unions are shown inside the group in which they are included (e.g. using
MACRUM	0:276e7a263c35	318	# @ingroup) instead of on a separate page (for HTML and Man pages) or
MACRUM	0:276e7a263c35	319	# section (for LaTeX and RTF).
MACRUM	0:276e7a263c35	320
MACRUM	0:276e7a263c35	321	INLINE_GROUPED_CLASSES = NO
MACRUM	0:276e7a263c35	322
MACRUM	0:276e7a263c35	323	# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
MACRUM	0:276e7a263c35	324	# unions with only public data fields will be shown inline in the documentation
MACRUM	0:276e7a263c35	325	# of the scope in which they are defined (i.e. file, namespace, or group
MACRUM	0:276e7a263c35	326	# documentation), provided this scope is documented. If set to NO (the default),
MACRUM	0:276e7a263c35	327	# structs, classes, and unions are shown on a separate page (for HTML and Man
MACRUM	0:276e7a263c35	328	# pages) or section (for LaTeX and RTF).
MACRUM	0:276e7a263c35	329
MACRUM	0:276e7a263c35	330	INLINE_SIMPLE_STRUCTS = NO
MACRUM	0:276e7a263c35	331
MACRUM	0:276e7a263c35	332	# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
MACRUM	0:276e7a263c35	333	# is documented as struct, union, or enum with the name of the typedef. So
MACRUM	0:276e7a263c35	334	# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
MACRUM	0:276e7a263c35	335	# with name TypeT. When disabled the typedef will appear as a member of a file,
MACRUM	0:276e7a263c35	336	# namespace, or class. And the struct will be named TypeS. This can typically
MACRUM	0:276e7a263c35	337	# be useful for C code in case the coding convention dictates that all compound
MACRUM	0:276e7a263c35	338	# types are typedef'ed and only the typedef is referenced, never the tag name.
MACRUM	0:276e7a263c35	339
MACRUM	0:276e7a263c35	340	TYPEDEF_HIDES_STRUCT = NO
MACRUM	0:276e7a263c35	341
MACRUM	0:276e7a263c35	342	# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
MACRUM	0:276e7a263c35	343	# determine which symbols to keep in memory and which to flush to disk.
MACRUM	0:276e7a263c35	344	# When the cache is full, less often used symbols will be written to disk.
MACRUM	0:276e7a263c35	345	# For small to medium size projects (<1000 input files) the default value is
MACRUM	0:276e7a263c35	346	# probably good enough. For larger projects a too small cache size can cause
MACRUM	0:276e7a263c35	347	# doxygen to be busy swapping symbols to and from disk most of the time
MACRUM	0:276e7a263c35	348	# causing a significant performance penalty.
MACRUM	0:276e7a263c35	349	# If the system has enough physical memory increasing the cache will improve the
MACRUM	0:276e7a263c35	350	# performance by keeping more symbols in memory. Note that the value works on
MACRUM	0:276e7a263c35	351	# a logarithmic scale so increasing the size by one will roughly double the
MACRUM	0:276e7a263c35	352	# memory usage. The cache size is given by this formula:
MACRUM	0:276e7a263c35	353	# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
MACRUM	0:276e7a263c35	354	# corresponding to a cache size of 2^16 = 65536 symbols.
MACRUM	0:276e7a263c35	355
MACRUM	0:276e7a263c35	356	SYMBOL_CACHE_SIZE = 0
MACRUM	0:276e7a263c35	357
MACRUM	0:276e7a263c35	358	# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
MACRUM	0:276e7a263c35	359	# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
MACRUM	0:276e7a263c35	360	# their name and scope. Since this can be an expensive process and often the
MACRUM	0:276e7a263c35	361	# same symbol appear multiple times in the code, doxygen keeps a cache of
MACRUM	0:276e7a263c35	362	# pre-resolved symbols. If the cache is too small doxygen will become slower.
MACRUM	0:276e7a263c35	363	# If the cache is too large, memory is wasted. The cache size is given by this
MACRUM	0:276e7a263c35	364	# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
MACRUM	0:276e7a263c35	365	# corresponding to a cache size of 2^16 = 65536 symbols.
MACRUM	0:276e7a263c35	366
MACRUM	0:276e7a263c35	367	LOOKUP_CACHE_SIZE = 0
MACRUM	0:276e7a263c35	368
MACRUM	0:276e7a263c35	369	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	370	# Build related configuration options
MACRUM	0:276e7a263c35	371	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	372
MACRUM	0:276e7a263c35	373	# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
MACRUM	0:276e7a263c35	374	# documentation are documented, even if no documentation was available.
MACRUM	0:276e7a263c35	375	# Private class members and static file members will be hidden unless
MACRUM	0:276e7a263c35	376	# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
MACRUM	0:276e7a263c35	377
MACRUM	0:276e7a263c35	378	EXTRACT_ALL = NO
MACRUM	0:276e7a263c35	379
MACRUM	0:276e7a263c35	380	# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
MACRUM	0:276e7a263c35	381	# will be included in the documentation.
MACRUM	0:276e7a263c35	382
MACRUM	0:276e7a263c35	383	EXTRACT_PRIVATE = NO
MACRUM	0:276e7a263c35	384
MACRUM	0:276e7a263c35	385	# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
MACRUM	0:276e7a263c35	386	# scope will be included in the documentation.
MACRUM	0:276e7a263c35	387
MACRUM	0:276e7a263c35	388	EXTRACT_PACKAGE = NO
MACRUM	0:276e7a263c35	389
MACRUM	0:276e7a263c35	390	# If the EXTRACT_STATIC tag is set to YES all static members of a file
MACRUM	0:276e7a263c35	391	# will be included in the documentation.
MACRUM	0:276e7a263c35	392
MACRUM	0:276e7a263c35	393	EXTRACT_STATIC = NO
MACRUM	0:276e7a263c35	394
MACRUM	0:276e7a263c35	395	# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
MACRUM	0:276e7a263c35	396	# defined locally in source files will be included in the documentation.
MACRUM	0:276e7a263c35	397	# If set to NO only classes defined in header files are included.
MACRUM	0:276e7a263c35	398
MACRUM	0:276e7a263c35	399	EXTRACT_LOCAL_CLASSES = NO
MACRUM	0:276e7a263c35	400
MACRUM	0:276e7a263c35	401	# This flag is only useful for Objective-C code. When set to YES local
MACRUM	0:276e7a263c35	402	# methods, which are defined in the implementation section but not in
MACRUM	0:276e7a263c35	403	# the interface are included in the documentation.
MACRUM	0:276e7a263c35	404	# If set to NO (the default) only methods in the interface are included.
MACRUM	0:276e7a263c35	405
MACRUM	0:276e7a263c35	406	EXTRACT_LOCAL_METHODS = NO
MACRUM	0:276e7a263c35	407
MACRUM	0:276e7a263c35	408	# If this flag is set to YES, the members of anonymous namespaces will be
MACRUM	0:276e7a263c35	409	# extracted and appear in the documentation as a namespace called
MACRUM	0:276e7a263c35	410	# 'anonymous_namespace{file}', where file will be replaced with the base
MACRUM	0:276e7a263c35	411	# name of the file that contains the anonymous namespace. By default
MACRUM	0:276e7a263c35	412	# anonymous namespaces are hidden.
MACRUM	0:276e7a263c35	413
MACRUM	0:276e7a263c35	414	EXTRACT_ANON_NSPACES = NO
MACRUM	0:276e7a263c35	415
MACRUM	0:276e7a263c35	416	# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
MACRUM	0:276e7a263c35	417	# undocumented members of documented classes, files or namespaces.
MACRUM	0:276e7a263c35	418	# If set to NO (the default) these members will be included in the
MACRUM	0:276e7a263c35	419	# various overviews, but no documentation section is generated.
MACRUM	0:276e7a263c35	420	# This option has no effect if EXTRACT_ALL is enabled.
MACRUM	0:276e7a263c35	421
MACRUM	0:276e7a263c35	422	HIDE_UNDOC_MEMBERS = YES
MACRUM	0:276e7a263c35	423
MACRUM	0:276e7a263c35	424	# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
MACRUM	0:276e7a263c35	425	# undocumented classes that are normally visible in the class hierarchy.
MACRUM	0:276e7a263c35	426	# If set to NO (the default) these classes will be included in the various
MACRUM	0:276e7a263c35	427	# overviews. This option has no effect if EXTRACT_ALL is enabled.
MACRUM	0:276e7a263c35	428
MACRUM	0:276e7a263c35	429	HIDE_UNDOC_CLASSES = YES
MACRUM	0:276e7a263c35	430
MACRUM	0:276e7a263c35	431	# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
MACRUM	0:276e7a263c35	432	# friend (class\|struct\|union) declarations.
MACRUM	0:276e7a263c35	433	# If set to NO (the default) these declarations will be included in the
MACRUM	0:276e7a263c35	434	# documentation.
MACRUM	0:276e7a263c35	435
MACRUM	0:276e7a263c35	436	HIDE_FRIEND_COMPOUNDS = YES
MACRUM	0:276e7a263c35	437
MACRUM	0:276e7a263c35	438	# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
MACRUM	0:276e7a263c35	439	# documentation blocks found inside the body of a function.
MACRUM	0:276e7a263c35	440	# If set to NO (the default) these blocks will be appended to the
MACRUM	0:276e7a263c35	441	# function's detailed documentation block.
MACRUM	0:276e7a263c35	442
MACRUM	0:276e7a263c35	443	HIDE_IN_BODY_DOCS = YES
MACRUM	0:276e7a263c35	444
MACRUM	0:276e7a263c35	445	# The INTERNAL_DOCS tag determines if documentation
MACRUM	0:276e7a263c35	446	# that is typed after a \internal command is included. If the tag is set
MACRUM	0:276e7a263c35	447	# to NO (the default) then the documentation will be excluded.
MACRUM	0:276e7a263c35	448	# Set it to YES to include the internal documentation.
MACRUM	0:276e7a263c35	449
MACRUM	0:276e7a263c35	450	INTERNAL_DOCS = NO
MACRUM	0:276e7a263c35	451
MACRUM	0:276e7a263c35	452	# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
MACRUM	0:276e7a263c35	453	# file names in lower-case letters. If set to YES upper-case letters are also
MACRUM	0:276e7a263c35	454	# allowed. This is useful if you have classes or files whose names only differ
MACRUM	0:276e7a263c35	455	# in case and if your file system supports case sensitive file names. Windows
MACRUM	0:276e7a263c35	456	# and Mac users are advised to set this option to NO.
MACRUM	0:276e7a263c35	457
MACRUM	0:276e7a263c35	458	CASE_SENSE_NAMES = NO
MACRUM	0:276e7a263c35	459
MACRUM	0:276e7a263c35	460	# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
MACRUM	0:276e7a263c35	461	# will show members with their full class and namespace scopes in the
MACRUM	0:276e7a263c35	462	# documentation. If set to YES the scope will be hidden.
MACRUM	0:276e7a263c35	463
MACRUM	0:276e7a263c35	464	HIDE_SCOPE_NAMES = YES
MACRUM	0:276e7a263c35	465
MACRUM	0:276e7a263c35	466	# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
MACRUM	0:276e7a263c35	467	# will put a list of the files that are included by a file in the documentation
MACRUM	0:276e7a263c35	468	# of that file.
MACRUM	0:276e7a263c35	469
MACRUM	0:276e7a263c35	470	SHOW_INCLUDE_FILES = NO
MACRUM	0:276e7a263c35	471
MACRUM	0:276e7a263c35	472	# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
MACRUM	0:276e7a263c35	473	# will list include files with double quotes in the documentation
MACRUM	0:276e7a263c35	474	# rather than with sharp brackets.
MACRUM	0:276e7a263c35	475
MACRUM	0:276e7a263c35	476	FORCE_LOCAL_INCLUDES = NO
MACRUM	0:276e7a263c35	477
MACRUM	0:276e7a263c35	478	# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
MACRUM	0:276e7a263c35	479	# is inserted in the documentation for inline members.
MACRUM	0:276e7a263c35	480
MACRUM	0:276e7a263c35	481	INLINE_INFO = YES
MACRUM	0:276e7a263c35	482
MACRUM	0:276e7a263c35	483	# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
MACRUM	0:276e7a263c35	484	# will sort the (detailed) documentation of file and class members
MACRUM	0:276e7a263c35	485	# alphabetically by member name. If set to NO the members will appear in
MACRUM	0:276e7a263c35	486	# declaration order.
MACRUM	0:276e7a263c35	487
MACRUM	0:276e7a263c35	488	SORT_MEMBER_DOCS = YES
MACRUM	0:276e7a263c35	489
MACRUM	0:276e7a263c35	490	# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
MACRUM	0:276e7a263c35	491	# brief documentation of file, namespace and class members alphabetically
MACRUM	0:276e7a263c35	492	# by member name. If set to NO (the default) the members will appear in
MACRUM	0:276e7a263c35	493	# declaration order.
MACRUM	0:276e7a263c35	494
MACRUM	0:276e7a263c35	495	SORT_BRIEF_DOCS = NO
MACRUM	0:276e7a263c35	496
MACRUM	0:276e7a263c35	497	# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
MACRUM	0:276e7a263c35	498	# will sort the (brief and detailed) documentation of class members so that
MACRUM	0:276e7a263c35	499	# constructors and destructors are listed first. If set to NO (the default)
MACRUM	0:276e7a263c35	500	# the constructors will appear in the respective orders defined by
MACRUM	0:276e7a263c35	501	# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
MACRUM	0:276e7a263c35	502	# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
MACRUM	0:276e7a263c35	503	# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
MACRUM	0:276e7a263c35	504
MACRUM	0:276e7a263c35	505	SORT_MEMBERS_CTORS_1ST = NO
MACRUM	0:276e7a263c35	506
MACRUM	0:276e7a263c35	507	# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
MACRUM	0:276e7a263c35	508	# hierarchy of group names into alphabetical order. If set to NO (the default)
MACRUM	0:276e7a263c35	509	# the group names will appear in their defined order.
MACRUM	0:276e7a263c35	510
MACRUM	0:276e7a263c35	511	SORT_GROUP_NAMES = NO
MACRUM	0:276e7a263c35	512
MACRUM	0:276e7a263c35	513	# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
MACRUM	0:276e7a263c35	514	# sorted by fully-qualified names, including namespaces. If set to
MACRUM	0:276e7a263c35	515	# NO (the default), the class list will be sorted only by class name,
MACRUM	0:276e7a263c35	516	# not including the namespace part.
MACRUM	0:276e7a263c35	517	# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
MACRUM	0:276e7a263c35	518	# Note: This option applies only to the class list, not to the
MACRUM	0:276e7a263c35	519	# alphabetical list.
MACRUM	0:276e7a263c35	520
MACRUM	0:276e7a263c35	521	SORT_BY_SCOPE_NAME = NO
MACRUM	0:276e7a263c35	522
MACRUM	0:276e7a263c35	523	# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
MACRUM	0:276e7a263c35	524	# do proper type resolution of all parameters of a function it will reject a
MACRUM	0:276e7a263c35	525	# match between the prototype and the implementation of a member function even
MACRUM	0:276e7a263c35	526	# if there is only one candidate or it is obvious which candidate to choose
MACRUM	0:276e7a263c35	527	# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
MACRUM	0:276e7a263c35	528	# will still accept a match between prototype and implementation in such cases.
MACRUM	0:276e7a263c35	529
MACRUM	0:276e7a263c35	530	STRICT_PROTO_MATCHING = NO
MACRUM	0:276e7a263c35	531
MACRUM	0:276e7a263c35	532	# The GENERATE_TODOLIST tag can be used to enable (YES) or
MACRUM	0:276e7a263c35	533	# disable (NO) the todo list. This list is created by putting \todo
MACRUM	0:276e7a263c35	534	# commands in the documentation.
MACRUM	0:276e7a263c35	535
MACRUM	0:276e7a263c35	536	GENERATE_TODOLIST = YES
MACRUM	0:276e7a263c35	537
MACRUM	0:276e7a263c35	538	# The GENERATE_TESTLIST tag can be used to enable (YES) or
MACRUM	0:276e7a263c35	539	# disable (NO) the test list. This list is created by putting \test
MACRUM	0:276e7a263c35	540	# commands in the documentation.
MACRUM	0:276e7a263c35	541
MACRUM	0:276e7a263c35	542	GENERATE_TESTLIST = YES
MACRUM	0:276e7a263c35	543
MACRUM	0:276e7a263c35	544	# The GENERATE_BUGLIST tag can be used to enable (YES) or
MACRUM	0:276e7a263c35	545	# disable (NO) the bug list. This list is created by putting \bug
MACRUM	0:276e7a263c35	546	# commands in the documentation.
MACRUM	0:276e7a263c35	547
MACRUM	0:276e7a263c35	548	GENERATE_BUGLIST = YES
MACRUM	0:276e7a263c35	549
MACRUM	0:276e7a263c35	550	# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
MACRUM	0:276e7a263c35	551	# disable (NO) the deprecated list. This list is created by putting
MACRUM	0:276e7a263c35	552	# \deprecated commands in the documentation.
MACRUM	0:276e7a263c35	553
MACRUM	0:276e7a263c35	554	GENERATE_DEPRECATEDLIST= YES
MACRUM	0:276e7a263c35	555
MACRUM	0:276e7a263c35	556	# The ENABLED_SECTIONS tag can be used to enable conditional
MACRUM	0:276e7a263c35	557	# documentation sections, marked by \if sectionname ... \endif.
MACRUM	0:276e7a263c35	558
MACRUM	0:276e7a263c35	559	ENABLED_SECTIONS =
MACRUM	0:276e7a263c35	560
MACRUM	0:276e7a263c35	561	# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
MACRUM	0:276e7a263c35	562	# the initial value of a variable or macro consists of for it to appear in
MACRUM	0:276e7a263c35	563	# the documentation. If the initializer consists of more lines than specified
MACRUM	0:276e7a263c35	564	# here it will be hidden. Use a value of 0 to hide initializers completely.
MACRUM	0:276e7a263c35	565	# The appearance of the initializer of individual variables and macros in the
MACRUM	0:276e7a263c35	566	# documentation can be controlled using \showinitializer or \hideinitializer
MACRUM	0:276e7a263c35	567	# command in the documentation regardless of this setting.
MACRUM	0:276e7a263c35	568
MACRUM	0:276e7a263c35	569	MAX_INITIALIZER_LINES = 18
MACRUM	0:276e7a263c35	570
MACRUM	0:276e7a263c35	571	# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
MACRUM	0:276e7a263c35	572	# at the bottom of the documentation of classes and structs. If set to YES the
MACRUM	0:276e7a263c35	573	# list will mention the files that were used to generate the documentation.
MACRUM	0:276e7a263c35	574
MACRUM	0:276e7a263c35	575	SHOW_USED_FILES = YES
MACRUM	0:276e7a263c35	576
MACRUM	0:276e7a263c35	577	# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
MACRUM	0:276e7a263c35	578	# This will remove the Files entry from the Quick Index and from the
MACRUM	0:276e7a263c35	579	# Folder Tree View (if specified). The default is YES.
MACRUM	0:276e7a263c35	580
MACRUM	0:276e7a263c35	581	SHOW_FILES = YES
MACRUM	0:276e7a263c35	582
MACRUM	0:276e7a263c35	583	# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
MACRUM	0:276e7a263c35	584	# Namespaces page. This will remove the Namespaces entry from the Quick Index
MACRUM	0:276e7a263c35	585	# and from the Folder Tree View (if specified). The default is YES.
MACRUM	0:276e7a263c35	586
MACRUM	0:276e7a263c35	587	SHOW_NAMESPACES = YES
MACRUM	0:276e7a263c35	588
MACRUM	0:276e7a263c35	589	# The FILE_VERSION_FILTER tag can be used to specify a program or script that
MACRUM	0:276e7a263c35	590	# doxygen should invoke to get the current version for each file (typically from
MACRUM	0:276e7a263c35	591	# the version control system). Doxygen will invoke the program by executing (via
MACRUM	0:276e7a263c35	592	# popen()) the command <command> <input-file>, where <command> is the value of
MACRUM	0:276e7a263c35	593	# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
MACRUM	0:276e7a263c35	594	# provided by doxygen. Whatever the program writes to standard output
MACRUM	0:276e7a263c35	595	# is used as the file version. See the manual for examples.
MACRUM	0:276e7a263c35	596
MACRUM	0:276e7a263c35	597	FILE_VERSION_FILTER =
MACRUM	0:276e7a263c35	598
MACRUM	0:276e7a263c35	599	# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
MACRUM	0:276e7a263c35	600	# by doxygen. The layout file controls the global structure of the generated
MACRUM	0:276e7a263c35	601	# output files in an output format independent way. To create the layout file
MACRUM	0:276e7a263c35	602	# that represents doxygen's defaults, run doxygen with the -l option.
MACRUM	0:276e7a263c35	603	# You can optionally specify a file name after the option, if omitted
MACRUM	0:276e7a263c35	604	# DoxygenLayout.xml will be used as the name of the layout file.
MACRUM	0:276e7a263c35	605
MACRUM	0:276e7a263c35	606	LAYOUT_FILE =
MACRUM	0:276e7a263c35	607
MACRUM	0:276e7a263c35	608	# The CITE_BIB_FILES tag can be used to specify one or more bib files
MACRUM	0:276e7a263c35	609	# containing the references data. This must be a list of .bib files. The
MACRUM	0:276e7a263c35	610	# .bib extension is automatically appended if omitted. Using this command
MACRUM	0:276e7a263c35	611	# requires the bibtex tool to be installed. See also
MACRUM	0:276e7a263c35	612	# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
MACRUM	0:276e7a263c35	613	# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
MACRUM	0:276e7a263c35	614	# feature you need bibtex and perl available in the search path.
MACRUM	0:276e7a263c35	615
MACRUM	0:276e7a263c35	616	CITE_BIB_FILES =
MACRUM	0:276e7a263c35	617
MACRUM	0:276e7a263c35	618	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	619	# configuration options related to warning and progress messages
MACRUM	0:276e7a263c35	620	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	621
MACRUM	0:276e7a263c35	622	# The QUIET tag can be used to turn on/off the messages that are generated
MACRUM	0:276e7a263c35	623	# by doxygen. Possible values are YES and NO. If left blank NO is used.
MACRUM	0:276e7a263c35	624
MACRUM	0:276e7a263c35	625	QUIET = NO
MACRUM	0:276e7a263c35	626
MACRUM	0:276e7a263c35	627	# The WARNINGS tag can be used to turn on/off the warning messages that are
MACRUM	0:276e7a263c35	628	# generated by doxygen. Possible values are YES and NO. If left blank
MACRUM	0:276e7a263c35	629	# NO is used.
MACRUM	0:276e7a263c35	630
MACRUM	0:276e7a263c35	631	WARNINGS = YES
MACRUM	0:276e7a263c35	632
MACRUM	0:276e7a263c35	633	# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
MACRUM	0:276e7a263c35	634	# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
MACRUM	0:276e7a263c35	635	# automatically be disabled.
MACRUM	0:276e7a263c35	636
MACRUM	0:276e7a263c35	637	WARN_IF_UNDOCUMENTED = YES
MACRUM	0:276e7a263c35	638
MACRUM	0:276e7a263c35	639	# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
MACRUM	0:276e7a263c35	640	# potential errors in the documentation, such as not documenting some
MACRUM	0:276e7a263c35	641	# parameters in a documented function, or documenting parameters that
MACRUM	0:276e7a263c35	642	# don't exist or using markup commands wrongly.
MACRUM	0:276e7a263c35	643
MACRUM	0:276e7a263c35	644	WARN_IF_DOC_ERROR = YES
MACRUM	0:276e7a263c35	645
MACRUM	0:276e7a263c35	646	# The WARN_NO_PARAMDOC option can be enabled to get warnings for
MACRUM	0:276e7a263c35	647	# functions that are documented, but have no documentation for their parameters
MACRUM	0:276e7a263c35	648	# or return value. If set to NO (the default) doxygen will only warn about
MACRUM	0:276e7a263c35	649	# wrong or incomplete parameter documentation, but not about the absence of
MACRUM	0:276e7a263c35	650	# documentation.
MACRUM	0:276e7a263c35	651
MACRUM	0:276e7a263c35	652	WARN_NO_PARAMDOC = NO
MACRUM	0:276e7a263c35	653
MACRUM	0:276e7a263c35	654	# The WARN_FORMAT tag determines the format of the warning messages that
MACRUM	0:276e7a263c35	655	# doxygen can produce. The string should contain the $file, $line, and $text
MACRUM	0:276e7a263c35	656	# tags, which will be replaced by the file and line number from which the
MACRUM	0:276e7a263c35	657	# warning originated and the warning text. Optionally the format may contain
MACRUM	0:276e7a263c35	658	# $version, which will be replaced by the version of the file (if it could
MACRUM	0:276e7a263c35	659	# be obtained via FILE_VERSION_FILTER)
MACRUM	0:276e7a263c35	660
MACRUM	0:276e7a263c35	661	WARN_FORMAT = "$file:$line: $text"
MACRUM	0:276e7a263c35	662
MACRUM	0:276e7a263c35	663	# The WARN_LOGFILE tag can be used to specify a file to which warning
MACRUM	0:276e7a263c35	664	# and error messages should be written. If left blank the output is written
MACRUM	0:276e7a263c35	665	# to stderr.
MACRUM	0:276e7a263c35	666
MACRUM	0:276e7a263c35	667	WARN_LOGFILE =
MACRUM	0:276e7a263c35	668
MACRUM	0:276e7a263c35	669	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	670	# configuration options related to the input files
MACRUM	0:276e7a263c35	671	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	672
MACRUM	0:276e7a263c35	673	# The INPUT tag can be used to specify the files and/or directories that contain
MACRUM	0:276e7a263c35	674	# documented source files. You may enter file names like "myfile.cpp" or
MACRUM	0:276e7a263c35	675	# directories like "/usr/src/myproject". Separate the files or directories
MACRUM	0:276e7a263c35	676	# with spaces.
MACRUM	0:276e7a263c35	677
MACRUM	0:276e7a263c35	678	INPUT = ../nsdl-c
MACRUM	0:276e7a263c35	679
MACRUM	0:276e7a263c35	680	# This tag can be used to specify the character encoding of the source files
MACRUM	0:276e7a263c35	681	# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
MACRUM	0:276e7a263c35	682	# also the default input encoding. Doxygen uses libiconv (or the iconv built
MACRUM	0:276e7a263c35	683	# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
MACRUM	0:276e7a263c35	684	# the list of possible encodings.
MACRUM	0:276e7a263c35	685
MACRUM	0:276e7a263c35	686	INPUT_ENCODING = UTF-8
MACRUM	0:276e7a263c35	687
MACRUM	0:276e7a263c35	688	# If the value of the INPUT tag contains directories, you can use the
MACRUM	0:276e7a263c35	689	# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
MACRUM	0:276e7a263c35	690	# and *.h) to filter out the source-files in the directories. If left
MACRUM	0:276e7a263c35	691	# blank the following patterns are tested:
MACRUM	0:276e7a263c35	692	# .c .cc .cxx .cpp .c++ .d .java .ii .ixx .ipp .i++ .inl .h .hh
MACRUM	0:276e7a263c35	693	# .hxx .hpp .h++ .idl .odl .cs .php .php3 .inc .m .mm .dox *.py
MACRUM	0:276e7a263c35	694	# .f90 .f .for .vhd *.vhdl
MACRUM	0:276e7a263c35	695
MACRUM	0:276e7a263c35	696	FILE_PATTERNS = *.c \
MACRUM	0:276e7a263c35	697	*.cc \
MACRUM	0:276e7a263c35	698	*.cxx \
MACRUM	0:276e7a263c35	699	*.cpp \
MACRUM	0:276e7a263c35	700	*.c++ \
MACRUM	0:276e7a263c35	701	*.d \
MACRUM	0:276e7a263c35	702	*.java \
MACRUM	0:276e7a263c35	703	*.ii \
MACRUM	0:276e7a263c35	704	*.ixx \
MACRUM	0:276e7a263c35	705	*.ipp \
MACRUM	0:276e7a263c35	706	*.i++ \
MACRUM	0:276e7a263c35	707	*.inl \
MACRUM	0:276e7a263c35	708	*.h \
MACRUM	0:276e7a263c35	709	*.hh \
MACRUM	0:276e7a263c35	710	*.hxx \
MACRUM	0:276e7a263c35	711	*.hpp \
MACRUM	0:276e7a263c35	712	*.h++ \
MACRUM	0:276e7a263c35	713	*.idl \
MACRUM	0:276e7a263c35	714	*.odl \
MACRUM	0:276e7a263c35	715	*.cs \
MACRUM	0:276e7a263c35	716	*.php \
MACRUM	0:276e7a263c35	717	*.php3 \
MACRUM	0:276e7a263c35	718	*.inc \
MACRUM	0:276e7a263c35	719	*.m \
MACRUM	0:276e7a263c35	720	*.markdown \
MACRUM	0:276e7a263c35	721	*.md \
MACRUM	0:276e7a263c35	722	*.mm \
MACRUM	0:276e7a263c35	723	*.dox \
MACRUM	0:276e7a263c35	724	*.py \
MACRUM	0:276e7a263c35	725	*.f90 \
MACRUM	0:276e7a263c35	726	*.f \
MACRUM	0:276e7a263c35	727	*.for \
MACRUM	0:276e7a263c35	728	*.vhd \
MACRUM	0:276e7a263c35	729	*.vhdl
MACRUM	0:276e7a263c35	730
MACRUM	0:276e7a263c35	731	# The RECURSIVE tag can be used to turn specify whether or not subdirectories
MACRUM	0:276e7a263c35	732	# should be searched for input files as well. Possible values are YES and NO.
MACRUM	0:276e7a263c35	733	# If left blank NO is used.
MACRUM	0:276e7a263c35	734
MACRUM	0:276e7a263c35	735	RECURSIVE = YES
MACRUM	0:276e7a263c35	736
MACRUM	0:276e7a263c35	737	# The EXCLUDE tag can be used to specify files and/or directories that should be
MACRUM	0:276e7a263c35	738	# excluded from the INPUT source files. This way you can easily exclude a
MACRUM	0:276e7a263c35	739	# subdirectory from a directory tree whose root is specified with the INPUT tag.
MACRUM	0:276e7a263c35	740	# Note that relative paths are relative to the directory from which doxygen is
MACRUM	0:276e7a263c35	741	# run.
MACRUM	0:276e7a263c35	742
MACRUM	0:276e7a263c35	743	EXCLUDE =
MACRUM	0:276e7a263c35	744
MACRUM	0:276e7a263c35	745	# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
MACRUM	0:276e7a263c35	746	# directories that are symbolic links (a Unix file system feature) are excluded
MACRUM	0:276e7a263c35	747	# from the input.
MACRUM	0:276e7a263c35	748
MACRUM	0:276e7a263c35	749	EXCLUDE_SYMLINKS = NO
MACRUM	0:276e7a263c35	750
MACRUM	0:276e7a263c35	751	# If the value of the INPUT tag contains directories, you can use the
MACRUM	0:276e7a263c35	752	# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
MACRUM	0:276e7a263c35	753	# certain files from those directories. Note that the wildcards are matched
MACRUM	0:276e7a263c35	754	# against the file with absolute path, so to exclude all test directories
MACRUM	0:276e7a263c35	755	# for example use the pattern /test/
MACRUM	0:276e7a263c35	756
MACRUM	0:276e7a263c35	757	EXCLUDE_PATTERNS =
MACRUM	0:276e7a263c35	758
MACRUM	0:276e7a263c35	759	# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
MACRUM	0:276e7a263c35	760	# (namespaces, classes, functions, etc.) that should be excluded from the
MACRUM	0:276e7a263c35	761	# output. The symbol name can be a fully qualified name, a word, or if the
MACRUM	0:276e7a263c35	762	# wildcard * is used, a substring. Examples: ANamespace, AClass,
MACRUM	0:276e7a263c35	763	# AClass::ANamespace, ANamespace::*Test
MACRUM	0:276e7a263c35	764
MACRUM	0:276e7a263c35	765	EXCLUDE_SYMBOLS =
MACRUM	0:276e7a263c35	766
MACRUM	0:276e7a263c35	767	# The EXAMPLE_PATH tag can be used to specify one or more files or
MACRUM	0:276e7a263c35	768	# directories that contain example code fragments that are included (see
MACRUM	0:276e7a263c35	769	# the \include command).
MACRUM	0:276e7a263c35	770
MACRUM	0:276e7a263c35	771	EXAMPLE_PATH =
MACRUM	0:276e7a263c35	772
MACRUM	0:276e7a263c35	773	# If the value of the EXAMPLE_PATH tag contains directories, you can use the
MACRUM	0:276e7a263c35	774	# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
MACRUM	0:276e7a263c35	775	# and *.h) to filter out the source-files in the directories. If left
MACRUM	0:276e7a263c35	776	# blank all files are included.
MACRUM	0:276e7a263c35	777
MACRUM	0:276e7a263c35	778	EXAMPLE_PATTERNS = *
MACRUM	0:276e7a263c35	779
MACRUM	0:276e7a263c35	780	# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
MACRUM	0:276e7a263c35	781	# searched for input files to be used with the \include or \dontinclude
MACRUM	0:276e7a263c35	782	# commands irrespective of the value of the RECURSIVE tag.
MACRUM	0:276e7a263c35	783	# Possible values are YES and NO. If left blank NO is used.
MACRUM	0:276e7a263c35	784
MACRUM	0:276e7a263c35	785	EXAMPLE_RECURSIVE = NO
MACRUM	0:276e7a263c35	786
MACRUM	0:276e7a263c35	787	# The IMAGE_PATH tag can be used to specify one or more files or
MACRUM	0:276e7a263c35	788	# directories that contain image that are included in the documentation (see
MACRUM	0:276e7a263c35	789	# the \image command).
MACRUM	0:276e7a263c35	790
MACRUM	0:276e7a263c35	791	IMAGE_PATH =
MACRUM	0:276e7a263c35	792
MACRUM	0:276e7a263c35	793	# The INPUT_FILTER tag can be used to specify a program that doxygen should
MACRUM	0:276e7a263c35	794	# invoke to filter for each input file. Doxygen will invoke the filter program
MACRUM	0:276e7a263c35	795	# by executing (via popen()) the command <filter> <input-file>, where <filter>
MACRUM	0:276e7a263c35	796	# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
MACRUM	0:276e7a263c35	797	# input file. Doxygen will then use the output that the filter program writes
MACRUM	0:276e7a263c35	798	# to standard output. If FILTER_PATTERNS is specified, this tag will be
MACRUM	0:276e7a263c35	799	# ignored.
MACRUM	0:276e7a263c35	800
MACRUM	0:276e7a263c35	801	INPUT_FILTER =
MACRUM	0:276e7a263c35	802
MACRUM	0:276e7a263c35	803	# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
MACRUM	0:276e7a263c35	804	# basis. Doxygen will compare the file name with each pattern and apply the
MACRUM	0:276e7a263c35	805	# filter if there is a match. The filters are a list of the form:
MACRUM	0:276e7a263c35	806	# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
MACRUM	0:276e7a263c35	807	# info on how filters are used. If FILTER_PATTERNS is empty or if
MACRUM	0:276e7a263c35	808	# non of the patterns match the file name, INPUT_FILTER is applied.
MACRUM	0:276e7a263c35	809
MACRUM	0:276e7a263c35	810	FILTER_PATTERNS =
MACRUM	0:276e7a263c35	811
MACRUM	0:276e7a263c35	812	# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
MACRUM	0:276e7a263c35	813	# INPUT_FILTER) will be used to filter the input files when producing source
MACRUM	0:276e7a263c35	814	# files to browse (i.e. when SOURCE_BROWSER is set to YES).
MACRUM	0:276e7a263c35	815
MACRUM	0:276e7a263c35	816	FILTER_SOURCE_FILES = NO
MACRUM	0:276e7a263c35	817
MACRUM	0:276e7a263c35	818	# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
MACRUM	0:276e7a263c35	819	# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
MACRUM	0:276e7a263c35	820	# and it is also possible to disable source filtering for a specific pattern
MACRUM	0:276e7a263c35	821	# using *.ext= (so without naming a filter). This option only has effect when
MACRUM	0:276e7a263c35	822	# FILTER_SOURCE_FILES is enabled.
MACRUM	0:276e7a263c35	823
MACRUM	0:276e7a263c35	824	FILTER_SOURCE_PATTERNS =
MACRUM	0:276e7a263c35	825
MACRUM	0:276e7a263c35	826	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	827	# configuration options related to source browsing
MACRUM	0:276e7a263c35	828	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	829
MACRUM	0:276e7a263c35	830	# If the SOURCE_BROWSER tag is set to YES then a list of source files will
MACRUM	0:276e7a263c35	831	# be generated. Documented entities will be cross-referenced with these sources.
MACRUM	0:276e7a263c35	832	# Note: To get rid of all source code in the generated output, make sure also
MACRUM	0:276e7a263c35	833	# VERBATIM_HEADERS is set to NO.
MACRUM	0:276e7a263c35	834
MACRUM	0:276e7a263c35	835	SOURCE_BROWSER = NO
MACRUM	0:276e7a263c35	836
MACRUM	0:276e7a263c35	837	# Setting the INLINE_SOURCES tag to YES will include the body
MACRUM	0:276e7a263c35	838	# of functions and classes directly in the documentation.
MACRUM	0:276e7a263c35	839
MACRUM	0:276e7a263c35	840	INLINE_SOURCES = NO
MACRUM	0:276e7a263c35	841
MACRUM	0:276e7a263c35	842	# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
MACRUM	0:276e7a263c35	843	# doxygen to hide any special comment blocks from generated source code
MACRUM	0:276e7a263c35	844	# fragments. Normal C, C++ and Fortran comments will always remain visible.
MACRUM	0:276e7a263c35	845
MACRUM	0:276e7a263c35	846	STRIP_CODE_COMMENTS = YES
MACRUM	0:276e7a263c35	847
MACRUM	0:276e7a263c35	848	# If the REFERENCED_BY_RELATION tag is set to YES
MACRUM	0:276e7a263c35	849	# then for each documented function all documented
MACRUM	0:276e7a263c35	850	# functions referencing it will be listed.
MACRUM	0:276e7a263c35	851
MACRUM	0:276e7a263c35	852	REFERENCED_BY_RELATION = NO
MACRUM	0:276e7a263c35	853
MACRUM	0:276e7a263c35	854	# If the REFERENCES_RELATION tag is set to YES
MACRUM	0:276e7a263c35	855	# then for each documented function all documented entities
MACRUM	0:276e7a263c35	856	# called/used by that function will be listed.
MACRUM	0:276e7a263c35	857
MACRUM	0:276e7a263c35	858	REFERENCES_RELATION = NO
MACRUM	0:276e7a263c35	859
MACRUM	0:276e7a263c35	860	# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
MACRUM	0:276e7a263c35	861	# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
MACRUM	0:276e7a263c35	862	# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
MACRUM	0:276e7a263c35	863	# link to the source code. Otherwise they will link to the documentation.
MACRUM	0:276e7a263c35	864
MACRUM	0:276e7a263c35	865	REFERENCES_LINK_SOURCE = YES
MACRUM	0:276e7a263c35	866
MACRUM	0:276e7a263c35	867	# If the USE_HTAGS tag is set to YES then the references to source code
MACRUM	0:276e7a263c35	868	# will point to the HTML generated by the htags(1) tool instead of doxygen
MACRUM	0:276e7a263c35	869	# built-in source browser. The htags tool is part of GNU's global source
MACRUM	0:276e7a263c35	870	# tagging system (see http://www.gnu.org/software/global/global.html). You
MACRUM	0:276e7a263c35	871	# will need version 4.8.6 or higher.
MACRUM	0:276e7a263c35	872
MACRUM	0:276e7a263c35	873	USE_HTAGS = NO
MACRUM	0:276e7a263c35	874
MACRUM	0:276e7a263c35	875	# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
MACRUM	0:276e7a263c35	876	# will generate a verbatim copy of the header file for each class for
MACRUM	0:276e7a263c35	877	# which an include is specified. Set to NO to disable this.
MACRUM	0:276e7a263c35	878
MACRUM	0:276e7a263c35	879	VERBATIM_HEADERS = YES
MACRUM	0:276e7a263c35	880
MACRUM	0:276e7a263c35	881	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	882	# configuration options related to the alphabetical class index
MACRUM	0:276e7a263c35	883	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	884
MACRUM	0:276e7a263c35	885	# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
MACRUM	0:276e7a263c35	886	# of all compounds will be generated. Enable this if the project
MACRUM	0:276e7a263c35	887	# contains a lot of classes, structs, unions or interfaces.
MACRUM	0:276e7a263c35	888
MACRUM	0:276e7a263c35	889	ALPHABETICAL_INDEX = YES
MACRUM	0:276e7a263c35	890
MACRUM	0:276e7a263c35	891	# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
MACRUM	0:276e7a263c35	892	# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
MACRUM	0:276e7a263c35	893	# in which this list will be split (can be a number in the range [1..20])
MACRUM	0:276e7a263c35	894
MACRUM	0:276e7a263c35	895	COLS_IN_ALPHA_INDEX = 5
MACRUM	0:276e7a263c35	896
MACRUM	0:276e7a263c35	897	# In case all classes in a project start with a common prefix, all
MACRUM	0:276e7a263c35	898	# classes will be put under the same header in the alphabetical index.
MACRUM	0:276e7a263c35	899	# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
MACRUM	0:276e7a263c35	900	# should be ignored while generating the index headers.
MACRUM	0:276e7a263c35	901
MACRUM	0:276e7a263c35	902	IGNORE_PREFIX =
MACRUM	0:276e7a263c35	903
MACRUM	0:276e7a263c35	904	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	905	# configuration options related to the HTML output
MACRUM	0:276e7a263c35	906	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	907
MACRUM	0:276e7a263c35	908	# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
MACRUM	0:276e7a263c35	909	# generate HTML output.
MACRUM	0:276e7a263c35	910
MACRUM	0:276e7a263c35	911	GENERATE_HTML = YES
MACRUM	0:276e7a263c35	912
MACRUM	0:276e7a263c35	913	# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
MACRUM	0:276e7a263c35	914	# If a relative path is entered the value of OUTPUT_DIRECTORY will be
MACRUM	0:276e7a263c35	915	# put in front of it. If left blank `html' will be used as the default path.
MACRUM	0:276e7a263c35	916
MACRUM	0:276e7a263c35	917	HTML_OUTPUT = html
MACRUM	0:276e7a263c35	918
MACRUM	0:276e7a263c35	919	# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
MACRUM	0:276e7a263c35	920	# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
MACRUM	0:276e7a263c35	921	# doxygen will generate files with .html extension.
MACRUM	0:276e7a263c35	922
MACRUM	0:276e7a263c35	923	HTML_FILE_EXTENSION = .html
MACRUM	0:276e7a263c35	924
MACRUM	0:276e7a263c35	925	# The HTML_HEADER tag can be used to specify a personal HTML header for
MACRUM	0:276e7a263c35	926	# each generated HTML page. If it is left blank doxygen will generate a
MACRUM	0:276e7a263c35	927	# standard header. Note that when using a custom header you are responsible
MACRUM	0:276e7a263c35	928	# for the proper inclusion of any scripts and style sheets that doxygen
MACRUM	0:276e7a263c35	929	# needs, which is dependent on the configuration options used.
MACRUM	0:276e7a263c35	930	# It is advised to generate a default header using "doxygen -w html
MACRUM	0:276e7a263c35	931	# header.html footer.html stylesheet.css YourConfigFile" and then modify
MACRUM	0:276e7a263c35	932	# that header. Note that the header is subject to change so you typically
MACRUM	0:276e7a263c35	933	# have to redo this when upgrading to a newer version of doxygen or when
MACRUM	0:276e7a263c35	934	# changing the value of configuration settings such as GENERATE_TREEVIEW!
MACRUM	0:276e7a263c35	935
MACRUM	0:276e7a263c35	936	HTML_HEADER =
MACRUM	0:276e7a263c35	937
MACRUM	0:276e7a263c35	938	# The HTML_FOOTER tag can be used to specify a personal HTML footer for
MACRUM	0:276e7a263c35	939	# each generated HTML page. If it is left blank doxygen will generate a
MACRUM	0:276e7a263c35	940	# standard footer.
MACRUM	0:276e7a263c35	941
MACRUM	0:276e7a263c35	942	HTML_FOOTER =
MACRUM	0:276e7a263c35	943
MACRUM	0:276e7a263c35	944	# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
MACRUM	0:276e7a263c35	945	# style sheet that is used by each HTML page. It can be used to
MACRUM	0:276e7a263c35	946	# fine-tune the look of the HTML output. If left blank doxygen will
MACRUM	0:276e7a263c35	947	# generate a default style sheet. Note that it is recommended to use
MACRUM	0:276e7a263c35	948	# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
MACRUM	0:276e7a263c35	949	# tag will in the future become obsolete.
MACRUM	0:276e7a263c35	950
MACRUM	0:276e7a263c35	951	HTML_STYLESHEET =
MACRUM	0:276e7a263c35	952
MACRUM	0:276e7a263c35	953	# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
MACRUM	0:276e7a263c35	954	# user-defined cascading style sheet that is included after the standard
MACRUM	0:276e7a263c35	955	# style sheets created by doxygen. Using this option one can overrule
MACRUM	0:276e7a263c35	956	# certain style aspects. This is preferred over using HTML_STYLESHEET
MACRUM	0:276e7a263c35	957	# since it does not replace the standard style sheet and is therefor more
MACRUM	0:276e7a263c35	958	# robust against future updates. Doxygen will copy the style sheet file to
MACRUM	0:276e7a263c35	959	# the output directory.
MACRUM	0:276e7a263c35	960
MACRUM	0:276e7a263c35	961	HTML_EXTRA_STYLESHEET =
MACRUM	0:276e7a263c35	962
MACRUM	0:276e7a263c35	963	# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
MACRUM	0:276e7a263c35	964	# other source files which should be copied to the HTML output directory. Note
MACRUM	0:276e7a263c35	965	# that these files will be copied to the base HTML output directory. Use the
MACRUM	0:276e7a263c35	966	# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
MACRUM	0:276e7a263c35	967	# files. In the HTML_STYLESHEET file, use the file name only. Also note that
MACRUM	0:276e7a263c35	968	# the files will be copied as-is; there are no commands or markers available.
MACRUM	0:276e7a263c35	969
MACRUM	0:276e7a263c35	970	HTML_EXTRA_FILES =
MACRUM	0:276e7a263c35	971
MACRUM	0:276e7a263c35	972	# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
MACRUM	0:276e7a263c35	973	# Doxygen will adjust the colors in the style sheet and background images
MACRUM	0:276e7a263c35	974	# according to this color. Hue is specified as an angle on a colorwheel,
MACRUM	0:276e7a263c35	975	# see http://en.wikipedia.org/wiki/Hue for more information.
MACRUM	0:276e7a263c35	976	# For instance the value 0 represents red, 60 is yellow, 120 is green,
MACRUM	0:276e7a263c35	977	# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
MACRUM	0:276e7a263c35	978	# The allowed range is 0 to 359.
MACRUM	0:276e7a263c35	979
MACRUM	0:276e7a263c35	980	HTML_COLORSTYLE_HUE = 220
MACRUM	0:276e7a263c35	981
MACRUM	0:276e7a263c35	982	# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
MACRUM	0:276e7a263c35	983	# the colors in the HTML output. For a value of 0 the output will use
MACRUM	0:276e7a263c35	984	# grayscales only. A value of 255 will produce the most vivid colors.
MACRUM	0:276e7a263c35	985
MACRUM	0:276e7a263c35	986	HTML_COLORSTYLE_SAT = 100
MACRUM	0:276e7a263c35	987
MACRUM	0:276e7a263c35	988	# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
MACRUM	0:276e7a263c35	989	# the luminance component of the colors in the HTML output. Values below
MACRUM	0:276e7a263c35	990	# 100 gradually make the output lighter, whereas values above 100 make
MACRUM	0:276e7a263c35	991	# the output darker. The value divided by 100 is the actual gamma applied,
MACRUM	0:276e7a263c35	992	# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
MACRUM	0:276e7a263c35	993	# and 100 does not change the gamma.
MACRUM	0:276e7a263c35	994
MACRUM	0:276e7a263c35	995	HTML_COLORSTYLE_GAMMA = 80
MACRUM	0:276e7a263c35	996
MACRUM	0:276e7a263c35	997	# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
MACRUM	0:276e7a263c35	998	# page will contain the date and time when the page was generated. Setting
MACRUM	0:276e7a263c35	999	# this to NO can help when comparing the output of multiple runs.
MACRUM	0:276e7a263c35	1000
MACRUM	0:276e7a263c35	1001	HTML_TIMESTAMP = YES
MACRUM	0:276e7a263c35	1002
MACRUM	0:276e7a263c35	1003	# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
MACRUM	0:276e7a263c35	1004	# documentation will contain sections that can be hidden and shown after the
MACRUM	0:276e7a263c35	1005	# page has loaded.
MACRUM	0:276e7a263c35	1006
MACRUM	0:276e7a263c35	1007	HTML_DYNAMIC_SECTIONS = NO
MACRUM	0:276e7a263c35	1008
MACRUM	0:276e7a263c35	1009	# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
MACRUM	0:276e7a263c35	1010	# entries shown in the various tree structured indices initially; the user
MACRUM	0:276e7a263c35	1011	# can expand and collapse entries dynamically later on. Doxygen will expand
MACRUM	0:276e7a263c35	1012	# the tree to such a level that at most the specified number of entries are
MACRUM	0:276e7a263c35	1013	# visible (unless a fully collapsed tree already exceeds this amount).
MACRUM	0:276e7a263c35	1014	# So setting the number of entries 1 will produce a full collapsed tree by
MACRUM	0:276e7a263c35	1015	# default. 0 is a special value representing an infinite number of entries
MACRUM	0:276e7a263c35	1016	# and will result in a full expanded tree by default.
MACRUM	0:276e7a263c35	1017
MACRUM	0:276e7a263c35	1018	HTML_INDEX_NUM_ENTRIES = 100
MACRUM	0:276e7a263c35	1019
MACRUM	0:276e7a263c35	1020	# If the GENERATE_DOCSET tag is set to YES, additional index files
MACRUM	0:276e7a263c35	1021	# will be generated that can be used as input for Apple's Xcode 3
MACRUM	0:276e7a263c35	1022	# integrated development environment, introduced with OSX 10.5 (Leopard).
MACRUM	0:276e7a263c35	1023	# To create a documentation set, doxygen will generate a Makefile in the
MACRUM	0:276e7a263c35	1024	# HTML output directory. Running make will produce the docset in that
MACRUM	0:276e7a263c35	1025	# directory and running "make install" will install the docset in
MACRUM	0:276e7a263c35	1026	# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
MACRUM	0:276e7a263c35	1027	# it at startup.
MACRUM	0:276e7a263c35	1028	# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
MACRUM	0:276e7a263c35	1029	# for more information.
MACRUM	0:276e7a263c35	1030
MACRUM	0:276e7a263c35	1031	GENERATE_DOCSET = NO
MACRUM	0:276e7a263c35	1032
MACRUM	0:276e7a263c35	1033	# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
MACRUM	0:276e7a263c35	1034	# feed. A documentation feed provides an umbrella under which multiple
MACRUM	0:276e7a263c35	1035	# documentation sets from a single provider (such as a company or product suite)
MACRUM	0:276e7a263c35	1036	# can be grouped.
MACRUM	0:276e7a263c35	1037
MACRUM	0:276e7a263c35	1038	DOCSET_FEEDNAME = "Doxygen generated docs"
MACRUM	0:276e7a263c35	1039
MACRUM	0:276e7a263c35	1040	# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
MACRUM	0:276e7a263c35	1041	# should uniquely identify the documentation set bundle. This should be a
MACRUM	0:276e7a263c35	1042	# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
MACRUM	0:276e7a263c35	1043	# will append .docset to the name.
MACRUM	0:276e7a263c35	1044
MACRUM	0:276e7a263c35	1045	DOCSET_BUNDLE_ID = org.doxygen.Project
MACRUM	0:276e7a263c35	1046
MACRUM	0:276e7a263c35	1047	# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
MACRUM	0:276e7a263c35	1048	# identify the documentation publisher. This should be a reverse domain-name
MACRUM	0:276e7a263c35	1049	# style string, e.g. com.mycompany.MyDocSet.documentation.
MACRUM	0:276e7a263c35	1050
MACRUM	0:276e7a263c35	1051	DOCSET_PUBLISHER_ID = org.doxygen.Publisher
MACRUM	0:276e7a263c35	1052
MACRUM	0:276e7a263c35	1053	# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
MACRUM	0:276e7a263c35	1054
MACRUM	0:276e7a263c35	1055	DOCSET_PUBLISHER_NAME = Publisher
MACRUM	0:276e7a263c35	1056
MACRUM	0:276e7a263c35	1057	# If the GENERATE_HTMLHELP tag is set to YES, additional index files
MACRUM	0:276e7a263c35	1058	# will be generated that can be used as input for tools like the
MACRUM	0:276e7a263c35	1059	# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
MACRUM	0:276e7a263c35	1060	# of the generated HTML documentation.
MACRUM	0:276e7a263c35	1061
MACRUM	0:276e7a263c35	1062	GENERATE_HTMLHELP = NO
MACRUM	0:276e7a263c35	1063
MACRUM	0:276e7a263c35	1064	# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
MACRUM	0:276e7a263c35	1065	# be used to specify the file name of the resulting .chm file. You
MACRUM	0:276e7a263c35	1066	# can add a path in front of the file if the result should not be
MACRUM	0:276e7a263c35	1067	# written to the html output directory.
MACRUM	0:276e7a263c35	1068
MACRUM	0:276e7a263c35	1069	CHM_FILE =
MACRUM	0:276e7a263c35	1070
MACRUM	0:276e7a263c35	1071	# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
MACRUM	0:276e7a263c35	1072	# be used to specify the location (absolute path including file name) of
MACRUM	0:276e7a263c35	1073	# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
MACRUM	0:276e7a263c35	1074	# the HTML help compiler on the generated index.hhp.
MACRUM	0:276e7a263c35	1075
MACRUM	0:276e7a263c35	1076	HHC_LOCATION =
MACRUM	0:276e7a263c35	1077
MACRUM	0:276e7a263c35	1078	# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
MACRUM	0:276e7a263c35	1079	# controls if a separate .chi index file is generated (YES) or that
MACRUM	0:276e7a263c35	1080	# it should be included in the master .chm file (NO).
MACRUM	0:276e7a263c35	1081
MACRUM	0:276e7a263c35	1082	GENERATE_CHI = NO
MACRUM	0:276e7a263c35	1083
MACRUM	0:276e7a263c35	1084	# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
MACRUM	0:276e7a263c35	1085	# is used to encode HtmlHelp index (hhk), content (hhc) and project file
MACRUM	0:276e7a263c35	1086	# content.
MACRUM	0:276e7a263c35	1087
MACRUM	0:276e7a263c35	1088	CHM_INDEX_ENCODING =
MACRUM	0:276e7a263c35	1089
MACRUM	0:276e7a263c35	1090	# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
MACRUM	0:276e7a263c35	1091	# controls whether a binary table of contents is generated (YES) or a
MACRUM	0:276e7a263c35	1092	# normal table of contents (NO) in the .chm file.
MACRUM	0:276e7a263c35	1093
MACRUM	0:276e7a263c35	1094	BINARY_TOC = NO
MACRUM	0:276e7a263c35	1095
MACRUM	0:276e7a263c35	1096	# The TOC_EXPAND flag can be set to YES to add extra items for group members
MACRUM	0:276e7a263c35	1097	# to the contents of the HTML help documentation and to the tree view.
MACRUM	0:276e7a263c35	1098
MACRUM	0:276e7a263c35	1099	TOC_EXPAND = NO
MACRUM	0:276e7a263c35	1100
MACRUM	0:276e7a263c35	1101	# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
MACRUM	0:276e7a263c35	1102	# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
MACRUM	0:276e7a263c35	1103	# that can be used as input for Qt's qhelpgenerator to generate a
MACRUM	0:276e7a263c35	1104	# Qt Compressed Help (.qch) of the generated HTML documentation.
MACRUM	0:276e7a263c35	1105
MACRUM	0:276e7a263c35	1106	GENERATE_QHP = NO
MACRUM	0:276e7a263c35	1107
MACRUM	0:276e7a263c35	1108	# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
MACRUM	0:276e7a263c35	1109	# be used to specify the file name of the resulting .qch file.
MACRUM	0:276e7a263c35	1110	# The path specified is relative to the HTML output folder.
MACRUM	0:276e7a263c35	1111
MACRUM	0:276e7a263c35	1112	QCH_FILE =
MACRUM	0:276e7a263c35	1113
MACRUM	0:276e7a263c35	1114	# The QHP_NAMESPACE tag specifies the namespace to use when generating
MACRUM	0:276e7a263c35	1115	# Qt Help Project output. For more information please see
MACRUM	0:276e7a263c35	1116	# http://doc.trolltech.com/qthelpproject.html#namespace
MACRUM	0:276e7a263c35	1117
MACRUM	0:276e7a263c35	1118	QHP_NAMESPACE = org.doxygen.Project
MACRUM	0:276e7a263c35	1119
MACRUM	0:276e7a263c35	1120	# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
MACRUM	0:276e7a263c35	1121	# Qt Help Project output. For more information please see
MACRUM	0:276e7a263c35	1122	# http://doc.trolltech.com/qthelpproject.html#virtual-folders
MACRUM	0:276e7a263c35	1123
MACRUM	0:276e7a263c35	1124	QHP_VIRTUAL_FOLDER = doc
MACRUM	0:276e7a263c35	1125
MACRUM	0:276e7a263c35	1126	# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
MACRUM	0:276e7a263c35	1127	# add. For more information please see
MACRUM	0:276e7a263c35	1128	# http://doc.trolltech.com/qthelpproject.html#custom-filters
MACRUM	0:276e7a263c35	1129
MACRUM	0:276e7a263c35	1130	QHP_CUST_FILTER_NAME =
MACRUM	0:276e7a263c35	1131
MACRUM	0:276e7a263c35	1132	# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
MACRUM	0:276e7a263c35	1133	# custom filter to add. For more information please see
MACRUM	0:276e7a263c35	1134	# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
MACRUM	0:276e7a263c35	1135	# Qt Help Project / Custom Filters</a>.
MACRUM	0:276e7a263c35	1136
MACRUM	0:276e7a263c35	1137	QHP_CUST_FILTER_ATTRS =
MACRUM	0:276e7a263c35	1138
MACRUM	0:276e7a263c35	1139	# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
MACRUM	0:276e7a263c35	1140	# project's
MACRUM	0:276e7a263c35	1141	# filter section matches.
MACRUM	0:276e7a263c35	1142	# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
MACRUM	0:276e7a263c35	1143	# Qt Help Project / Filter Attributes</a>.
MACRUM	0:276e7a263c35	1144
MACRUM	0:276e7a263c35	1145	QHP_SECT_FILTER_ATTRS =
MACRUM	0:276e7a263c35	1146
MACRUM	0:276e7a263c35	1147	# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
MACRUM	0:276e7a263c35	1148	# be used to specify the location of Qt's qhelpgenerator.
MACRUM	0:276e7a263c35	1149	# If non-empty doxygen will try to run qhelpgenerator on the generated
MACRUM	0:276e7a263c35	1150	# .qhp file.
MACRUM	0:276e7a263c35	1151
MACRUM	0:276e7a263c35	1152	QHG_LOCATION =
MACRUM	0:276e7a263c35	1153
MACRUM	0:276e7a263c35	1154	# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
MACRUM	0:276e7a263c35	1155	# will be generated, which together with the HTML files, form an Eclipse help
MACRUM	0:276e7a263c35	1156	# plugin. To install this plugin and make it available under the help contents
MACRUM	0:276e7a263c35	1157	# menu in Eclipse, the contents of the directory containing the HTML and XML
MACRUM	0:276e7a263c35	1158	# files needs to be copied into the plugins directory of eclipse. The name of
MACRUM	0:276e7a263c35	1159	# the directory within the plugins directory should be the same as
MACRUM	0:276e7a263c35	1160	# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
MACRUM	0:276e7a263c35	1161	# the help appears.
MACRUM	0:276e7a263c35	1162
MACRUM	0:276e7a263c35	1163	GENERATE_ECLIPSEHELP = NO
MACRUM	0:276e7a263c35	1164
MACRUM	0:276e7a263c35	1165	# A unique identifier for the eclipse help plugin. When installing the plugin
MACRUM	0:276e7a263c35	1166	# the directory name containing the HTML and XML files should also have
MACRUM	0:276e7a263c35	1167	# this name.
MACRUM	0:276e7a263c35	1168
MACRUM	0:276e7a263c35	1169	ECLIPSE_DOC_ID = org.doxygen.Project
MACRUM	0:276e7a263c35	1170
MACRUM	0:276e7a263c35	1171	# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
MACRUM	0:276e7a263c35	1172	# at top of each HTML page. The value NO (the default) enables the index and
MACRUM	0:276e7a263c35	1173	# the value YES disables it. Since the tabs have the same information as the
MACRUM	0:276e7a263c35	1174	# navigation tree you can set this option to NO if you already set
MACRUM	0:276e7a263c35	1175	# GENERATE_TREEVIEW to YES.
MACRUM	0:276e7a263c35	1176
MACRUM	0:276e7a263c35	1177	DISABLE_INDEX = NO
MACRUM	0:276e7a263c35	1178
MACRUM	0:276e7a263c35	1179	# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
MACRUM	0:276e7a263c35	1180	# structure should be generated to display hierarchical information.
MACRUM	0:276e7a263c35	1181	# If the tag value is set to YES, a side panel will be generated
MACRUM	0:276e7a263c35	1182	# containing a tree-like index structure (just like the one that
MACRUM	0:276e7a263c35	1183	# is generated for HTML Help). For this to work a browser that supports
MACRUM	0:276e7a263c35	1184	# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
MACRUM	0:276e7a263c35	1185	# Windows users are probably better off using the HTML help feature.
MACRUM	0:276e7a263c35	1186	# Since the tree basically has the same information as the tab index you
MACRUM	0:276e7a263c35	1187	# could consider to set DISABLE_INDEX to NO when enabling this option.
MACRUM	0:276e7a263c35	1188
MACRUM	0:276e7a263c35	1189	GENERATE_TREEVIEW = NO
MACRUM	0:276e7a263c35	1190
MACRUM	0:276e7a263c35	1191	# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
MACRUM	0:276e7a263c35	1192	# (range [0,1..20]) that doxygen will group on one line in the generated HTML
MACRUM	0:276e7a263c35	1193	# documentation. Note that a value of 0 will completely suppress the enum
MACRUM	0:276e7a263c35	1194	# values from appearing in the overview section.
MACRUM	0:276e7a263c35	1195
MACRUM	0:276e7a263c35	1196	ENUM_VALUES_PER_LINE = 4
MACRUM	0:276e7a263c35	1197
MACRUM	0:276e7a263c35	1198	# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
MACRUM	0:276e7a263c35	1199	# used to set the initial width (in pixels) of the frame in which the tree
MACRUM	0:276e7a263c35	1200	# is shown.
MACRUM	0:276e7a263c35	1201
MACRUM	0:276e7a263c35	1202	TREEVIEW_WIDTH = 250
MACRUM	0:276e7a263c35	1203
MACRUM	0:276e7a263c35	1204	# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
MACRUM	0:276e7a263c35	1205	# links to external symbols imported via tag files in a separate window.
MACRUM	0:276e7a263c35	1206
MACRUM	0:276e7a263c35	1207	EXT_LINKS_IN_WINDOW = NO
MACRUM	0:276e7a263c35	1208
MACRUM	0:276e7a263c35	1209	# Use this tag to change the font size of Latex formulas included
MACRUM	0:276e7a263c35	1210	# as images in the HTML documentation. The default is 10. Note that
MACRUM	0:276e7a263c35	1211	# when you change the font size after a successful doxygen run you need
MACRUM	0:276e7a263c35	1212	# to manually remove any form_*.png images from the HTML output directory
MACRUM	0:276e7a263c35	1213	# to force them to be regenerated.
MACRUM	0:276e7a263c35	1214
MACRUM	0:276e7a263c35	1215	FORMULA_FONTSIZE = 10
MACRUM	0:276e7a263c35	1216
MACRUM	0:276e7a263c35	1217	# Use the FORMULA_TRANPARENT tag to determine whether or not the images
MACRUM	0:276e7a263c35	1218	# generated for formulas are transparent PNGs. Transparent PNGs are
MACRUM	0:276e7a263c35	1219	# not supported properly for IE 6.0, but are supported on all modern browsers.
MACRUM	0:276e7a263c35	1220	# Note that when changing this option you need to delete any form_*.png files
MACRUM	0:276e7a263c35	1221	# in the HTML output before the changes have effect.
MACRUM	0:276e7a263c35	1222
MACRUM	0:276e7a263c35	1223	FORMULA_TRANSPARENT = YES
MACRUM	0:276e7a263c35	1224
MACRUM	0:276e7a263c35	1225	# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
MACRUM	0:276e7a263c35	1226	# (see http://www.mathjax.org) which uses client side Javascript for the
MACRUM	0:276e7a263c35	1227	# rendering instead of using prerendered bitmaps. Use this if you do not
MACRUM	0:276e7a263c35	1228	# have LaTeX installed or if you want to formulas look prettier in the HTML
MACRUM	0:276e7a263c35	1229	# output. When enabled you may also need to install MathJax separately and
MACRUM	0:276e7a263c35	1230	# configure the path to it using the MATHJAX_RELPATH option.
MACRUM	0:276e7a263c35	1231
MACRUM	0:276e7a263c35	1232	USE_MATHJAX = NO
MACRUM	0:276e7a263c35	1233
MACRUM	0:276e7a263c35	1234	# When MathJax is enabled you need to specify the location relative to the
MACRUM	0:276e7a263c35	1235	# HTML output directory using the MATHJAX_RELPATH option. The destination
MACRUM	0:276e7a263c35	1236	# directory should contain the MathJax.js script. For instance, if the mathjax
MACRUM	0:276e7a263c35	1237	# directory is located at the same level as the HTML output directory, then
MACRUM	0:276e7a263c35	1238	# MATHJAX_RELPATH should be ../mathjax. The default value points to
MACRUM	0:276e7a263c35	1239	# the MathJax Content Delivery Network so you can quickly see the result without
MACRUM	0:276e7a263c35	1240	# installing MathJax. However, it is strongly recommended to install a local
MACRUM	0:276e7a263c35	1241	# copy of MathJax from http://www.mathjax.org before deployment.
MACRUM	0:276e7a263c35	1242
MACRUM	0:276e7a263c35	1243	MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
MACRUM	0:276e7a263c35	1244
MACRUM	0:276e7a263c35	1245	# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
MACRUM	0:276e7a263c35	1246	# names that should be enabled during MathJax rendering.
MACRUM	0:276e7a263c35	1247
MACRUM	0:276e7a263c35	1248	MATHJAX_EXTENSIONS =
MACRUM	0:276e7a263c35	1249
MACRUM	0:276e7a263c35	1250	# When the SEARCHENGINE tag is enabled doxygen will generate a search box
MACRUM	0:276e7a263c35	1251	# for the HTML output. The underlying search engine uses javascript
MACRUM	0:276e7a263c35	1252	# and DHTML and should work on any modern browser. Note that when using
MACRUM	0:276e7a263c35	1253	# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
MACRUM	0:276e7a263c35	1254	# (GENERATE_DOCSET) there is already a search function so this one should
MACRUM	0:276e7a263c35	1255	# typically be disabled. For large projects the javascript based search engine
MACRUM	0:276e7a263c35	1256	# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
MACRUM	0:276e7a263c35	1257
MACRUM	0:276e7a263c35	1258	SEARCHENGINE = YES
MACRUM	0:276e7a263c35	1259
MACRUM	0:276e7a263c35	1260	# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
MACRUM	0:276e7a263c35	1261	# implemented using a PHP enabled web server instead of at the web client
MACRUM	0:276e7a263c35	1262	# using Javascript. Doxygen will generate the search PHP script and index
MACRUM	0:276e7a263c35	1263	# file to put on the web server. The advantage of the server
MACRUM	0:276e7a263c35	1264	# based approach is that it scales better to large projects and allows
MACRUM	0:276e7a263c35	1265	# full text search. The disadvantages are that it is more difficult to setup
MACRUM	0:276e7a263c35	1266	# and does not have live searching capabilities.
MACRUM	0:276e7a263c35	1267
MACRUM	0:276e7a263c35	1268	SERVER_BASED_SEARCH = NO
MACRUM	0:276e7a263c35	1269
MACRUM	0:276e7a263c35	1270	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1271	# configuration options related to the LaTeX output
MACRUM	0:276e7a263c35	1272	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1273
MACRUM	0:276e7a263c35	1274	# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
MACRUM	0:276e7a263c35	1275	# generate Latex output.
MACRUM	0:276e7a263c35	1276
MACRUM	0:276e7a263c35	1277	GENERATE_LATEX = NO
MACRUM	0:276e7a263c35	1278
MACRUM	0:276e7a263c35	1279	# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
MACRUM	0:276e7a263c35	1280	# If a relative path is entered the value of OUTPUT_DIRECTORY will be
MACRUM	0:276e7a263c35	1281	# put in front of it. If left blank `latex' will be used as the default path.
MACRUM	0:276e7a263c35	1282
MACRUM	0:276e7a263c35	1283	LATEX_OUTPUT = latex
MACRUM	0:276e7a263c35	1284
MACRUM	0:276e7a263c35	1285	# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
MACRUM	0:276e7a263c35	1286	# invoked. If left blank `latex' will be used as the default command name.
MACRUM	0:276e7a263c35	1287	# Note that when enabling USE_PDFLATEX this option is only used for
MACRUM	0:276e7a263c35	1288	# generating bitmaps for formulas in the HTML output, but not in the
MACRUM	0:276e7a263c35	1289	# Makefile that is written to the output directory.
MACRUM	0:276e7a263c35	1290
MACRUM	0:276e7a263c35	1291	LATEX_CMD_NAME = latex
MACRUM	0:276e7a263c35	1292
MACRUM	0:276e7a263c35	1293	# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
MACRUM	0:276e7a263c35	1294	# generate index for LaTeX. If left blank `makeindex' will be used as the
MACRUM	0:276e7a263c35	1295	# default command name.
MACRUM	0:276e7a263c35	1296
MACRUM	0:276e7a263c35	1297	MAKEINDEX_CMD_NAME = makeindex
MACRUM	0:276e7a263c35	1298
MACRUM	0:276e7a263c35	1299	# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
MACRUM	0:276e7a263c35	1300	# LaTeX documents. This may be useful for small projects and may help to
MACRUM	0:276e7a263c35	1301	# save some trees in general.
MACRUM	0:276e7a263c35	1302
MACRUM	0:276e7a263c35	1303	COMPACT_LATEX = NO
MACRUM	0:276e7a263c35	1304
MACRUM	0:276e7a263c35	1305	# The PAPER_TYPE tag can be used to set the paper type that is used
MACRUM	0:276e7a263c35	1306	# by the printer. Possible values are: a4, letter, legal and
MACRUM	0:276e7a263c35	1307	# executive. If left blank a4wide will be used.
MACRUM	0:276e7a263c35	1308
MACRUM	0:276e7a263c35	1309	PAPER_TYPE = a4
MACRUM	0:276e7a263c35	1310
MACRUM	0:276e7a263c35	1311	# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
MACRUM	0:276e7a263c35	1312	# packages that should be included in the LaTeX output.
MACRUM	0:276e7a263c35	1313
MACRUM	0:276e7a263c35	1314	EXTRA_PACKAGES =
MACRUM	0:276e7a263c35	1315
MACRUM	0:276e7a263c35	1316	# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
MACRUM	0:276e7a263c35	1317	# the generated latex document. The header should contain everything until
MACRUM	0:276e7a263c35	1318	# the first chapter. If it is left blank doxygen will generate a
MACRUM	0:276e7a263c35	1319	# standard header. Notice: only use this tag if you know what you are doing!
MACRUM	0:276e7a263c35	1320
MACRUM	0:276e7a263c35	1321	LATEX_HEADER =
MACRUM	0:276e7a263c35	1322
MACRUM	0:276e7a263c35	1323	# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
MACRUM	0:276e7a263c35	1324	# the generated latex document. The footer should contain everything after
MACRUM	0:276e7a263c35	1325	# the last chapter. If it is left blank doxygen will generate a
MACRUM	0:276e7a263c35	1326	# standard footer. Notice: only use this tag if you know what you are doing!
MACRUM	0:276e7a263c35	1327
MACRUM	0:276e7a263c35	1328	LATEX_FOOTER =
MACRUM	0:276e7a263c35	1329
MACRUM	0:276e7a263c35	1330	# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
MACRUM	0:276e7a263c35	1331	# is prepared for conversion to pdf (using ps2pdf). The pdf file will
MACRUM	0:276e7a263c35	1332	# contain links (just like the HTML output) instead of page references
MACRUM	0:276e7a263c35	1333	# This makes the output suitable for online browsing using a pdf viewer.
MACRUM	0:276e7a263c35	1334
MACRUM	0:276e7a263c35	1335	PDF_HYPERLINKS = YES
MACRUM	0:276e7a263c35	1336
MACRUM	0:276e7a263c35	1337	# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
MACRUM	0:276e7a263c35	1338	# plain latex in the generated Makefile. Set this option to YES to get a
MACRUM	0:276e7a263c35	1339	# higher quality PDF documentation.
MACRUM	0:276e7a263c35	1340
MACRUM	0:276e7a263c35	1341	USE_PDFLATEX = YES
MACRUM	0:276e7a263c35	1342
MACRUM	0:276e7a263c35	1343	# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
MACRUM	0:276e7a263c35	1344	# command to the generated LaTeX files. This will instruct LaTeX to keep
MACRUM	0:276e7a263c35	1345	# running if errors occur, instead of asking the user for help.
MACRUM	0:276e7a263c35	1346	# This option is also used when generating formulas in HTML.
MACRUM	0:276e7a263c35	1347
MACRUM	0:276e7a263c35	1348	LATEX_BATCHMODE = NO
MACRUM	0:276e7a263c35	1349
MACRUM	0:276e7a263c35	1350	# If LATEX_HIDE_INDICES is set to YES then doxygen will not
MACRUM	0:276e7a263c35	1351	# include the index chapters (such as File Index, Compound Index, etc.)
MACRUM	0:276e7a263c35	1352	# in the output.
MACRUM	0:276e7a263c35	1353
MACRUM	0:276e7a263c35	1354	LATEX_HIDE_INDICES = NO
MACRUM	0:276e7a263c35	1355
MACRUM	0:276e7a263c35	1356	# If LATEX_SOURCE_CODE is set to YES then doxygen will include
MACRUM	0:276e7a263c35	1357	# source code with syntax highlighting in the LaTeX output.
MACRUM	0:276e7a263c35	1358	# Note that which sources are shown also depends on other settings
MACRUM	0:276e7a263c35	1359	# such as SOURCE_BROWSER.
MACRUM	0:276e7a263c35	1360
MACRUM	0:276e7a263c35	1361	LATEX_SOURCE_CODE = NO
MACRUM	0:276e7a263c35	1362
MACRUM	0:276e7a263c35	1363	# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
MACRUM	0:276e7a263c35	1364	# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
MACRUM	0:276e7a263c35	1365	# http://en.wikipedia.org/wiki/BibTeX for more info.
MACRUM	0:276e7a263c35	1366
MACRUM	0:276e7a263c35	1367	LATEX_BIB_STYLE = plain
MACRUM	0:276e7a263c35	1368
MACRUM	0:276e7a263c35	1369	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1370	# configuration options related to the RTF output
MACRUM	0:276e7a263c35	1371	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1372
MACRUM	0:276e7a263c35	1373	# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
MACRUM	0:276e7a263c35	1374	# The RTF output is optimized for Word 97 and may not look very pretty with
MACRUM	0:276e7a263c35	1375	# other RTF readers or editors.
MACRUM	0:276e7a263c35	1376
MACRUM	0:276e7a263c35	1377	GENERATE_RTF = NO
MACRUM	0:276e7a263c35	1378
MACRUM	0:276e7a263c35	1379	# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
MACRUM	0:276e7a263c35	1380	# If a relative path is entered the value of OUTPUT_DIRECTORY will be
MACRUM	0:276e7a263c35	1381	# put in front of it. If left blank `rtf' will be used as the default path.
MACRUM	0:276e7a263c35	1382
MACRUM	0:276e7a263c35	1383	RTF_OUTPUT = rtf
MACRUM	0:276e7a263c35	1384
MACRUM	0:276e7a263c35	1385	# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
MACRUM	0:276e7a263c35	1386	# RTF documents. This may be useful for small projects and may help to
MACRUM	0:276e7a263c35	1387	# save some trees in general.
MACRUM	0:276e7a263c35	1388
MACRUM	0:276e7a263c35	1389	COMPACT_RTF = NO
MACRUM	0:276e7a263c35	1390
MACRUM	0:276e7a263c35	1391	# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
MACRUM	0:276e7a263c35	1392	# will contain hyperlink fields. The RTF file will
MACRUM	0:276e7a263c35	1393	# contain links (just like the HTML output) instead of page references.
MACRUM	0:276e7a263c35	1394	# This makes the output suitable for online browsing using WORD or other
MACRUM	0:276e7a263c35	1395	# programs which support those fields.
MACRUM	0:276e7a263c35	1396	# Note: wordpad (write) and others do not support links.
MACRUM	0:276e7a263c35	1397
MACRUM	0:276e7a263c35	1398	RTF_HYPERLINKS = NO
MACRUM	0:276e7a263c35	1399
MACRUM	0:276e7a263c35	1400	# Load style sheet definitions from file. Syntax is similar to doxygen's
MACRUM	0:276e7a263c35	1401	# config file, i.e. a series of assignments. You only have to provide
MACRUM	0:276e7a263c35	1402	# replacements, missing definitions are set to their default value.
MACRUM	0:276e7a263c35	1403
MACRUM	0:276e7a263c35	1404	RTF_STYLESHEET_FILE =
MACRUM	0:276e7a263c35	1405
MACRUM	0:276e7a263c35	1406	# Set optional variables used in the generation of an rtf document.
MACRUM	0:276e7a263c35	1407	# Syntax is similar to doxygen's config file.
MACRUM	0:276e7a263c35	1408
MACRUM	0:276e7a263c35	1409	RTF_EXTENSIONS_FILE =
MACRUM	0:276e7a263c35	1410
MACRUM	0:276e7a263c35	1411	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1412	# configuration options related to the man page output
MACRUM	0:276e7a263c35	1413	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1414
MACRUM	0:276e7a263c35	1415	# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
MACRUM	0:276e7a263c35	1416	# generate man pages
MACRUM	0:276e7a263c35	1417
MACRUM	0:276e7a263c35	1418	GENERATE_MAN = NO
MACRUM	0:276e7a263c35	1419
MACRUM	0:276e7a263c35	1420	# The MAN_OUTPUT tag is used to specify where the man pages will be put.
MACRUM	0:276e7a263c35	1421	# If a relative path is entered the value of OUTPUT_DIRECTORY will be
MACRUM	0:276e7a263c35	1422	# put in front of it. If left blank `man' will be used as the default path.
MACRUM	0:276e7a263c35	1423
MACRUM	0:276e7a263c35	1424	MAN_OUTPUT = man
MACRUM	0:276e7a263c35	1425
MACRUM	0:276e7a263c35	1426	# The MAN_EXTENSION tag determines the extension that is added to
MACRUM	0:276e7a263c35	1427	# the generated man pages (default is the subroutine's section .3)
MACRUM	0:276e7a263c35	1428
MACRUM	0:276e7a263c35	1429	MAN_EXTENSION = .3
MACRUM	0:276e7a263c35	1430
MACRUM	0:276e7a263c35	1431	# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
MACRUM	0:276e7a263c35	1432	# then it will generate one additional man file for each entity
MACRUM	0:276e7a263c35	1433	# documented in the real man page(s). These additional files
MACRUM	0:276e7a263c35	1434	# only source the real man page, but without them the man command
MACRUM	0:276e7a263c35	1435	# would be unable to find the correct page. The default is NO.
MACRUM	0:276e7a263c35	1436
MACRUM	0:276e7a263c35	1437	MAN_LINKS = NO
MACRUM	0:276e7a263c35	1438
MACRUM	0:276e7a263c35	1439	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1440	# configuration options related to the XML output
MACRUM	0:276e7a263c35	1441	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1442
MACRUM	0:276e7a263c35	1443	# If the GENERATE_XML tag is set to YES Doxygen will
MACRUM	0:276e7a263c35	1444	# generate an XML file that captures the structure of
MACRUM	0:276e7a263c35	1445	# the code including all documentation.
MACRUM	0:276e7a263c35	1446
MACRUM	0:276e7a263c35	1447	GENERATE_XML = NO
MACRUM	0:276e7a263c35	1448
MACRUM	0:276e7a263c35	1449	# The XML_OUTPUT tag is used to specify where the XML pages will be put.
MACRUM	0:276e7a263c35	1450	# If a relative path is entered the value of OUTPUT_DIRECTORY will be
MACRUM	0:276e7a263c35	1451	# put in front of it. If left blank `xml' will be used as the default path.
MACRUM	0:276e7a263c35	1452
MACRUM	0:276e7a263c35	1453	XML_OUTPUT = xml
MACRUM	0:276e7a263c35	1454
MACRUM	0:276e7a263c35	1455	# The XML_SCHEMA tag can be used to specify an XML schema,
MACRUM	0:276e7a263c35	1456	# which can be used by a validating XML parser to check the
MACRUM	0:276e7a263c35	1457	# syntax of the XML files.
MACRUM	0:276e7a263c35	1458
MACRUM	0:276e7a263c35	1459	XML_SCHEMA =
MACRUM	0:276e7a263c35	1460
MACRUM	0:276e7a263c35	1461	# The XML_DTD tag can be used to specify an XML DTD,
MACRUM	0:276e7a263c35	1462	# which can be used by a validating XML parser to check the
MACRUM	0:276e7a263c35	1463	# syntax of the XML files.
MACRUM	0:276e7a263c35	1464
MACRUM	0:276e7a263c35	1465	XML_DTD =
MACRUM	0:276e7a263c35	1466
MACRUM	0:276e7a263c35	1467	# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
MACRUM	0:276e7a263c35	1468	# dump the program listings (including syntax highlighting
MACRUM	0:276e7a263c35	1469	# and cross-referencing information) to the XML output. Note that
MACRUM	0:276e7a263c35	1470	# enabling this will significantly increase the size of the XML output.
MACRUM	0:276e7a263c35	1471
MACRUM	0:276e7a263c35	1472	XML_PROGRAMLISTING = YES
MACRUM	0:276e7a263c35	1473
MACRUM	0:276e7a263c35	1474	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1475	# configuration options for the AutoGen Definitions output
MACRUM	0:276e7a263c35	1476	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1477
MACRUM	0:276e7a263c35	1478	# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
MACRUM	0:276e7a263c35	1479	# generate an AutoGen Definitions (see autogen.sf.net) file
MACRUM	0:276e7a263c35	1480	# that captures the structure of the code including all
MACRUM	0:276e7a263c35	1481	# documentation. Note that this feature is still experimental
MACRUM	0:276e7a263c35	1482	# and incomplete at the moment.
MACRUM	0:276e7a263c35	1483
MACRUM	0:276e7a263c35	1484	GENERATE_AUTOGEN_DEF = NO
MACRUM	0:276e7a263c35	1485
MACRUM	0:276e7a263c35	1486	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1487	# configuration options related to the Perl module output
MACRUM	0:276e7a263c35	1488	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1489
MACRUM	0:276e7a263c35	1490	# If the GENERATE_PERLMOD tag is set to YES Doxygen will
MACRUM	0:276e7a263c35	1491	# generate a Perl module file that captures the structure of
MACRUM	0:276e7a263c35	1492	# the code including all documentation. Note that this
MACRUM	0:276e7a263c35	1493	# feature is still experimental and incomplete at the
MACRUM	0:276e7a263c35	1494	# moment.
MACRUM	0:276e7a263c35	1495
MACRUM	0:276e7a263c35	1496	GENERATE_PERLMOD = NO
MACRUM	0:276e7a263c35	1497
MACRUM	0:276e7a263c35	1498	# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
MACRUM	0:276e7a263c35	1499	# the necessary Makefile rules, Perl scripts and LaTeX code to be able
MACRUM	0:276e7a263c35	1500	# to generate PDF and DVI output from the Perl module output.
MACRUM	0:276e7a263c35	1501
MACRUM	0:276e7a263c35	1502	PERLMOD_LATEX = NO
MACRUM	0:276e7a263c35	1503
MACRUM	0:276e7a263c35	1504	# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
MACRUM	0:276e7a263c35	1505	# nicely formatted so it can be parsed by a human reader. This is useful
MACRUM	0:276e7a263c35	1506	# if you want to understand what is going on. On the other hand, if this
MACRUM	0:276e7a263c35	1507	# tag is set to NO the size of the Perl module output will be much smaller
MACRUM	0:276e7a263c35	1508	# and Perl will parse it just the same.
MACRUM	0:276e7a263c35	1509
MACRUM	0:276e7a263c35	1510	PERLMOD_PRETTY = YES
MACRUM	0:276e7a263c35	1511
MACRUM	0:276e7a263c35	1512	# The names of the make variables in the generated doxyrules.make file
MACRUM	0:276e7a263c35	1513	# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
MACRUM	0:276e7a263c35	1514	# This is useful so different doxyrules.make files included by the same
MACRUM	0:276e7a263c35	1515	# Makefile don't overwrite each other's variables.
MACRUM	0:276e7a263c35	1516
MACRUM	0:276e7a263c35	1517	PERLMOD_MAKEVAR_PREFIX =
MACRUM	0:276e7a263c35	1518
MACRUM	0:276e7a263c35	1519	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1520	# Configuration options related to the preprocessor
MACRUM	0:276e7a263c35	1521	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1522
MACRUM	0:276e7a263c35	1523	# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
MACRUM	0:276e7a263c35	1524	# evaluate all C-preprocessor directives found in the sources and include
MACRUM	0:276e7a263c35	1525	# files.
MACRUM	0:276e7a263c35	1526
MACRUM	0:276e7a263c35	1527	ENABLE_PREPROCESSING = YES
MACRUM	0:276e7a263c35	1528
MACRUM	0:276e7a263c35	1529	# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
MACRUM	0:276e7a263c35	1530	# names in the source code. If set to NO (the default) only conditional
MACRUM	0:276e7a263c35	1531	# compilation will be performed. Macro expansion can be done in a controlled
MACRUM	0:276e7a263c35	1532	# way by setting EXPAND_ONLY_PREDEF to YES.
MACRUM	0:276e7a263c35	1533
MACRUM	0:276e7a263c35	1534	MACRO_EXPANSION = NO
MACRUM	0:276e7a263c35	1535
MACRUM	0:276e7a263c35	1536	# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
MACRUM	0:276e7a263c35	1537	# then the macro expansion is limited to the macros specified with the
MACRUM	0:276e7a263c35	1538	# PREDEFINED and EXPAND_AS_DEFINED tags.
MACRUM	0:276e7a263c35	1539
MACRUM	0:276e7a263c35	1540	EXPAND_ONLY_PREDEF = NO
MACRUM	0:276e7a263c35	1541
MACRUM	0:276e7a263c35	1542	# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
MACRUM	0:276e7a263c35	1543	# pointed to by INCLUDE_PATH will be searched when a #include is found.
MACRUM	0:276e7a263c35	1544
MACRUM	0:276e7a263c35	1545	SEARCH_INCLUDES = YES
MACRUM	0:276e7a263c35	1546
MACRUM	0:276e7a263c35	1547	# The INCLUDE_PATH tag can be used to specify one or more directories that
MACRUM	0:276e7a263c35	1548	# contain include files that are not input files but should be processed by
MACRUM	0:276e7a263c35	1549	# the preprocessor.
MACRUM	0:276e7a263c35	1550
MACRUM	0:276e7a263c35	1551	INCLUDE_PATH =
MACRUM	0:276e7a263c35	1552
MACRUM	0:276e7a263c35	1553	# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
MACRUM	0:276e7a263c35	1554	# patterns (like .h and .hpp) to filter out the header-files in the
MACRUM	0:276e7a263c35	1555	# directories. If left blank, the patterns specified with FILE_PATTERNS will
MACRUM	0:276e7a263c35	1556	# be used.
MACRUM	0:276e7a263c35	1557
MACRUM	0:276e7a263c35	1558	INCLUDE_FILE_PATTERNS =
MACRUM	0:276e7a263c35	1559
MACRUM	0:276e7a263c35	1560	# The PREDEFINED tag can be used to specify one or more macro names that
MACRUM	0:276e7a263c35	1561	# are defined before the preprocessor is started (similar to the -D option of
MACRUM	0:276e7a263c35	1562	# gcc). The argument of the tag is a list of macros of the form: name
MACRUM	0:276e7a263c35	1563	# or name=definition (no spaces). If the definition and the = are
MACRUM	0:276e7a263c35	1564	# omitted =1 is assumed. To prevent a macro definition from being
MACRUM	0:276e7a263c35	1565	# undefined via #undef or recursively expanded use the := operator
MACRUM	0:276e7a263c35	1566	# instead of the = operator.
MACRUM	0:276e7a263c35	1567
MACRUM	0:276e7a263c35	1568	PREDEFINED =
MACRUM	0:276e7a263c35	1569
MACRUM	0:276e7a263c35	1570	# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
MACRUM	0:276e7a263c35	1571	# this tag can be used to specify a list of macro names that should be expanded.
MACRUM	0:276e7a263c35	1572	# The macro definition that is found in the sources will be used.
MACRUM	0:276e7a263c35	1573	# Use the PREDEFINED tag if you want to use a different macro definition that
MACRUM	0:276e7a263c35	1574	# overrules the definition found in the source code.
MACRUM	0:276e7a263c35	1575
MACRUM	0:276e7a263c35	1576	EXPAND_AS_DEFINED =
MACRUM	0:276e7a263c35	1577
MACRUM	0:276e7a263c35	1578	# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
MACRUM	0:276e7a263c35	1579	# doxygen's preprocessor will remove all references to function-like macros
MACRUM	0:276e7a263c35	1580	# that are alone on a line, have an all uppercase name, and do not end with a
MACRUM	0:276e7a263c35	1581	# semicolon, because these will confuse the parser if not removed.
MACRUM	0:276e7a263c35	1582
MACRUM	0:276e7a263c35	1583	SKIP_FUNCTION_MACROS = YES
MACRUM	0:276e7a263c35	1584
MACRUM	0:276e7a263c35	1585	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1586	# Configuration::additions related to external references
MACRUM	0:276e7a263c35	1587	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1588
MACRUM	0:276e7a263c35	1589	# The TAGFILES option can be used to specify one or more tagfiles. For each
MACRUM	0:276e7a263c35	1590	# tag file the location of the external documentation should be added. The
MACRUM	0:276e7a263c35	1591	# format of a tag file without this location is as follows:
MACRUM	0:276e7a263c35	1592	# TAGFILES = file1 file2 ...
MACRUM	0:276e7a263c35	1593	# Adding location for the tag files is done as follows:
MACRUM	0:276e7a263c35	1594	# TAGFILES = file1=loc1 "file2 = loc2" ...
MACRUM	0:276e7a263c35	1595	# where "loc1" and "loc2" can be relative or absolute paths
MACRUM	0:276e7a263c35	1596	# or URLs. Note that each tag file must have a unique name (where the name does
MACRUM	0:276e7a263c35	1597	# NOT include the path). If a tag file is not located in the directory in which
MACRUM	0:276e7a263c35	1598	# doxygen is run, you must also specify the path to the tagfile here.
MACRUM	0:276e7a263c35	1599
MACRUM	0:276e7a263c35	1600	TAGFILES =
MACRUM	0:276e7a263c35	1601
MACRUM	0:276e7a263c35	1602	# When a file name is specified after GENERATE_TAGFILE, doxygen will create
MACRUM	0:276e7a263c35	1603	# a tag file that is based on the input files it reads.
MACRUM	0:276e7a263c35	1604
MACRUM	0:276e7a263c35	1605	GENERATE_TAGFILE =
MACRUM	0:276e7a263c35	1606
MACRUM	0:276e7a263c35	1607	# If the ALLEXTERNALS tag is set to YES all external classes will be listed
MACRUM	0:276e7a263c35	1608	# in the class index. If set to NO only the inherited external classes
MACRUM	0:276e7a263c35	1609	# will be listed.
MACRUM	0:276e7a263c35	1610
MACRUM	0:276e7a263c35	1611	ALLEXTERNALS = NO
MACRUM	0:276e7a263c35	1612
MACRUM	0:276e7a263c35	1613	# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
MACRUM	0:276e7a263c35	1614	# in the modules index. If set to NO, only the current project's groups will
MACRUM	0:276e7a263c35	1615	# be listed.
MACRUM	0:276e7a263c35	1616
MACRUM	0:276e7a263c35	1617	EXTERNAL_GROUPS = YES
MACRUM	0:276e7a263c35	1618
MACRUM	0:276e7a263c35	1619	# The PERL_PATH should be the absolute path and name of the perl script
MACRUM	0:276e7a263c35	1620	# interpreter (i.e. the result of `which perl').
MACRUM	0:276e7a263c35	1621
MACRUM	0:276e7a263c35	1622	PERL_PATH = /usr/bin/perl
MACRUM	0:276e7a263c35	1623
MACRUM	0:276e7a263c35	1624	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1625	# Configuration options related to the dot tool
MACRUM	0:276e7a263c35	1626	#---------------------------------------------------------------------------
MACRUM	0:276e7a263c35	1627
MACRUM	0:276e7a263c35	1628	# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
MACRUM	0:276e7a263c35	1629	# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
MACRUM	0:276e7a263c35	1630	# or super classes. Setting the tag to NO turns the diagrams off. Note that
MACRUM	0:276e7a263c35	1631	# this option also works with HAVE_DOT disabled, but it is recommended to
MACRUM	0:276e7a263c35	1632	# install and use dot, since it yields more powerful graphs.
MACRUM	0:276e7a263c35	1633
MACRUM	0:276e7a263c35	1634	CLASS_DIAGRAMS = NO
MACRUM	0:276e7a263c35	1635
MACRUM	0:276e7a263c35	1636	# You can define message sequence charts within doxygen comments using the \msc
MACRUM	0:276e7a263c35	1637	# command. Doxygen will then run the mscgen tool (see
MACRUM	0:276e7a263c35	1638	# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
MACRUM	0:276e7a263c35	1639	# documentation. The MSCGEN_PATH tag allows you to specify the directory where
MACRUM	0:276e7a263c35	1640	# the mscgen tool resides. If left empty the tool is assumed to be found in the
MACRUM	0:276e7a263c35	1641	# default search path.
MACRUM	0:276e7a263c35	1642
MACRUM	0:276e7a263c35	1643	MSCGEN_PATH =
MACRUM	0:276e7a263c35	1644
MACRUM	0:276e7a263c35	1645	# If set to YES, the inheritance and collaboration graphs will hide
MACRUM	0:276e7a263c35	1646	# inheritance and usage relations if the target is undocumented
MACRUM	0:276e7a263c35	1647	# or is not a class.
MACRUM	0:276e7a263c35	1648
MACRUM	0:276e7a263c35	1649	HIDE_UNDOC_RELATIONS = YES
MACRUM	0:276e7a263c35	1650
MACRUM	0:276e7a263c35	1651	# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
MACRUM	0:276e7a263c35	1652	# available from the path. This tool is part of Graphviz, a graph visualization
MACRUM	0:276e7a263c35	1653	# toolkit from AT&T and Lucent Bell Labs. The other options in this section
MACRUM	0:276e7a263c35	1654	# have no effect if this option is set to NO (the default)
MACRUM	0:276e7a263c35	1655
MACRUM	0:276e7a263c35	1656	HAVE_DOT = NO
MACRUM	0:276e7a263c35	1657
MACRUM	0:276e7a263c35	1658	# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
MACRUM	0:276e7a263c35	1659	# allowed to run in parallel. When set to 0 (the default) doxygen will
MACRUM	0:276e7a263c35	1660	# base this on the number of processors available in the system. You can set it
MACRUM	0:276e7a263c35	1661	# explicitly to a value larger than 0 to get control over the balance
MACRUM	0:276e7a263c35	1662	# between CPU load and processing speed.
MACRUM	0:276e7a263c35	1663
MACRUM	0:276e7a263c35	1664	DOT_NUM_THREADS = 0
MACRUM	0:276e7a263c35	1665
MACRUM	0:276e7a263c35	1666	# By default doxygen will use the Helvetica font for all dot files that
MACRUM	0:276e7a263c35	1667	# doxygen generates. When you want a differently looking font you can specify
MACRUM	0:276e7a263c35	1668	# the font name using DOT_FONTNAME. You need to make sure dot is able to find
MACRUM	0:276e7a263c35	1669	# the font, which can be done by putting it in a standard location or by setting
MACRUM	0:276e7a263c35	1670	# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
MACRUM	0:276e7a263c35	1671	# directory containing the font.
MACRUM	0:276e7a263c35	1672
MACRUM	0:276e7a263c35	1673	DOT_FONTNAME = Helvetica
MACRUM	0:276e7a263c35	1674
MACRUM	0:276e7a263c35	1675	# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
MACRUM	0:276e7a263c35	1676	# The default size is 10pt.
MACRUM	0:276e7a263c35	1677
MACRUM	0:276e7a263c35	1678	DOT_FONTSIZE = 10
MACRUM	0:276e7a263c35	1679
MACRUM	0:276e7a263c35	1680	# By default doxygen will tell dot to use the Helvetica font.
MACRUM	0:276e7a263c35	1681	# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
MACRUM	0:276e7a263c35	1682	# set the path where dot can find it.
MACRUM	0:276e7a263c35	1683
MACRUM	0:276e7a263c35	1684	DOT_FONTPATH =
MACRUM	0:276e7a263c35	1685
MACRUM	0:276e7a263c35	1686	# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
MACRUM	0:276e7a263c35	1687	# will generate a graph for each documented class showing the direct and
MACRUM	0:276e7a263c35	1688	# indirect inheritance relations. Setting this tag to YES will force the
MACRUM	0:276e7a263c35	1689	# CLASS_DIAGRAMS tag to NO.
MACRUM	0:276e7a263c35	1690
MACRUM	0:276e7a263c35	1691	CLASS_GRAPH = YES
MACRUM	0:276e7a263c35	1692
MACRUM	0:276e7a263c35	1693	# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
MACRUM	0:276e7a263c35	1694	# will generate a graph for each documented class showing the direct and
MACRUM	0:276e7a263c35	1695	# indirect implementation dependencies (inheritance, containment, and
MACRUM	0:276e7a263c35	1696	# class references variables) of the class with other documented classes.
MACRUM	0:276e7a263c35	1697
MACRUM	0:276e7a263c35	1698	COLLABORATION_GRAPH = YES
MACRUM	0:276e7a263c35	1699
MACRUM	0:276e7a263c35	1700	# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
MACRUM	0:276e7a263c35	1701	# will generate a graph for groups, showing the direct groups dependencies
MACRUM	0:276e7a263c35	1702
MACRUM	0:276e7a263c35	1703	GROUP_GRAPHS = YES
MACRUM	0:276e7a263c35	1704
MACRUM	0:276e7a263c35	1705	# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
MACRUM	0:276e7a263c35	1706	# collaboration diagrams in a style similar to the OMG's Unified Modeling
MACRUM	0:276e7a263c35	1707	# Language.
MACRUM	0:276e7a263c35	1708
MACRUM	0:276e7a263c35	1709	UML_LOOK = NO
MACRUM	0:276e7a263c35	1710
MACRUM	0:276e7a263c35	1711	# If the UML_LOOK tag is enabled, the fields and methods are shown inside
MACRUM	0:276e7a263c35	1712	# the class node. If there are many fields or methods and many nodes the
MACRUM	0:276e7a263c35	1713	# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
MACRUM	0:276e7a263c35	1714	# threshold limits the number of items for each type to make the size more
MACRUM	0:276e7a263c35	1715	# managable. Set this to 0 for no limit. Note that the threshold may be
MACRUM	0:276e7a263c35	1716	# exceeded by 50% before the limit is enforced.
MACRUM	0:276e7a263c35	1717
MACRUM	0:276e7a263c35	1718	UML_LIMIT_NUM_FIELDS = 10
MACRUM	0:276e7a263c35	1719
MACRUM	0:276e7a263c35	1720	# If set to YES, the inheritance and collaboration graphs will show the
MACRUM	0:276e7a263c35	1721	# relations between templates and their instances.
MACRUM	0:276e7a263c35	1722
MACRUM	0:276e7a263c35	1723	TEMPLATE_RELATIONS = NO
MACRUM	0:276e7a263c35	1724
MACRUM	0:276e7a263c35	1725	# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
MACRUM	0:276e7a263c35	1726	# tags are set to YES then doxygen will generate a graph for each documented
MACRUM	0:276e7a263c35	1727	# file showing the direct and indirect include dependencies of the file with
MACRUM	0:276e7a263c35	1728	# other documented files.
MACRUM	0:276e7a263c35	1729
MACRUM	0:276e7a263c35	1730	INCLUDE_GRAPH = YES
MACRUM	0:276e7a263c35	1731
MACRUM	0:276e7a263c35	1732	# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
MACRUM	0:276e7a263c35	1733	# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
MACRUM	0:276e7a263c35	1734	# documented header file showing the documented files that directly or
MACRUM	0:276e7a263c35	1735	# indirectly include this file.
MACRUM	0:276e7a263c35	1736
MACRUM	0:276e7a263c35	1737	INCLUDED_BY_GRAPH = YES
MACRUM	0:276e7a263c35	1738
MACRUM	0:276e7a263c35	1739	# If the CALL_GRAPH and HAVE_DOT options are set to YES then
MACRUM	0:276e7a263c35	1740	# doxygen will generate a call dependency graph for every global function
MACRUM	0:276e7a263c35	1741	# or class method. Note that enabling this option will significantly increase
MACRUM	0:276e7a263c35	1742	# the time of a run. So in most cases it will be better to enable call graphs
MACRUM	0:276e7a263c35	1743	# for selected functions only using the \callgraph command.
MACRUM	0:276e7a263c35	1744
MACRUM	0:276e7a263c35	1745	CALL_GRAPH = YES
MACRUM	0:276e7a263c35	1746
MACRUM	0:276e7a263c35	1747	# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
MACRUM	0:276e7a263c35	1748	# doxygen will generate a caller dependency graph for every global function
MACRUM	0:276e7a263c35	1749	# or class method. Note that enabling this option will significantly increase
MACRUM	0:276e7a263c35	1750	# the time of a run. So in most cases it will be better to enable caller
MACRUM	0:276e7a263c35	1751	# graphs for selected functions only using the \callergraph command.
MACRUM	0:276e7a263c35	1752
MACRUM	0:276e7a263c35	1753	CALLER_GRAPH = YES
MACRUM	0:276e7a263c35	1754
MACRUM	0:276e7a263c35	1755	# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
MACRUM	0:276e7a263c35	1756	# will generate a graphical hierarchy of all classes instead of a textual one.
MACRUM	0:276e7a263c35	1757
MACRUM	0:276e7a263c35	1758	GRAPHICAL_HIERARCHY = YES
MACRUM	0:276e7a263c35	1759
MACRUM	0:276e7a263c35	1760	# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
MACRUM	0:276e7a263c35	1761	# then doxygen will show the dependencies a directory has on other directories
MACRUM	0:276e7a263c35	1762	# in a graphical way. The dependency relations are determined by the #include
MACRUM	0:276e7a263c35	1763	# relations between the files in the directories.
MACRUM	0:276e7a263c35	1764
MACRUM	0:276e7a263c35	1765	DIRECTORY_GRAPH = YES
MACRUM	0:276e7a263c35	1766
MACRUM	0:276e7a263c35	1767	# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
MACRUM	0:276e7a263c35	1768	# generated by dot. Possible values are svg, png, jpg, or gif.
MACRUM	0:276e7a263c35	1769	# If left blank png will be used. If you choose svg you need to set
MACRUM	0:276e7a263c35	1770	# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
MACRUM	0:276e7a263c35	1771	# visible in IE 9+ (other browsers do not have this requirement).
MACRUM	0:276e7a263c35	1772
MACRUM	0:276e7a263c35	1773	DOT_IMAGE_FORMAT = png
MACRUM	0:276e7a263c35	1774
MACRUM	0:276e7a263c35	1775	# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
MACRUM	0:276e7a263c35	1776	# enable generation of interactive SVG images that allow zooming and panning.
MACRUM	0:276e7a263c35	1777	# Note that this requires a modern browser other than Internet Explorer.
MACRUM	0:276e7a263c35	1778	# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
MACRUM	0:276e7a263c35	1779	# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
MACRUM	0:276e7a263c35	1780	# visible. Older versions of IE do not have SVG support.
MACRUM	0:276e7a263c35	1781
MACRUM	0:276e7a263c35	1782	INTERACTIVE_SVG = NO
MACRUM	0:276e7a263c35	1783
MACRUM	0:276e7a263c35	1784	# The tag DOT_PATH can be used to specify the path where the dot tool can be
MACRUM	0:276e7a263c35	1785	# found. If left blank, it is assumed the dot tool can be found in the path.
MACRUM	0:276e7a263c35	1786
MACRUM	0:276e7a263c35	1787	DOT_PATH =
MACRUM	0:276e7a263c35	1788
MACRUM	0:276e7a263c35	1789	# The DOTFILE_DIRS tag can be used to specify one or more directories that
MACRUM	0:276e7a263c35	1790	# contain dot files that are included in the documentation (see the
MACRUM	0:276e7a263c35	1791	# \dotfile command).
MACRUM	0:276e7a263c35	1792
MACRUM	0:276e7a263c35	1793	DOTFILE_DIRS =
MACRUM	0:276e7a263c35	1794
MACRUM	0:276e7a263c35	1795	# The MSCFILE_DIRS tag can be used to specify one or more directories that
MACRUM	0:276e7a263c35	1796	# contain msc files that are included in the documentation (see the
MACRUM	0:276e7a263c35	1797	# \mscfile command).
MACRUM	0:276e7a263c35	1798
MACRUM	0:276e7a263c35	1799	MSCFILE_DIRS =
MACRUM	0:276e7a263c35	1800
MACRUM	0:276e7a263c35	1801	# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
MACRUM	0:276e7a263c35	1802	# nodes that will be shown in the graph. If the number of nodes in a graph
MACRUM	0:276e7a263c35	1803	# becomes larger than this value, doxygen will truncate the graph, which is
MACRUM	0:276e7a263c35	1804	# visualized by representing a node as a red box. Note that doxygen if the
MACRUM	0:276e7a263c35	1805	# number of direct children of the root node in a graph is already larger than
MACRUM	0:276e7a263c35	1806	# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
MACRUM	0:276e7a263c35	1807	# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
MACRUM	0:276e7a263c35	1808
MACRUM	0:276e7a263c35	1809	DOT_GRAPH_MAX_NODES = 44
MACRUM	0:276e7a263c35	1810
MACRUM	0:276e7a263c35	1811	# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
MACRUM	0:276e7a263c35	1812	# graphs generated by dot. A depth value of 3 means that only nodes reachable
MACRUM	0:276e7a263c35	1813	# from the root by following a path via at most 3 edges will be shown. Nodes
MACRUM	0:276e7a263c35	1814	# that lay further from the root node will be omitted. Note that setting this
MACRUM	0:276e7a263c35	1815	# option to 1 or 2 may greatly reduce the computation time needed for large
MACRUM	0:276e7a263c35	1816	# code bases. Also note that the size of a graph can be further restricted by
MACRUM	0:276e7a263c35	1817	# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
MACRUM	0:276e7a263c35	1818
MACRUM	0:276e7a263c35	1819	MAX_DOT_GRAPH_DEPTH = 0
MACRUM	0:276e7a263c35	1820
MACRUM	0:276e7a263c35	1821	# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
MACRUM	0:276e7a263c35	1822	# background. This is disabled by default, because dot on Windows does not
MACRUM	0:276e7a263c35	1823	# seem to support this out of the box. Warning: Depending on the platform used,
MACRUM	0:276e7a263c35	1824	# enabling this option may lead to badly anti-aliased labels on the edges of
MACRUM	0:276e7a263c35	1825	# a graph (i.e. they become hard to read).
MACRUM	0:276e7a263c35	1826
MACRUM	0:276e7a263c35	1827	DOT_TRANSPARENT = NO
MACRUM	0:276e7a263c35	1828
MACRUM	0:276e7a263c35	1829	# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
MACRUM	0:276e7a263c35	1830	# files in one run (i.e. multiple -o and -T options on the command line). This
MACRUM	0:276e7a263c35	1831	# makes dot run faster, but since only newer versions of dot (>1.8.10)
MACRUM	0:276e7a263c35	1832	# support this, this feature is disabled by default.
MACRUM	0:276e7a263c35	1833
MACRUM	0:276e7a263c35	1834	DOT_MULTI_TARGETS = NO
MACRUM	0:276e7a263c35	1835
MACRUM	0:276e7a263c35	1836	# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
MACRUM	0:276e7a263c35	1837	# generate a legend page explaining the meaning of the various boxes and
MACRUM	0:276e7a263c35	1838	# arrows in the dot generated graphs.
MACRUM	0:276e7a263c35	1839
MACRUM	0:276e7a263c35	1840	GENERATE_LEGEND = YES
MACRUM	0:276e7a263c35	1841
MACRUM	0:276e7a263c35	1842	# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
MACRUM	0:276e7a263c35	1843	# remove the intermediate dot files that are used to generate
MACRUM	0:276e7a263c35	1844	# the various graphs.
MACRUM	0:276e7a263c35	1845
MACRUM	0:276e7a263c35	1846	DOT_CLEANUP = YES

Repository toolbox

Repository details

Type:	Library
Created:	02 Jul 2018
Imports:	1
Forks:	0
Commits:	3
Dependents:	1
Dependencies:	0
Followers:	1

This repository is Public (Unlisted).

The code in this repository is Apache licensed.

Important changes to repositories hosted on mbed.com

mbed-cloud-client/mbed-coap/doxygen/libcoap_doxy@0:276e7a263c35, 2018-07-02 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Important changes to repositories hosted on mbed.com

mbed-cloud-client/mbed-coap/doxygen/libcoap_doxy@0:276e7a263c35, 2018-07-02 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning