Nucleo_446 - Color Oled(SSD1331) connect to STMicroelectronics…

Users » kadonotakashi » Code » Nucleo_446

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

mbed-os/doxyfile_options@3:f3764f852aa8, 2018-10-11 (annotated)

Committer:: kadonotakashi
Date:: Thu Oct 11 02:27:46 2018 +0000
Revision:: 3:f3764f852aa8
Parent:: 0:8fdf9a60065b

Nucreo 446 + SSD1331 test version;

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed OS
Created:	11 Oct 2018
Imports:	23
Forks:	0
Commits:	4
Dependents:	0
Dependencies:	1
Followers:	1

mbed-os/doxyfile_options@3:f3764f852aa8, 2018-10-11 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning