llvm.org GIT mirror llvm / f7a833a
[docs] Update the doxygen configuration file. Update the doxygen configuration file and Makefile build rules to provide better output (simply use the default stylesheet and template from the Doxygen distribution.) This CL has upgrade doxygen.cfg.in to Doxygen 1.8.6. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@232064 91177308-0d34-0410-b5e6-96231b3b80d8 Logan Chien 4 years ago
5 changed file(s) with 1579 addition(s) and 1344 deletion(s). Raw diff Collapse all Expand all
3737
3838 HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
3939 $(wildcard $(PROJ_SRC_DIR)/*.css)
40 DOXYFILES := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
41 doxygen.intro
42 EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide
40 DOXYFILES := doxygen.cfg.in doxygen.intro
4341
4442 .PHONY: install-html install-doxygen doxygen install-ocamldoc ocamldoc generated
4543
7876
7977 install-doxygen: doxygen
8078 $(Echo) Installing doxygen documentation
81 $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/html/doxygen
8279 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(DESTDIR)$(PROJ_docsdir)
83 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
84 $(FIND) . -type f -exec \
85 $(DataInstall) {} $(DESTDIR)$(PROJ_docsdir)/html/doxygen \;
80 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen/html && \
81 for DIR in $$($(FIND) . -type d); do \
82 DESTSUB="$(DESTDIR)$(PROJ_docsdir)/html/doxygen/$$(echo $$DIR | cut -c 3-)"; \
83 $(MKDIR) $$DESTSUB && \
84 $(FIND) $$DIR -maxdepth 1 -type f -exec $(DataInstall) {} $$DESTSUB \; ; \
85 if [ $$? != 0 ]; then exit 1; fi \
86 done
8687
8788 doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
8889
None
1 # Doxyfile 1.7.1
0 # Doxyfile 1.8.6
21
32 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
5 #
6 # All text after a hash (#) is considered a comment and will be ignored
3 # doxygen (www.doxygen.org) for a project.
4 #
5 # All text after a double hash (##) is considered a comment and is placed in
6 # front of the TAG it is preceding.
7 #
8 # All text after a single hash (#) is considered a comment and will be ignored.
79 # The format is:
8 # TAG = value [value, ...]
9 # For lists items can also be appended using:
10 # TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
10 # TAG = value [value, ...]
11 # For lists, items can also be appended using:
12 # TAG += value [value, ...]
13 # Values that contain spaces should be placed between quotes (\" \").
1214
1315 #---------------------------------------------------------------------------
1416 # Project related configuration options
1517 #---------------------------------------------------------------------------
1618
1719 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
20 # that follow. The default is UTF-8 which is also the encoding used for all text
21 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
22 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
23 # for the list of possible encodings.
24 # The default value is: UTF-8.
2225
2326 DOXYFILE_ENCODING = UTF-8
2427
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
28 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
29 # double-quotes, unless you are using Doxywizard) that should identify the
30 # project for which the documentation is generated. This name is used in the
31 # title of most generated pages and in a few other places.
32 # The default value is: My Project.
2733
2834 PROJECT_NAME = LLVM
2935
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
32 # if some version control system is used.
36 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
37 # could be handy for archiving the generated documentation or if some version
38 # control system is used.
3339
3440 PROJECT_NUMBER = @PACKAGE_VERSION@
3541
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
42 # Using the PROJECT_BRIEF tag one can provide an optional one line description
43 # for a project that appears at the top of each page and should give viewer a
44 # quick idea about the purpose of the project. Keep the description short.
45
46 PROJECT_BRIEF =
47
48 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
49 # the documentation. The maximum height of the logo should not exceed 55 pixels
50 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
51 # to the output directory.
52
53 PROJECT_LOGO =
54
55 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
56 # into which the generated documentation will be written. If a relative path is
57 # entered, it will be relative to the location where doxygen was started. If
58 # left blank the current directory will be used.
4059
4160 OUTPUT_DIRECTORY = @abs_top_builddir@/docs/doxygen
4261
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
62 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
63 # directories (in 2 levels) under the output directory of each output format and
64 # will distribute the generated files over these directories. Enabling this
65 # option can be useful when feeding doxygen a huge amount of source files, where
66 # putting all generated files in the same directory would otherwise causes
67 # performance problems for the file system.
68 # The default value is: NO.
4969
5070 CREATE_SUBDIRS = NO
5171
5272 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
5373 # documentation generated by doxygen is written. Doxygen will use this
5474 # information to generate all constant output in the proper language.
55 # The default language is English, other supported languages are:
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
75 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
76 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
77 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
78 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
79 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
80 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
81 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
82 # Ukrainian and Vietnamese.
83 # The default value is: English.
6284
6385 OUTPUT_LANGUAGE = English
6486
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66 # include brief member descriptions after the members that are listed in
67 # the file and class documentation (similar to JavaDoc).
68 # Set to NO to disable this.
87 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
88 # descriptions after the members that are listed in the file and class
89 # documentation (similar to Javadoc). Set to NO to disable this.
90 # The default value is: YES.
6991
7092 BRIEF_MEMBER_DESC = YES
7193
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73 # the brief description of a member or function before the detailed description.
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
94 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
95 # description of a member or function before the detailed description
96 #
97 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
7598 # brief descriptions will be completely suppressed.
99 # The default value is: YES.
76100
77101 REPEAT_BRIEF = YES
78102
79 # This tag implements a quasi-intelligent brief description abbreviator
80 # that is used to form the text in various listings. Each string
81 # in this list, if found as the leading text of the brief description, will be
82 # stripped from the text and the result after processing the whole list, is
83 # used as the annotated text. Otherwise, the brief description is used as-is.
84 # If left blank, the following values are used ("$name" is automatically
85 # replaced with the name of the entity): "The $name class" "The $name widget"
86 # "The $name file" "is" "provides" "specifies" "contains"
87 # "represents" "a" "an" "the"
103 # This tag implements a quasi-intelligent brief description abbreviator that is
104 # used to form the text in various listings. Each string in this list, if found
105 # as the leading text of the brief description, will be stripped from the text
106 # and the result, after processing the whole list, is used as the annotated
107 # text. Otherwise, the brief description is used as-is. If left blank, the
108 # following values are used ($name is automatically replaced with the name of
109 # the entity):The $name class, The $name widget, The $name file, is, provides,
110 # specifies, contains, represents, a, an and the.
88111
89112 ABBREVIATE_BRIEF =
90113
91114 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92 # Doxygen will generate a detailed section even if there is only a brief
115 # doxygen will generate a detailed section even if there is only a brief
93116 # description.
117 # The default value is: NO.
94118
95119 ALWAYS_DETAILED_SEC = NO
96120
98122 # inherited members of a class in the documentation of that class as if those
99123 # members were ordinary class members. Constructors, destructors and assignment
100124 # operators of the base classes will not be shown.
125 # The default value is: NO.
101126
102127 INLINE_INHERITED_MEMB = NO
103128
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105 # path before files name in the file list and in the header files. If set
106 # to NO the shortest path that makes the file name unique will be used.
129 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
130 # before files name in the file list and in the header files. If set to NO the
131 # shortest path that makes the file name unique will be used
132 # The default value is: YES.
107133
108134 FULL_PATH_NAMES = NO
109135
110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111 # can be used to strip a user-defined part of the path. Stripping is
112 # only done if one of the specified strings matches the left-hand part of
113 # the path. The tag can be used to show relative paths in the file list.
114 # If left blank the directory from which doxygen is run is used as the
115 # path to strip.
136 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
137 # Stripping is only done if one of the specified strings matches the left-hand
138 # part of the path. The tag can be used to show relative paths in the file list.
139 # If left blank the directory from which doxygen is run is used as the path to
140 # strip.
141 #
142 # Note that you can specify absolute paths here, but also relative paths, which
143 # will be relative from the directory where doxygen is started.
144 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
116145
117146 STRIP_FROM_PATH = ../..
118147
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120 # the path mentioned in the documentation of a class, which tells
121 # the reader which header file to include in order to use a class.
122 # If left blank only the name of the header file containing the class
123 # definition is used. Otherwise one should specify the include paths that
124 # are normally passed to the compiler using the -I flag.
148 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
149 # path mentioned in the documentation of a class, which tells the reader which
150 # header file to include in order to use a class. If left blank only the name of
151 # the header file containing the class definition is used. Otherwise one should
152 # specify the list of include paths that are normally passed to the compiler
153 # using the -I flag.
125154
126155 STRIP_FROM_INC_PATH =
127156
128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129 # (but less readable) file names. This can be useful is your file systems
130 # doesn't support long names like on DOS, Mac, or CD-ROM.
157 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
158 # less readable) file names. This can be useful is your file systems doesn't
159 # support long names like on DOS, Mac, or CD-ROM.
160 # The default value is: NO.
131161
132162 SHORT_NAMES = NO
133163
134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135 # will interpret the first line (until the first dot) of a JavaDoc-style
136 # comment as the brief description. If set to NO, the JavaDoc
137 # comments will behave just like regular Qt-style comments
138 # (thus requiring an explicit @brief command for a brief description.)
164 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
165 # first line (until the first dot) of a Javadoc-style comment as the brief
166 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
167 # style comments (thus requiring an explicit @brief command for a brief
168 # description.)
169 # The default value is: NO.
139170
140171 JAVADOC_AUTOBRIEF = NO
141172
142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143 # interpret the first line (until the first dot) of a Qt-style
144 # comment as the brief description. If set to NO, the comments
145 # will behave just like regular Qt-style comments (thus requiring
146 # an explicit \brief command for a brief description.)
173 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
174 # line (until the first dot) of a Qt-style comment as the brief description. If
175 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
176 # requiring an explicit \brief command for a brief description.)
177 # The default value is: NO.
147178
148179 QT_AUTOBRIEF = NO
149180
150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
152 # comments) as a brief description. This used to be the default behaviour.
153 # The new default is to treat a multi-line C++ comment block as a detailed
154 # description. Set this tag to YES if you prefer the old behaviour instead.
181 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
182 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
183 # a brief description. This used to be the default behavior. The new default is
184 # to treat a multi-line C++ comment block as a detailed description. Set this
185 # tag to YES if you prefer the old behavior instead.
186 #
187 # Note that setting this tag to YES also means that rational rose comments are
188 # not recognized any more.
189 # The default value is: NO.
155190
156191 MULTILINE_CPP_IS_BRIEF = NO
157192
158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159 # member inherits the documentation from any documented member that it
160 # re-implements.
193 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
194 # documentation from any documented member that it re-implements.
195 # The default value is: YES.
161196
162197 INHERIT_DOCS = YES
163198
164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165 # a new page for each member. If set to NO, the documentation of a member will
166 # be part of the file/class/namespace that contains it.
199 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
200 # new page for each member. If set to NO, the documentation of a member will be
201 # part of the file/class/namespace that contains it.
202 # The default value is: NO.
167203
168204 SEPARATE_MEMBER_PAGES = NO
169205
170 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
171 # Doxygen uses this value to replace tabs by spaces in code fragments.
206 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
207 # uses this value to replace tabs by spaces in code fragments.
208 # Minimum value: 1, maximum value: 16, default value: 4.
172209
173210 TAB_SIZE = 2
174211
175 # This tag can be used to specify a number of aliases that acts
176 # as commands in the documentation. An alias has the form "name=value".
177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
178 # put the command \sideeffect (or @sideeffect) in the documentation, which
179 # will result in a user-defined paragraph with heading "Side Effects:".
180 # You can put \n's in the value part of an alias to insert newlines.
212 # This tag can be used to specify a number of aliases that act as commands in
213 # the documentation. An alias has the form:
214 # name=value
215 # For example adding
216 # "sideeffect=@par Side Effects:\n"
217 # will allow you to put the command \sideeffect (or @sideeffect) in the
218 # documentation, which will result in a user-defined paragraph with heading
219 # "Side Effects:". You can put \n's in the value part of an alias to insert
220 # newlines.
181221
182222 ALIASES =
183223
184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185 # sources only. Doxygen will then generate output that is more tailored for C.
186 # For instance, some of the names that are used will be different. The list
187 # of all members will be omitted, etc.
224 # This tag can be used to specify a number of word-keyword mappings (TCL only).
225 # A mapping has the form "name=value". For example adding "class=itcl::class"
226 # will allow you to use the command class in the itcl::class meaning.
227
228 TCL_SUBST =
229
230 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
231 # only. Doxygen will then generate output that is more tailored for C. For
232 # instance, some of the names that are used will be different. The list of all
233 # members will be omitted, etc.
234 # The default value is: NO.
188235
189236 OPTIMIZE_OUTPUT_FOR_C = NO
190237
191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192 # sources only. Doxygen will then generate output that is more tailored for
193 # Java. For instance, namespaces will be presented as packages, qualified
194 # scopes will look different, etc.
238 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
239 # Python sources only. Doxygen will then generate output that is more tailored
240 # for that language. For instance, namespaces will be presented as packages,
241 # qualified scopes will look different, etc.
242 # The default value is: NO.
195243
196244 OPTIMIZE_OUTPUT_JAVA = NO
197245
198246 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
199 # sources only. Doxygen will then generate output that is more tailored for
200 # Fortran.
247 # sources. Doxygen will then generate output that is tailored for Fortran.
248 # The default value is: NO.
201249
202250 OPTIMIZE_FOR_FORTRAN = NO
203251
204252 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
205 # sources. Doxygen will then generate output that is tailored for
206 # VHDL.
253 # sources. Doxygen will then generate output that is tailored for VHDL.
254 # The default value is: NO.
207255
208256 OPTIMIZE_OUTPUT_VHDL = NO
209257
210258 # Doxygen selects the parser to use depending on the extension of the files it
211 # parses. With this tag you can assign which parser to use for a given extension.
212 # Doxygen has a built-in mapping, but you can override or extend it using this
213 # tag. The format is ext=language, where ext is a file extension, and language
214 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
215 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
259 # parses. With this tag you can assign which parser to use for a given
260 # extension. Doxygen has a built-in mapping, but you can override or extend it
261 # using this tag. The format is ext=language, where ext is a file extension, and
262 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
263 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
216264 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
217 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
218 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
265 # (default is Fortran), use: inc=Fortran f=C.
266 #
267 # Note For files without extension you can use no_extension as a placeholder.
268 #
269 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
270 # the files are not read by doxygen.
219271
220272 EXTENSION_MAPPING =
221273
274 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
275 # according to the Markdown format, which allows for more readable
276 # documentation. See http://daringfireball.net/projects/markdown/ for details.
277 # The output of markdown processing is further processed by doxygen, so you can
278 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
279 # case of backward compatibilities issues.
280 # The default value is: YES.
281
282 MARKDOWN_SUPPORT = YES
283
284 # When enabled doxygen tries to link words that correspond to documented
285 # classes, or namespaces to their corresponding documentation. Such a link can
286 # be prevented in individual cases by by putting a % sign in front of the word
287 # or globally by setting AUTOLINK_SUPPORT to NO.
288 # The default value is: YES.
289
290 AUTOLINK_SUPPORT = YES
291
222292 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
223 # to include (a tag file for) the STL sources as input, then you should
224 # set this tag to YES in order to let doxygen match functions declarations and
225 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
226 # func(std::string) {}). This also make the inheritance and collaboration
293 # to include (a tag file for) the STL sources as input, then you should set this
294 # tag to YES in order to let doxygen match functions declarations and
295 # definitions whose arguments contain STL classes (e.g. func(std::string);
296 # versus func(std::string) {}). This also make the inheritance and collaboration
227297 # diagrams that involve STL classes more complete and accurate.
298 # The default value is: NO.
228299
229300 BUILTIN_STL_SUPPORT = NO
230301
231302 # If you use Microsoft's C++/CLI language, you should set this option to YES to
232303 # enable parsing support.
304 # The default value is: NO.
233305
234306 CPP_CLI_SUPPORT = NO
235307
236 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
237 # Doxygen will parse them like normal C++ but will assume all classes use public
238 # instead of private inheritance when no explicit protection keyword is present.
308 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
309 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
310 # will parse them like normal C++ but will assume all classes use public instead
311 # of private inheritance when no explicit protection keyword is present.
312 # The default value is: NO.
239313
240314 SIP_SUPPORT = NO
241315
242 # For Microsoft's IDL there are propget and propput attributes to indicate getter
243 # and setter methods for a property. Setting this option to YES (the default)
244 # will make doxygen to replace the get and set methods by a property in the
245 # documentation. This will only work if the methods are indeed getting or
246 # setting a simple type. If this is not the case, or you want to show the
247 # methods anyway, you should set this option to NO.
316 # For Microsoft's IDL there are propget and propput attributes to indicate
317 # getter and setter methods for a property. Setting this option to YES will make
318 # doxygen to replace the get and set methods by a property in the documentation.
319 # This will only work if the methods are indeed getting or setting a simple
320 # type. If this is not the case, or you want to show the methods anyway, you
321 # should set this option to NO.
322 # The default value is: YES.
248323
249324 IDL_PROPERTY_SUPPORT = YES
250325
252327 # tag is set to YES, then doxygen will reuse the documentation of the first
253328 # member in the group (if any) for the other members of the group. By default
254329 # all members of a group must be documented explicitly.
330 # The default value is: NO.
255331
256332 DISTRIBUTE_GROUP_DOC = NO
257333
258 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
259 # the same type (for instance a group of public functions) to be put as a
260 # subgroup of that type (e.g. under the Public Functions section). Set it to
261 # NO to prevent subgrouping. Alternatively, this can be done per class using
262 # the \nosubgrouping command.
334 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
335 # (for instance a group of public functions) to be put as a subgroup of that
336 # type (e.g. under the Public Functions section). Set it to NO to prevent
337 # subgrouping. Alternatively, this can be done per class using the
338 # \nosubgrouping command.
339 # The default value is: YES.
263340
264341 SUBGROUPING = YES
265342
266 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
267 # is documented as struct, union, or enum with the name of the typedef. So
343 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
344 # are shown inside the group in which they are included (e.g. using \ingroup)
345 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
346 # and RTF).
347 #
348 # Note that this feature does not work in combination with
349 # SEPARATE_MEMBER_PAGES.
350 # The default value is: NO.
351
352 INLINE_GROUPED_CLASSES = NO
353
354 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
355 # with only public data fields or simple typedef fields will be shown inline in
356 # the documentation of the scope in which they are defined (i.e. file,
357 # namespace, or group documentation), provided this scope is documented. If set
358 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
359 # Man pages) or section (for LaTeX and RTF).
360 # The default value is: NO.
361
362 INLINE_SIMPLE_STRUCTS = NO
363
364 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
365 # enum is documented as struct, union, or enum with the name of the typedef. So
268366 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
269367 # with name TypeT. When disabled the typedef will appear as a member of a file,
270 # namespace, or class. And the struct will be named TypeS. This can typically
271 # be useful for C code in case the coding convention dictates that all compound
368 # namespace, or class. And the struct will be named TypeS. This can typically be
369 # useful for C code in case the coding convention dictates that all compound
272370 # types are typedef'ed and only the typedef is referenced, never the tag name.
371 # The default value is: NO.
273372
274373 TYPEDEF_HIDES_STRUCT = NO
275374
276 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
277 # determine which symbols to keep in memory and which to flush to disk.
278 # When the cache is full, less often used symbols will be written to disk.
279 # For small to medium size projects (<1000 input files) the default value is
280 # probably good enough. For larger projects a too small cache size can cause
281 # doxygen to be busy swapping symbols to and from disk most of the time
282 # causing a significant performance penalty.
283 # If the system has enough physical memory increasing the cache will improve the
284 # performance by keeping more symbols in memory. Note that the value works on
285 # a logarithmic scale so increasing the size by one will roughly double the
286 # memory usage. The cache size is given by this formula:
287 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
288 # corresponding to a cache size of 2^16 = 65536 symbols
289
290 SYMBOL_CACHE_SIZE = 0
375 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
376 # cache is used to resolve symbols given their name and scope. Since this can be
377 # an expensive process and often the same symbol appears multiple times in the
378 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
379 # doxygen will become slower. If the cache is too large, memory is wasted. The
380 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
381 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
382 # symbols. At the end of a run doxygen will report the cache usage and suggest
383 # the optimal cache size from a speed point of view.
384 # Minimum value: 0, maximum value: 9, default value: 0.
385
386 LOOKUP_CACHE_SIZE = 2
291387
292388 #---------------------------------------------------------------------------
293389 # Build related configuration options
294390 #---------------------------------------------------------------------------
295391
296392 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
297 # documentation are documented, even if no documentation was available.
298 # Private class members and static file members will be hidden unless
299 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
393 # documentation are documented, even if no documentation was available. Private
394 # class members and static file members will be hidden unless the
395 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
396 # Note: This will also disable the warnings about undocumented members that are
397 # normally produced when WARNINGS is set to YES.
398 # The default value is: NO.
300399
301400 EXTRACT_ALL = YES
302401
303 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
304 # will be included in the documentation.
402 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
403 # be included in the documentation.
404 # The default value is: NO.
305405
306406 EXTRACT_PRIVATE = NO
307407
308 # If the EXTRACT_STATIC tag is set to YES all static members of a file
309 # will be included in the documentation.
408 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
409 # scope will be included in the documentation.
410 # The default value is: NO.
411
412 EXTRACT_PACKAGE = NO
413
414 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
415 # included in the documentation.
416 # The default value is: NO.
310417
311418 EXTRACT_STATIC = YES
312419
313 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
314 # defined locally in source files will be included in the documentation.
315 # If set to NO only classes defined in header files are included.
420 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
421 # locally in source files will be included in the documentation. If set to NO
422 # only classes defined in header files are included. Does not have any effect
423 # for Java sources.
424 # The default value is: YES.
316425
317426 EXTRACT_LOCAL_CLASSES = YES
318427
319 # This flag is only useful for Objective-C code. When set to YES local
320 # methods, which are defined in the implementation section but not in
321 # the interface are included in the documentation.
322 # If set to NO (the default) only methods in the interface are included.
428 # This flag is only useful for Objective-C code. When set to YES local methods,
429 # which are defined in the implementation section but not in the interface are
430 # included in the documentation. If set to NO only methods in the interface are
431 # included.
432 # The default value is: NO.
323433
324434 EXTRACT_LOCAL_METHODS = NO
325435
326436 # If this flag is set to YES, the members of anonymous namespaces will be
327437 # extracted and appear in the documentation as a namespace called
328 # 'anonymous_namespace{file}', where file will be replaced with the base
329 # name of the file that contains the anonymous namespace. By default
330 # anonymous namespace are hidden.
438 # 'anonymous_namespace{file}', where file will be replaced with the base name of
439 # the file that contains the anonymous namespace. By default anonymous namespace
440 # are hidden.
441 # The default value is: NO.
331442
332443 EXTRACT_ANON_NSPACES = NO
333444
334 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
335 # undocumented members of documented classes, files or namespaces.
336 # If set to NO (the default) these members will be included in the
337 # various overviews, but no documentation section is generated.
338 # This option has no effect if EXTRACT_ALL is enabled.
445 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
446 # undocumented members inside documented classes or files. If set to NO these
447 # members will be included in the various overviews, but no documentation
448 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
449 # The default value is: NO.
339450
340451 HIDE_UNDOC_MEMBERS = NO
341452
342 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
343 # undocumented classes that are normally visible in the class hierarchy.
344 # If set to NO (the default) these classes will be included in the various
345 # overviews. This option has no effect if EXTRACT_ALL is enabled.
453 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
454 # undocumented classes that are normally visible in the class hierarchy. If set
455 # to NO these classes will be included in the various overviews. This option has
456 # no effect if EXTRACT_ALL is enabled.
457 # The default value is: NO.
346458
347459 HIDE_UNDOC_CLASSES = NO
348460
349 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
350 # friend (class|struct|union) declarations.
351 # If set to NO (the default) these declarations will be included in the
352 # documentation.
461 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
462 # (class|struct|union) declarations. If set to NO these declarations will be
463 # included in the documentation.
464 # The default value is: NO.
353465
354466 HIDE_FRIEND_COMPOUNDS = NO
355467
356 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
357 # documentation blocks found inside the body of a function.
358 # If set to NO (the default) these blocks will be appended to the
359 # function's detailed documentation block.
468 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
469 # documentation blocks found inside the body of a function. If set to NO these
470 # blocks will be appended to the function's detailed documentation block.
471 # The default value is: NO.
360472
361473 HIDE_IN_BODY_DOCS = NO
362474
363 # The INTERNAL_DOCS tag determines if documentation
364 # that is typed after a \internal command is included. If the tag is set
365 # to NO (the default) then the documentation will be excluded.
366 # Set it to YES to include the internal documentation.
475 # The INTERNAL_DOCS tag determines if documentation that is typed after a
476 # \internal command is included. If the tag is set to NO then the documentation
477 # will be excluded. Set it to YES to include the internal documentation.
478 # The default value is: NO.
367479
368480 INTERNAL_DOCS = NO
369481
370 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
371 # file names in lower-case letters. If set to YES upper-case letters are also
482 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
483 # names in lower-case letters. If set to YES upper-case letters are also
372484 # allowed. This is useful if you have classes or files whose names only differ
373485 # in case and if your file system supports case sensitive file names. Windows
374486 # and Mac users are advised to set this option to NO.
487 # The default value is: system dependent.
375488
376489 CASE_SENSE_NAMES = YES
377490
378 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
379 # will show members with their full class and namespace scopes in the
380 # documentation. If set to YES the scope will be hidden.
491 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
492 # their full class and namespace scopes in the documentation. If set to YES the
493 # scope will be hidden.
494 # The default value is: NO.
381495
382496 HIDE_SCOPE_NAMES = NO
383497
384 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
385 # will put a list of the files that are included by a file in the documentation
386 # of that file.
498 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
499 # the files that are included by a file in the documentation of that file.
500 # The default value is: YES.
387501
388502 SHOW_INCLUDE_FILES = YES
389503
390 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
391 # will list include files with double quotes in the documentation
392 # rather than with sharp brackets.
504 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
505 # grouped member an include statement to the documentation, telling the reader
506 # which file to include in order to use the member.
507 # The default value is: NO.
508
509 SHOW_GROUPED_MEMB_INC = NO
510
511 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
512 # files with double quotes in the documentation rather than with sharp brackets.
513 # The default value is: NO.
393514
394515 FORCE_LOCAL_INCLUDES = NO
395516
396 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
397 # is inserted in the documentation for inline members.
517 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
518 # documentation for inline members.
519 # The default value is: YES.
398520
399521 INLINE_INFO = YES
400522
401 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
402 # will sort the (detailed) documentation of file and class members
403 # alphabetically by member name. If set to NO the members will appear in
404 # declaration order.
523 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
524 # (detailed) documentation of file and class members alphabetically by member
525 # name. If set to NO the members will appear in declaration order.
526 # The default value is: YES.
405527
406528 SORT_MEMBER_DOCS = YES
407529
408 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
409 # brief documentation of file, namespace and class members alphabetically
410 # by member name. If set to NO (the default) the members will appear in
411 # declaration order.
530 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
531 # descriptions of file, namespace and class members alphabetically by member
532 # name. If set to NO the members will appear in declaration order. Note that
533 # this will also influence the order of the classes in the class list.
534 # The default value is: NO.
412535
413536 SORT_BRIEF_DOCS = NO
414537
415 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
416 # will sort the (brief and detailed) documentation of class members so that
417 # constructors and destructors are listed first. If set to NO (the default)
418 # the constructors will appear in the respective orders defined by
419 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
420 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
421 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
538 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
539 # (brief and detailed) documentation of class members so that constructors and
540 # destructors are listed first. If set to NO the constructors will appear in the
541 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
542 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
543 # member documentation.
544 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
545 # detailed member documentation.
546 # The default value is: NO.
422547
423548 SORT_MEMBERS_CTORS_1ST = NO
424549
425 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
426 # hierarchy of group names into alphabetical order. If set to NO (the default)
427 # the group names will appear in their defined order.
550 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
551 # of group names into alphabetical order. If set to NO the group names will
552 # appear in their defined order.
553 # The default value is: NO.
428554
429555 SORT_GROUP_NAMES = NO
430556
431 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
432 # sorted by fully-qualified names, including namespaces. If set to
433 # NO (the default), the class list will be sorted only by class name,
434 # not including the namespace part.
557 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
558 # fully-qualified names, including namespaces. If set to NO, the class list will
559 # be sorted only by class name, not including the namespace part.
435560 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
436 # Note: This option applies only to the class list, not to the
437 # alphabetical list.
561 # Note: This option applies only to the class list, not to the alphabetical
562 # list.
563 # The default value is: NO.
438564
439565 SORT_BY_SCOPE_NAME = NO
440566
441 # The GENERATE_TODOLIST tag can be used to enable (YES) or
442 # disable (NO) the todo list. This list is created by putting \todo
443 # commands in the documentation.
567 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
568 # type resolution of all parameters of a function it will reject a match between
569 # the prototype and the implementation of a member function even if there is
570 # only one candidate or it is obvious which candidate to choose by doing a
571 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
572 # accept a match between prototype and implementation in such cases.
573 # The default value is: NO.
574
575 STRICT_PROTO_MATCHING = NO
576
577 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
578 # todo list. This list is created by putting \todo commands in the
579 # documentation.
580 # The default value is: YES.
444581
445582 GENERATE_TODOLIST = YES
446583
447 # The GENERATE_TESTLIST tag can be used to enable (YES) or
448 # disable (NO) the test list. This list is created by putting \test
449 # commands in the documentation.
584 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
585 # test list. This list is created by putting \test commands in the
586 # documentation.
587 # The default value is: YES.
450588
451589 GENERATE_TESTLIST = YES
452590
453 # The GENERATE_BUGLIST tag can be used to enable (YES) or
454 # disable (NO) the bug list. This list is created by putting \bug
455 # commands in the documentation.
591 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
592 # list. This list is created by putting \bug commands in the documentation.
593 # The default value is: YES.
456594
457595 GENERATE_BUGLIST = YES
458596
459 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
460 # disable (NO) the deprecated list. This list is created by putting
461 # \deprecated commands in the documentation.
597 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
598 # the deprecated list. This list is created by putting \deprecated commands in
599 # the documentation.
600 # The default value is: YES.
462601
463602 GENERATE_DEPRECATEDLIST= YES
464603
465 # The ENABLED_SECTIONS tag can be used to enable conditional
466 # documentation sections, marked by \if sectionname ... \endif.
604 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
605 # sections, marked by \if ... \endif and \cond
606 # ... \endcond blocks.
467607
468608 ENABLED_SECTIONS =
469609
470 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
471 # the initial value of a variable or define consists of for it to appear in
472 # the documentation. If the initializer consists of more lines than specified
473 # here it will be hidden. Use a value of 0 to hide initializers completely.
474 # The appearance of the initializer of individual variables and defines in the
475 # documentation can be controlled using \showinitializer or \hideinitializer
476 # command in the documentation regardless of this setting.
610 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
611 # initial value of a variable or macro / define can have for it to appear in the
612 # documentation. If the initializer consists of more lines than specified here
613 # it will be hidden. Use a value of 0 to hide initializers completely. The
614 # appearance of the value of individual variables and macros / defines can be
615 # controlled using \showinitializer or \hideinitializer command in the
616 # documentation regardless of this setting.
617 # Minimum value: 0, maximum value: 10000, default value: 30.
477618
478619 MAX_INITIALIZER_LINES = 30
479620
480 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
481 # at the bottom of the documentation of classes and structs. If set to YES the
482 # list will mention the files that were used to generate the documentation.
621 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
622 # the bottom of the documentation of classes and structs. If set to YES the list
623 # will mention the files that were used to generate the documentation.
624 # The default value is: YES.
483625
484626 SHOW_USED_FILES = YES
485627
486 # If the sources in your project are distributed over multiple directories
487 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
488 # in the documentation. The default is NO.
489
490 SHOW_DIRECTORIES = YES
491
492 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
493 # This will remove the Files entry from the Quick Index and from the
494 # Folder Tree View (if specified). The default is YES.
628 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
629 # will remove the Files entry from the Quick Index and from the Folder Tree View
630 # (if specified).
631 # The default value is: YES.
495632
496633 SHOW_FILES = YES
497634
498 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
499 # Namespaces page.
500 # This will remove the Namespaces entry from the Quick Index
501 # and from the Folder Tree View (if specified). The default is YES.
635 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
636 # page. This will remove the Namespaces entry from the Quick Index and from the
637 # Folder Tree View (if specified).
638 # The default value is: YES.
502639
503640 SHOW_NAMESPACES = YES
504641
505642 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
506643 # doxygen should invoke to get the current version for each file (typically from
507644 # the version control system). Doxygen will invoke the program by executing (via
508 # popen()) the command , where is the value of
509 # the FILE_VERSION_FILTER tag, and is the name of an input file
510 # provided by doxygen. Whatever the program writes to standard output
511 # is used as the file version. See the manual for examples.
645 # popen()) the command command input-file, where command is the value of the
646 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
647 # by doxygen. Whatever the program writes to standard output is used as the file
648 # version. For an example see the documentation.
512649
513650 FILE_VERSION_FILTER =
514651
515652 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
516653 # by doxygen. The layout file controls the global structure of the generated
517 # output files in an output format independent way. The create the layout file
518 # that represents doxygen's defaults, run doxygen with the -l option.
519 # You can optionally specify a file name after the option, if omitted
520 # DoxygenLayout.xml will be used as the name of the layout file.
654 # output files in an output format independent way. To create the layout file
655 # that represents doxygen's defaults, run doxygen with the -l option. You can
656 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
657 # will be used as the name of the layout file.
658 #
659 # Note that if you run doxygen from a directory containing a file called
660 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
661 # tag is left empty.
521662
522663 LAYOUT_FILE =
523664
524 #---------------------------------------------------------------------------
525 # configuration options related to warning and progress messages
526 #---------------------------------------------------------------------------
527
528 # The QUIET tag can be used to turn on/off the messages that are generated
529 # by doxygen. Possible values are YES and NO. If left blank NO is used.
665 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
666 # the reference definitions. This must be a list of .bib files. The .bib
667 # extension is automatically appended if omitted. This requires the bibtex tool
668 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
669 # For LaTeX the style of the bibliography can be controlled using
670 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
671 # search path. Do not use file names with spaces, bibtex cannot handle them. See
672 # also \cite for info how to create references.
673
674 CITE_BIB_FILES =
675
676 #---------------------------------------------------------------------------
677 # Configuration options related to warning and progress messages
678 #---------------------------------------------------------------------------
679
680 # The QUIET tag can be used to turn on/off the messages that are generated to
681 # standard output by doxygen. If QUIET is set to YES this implies that the
682 # messages are off.
683 # The default value is: NO.
530684
531685 QUIET = NO
532686
533687 # The WARNINGS tag can be used to turn on/off the warning messages that are
534 # generated by doxygen. Possible values are YES and NO. If left blank
535 # NO is used.
688 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
689 # this implies that the warnings are on.
690 #
691 # Tip: Turn warnings on while writing the documentation.
692 # The default value is: YES.
536693
537694 WARNINGS = NO
538695
539 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
540 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
541 # automatically be disabled.
696 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
697 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
698 # will automatically be disabled.
699 # The default value is: YES.
542700
543701 WARN_IF_UNDOCUMENTED = NO
544702
545 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
546 # potential errors in the documentation, such as not documenting some
547 # parameters in a documented function, or documenting parameters that
548 # don't exist or using markup commands wrongly.
703 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
704 # potential errors in the documentation, such as not documenting some parameters
705 # in a documented function, or documenting parameters that don't exist or using
706 # markup commands wrongly.
707 # The default value is: YES.
549708
550709 WARN_IF_DOC_ERROR = YES
551710
552 # This WARN_NO_PARAMDOC option can be abled to get warnings for
553 # functions that are documented, but have no documentation for their parameters
554 # or return value. If set to NO (the default) doxygen will only warn about
555 # wrong or incomplete parameter documentation, but not about the absence of
556 # documentation.
711 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
712 # are documented, but have no documentation for their parameters or return
713 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
714 # documentation, but not about the absence of documentation.
715 # The default value is: NO.
557716
558717 WARN_NO_PARAMDOC = NO
559718
560 # The WARN_FORMAT tag determines the format of the warning messages that
561 # doxygen can produce. The string should contain the $file, $line, and $text
562 # tags, which will be replaced by the file and line number from which the
563 # warning originated and the warning text. Optionally the format may contain
564 # $version, which will be replaced by the version of the file (if it could
565 # be obtained via FILE_VERSION_FILTER)
566
567 WARN_FORMAT =
568
569 # The WARN_LOGFILE tag can be used to specify a file to which warning
570 # and error messages should be written. If left blank the output is written
571 # to stderr.
719 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
720 # can produce. The string should contain the $file, $line, and $text tags, which
721 # will be replaced by the file and line number from which the warning originated
722 # and the warning text. Optionally the format may contain $version, which will
723 # be replaced by the version of the file (if it could be obtained via
724 # FILE_VERSION_FILTER)
725 # The default value is: $file:$line: $text.
726
727 WARN_FORMAT = "$file:$line: $text"
728
729 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
730 # messages should be written. If left blank the output is written to standard
731 # error (stderr).
572732
573733 WARN_LOGFILE =
574734
575735 #---------------------------------------------------------------------------
576 # configuration options related to the input files
577 #---------------------------------------------------------------------------
578
579 # The INPUT tag can be used to specify the files and/or directories that contain
580 # documented source files. You may enter file names like "myfile.cpp" or
581 # directories like "/usr/src/myproject". Separate the files or directories
582 # with spaces.
736 # Configuration options related to the input files
737 #---------------------------------------------------------------------------
738
739 # The INPUT tag is used to specify the files and/or directories that contain
740 # documented source files. You may enter file names like myfile.cpp or
741 # directories like /usr/src/myproject. Separate the files or directories with
742 # spaces.
743 # Note: If this tag is empty the current directory is searched.
583744
584745 INPUT = @abs_top_srcdir@/include \
585746 @abs_top_srcdir@/lib \
586747 @abs_top_srcdir@/docs/doxygen.intro
587748
588749 # This tag can be used to specify the character encoding of the source files
589 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
590 # also the default input encoding. Doxygen uses libiconv (or the iconv built
591 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
592 # the list of possible encodings.
750 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
751 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
752 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
753 # possible encodings.
754 # The default value is: UTF-8.
593755
594756 INPUT_ENCODING = UTF-8
595757
596758 # If the value of the INPUT tag contains directories, you can use the
597 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
598 # and *.h) to filter out the source-files in the directories. If left
599 # blank the following patterns are tested:
600 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
601 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
759 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
760 # *.h) to filter out the source-files in the directories. If left blank the
761 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
762 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
763 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
764 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
765 # *.qsf, *.as and *.js.
602766
603767 FILE_PATTERNS =
604768
605 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
606 # should be searched for input files as well. Possible values are YES and NO.
607 # If left blank NO is used.
769 # The RECURSIVE tag can be used to specify whether or not subdirectories should
770 # be searched for input files as well.
771 # The default value is: NO.
608772
609773 RECURSIVE = YES
610774
611 # The EXCLUDE tag can be used to specify files and/or directories that should
775 # The EXCLUDE tag can be used to specify files and/or directories that should be
612776 # excluded from the INPUT source files. This way you can easily exclude a
613777 # subdirectory from a directory tree whose root is specified with the INPUT tag.
778 #
779 # Note that relative paths are relative to the directory from which doxygen is
780 # run.
614781
615782 EXCLUDE =
616783
617 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
618 # directories that are symbolic links (a Unix filesystem feature) are excluded
784 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
785 # directories that are symbolic links (a Unix file system feature) are excluded
619786 # from the input.
787 # The default value is: NO.
620788
621789 EXCLUDE_SYMLINKS = NO
622790
623791 # If the value of the INPUT tag contains directories, you can use the
624792 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
625 # certain files from those directories. Note that the wildcards are matched
626 # against the file with absolute path, so to exclude all test directories
627 # for example use the pattern */test/*
793 # certain files from those directories.
794 #
795 # Note that the wildcards are matched against the file with absolute path, so to
796 # exclude all test directories for example use the pattern */test/*
628797
629798 EXCLUDE_PATTERNS =
630799
633802 # output. The symbol name can be a fully qualified name, a word, or if the
634803 # wildcard * is used, a substring. Examples: ANamespace, AClass,
635804 # AClass::ANamespace, ANamespace::*Test
805 #
806 # Note that the wildcards are matched against the file with absolute path, so to
807 # exclude all test directories use the pattern */test/*
636808
637809 EXCLUDE_SYMBOLS =
638810
639 # The EXAMPLE_PATH tag can be used to specify one or more files or
640 # directories that contain example code fragments that are included (see
641 # the \include command).
811 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
812 # that contain example code fragments that are included (see the \include
813 # command).
642814
643815 EXAMPLE_PATH = @abs_top_srcdir@/examples
644816
645817 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
646 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
647 # and *.h) to filter out the source-files in the directories. If left
648 # blank all files are included.
818 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
819 # *.h) to filter out the source-files in the directories. If left blank all
820 # files are included.
649821
650822 EXAMPLE_PATTERNS =
651823
652824 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
653 # searched for input files to be used with the \include or \dontinclude
654 # commands irrespective of the value of the RECURSIVE tag.
655 # Possible values are YES and NO. If left blank NO is used.
825 # searched for input files to be used with the \include or \dontinclude commands
826 # irrespective of the value of the RECURSIVE tag.
827 # The default value is: NO.
656828
657829 EXAMPLE_RECURSIVE = YES
658830
659 # The IMAGE_PATH tag can be used to specify one or more files or
660 # directories that contain image that are included in the documentation (see
661 # the \image command).
831 # The IMAGE_PATH tag can be used to specify one or more files or directories
832 # that contain images that are to be included in the documentation (see the
833 # \image command).
662834
663835 IMAGE_PATH = @abs_top_srcdir@/docs/img
664836
665837 # The INPUT_FILTER tag can be used to specify a program that doxygen should
666838 # invoke to filter for each input file. Doxygen will invoke the filter program
667 # by executing (via popen()) the command , where
668 # is the value of the INPUT_FILTER tag, and is the name of an
669 # input file. Doxygen will then use the output that the filter program writes
670 # to standard output.
671 # If FILTER_PATTERNS is specified, this tag will be
672 # ignored.
839 # by executing (via popen()) the command:
840 #
841 #
842 #
843 # where is the value of the INPUT_FILTER tag, and is the
844 # name of an input file. Doxygen will then use the output that the filter
845 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
846 # will be ignored.
847 #
848 # Note that the filter must not add or remove lines; it is applied before the
849 # code is scanned, but not when the output code is generated. If lines are added
850 # or removed, the anchors will not be placed correctly.
673851
674852 INPUT_FILTER =
675853
676854 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
677 # basis.
678 # Doxygen will compare the file name with each pattern and apply the
679 # filter if there is a match.
680 # The filters are a list of the form:
681 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
682 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
683 # is applied to all files.
855 # basis. Doxygen will compare the file name with each pattern and apply the
856 # filter if there is a match. The filters are a list of the form: pattern=filter
857 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
858 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
859 # patterns match the file name, INPUT_FILTER is applied.
684860
685861 FILTER_PATTERNS =
686862
687863 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
688 # INPUT_FILTER) will be used to filter the input files when producing source
689 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
864 # INPUT_FILTER ) will also be used to filter the input files that are used for
865 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
866 # The default value is: NO.
690867
691868 FILTER_SOURCE_FILES = NO
692869
693 #---------------------------------------------------------------------------
694 # configuration options related to source browsing
695 #---------------------------------------------------------------------------
696
697 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
698 # be generated. Documented entities will be cross-referenced with these sources.
699 # Note: To get rid of all source code in the generated output, make sure also
700 # VERBATIM_HEADERS is set to NO.
870 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
871 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
872 # it is also possible to disable source filtering for a specific pattern using
873 # *.ext= (so without naming a filter).
874 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
875
876 FILTER_SOURCE_PATTERNS =
877
878 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
879 # is part of the input, its contents will be placed on the main page
880 # (index.html). This can be useful if you have a project on for instance GitHub
881 # and want to reuse the introduction page also for the doxygen output.
882
883 USE_MDFILE_AS_MAINPAGE =
884
885 #---------------------------------------------------------------------------
886 # Configuration options related to source browsing
887 #---------------------------------------------------------------------------
888
889 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
890 # generated. Documented entities will be cross-referenced with these sources.
891 #
892 # Note: To get rid of all source code in the generated output, make sure that
893 # also VERBATIM_HEADERS is set to NO.
894 # The default value is: NO.
701895
702896 SOURCE_BROWSER = YES
703897
704 # Setting the INLINE_SOURCES tag to YES will include the body
705 # of functions and classes directly in the documentation.
898 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
899 # classes and enums directly into the documentation.
900 # The default value is: NO.
706901
707902 INLINE_SOURCES = NO
708903
709 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
710 # doxygen to hide any special comment blocks from generated source code
711 # fragments. Normal C and C++ comments will always remain visible.
904 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
905 # special comment blocks from generated source code fragments. Normal C, C++ and
906 # Fortran comments will always remain visible.
907 # The default value is: YES.
712908
713909 STRIP_CODE_COMMENTS = NO
714910
715 # If the REFERENCED_BY_RELATION tag is set to YES
716 # then for each documented function all documented
717 # functions referencing it will be listed.
911 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
912 # function all documented functions referencing it will be listed.
913 # The default value is: NO.
718914
719915 REFERENCED_BY_RELATION = YES
720916
721 # If the REFERENCES_RELATION tag is set to YES
722 # then for each documented function all documented entities
723 # called/used by that function will be listed.
917 # If the REFERENCES_RELATION tag is set to YES then for each documented function
918 # all documented entities called/used by that function will be listed.
919 # The default value is: NO.
724920
725921 REFERENCES_RELATION = YES
726922
727 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
728 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
729 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
730 # link to the source code.
731 # Otherwise they will link to the documentation.
923 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
924 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
925 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
926 # link to the documentation.
927 # The default value is: YES.
732928
733929 REFERENCES_LINK_SOURCE = YES
734930
735 # If the USE_HTAGS tag is set to YES then the references to source code
736 # will point to the HTML generated by the htags(1) tool instead of doxygen
737 # built-in source browser. The htags tool is part of GNU's global source
738 # tagging system (see http://www.gnu.org/software/global/global.html). You
739 # will need version 4.8.6 or higher.
931 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
932 # source code will show a tooltip with additional information such as prototype,
933 # brief description and links to the definition and documentation. Since this
934 # will make the HTML file larger and loading of large files a bit slower, you
935 # can opt to disable this feature.
936 # The default value is: YES.
937 # This tag requires that the tag SOURCE_BROWSER is set to YES.
938
939 SOURCE_TOOLTIPS = YES
940
941 # If the USE_HTAGS tag is set to YES then the references to source code will
942 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
943 # source browser. The htags tool is part of GNU's global source tagging system
944 # (see http://www.gnu.org/software/global/global.html). You will need version
945 # 4.8.6 or higher.
946 #
947 # To use it do the following:
948 # - Install the latest version of global
949 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
950 # - Make sure the INPUT points to the root of the source tree
951 # - Run doxygen as normal
952 #
953 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
954 # tools must be available from the command line (i.e. in the search path).
955 #
956 # The result: instead of the source browser generated by doxygen, the links to
957 # source code will now point to the output of htags.
958 # The default value is: NO.
959 # This tag requires that the tag SOURCE_BROWSER is set to YES.
740960
741961 USE_HTAGS = NO
742962
743 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
744 # will generate a verbatim copy of the header file for each class for
745 # which an include is specified. Set to NO to disable this.
963 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
964 # verbatim copy of the header file for each class for which an include is
965 # specified. Set to NO to disable this.
966 # See also: Section \class.
967 # The default value is: YES.
746968
747969 VERBATIM_HEADERS = YES
748970
749971 #---------------------------------------------------------------------------
750 # configuration options related to the alphabetical class index
751 #---------------------------------------------------------------------------
752
753 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
754 # of all compounds will be generated. Enable this if the project
755 # contains a lot of classes, structs, unions or interfaces.
972 # Configuration options related to the alphabetical class index
973 #---------------------------------------------------------------------------
974
975 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
976 # compounds will be generated. Enable this if the project contains a lot of
977 # classes, structs, unions or interfaces.
978 # The default value is: YES.
756979
757980 ALPHABETICAL_INDEX = YES
758981
759 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
760 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
761 # in which this list will be split (can be a number in the range [1..20])
982 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
983 # which the alphabetical index list will be split.
984 # Minimum value: 1, maximum value: 20, default value: 5.
985 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
762986
763987 COLS_IN_ALPHA_INDEX = 4
764988
765 # In case all classes in a project start with a common prefix, all
766 # classes will be put under the same header in the alphabetical index.
767 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
768 # should be ignored while generating the index headers.
989 # In case all classes in a project start with a common prefix, all classes will
990 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
991 # can be used to specify a prefix (or a list of prefixes) that should be ignored
992 # while generating the index headers.
993 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
769994
770995 IGNORE_PREFIX = llvm::
771996
772997 #---------------------------------------------------------------------------
773 # configuration options related to the HTML output
774 #---------------------------------------------------------------------------
775
776 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
777 # generate HTML output.
998 # Configuration options related to the HTML output
999 #---------------------------------------------------------------------------
1000
1001 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1002 # The default value is: YES.
7781003
7791004 GENERATE_HTML = YES
7801005
781 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
782 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
783 # put in front of it. If left blank `html' will be used as the default path.
1006 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1007 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1008 # it.
1009 # The default directory is: html.
1010 # This tag requires that the tag GENERATE_HTML is set to YES.
7841011
7851012 HTML_OUTPUT = html
7861013
787 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
788 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
789 # doxygen will generate files with .html extension.
1014 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1015 # generated HTML page (for example: .htm, .php, .asp).
1016 # The default value is: .html.
1017 # This tag requires that the tag GENERATE_HTML is set to YES.
7901018
7911019 HTML_FILE_EXTENSION = .html
7921020
793 # The HTML_HEADER tag can be used to specify a personal HTML header for
794 # each generated HTML page. If it is left blank doxygen will generate a
1021 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1022 # each generated HTML page. If the tag is left blank doxygen will generate a
7951023 # standard header.
796
797 HTML_HEADER = @abs_top_srcdir@/docs/doxygen.header
798
799 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
800 # each generated HTML page. If it is left blank doxygen will generate a
801 # standard footer.
802
803 HTML_FOOTER = @abs_top_srcdir@/docs/doxygen.footer
804
805 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
806 # style sheet that is used by each HTML page. It can be used to
807 # fine-tune the look of the HTML output. If the tag is left blank doxygen
808 # will generate a default style sheet. Note that doxygen will try to copy
809 # the style sheet file to the HTML output directory, so don't put your own
810 # stylesheet in the HTML output directory as well, or it will be erased!
811
812 HTML_STYLESHEET = @abs_top_srcdir@/docs/doxygen.css
813
814 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
815 # Doxygen will adjust the colors in the stylesheet and background images
816 # according to this color. Hue is specified as an angle on a colorwheel,
817 # see http://en.wikipedia.org/wiki/Hue for more information.
818 # For instance the value 0 represents red, 60 is yellow, 120 is green,
819 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
820 # The allowed range is 0 to 359.
1024 #
1025 # To get valid HTML the header file that includes any scripts and style sheets
1026 # that doxygen needs, which is dependent on the configuration options used (e.g.
1027 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1028 # default header using
1029 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1030 # YourConfigFile
1031 # and then modify the file new_header.html. See also section "Doxygen usage"
1032 # for information on how to generate the default header that doxygen normally
1033 # uses.
1034 # Note: The header is subject to change so you typically have to regenerate the
1035 # default header when upgrading to a newer version of doxygen. For a description
1036 # of the possible markers and block names see the documentation.
1037 # This tag requires that the tag GENERATE_HTML is set to YES.
1038
1039 HTML_HEADER =
1040
1041 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1042 # generated HTML page. If the tag is left blank doxygen will generate a standard
1043 # footer. See HTML_HEADER for more information on how to generate a default
1044 # footer and what special commands can be used inside the footer. See also
1045 # section "Doxygen usage" for information on how to generate the default footer
1046 # that doxygen normally uses.
1047 # This tag requires that the tag GENERATE_HTML is set to YES.
1048
1049 HTML_FOOTER =
1050
1051 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1052 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1053 # the HTML output. If left blank doxygen will generate a default style sheet.
1054 # See also section "Doxygen usage" for information on how to generate the style
1055 # sheet that doxygen normally uses.
1056 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1057 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1058 # obsolete.
1059 # This tag requires that the tag GENERATE_HTML is set to YES.
1060
1061 HTML_STYLESHEET =
1062
1063 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1064 # defined cascading style sheet that is included after the standard style sheets
1065 # created by doxygen. Using this option one can overrule certain style aspects.
1066 # This is preferred over using HTML_STYLESHEET since it does not replace the
1067 # standard style sheet and is therefor more robust against future updates.
1068 # Doxygen will copy the style sheet file to the output directory. For an example
1069 # see the documentation.
1070 # This tag requires that the tag GENERATE_HTML is set to YES.
1071
1072 HTML_EXTRA_STYLESHEET =
1073
1074 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1075 # other source files which should be copied to the HTML output directory. Note
1076 # that these files will be copied to the base HTML output directory. Use the
1077 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1078 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1079 # files will be copied as-is; there are no commands or markers available.
1080 # This tag requires that the tag GENERATE_HTML is set to YES.
1081
1082 HTML_EXTRA_FILES =
1083
1084 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1085 # will adjust the colors in the stylesheet and background images according to
1086 # this color. Hue is specified as an angle on a colorwheel, see
1087 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1088 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1089 # purple, and 360 is red again.
1090 # Minimum value: 0, maximum value: 359, default value: 220.
1091 # This tag requires that the tag GENERATE_HTML is set to YES.
8211092
8221093 HTML_COLORSTYLE_HUE = 220
8231094
824 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
825 # the colors in the HTML output. For a value of 0 the output will use
826 # grayscales only. A value of 255 will produce the most vivid colors.
1095 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1096 # in the HTML output. For a value of 0 the output will use grayscales only. A
1097 # value of 255 will produce the most vivid colors.
1098 # Minimum value: 0, maximum value: 255, default value: 100.
1099 # This tag requires that the tag GENERATE_HTML is set to YES.
8271100
8281101 HTML_COLORSTYLE_SAT = 100
8291102
830 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
831 # the luminance component of the colors in the HTML output. Values below
832 # 100 gradually make the output lighter, whereas values above 100 make
833 # the output darker. The value divided by 100 is the actual gamma applied,
834 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
835 # and 100 does not change the gamma.
1103 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1104 # luminance component of the colors in the HTML output. Values below 100
1105 # gradually make the output lighter, whereas values above 100 make the output
1106 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1107 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1108 # change the gamma.
1109 # Minimum value: 40, maximum value: 240, default value: 80.
1110 # This tag requires that the tag GENERATE_HTML is set to YES.
8361111
8371112 HTML_COLORSTYLE_GAMMA = 80
8381113
8391114 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
840 # page will contain the date and time when the page was generated. Setting
841 # this to NO can help when comparing the output of multiple runs.
1115 # page will contain the date and time when the page was generated. Setting this
1116 # to NO can help when comparing the output of multiple runs.
1117 # The default value is: YES.
1118 # This tag requires that the tag GENERATE_HTML is set to YES.
8421119
8431120 HTML_TIMESTAMP = YES
844
845 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
846 # files or namespaces will be aligned in HTML using tables. If set to
847 # NO a bullet list will be used.
848
849 HTML_ALIGN_MEMBERS = YES
8501121
8511122 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
8521123 # documentation will contain sections that can be hidden and shown after the
853 # page has loaded. For this to work a browser that supports
854 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
855 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
1124 # page has loaded.
1125 # The default value is: NO.
1126 # This tag requires that the tag GENERATE_HTML is set to YES.
8561127
8571128 HTML_DYNAMIC_SECTIONS = NO
8581129
859 # If the GENERATE_DOCSET tag is set to YES, additional index files
860 # will be generated that can be used as input for Apple's Xcode 3
861 # integrated development environment, introduced with OSX 10.5 (Leopard).
862 # To create a documentation set, doxygen will generate a Makefile in the
863 # HTML output directory. Running make will produce the docset in that
864 # directory and running "make install" will install the docset in
865 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
866 # it at startup.
867 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1130 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1131 # shown in the various tree structured indices initially; the user can expand
1132 # and collapse entries dynamically later on. Doxygen will expand the tree to
1133 # such a level that at most the specified number of entries are visible (unless
1134 # a fully collapsed tree already exceeds this amount). So setting the number of
1135 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1136 # representing an infinite number of entries and will result in a full expanded
1137 # tree by default.
1138 # Minimum value: 0, maximum value: 9999, default value: 100.
1139 # This tag requires that the tag GENERATE_HTML is set to YES.
1140
1141 HTML_INDEX_NUM_ENTRIES = 100
1142
1143 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1144 # generated that can be used as input for Apple's Xcode 3 integrated development
1145 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1146 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1147 # Makefile in the HTML output directory. Running make will produce the docset in
1148 # that directory and running make install will install the docset in
1149 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1150 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
8681151 # for more information.
1152 # The default value is: NO.
1153 # This tag requires that the tag GENERATE_HTML is set to YES.
8691154
8701155 GENERATE_DOCSET = NO
8711156
872 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
873 # feed. A documentation feed provides an umbrella under which multiple
874 # documentation sets from a single provider (such as a company or product suite)
875 # can be grouped.
1157 # This tag determines the name of the docset feed. A documentation feed provides
1158 # an umbrella under which multiple documentation sets from a single provider
1159 # (such as a company or product suite) can be grouped.
1160 # The default value is: Doxygen generated docs.
1161 # This tag requires that the tag GENERATE_DOCSET is set to YES.
8761162
8771163 DOCSET_FEEDNAME = "Doxygen generated docs"
8781164
879 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
880 # should uniquely identify the documentation set bundle. This should be a
881 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
882 # will append .docset to the name.
1165 # This tag specifies a string that should uniquely identify the documentation
1166 # set bundle. This should be a reverse domain-name style string, e.g.
1167 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1168 # The default value is: org.doxygen.Project.
1169 # This tag requires that the tag GENERATE_DOCSET is set to YES.
8831170
8841171 DOCSET_BUNDLE_ID = org.doxygen.Project
8851172
886 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
1173 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
8871174 # the documentation publisher. This should be a reverse domain-name style
8881175 # string, e.g. com.mycompany.MyDocSet.documentation.
1176 # The default value is: org.doxygen.Publisher.
1177 # This tag requires that the tag GENERATE_DOCSET is set to YES.
8891178
8901179 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
8911180
892 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1181 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1182 # The default value is: Publisher.
1183 # This tag requires that the tag GENERATE_DOCSET is set to YES.
8931184
8941185 DOCSET_PUBLISHER_NAME = Publisher
8951186
896 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
897 # will be generated that can be used as input for tools like the
898 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
899 # of the generated HTML documentation.
1187 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1188 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1189 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1190 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1191 # Windows.
1192 #
1193 # The HTML Help Workshop contains a compiler that can convert all HTML output
1194 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1195 # files are now used as the Windows 98 help format, and will replace the old
1196 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1197 # HTML files also contain an index, a table of contents, and you can search for
1198 # words in the documentation. The HTML workshop also contains a viewer for
1199 # compressed HTML files.
1200 # The default value is: NO.
1201 # This tag requires that the tag GENERATE_HTML is set to YES.
9001202
9011203 GENERATE_HTMLHELP = NO
9021204
903 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
904 # be used to specify the file name of the resulting .chm file. You
905 # can add a path in front of the file if the result should not be
1205 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1206 # file. You can add a path in front of the file if the result should not be
9061207 # written to the html output directory.
1208 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
9071209
9081210 CHM_FILE =
9091211
910 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
911 # be used to specify the location (absolute path including file name) of
912 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
913 # the HTML help compiler on the generated index.hhp.
1212 # The HHC_LOCATION tag can be used to specify the location (absolute path
1213 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1214 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1215 # The file has to be specified with full path.
1216 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
9141217
9151218 HHC_LOCATION =
9161219
917 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
918 # controls if a separate .chi index file is generated (YES) or that
919 # it should be included in the master .chm file (NO).
1220 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1221 # YES) or that it should be included in the master .chm file ( NO).
1222 # The default value is: NO.
1223 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
9201224
9211225 GENERATE_CHI = NO
9221226
923 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
924 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
925 # content.
1227 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1228 # and project file content.
1229 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
9261230
9271231 CHM_INDEX_ENCODING =
9281232
929 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
930 # controls whether a binary table of contents is generated (YES) or a
931 # normal table of contents (NO) in the .chm file.
1233 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1234 # YES) or a normal table of contents ( NO) in the .chm file.
1235 # The default value is: NO.
1236 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
9321237
9331238 BINARY_TOC = NO
9341239
935 # The TOC_EXPAND flag can be set to YES to add extra items for group members
936 # to the contents of the HTML help documentation and to the tree view.
1240 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1241 # the table of contents of the HTML help documentation and to the tree view.
1242 # The default value is: NO.
1243 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
9371244
9381245 TOC_EXPAND = NO
9391246
940 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
941 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
942 # that can be used as input for Qt's qhelpgenerator to generate a
943 # Qt Compressed Help (.qch) of the generated HTML documentation.
1247 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1248 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1249 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1250 # (.qch) of the generated HTML documentation.
1251 # The default value is: NO.
1252 # This tag requires that the tag GENERATE_HTML is set to YES.
9441253
9451254 GENERATE_QHP = @llvm_doxygen_generate_qhp@
9461255
947 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
948 # be used to specify the file name of the resulting .qch file.
949 # The path specified is relative to the HTML output folder.
1256 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1257 # the file name of the resulting .qch file. The path specified is relative to
1258 # the HTML output folder.
1259 # This tag requires that the tag GENERATE_QHP is set to YES.
9501260
9511261 QCH_FILE = @llvm_doxygen_qch_filename@
9521262
953 # The QHP_NAMESPACE tag specifies the namespace to use when generating
954 # Qt Help Project output. For more information please see
955 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace
1263 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1264 # Project output. For more information please see Qt Help Project / Namespace
1265 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1266 # The default value is: org.doxygen.Project.
1267 # This tag requires that the tag GENERATE_QHP is set to YES.
9561268
9571269 QHP_NAMESPACE = @llvm_doxygen_qhp_namespace@
9581270
959 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
960 # Qt Help Project output. For more information please see
961 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-folders
1271 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1272 # Help Project output. For more information please see Qt Help Project / Virtual
1273 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1274 # folders).
1275 # The default value is: doc.
1276 # This tag requires that the tag GENERATE_QHP is set to YES.
9621277
9631278 QHP_VIRTUAL_FOLDER = doc
9641279
965 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
966 # add. For more information please see
967 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters
1280 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1281 # filter to add. For more information please see Qt Help Project / Custom
1282 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1283 # filters).
1284 # This tag requires that the tag GENERATE_QHP is set to YES.
9681285
9691286 QHP_CUST_FILTER_NAME = @llvm_doxygen_qhp_cust_filter_name@
9701287
971 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
972 # custom filter to add. For more information please see
973 #
974 # Qt Help Project / Custom Filters.
1288 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1289 # custom filter to add. For more information please see Qt Help Project / Custom
1290 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1291 # filters).
1292 # This tag requires that the tag GENERATE_QHP is set to YES.
9751293
9761294 QHP_CUST_FILTER_ATTRS = @llvm_doxygen_qhp_cust_filter_attrs@
9771295
978 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
979 # project's
980 # filter section matches.
981 #
982 # Qt Help Project / Filter Attributes.
983
984 QHP_SECT_FILTER_ATTRS =
985
986 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
987 # be used to specify the location of Qt's qhelpgenerator.
988 # If non-empty doxygen will try to run qhelpgenerator on the generated
989 # .qhp file.
1296 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1297 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1298 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1299 # This tag requires that the tag GENERATE_QHP is set to YES.
1300
1301 QHP_SECT_FILTER_ATTRS =
1302
1303 # The QHG_LOCATION tag can be used to specify the location of Qt's
1304 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1305 # generated .qhp file.
1306 # This tag requires that the tag GENERATE_QHP is set to YES.
9901307
9911308 QHG_LOCATION = @llvm_doxygen_qhelpgenerator_path@
9921309
993 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
994 # will be generated, which together with the HTML files, form an Eclipse help
995 # plugin. To install this plugin and make it available under the help contents
996 # menu in Eclipse, the contents of the directory containing the HTML and XML
997 # files needs to be copied into the plugins directory of eclipse. The name of
998 # the directory within the plugins directory should be the same as
999 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1000 # the help appears.
1310 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1311 # generated, together with the HTML files, they form an Eclipse help plugin. To
1312 # install this plugin and make it available under the help contents menu in
1313 # Eclipse, the contents of the directory containing the HTML and XML files needs
1314 # to be copied into the plugins directory of eclipse. The name of the directory
1315 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1316 # After copying Eclipse needs to be restarted before the help appears.
1317 # The default value is: NO.
1318 # This tag requires that the tag GENERATE_HTML is set to YES.
10011319
10021320 GENERATE_ECLIPSEHELP = NO
10031321
1004 # A unique identifier for the eclipse help plugin. When installing the plugin
1005 # the directory name containing the HTML and XML files should also have
1006 # this name.
1322 # A unique identifier for the Eclipse help plugin. When installing the plugin
1323 # the directory name containing the HTML and XML files should also have this
1324 # name. Each documentation set should have its own identifier.
1325 # The default value is: org.doxygen.Project.
1326 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
10071327
10081328 ECLIPSE_DOC_ID = org.doxygen.Project
10091329
1010 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1011 # top of each HTML page. The value NO (the default) enables the index and
1012 # the value YES disables it.
1330 # If you want full control over the layout of the generated HTML pages it might
1331 # be necessary to disable the index and replace it with your own. The
1332 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1333 # of each HTML page. A value of NO enables the index and the value YES disables
1334 # it. Since the tabs in the index contain the same information as the navigation
1335 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1336 # The default value is: NO.
1337 # This tag requires that the tag GENERATE_HTML is set to YES.
10131338
10141339 DISABLE_INDEX = NO
10151340
1016 # This tag can be used to set the number of enum values (range [1..20])
1017 # that doxygen will group on one line in the generated HTML documentation.
1341 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1342 # structure should be generated to display hierarchical information. If the tag
1343 # value is set to YES, a side panel will be generated containing a tree-like
1344 # index structure (just like the one that is generated for HTML Help). For this
1345 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1346 # (i.e. any modern browser). Windows users are probably better off using the
1347 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1348 # further fine-tune the look of the index. As an example, the default style
1349 # sheet generated by doxygen has an example that shows how to put an image at
1350 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1351 # the same information as the tab index, you could consider setting
1352 # DISABLE_INDEX to YES when enabling this option.
1353 # The default value is: NO.
1354 # This tag requires that the tag GENERATE_HTML is set to YES.
1355
1356 GENERATE_TREEVIEW = NO
1357
1358 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1359 # doxygen will group on one line in the generated HTML documentation.
1360 #
1361 # Note that a value of 0 will completely suppress the enum values from appearing
1362 # in the overview section.
1363 # Minimum value: 0, maximum value: 20, default value: 4.
1364 # This tag requires that the tag GENERATE_HTML is set to YES.
10181365
10191366 ENUM_VALUES_PER_LINE = 4
10201367
1021 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1022 # structure should be generated to display hierarchical information.
1023 # If the tag value is set to YES, a side panel will be generated
1024 # containing a tree-like index structure (just like the one that
1025 # is generated for HTML Help). For this to work a browser that supports
1026 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1027 # Windows users are probably better off using the HTML help feature.
1028
1029 GENERATE_TREEVIEW = NO
1030
1031 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1032 # and Class Hierarchy pages using a tree view instead of an ordered list.
1033
1034 USE_INLINE_TREES = NO
1035
1036 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1037 # used to set the initial width (in pixels) of the frame in which the tree
1038 # is shown.
1368 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1369 # to set the initial width (in pixels) of the frame in which the tree is shown.
1370 # Minimum value: 0, maximum value: 1500, default value: 250.
1371 # This tag requires that the tag GENERATE_HTML is set to YES.
10391372
10401373 TREEVIEW_WIDTH = 250
10411374
1042 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1043 # links to external symbols imported via tag files in a separate window.
1375 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1376 # external symbols imported via tag files in a separate window.
1377 # The default value is: NO.
1378 # This tag requires that the tag GENERATE_HTML is set to YES.
10441379
10451380 EXT_LINKS_IN_WINDOW = NO
10461381
1047 # Use this tag to change the font size of Latex formulas included
1048 # as images in the HTML documentation. The default is 10. Note that
1049 # when you change the font size after a successful doxygen run you need
1050 # to manually remove any form_*.png images from the HTML output directory
1051 # to force them to be regenerated.
1382 # Use this tag to change the font size of LaTeX formulas included as images in
1383 # the HTML documentation. When you change the font size after a successful
1384 # doxygen run you need to manually remove any form_*.png images from the HTML
1385 # output directory to force them to be regenerated.
1386 # Minimum value: 8, maximum value: 50, default value: 10.
1387 # This tag requires that the tag GENERATE_HTML is set to YES.
10521388
10531389 FORMULA_FONTSIZE = 10
10541390
10551391 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1056 # generated for formulas are transparent PNGs. Transparent PNGs are
1057 # not supported properly for IE 6.0, but are supported on all modern browsers.
1058 # Note that when changing this option you need to delete any form_*.png files
1059 # in the HTML output before the changes have effect.
1392 # generated for formulas are transparent PNGs. Transparent PNGs are not
1393 # supported properly for IE 6.0, but are supported on all modern browsers.
1394 #
1395 # Note that when changing this option you need to delete any form_*.png files in
1396 # the HTML output directory before the changes have effect.
1397 # The default value is: YES.
1398 # This tag requires that the tag GENERATE_HTML is set to YES.
10601399
10611400 FORMULA_TRANSPARENT = YES
10621401
1063 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1064 # for the HTML output. The underlying search engine uses javascript
1065 # and DHTML and should work on any modern browser. Note that when using
1066 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1067 # (GENERATE_DOCSET) there is already a search function so this one should
1068 # typically be disabled. For large projects the javascript based search engine
1069 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1402 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1403 # http://www.mathjax.org) which uses client side Javascript for the rendering
1404 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
1405 # installed or if you want to formulas look prettier in the HTML output. When
1406 # enabled you may also need to install MathJax separately and configure the path
1407 # to it using the MATHJAX_RELPATH option.
1408 # The default value is: NO.
1409 # This tag requires that the tag GENERATE_HTML is set to YES.
1410
1411 USE_MATHJAX = NO
1412
1413 # When MathJax is enabled you can set the default output format to be used for
1414 # the MathJax output. See the MathJax site (see:
1415 # http://docs.mathjax.org/en/latest/output.html) for more details.
1416 # Possible values are: HTML-CSS (which is slower, but has the best
1417 # compatibility), NativeMML (i.e. MathML) and SVG.
1418 # The default value is: HTML-CSS.
1419 # This tag requires that the tag USE_MATHJAX is set to YES.
1420
1421 MATHJAX_FORMAT = HTML-CSS
1422
1423 # When MathJax is enabled you need to specify the location relative to the HTML
1424 # output directory using the MATHJAX_RELPATH option. The destination directory
1425 # should contain the MathJax.js script. For instance, if the mathjax directory
1426 # is located at the same level as the HTML output directory, then
1427 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1428 # Content Delivery Network so you can quickly see the result without installing
1429 # MathJax. However, it is strongly recommended to install a local copy of
1430 # MathJax from http://www.mathjax.org before deployment.
1431 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1432 # This tag requires that the tag USE_MATHJAX is set to YES.
1433
1434 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1435
1436 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1437 # extension names that should be enabled during MathJax rendering. For example
1438 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1439 # This tag requires that the tag USE_MATHJAX is set to YES.
1440
1441 MATHJAX_EXTENSIONS =
1442
1443 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1444 # of code that will be used on startup of the MathJax code. See the MathJax site
1445 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1446 # example see the documentation.
1447 # This tag requires that the tag USE_MATHJAX is set to YES.
1448
1449 MATHJAX_CODEFILE =
1450
1451 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1452 # the HTML output. The underlying search engine uses javascript and DHTML and
1453 # should work on any modern browser. Note that when using HTML help
1454 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1455 # there is already a search function so this one should typically be disabled.
1456 # For large projects the javascript based search engine can be slow, then
1457 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1458 # search using the keyboard; to jump to the search box use + S
1459 # (what the is depends on the OS and browser, but it is typically
1460 # , /
1461 # key> to jump into the search results window, the results can be navigated
1462 # using the . Press to select an item or to cancel
1463 # the search. The filter options can be selected when the cursor is inside the
1464 # search box by pressing +. Also here use the
1465 # to select a filter and or to activate or cancel the filter
1466 # option.
1467 # The default value is: YES.
1468 # This tag requires that the tag GENERATE_HTML is set to YES.
10701469
10711470 SEARCHENGINE = @enable_searchengine@
10721471
10731472 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1074 # implemented using a PHP enabled web server instead of at the web client
1075 # using Javascript. Doxygen will generate the search PHP script and index
1076 # file to put on the web server. The advantage of the server
1077 # based approach is that it scales better to large projects and allows
1078 # full text search. The disadvances is that it is more difficult to setup
1079 # and does not have live searching capabilities.
1473 # implemented using a web server instead of a web client using Javascript. There
1474 # are two flavours of web server based searching depending on the
1475 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1476 # searching and an index file used by the script. When EXTERNAL_SEARCH is
1477 # enabled the indexing and searching needs to be provided by external tools. See
1478 # the section "External Indexing and Searching" for details.
1479 # The default value is: NO.
1480 # This tag requires that the tag SEARCHENGINE is set to YES.
10801481
10811482 SERVER_BASED_SEARCH = @enable_server_based_search@
10821483
1484 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1485 # script for searching. Instead the search results are written to an XML file
1486 # which needs to be processed by an external indexer. Doxygen will invoke an
1487 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1488 # search results.
1489 #
1490 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1491 # (doxysearch.cgi) which are based on the open source search engine library
1492 # Xapian (see: http://xapian.org/).
1493 #
1494 # See the section "External Indexing and Searching" for details.
1495 # The default value is: NO.
1496 # This tag requires that the tag SEARCHENGINE is set to YES.
1497
1498 EXTERNAL_SEARCH = @enable_external_search@
1499
1500 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1501 # which will return the search results when EXTERNAL_SEARCH is enabled.
1502 #
1503 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1504 # (doxysearch.cgi) which are based on the open source search engine library
1505 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1506 # Searching" for details.
1507 # This tag requires that the tag SEARCHENGINE is set to YES.
1508
10831509 SEARCHENGINE_URL = @searchengine_url@
10841510
1085 EXTERNAL_SEARCH = @enable_external_search@
1511 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1512 # search data is written to a file for indexing by an external tool. With the
1513 # SEARCHDATA_FILE tag the name of this file can be specified.
1514 # The default file is: searchdata.xml.
1515 # This tag requires that the tag SEARCHENGINE is set to YES.
1516
1517 SEARCHDATA_FILE = searchdata.xml
1518
1519 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1520 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1521 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1522 # projects and redirect the results back to the right project.
1523 # This tag requires that the tag SEARCHENGINE is set to YES.
10861524
10871525 EXTERNAL_SEARCH_ID = llvm
10881526
1527 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1528 # projects other than the one defined by this configuration file, but that are
1529 # all added to the same external search index. Each project needs to have a
1530 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1531 # to a relative location where the documentation can be found. The format is:
1532 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1533 # This tag requires that the tag SEARCHENGINE is set to YES.
1534
10891535 EXTRA_SEARCH_MAPPINGS = @extra_search_mappings@
10901536
10911537 #---------------------------------------------------------------------------
1092 # configuration options related to the LaTeX output
1093 #---------------------------------------------------------------------------
1094
1095 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1096 # generate Latex output.
1538 # Configuration options related to the LaTeX output
1539 #---------------------------------------------------------------------------
1540
1541 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1542 # The default value is: YES.
10971543
10981544 GENERATE_LATEX = NO
10991545
1100 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1101 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1102 # put in front of it. If left blank `latex' will be used as the default path.
1103
1104 LATEX_OUTPUT =
1546 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1547 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1548 # it.
1549 # The default directory is: latex.
1550 # This tag requires that the tag GENERATE_LATEX is set to YES.
1551
1552 LATEX_OUTPUT = latex
11051553
11061554 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1107 # invoked. If left blank `latex' will be used as the default command name.
1108 # Note that when enabling USE_PDFLATEX this option is only used for
1109 # generating bitmaps for formulas in the HTML output, but not in the
1110 # Makefile that is written to the output directory.
1555 # invoked.
1556 #
1557 # Note that when enabling USE_PDFLATEX this option is only used for generating
1558 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1559 # written to the output directory.
1560 # The default file is: latex.
1561 # This tag requires that the tag GENERATE_LATEX is set to YES.
11111562
11121563 LATEX_CMD_NAME = latex
11131564
1114 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1115 # generate index for LaTeX. If left blank `makeindex' will be used as the
1116 # default command name.
1565 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1566 # index for LaTeX.
1567 # The default file is: makeindex.
1568 # This tag requires that the tag GENERATE_LATEX is set to YES.
11171569
11181570 MAKEINDEX_CMD_NAME = makeindex
11191571
1120 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1121 # LaTeX documents. This may be useful for small projects and may help to
1122 # save some trees in general.
1572 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1573 # documents. This may be useful for small projects and may help to save some
1574 # trees in general.
1575 # The default value is: NO.
1576 # This tag requires that the tag GENERATE_LATEX is set to YES.
11231577
11241578 COMPACT_LATEX = NO
11251579
1126 # The PAPER_TYPE tag can be used to set the paper type that is used
1127 # by the printer. Possible values are: a4, a4wide, letter, legal and
1128 # executive. If left blank a4wide will be used.
1129
1130 PAPER_TYPE = letter
1131
1132 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1133 # packages that should be included in the LaTeX output.
1580 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1581 # printer.
1582 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1583 # 14 inches) and executive (7.25 x 10.5 inches).
1584 # The default value is: a4.
1585 # This tag requires that the tag GENERATE_LATEX is set to YES.
1586
1587 PAPER_TYPE = a4
1588
1589 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1590 # that should be included in the LaTeX output. To get the times font for
1591 # instance you can specify
1592 # EXTRA_PACKAGES=times
1593 # If left blank no extra packages will be included.
1594 # This tag requires that the tag GENERATE_LATEX is set to YES.
11341595
11351596 EXTRA_PACKAGES =
11361597
1137 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1138 # the generated latex document. The header should contain everything until
1139 # the first chapter. If it is left blank doxygen will generate a
1140 # standard header. Notice: only use this tag if you know what you are doing!
1598 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1599 # generated LaTeX document. The header should contain everything until the first
1600 # chapter. If it is left blank doxygen will generate a standard header. See
1601 # section "Doxygen usage" for information on how to let doxygen write the
1602 # default header to a separate file.
1603 #
1604 # Note: Only use a user-defined header if you know what you are doing! The
1605 # following commands have a special meaning inside the header: $title,
1606 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1607 # replace them by respectively the title of the page, the current date and time,
1608 # only the current date, the version number of doxygen, the project name (see
1609 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1610 # This tag requires that the tag GENERATE_LATEX is set to YES.
11411611
11421612 LATEX_HEADER =
11431613
1144 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1145 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1146 # contain links (just like the HTML output) instead of page references
1147 # This makes the output suitable for online browsing using a pdf viewer.
1148
1149 PDF_HYPERLINKS = NO
1150
1151 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1152 # plain latex in the generated Makefile. Set this option to YES to get a
1614 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1615 # generated LaTeX document. The footer should contain everything after the last
1616 # chapter. If it is left blank doxygen will generate a standard footer.
1617 #
1618 # Note: Only use a user-defined footer if you know what you are doing!
1619 # This tag requires that the tag GENERATE_LATEX is set to YES.
1620
1621 LATEX_FOOTER =
1622
1623 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1624 # other source files which should be copied to the LATEX_OUTPUT output
1625 # directory. Note that the files will be copied as-is; there are no commands or
1626 # markers available.
1627 # This tag requires that the tag GENERATE_LATEX is set to YES.
1628
1629 LATEX_EXTRA_FILES =
1630
1631 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1632 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1633 # contain links (just like the HTML output) instead of page references. This
1634 # makes the output suitable for online browsing using a PDF viewer.
1635 # The default value is: YES.
1636 # This tag requires that the tag GENERATE_LATEX is set to YES.
1637
1638 PDF_HYPERLINKS = YES
1639
1640 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1641 # the PDF file directly from the LaTeX files. Set this option to YES to get a
11531642 # higher quality PDF documentation.
1154
1155 USE_PDFLATEX = NO
1156
1157 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1158 # command to the generated LaTeX files. This will instruct LaTeX to keep
1159 # running if errors occur, instead of asking the user for help.
1160 # This option is also used when generating formulas in HTML.
1643 # The default value is: YES.
1644 # This tag requires that the tag GENERATE_LATEX is set to YES.
1645
1646 USE_PDFLATEX = YES
1647
1648 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1649 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1650 # if errors occur, instead of asking the user for help. This option is also used
1651 # when generating formulas in HTML.
1652 # The default value is: NO.
1653 # This tag requires that the tag GENERATE_LATEX is set to YES.
11611654
11621655 LATEX_BATCHMODE = NO
11631656
1164 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1165 # include the index chapters (such as File Index, Compound Index, etc.)
1166 # in the output.
1657 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1658 # index chapters (such as File Index, Compound Index, etc.) in the output.
1659 # The default value is: NO.
1660 # This tag requires that the tag GENERATE_LATEX is set to YES.
11671661
11681662 LATEX_HIDE_INDICES = NO
11691663
1170 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1171 # source code with syntax highlighting in the LaTeX output.
1172 # Note that which sources are shown also depends on other settings
1173 # such as SOURCE_BROWSER.
1664 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1665 # code with syntax highlighting in the LaTeX output.
1666 #
1667 # Note that which sources are shown also depends on other settings such as
1668 # SOURCE_BROWSER.
1669 # The default value is: NO.
1670 # This tag requires that the tag GENERATE_LATEX is set to YES.
11741671
11751672 LATEX_SOURCE_CODE = NO
11761673
1177 #---------------------------------------------------------------------------
1178 # configuration options related to the RTF output
1179 #---------------------------------------------------------------------------
1180
1181 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1182 # The RTF output is optimized for Word 97 and may not look very pretty with
1183 # other RTF readers or editors.
1674 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1675 # bibliography, e.g. plainnat, or ieeetr. See
1676 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1677 # The default value is: plain.
1678 # This tag requires that the tag GENERATE_LATEX is set to YES.
1679
1680 LATEX_BIB_STYLE = plain
1681
1682 #---------------------------------------------------------------------------
1683 # Configuration options related to the RTF output
1684 #---------------------------------------------------------------------------
1685
1686 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1687 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1688 # readers/editors.
1689 # The default value is: NO.
11841690
11851691 GENERATE_RTF = NO
11861692
1187 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1188 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1189 # put in front of it. If left blank `rtf' will be used as the default path.
1190
1191 RTF_OUTPUT =
1192
1193 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1194 # RTF documents. This may be useful for small projects and may help to
1195 # save some trees in general.
1693 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1694 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1695 # it.
1696 # The default directory is: rtf.
1697 # This tag requires that the tag GENERATE_RTF is set to YES.
1698
1699 RTF_OUTPUT = rtf
1700
1701 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1702 # documents. This may be useful for small projects and may help to save some
1703 # trees in general.
1704 # The default value is: NO.
1705 # This tag requires that the tag GENERATE_RTF is set to YES.
11961706
11971707 COMPACT_RTF = NO
11981708
1199 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1200 # will contain hyperlink fields. The RTF file will
1201 # contain links (just like the HTML output) instead of page references.
1202 # This makes the output suitable for online browsing using WORD or other
1203 # programs which support those fields.
1204 # Note: wordpad (write) and others do not support links.
1709 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1710 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1711 # output) instead of page references. This makes the output suitable for online
1712 # browsing using Word or some other Word compatible readers that support those
1713 # fields.
1714 #
1715 # Note: WordPad (write) and others do not support links.
1716 # The default value is: NO.
1717 # This tag requires that the tag GENERATE_RTF is set to YES.
12051718
12061719 RTF_HYPERLINKS = NO
12071720
1208 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1209 # config file, i.e. a series of assignments. You only have to provide
1210 # replacements, missing definitions are set to their default value.
1721 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1722 # file, i.e. a series of assignments. You only have to provide replacements,
1723 # missing definitions are set to their default value.
1724 #
1725 # See also section "Doxygen usage" for information on how to generate the
1726 # default style sheet that doxygen normally uses.
1727 # This tag requires that the tag GENERATE_RTF is set to YES.
12111728
12121729 RTF_STYLESHEET_FILE =
12131730
1214 # Set optional variables used in the generation of an rtf document.
1215 # Syntax is similar to doxygen's config file.
1731 # Set optional variables used in the generation of an RTF document. Syntax is
1732 # similar to doxygen's config file. A template extensions file can be generated
1733 # using doxygen -e rtf extensionFile.
1734 # This tag requires that the tag GENERATE_RTF is set to YES.
12161735
12171736 RTF_EXTENSIONS_FILE =
12181737
12191738 #---------------------------------------------------------------------------
1220 # configuration options related to the man page output
1221 #---------------------------------------------------------------------------
1222
1223 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1224 # generate man pages
1739 # Configuration options related to the man page output
1740 #---------------------------------------------------------------------------
1741
1742 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1743 # classes and files.
1744 # The default value is: NO.
12251745
12261746 GENERATE_MAN = NO
12271747
1228 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1229 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1230 # put in front of it. If left blank `man' will be used as the default path.
1231
1232 MAN_OUTPUT =
1233
1234 # The MAN_EXTENSION tag determines the extension that is added to
1235 # the generated man pages (default is the subroutine's section .3)
1236
1237 MAN_EXTENSION =
1238
1239 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1240 # then it will generate one additional man file for each entity
1241 # documented in the real man page(s). These additional files
1242 # only source the real man page, but without them the man command
1243 # would be unable to find the correct page. The default is NO.
1748 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1749 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1750 # it. A directory man3 will be created inside the directory specified by
1751 # MAN_OUTPUT.
1752 # The default directory is: man.
1753 # This tag requires that the tag GENERATE_MAN is set to YES.
1754
1755 MAN_OUTPUT = man
1756
1757 # The MAN_EXTENSION tag determines the extension that is added to the generated
1758 # man pages. In case the manual section does not start with a number, the number
1759 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1760 # optional.
1761 # The default value is: .3.
1762 # This tag requires that the tag GENERATE_MAN is set to YES.
1763
1764 MAN_EXTENSION = .3
1765
1766 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1767 # will generate one additional man file for each entity documented in the real
1768 # man page(s). These additional files only source the real man page, but without
1769 # them the man command would be unable to find the correct page.
1770 # The default value is: NO.
1771 # This tag requires that the tag GENERATE_MAN is set to YES.
12441772
12451773 MAN_LINKS = NO
12461774
12471775 #---------------------------------------------------------------------------
1248 # configuration options related to the XML output
1249 #---------------------------------------------------------------------------
1250
1251 # If the GENERATE_XML tag is set to YES Doxygen will
1252 # generate an XML file that captures the structure of
1253 # the code including all documentation.
1776 # Configuration options related to the XML output
1777 #---------------------------------------------------------------------------
1778
1779 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1780 # captures the structure of the code including all documentation.
1781 # The default value is: NO.
12541782
12551783 GENERATE_XML = NO
12561784
1257 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1258 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1259 # put in front of it. If left blank `xml' will be used as the default path.
1785 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1786 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1787 # it.
1788 # The default directory is: xml.
1789 # This tag requires that the tag GENERATE_XML is set to YES.
12601790
12611791 XML_OUTPUT = xml
12621792
1263 # The XML_SCHEMA tag can be used to specify an XML schema,
1264 # which can be used by a validating XML parser to check the
1265 # syntax of the XML files.
1793 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1794 # validating XML parser to check the syntax of the XML files.
1795 # This tag requires that the tag GENERATE_XML is set to YES.
12661796
12671797 XML_SCHEMA =
12681798
1269 # The XML_DTD tag can be used to specify an XML DTD,
1270 # which can be used by a validating XML parser to check the
1271 # syntax of the XML files.
1799 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1800 # validating XML parser to check the syntax of the XML files.
1801 # This tag requires that the tag GENERATE_XML is set to YES.
12721802
12731803 XML_DTD =
12741804
1275 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1276 # dump the program listings (including syntax highlighting
1277 # and cross-referencing information) to the XML output. Note that
1278 # enabling this will significantly increase the size of the XML output.
1805 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1806 # listings (including syntax highlighting and cross-referencing information) to
1807 # the XML output. Note that enabling this will significantly increase the size
1808 # of the XML output.
1809 # The default value is: YES.
1810 # This tag requires that the tag GENERATE_XML is set to YES.
12791811
12801812 XML_PROGRAMLISTING = YES
12811813
12821814 #---------------------------------------------------------------------------
1283 # configuration options for the AutoGen Definitions output
1284 #---------------------------------------------------------------------------
1285
1286 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1287 # generate an AutoGen Definitions (see autogen.sf.net) file
1288 # that captures the structure of the code including all
1289 # documentation. Note that this feature is still experimental
1290 # and incomplete at the moment.
1815 # Configuration options related to the DOCBOOK output
1816 #---------------------------------------------------------------------------
1817
1818 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1819 # that can be used to generate PDF.
1820 # The default value is: NO.
1821
1822 GENERATE_DOCBOOK = NO
1823
1824 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1825 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1826 # front of it.
1827 # The default directory is: docbook.
1828 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1829
1830 DOCBOOK_OUTPUT = docbook
1831
1832 #---------------------------------------------------------------------------
1833 # Configuration options for the AutoGen Definitions output
1834 #---------------------------------------------------------------------------
1835
1836 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1837 # Definitions (see http://autogen.sf.net) file that captures the structure of
1838 # the code including all documentation. Note that this feature is still
1839 # experimental and incomplete at the moment.
1840 # The default value is: NO.
12911841
12921842 GENERATE_AUTOGEN_DEF = NO
12931843
12941844 #---------------------------------------------------------------------------
1295 # configuration options related to the Perl module output
1296 #---------------------------------------------------------------------------
1297
1298 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1299 # generate a Perl module file that captures the structure of
1300 # the code including all documentation. Note that this
1301 # feature is still experimental and incomplete at the
1302 # moment.
1845 # Configuration options related to the Perl module output
1846 #---------------------------------------------------------------------------
1847
1848 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1849 # file that captures the structure of the code including all documentation.
1850 #
1851 # Note that this feature is still experimental and incomplete at the moment.
1852 # The default value is: NO.
13031853
13041854 GENERATE_PERLMOD = NO
13051855
1306 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1307 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1308 # to generate PDF and DVI output from the Perl module output.
1856 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1857 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1858 # output from the Perl module output.
1859 # The default value is: NO.
1860 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
13091861
13101862 PERLMOD_LATEX = NO
13111863
1312 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1313 # nicely formatted so it can be parsed by a human reader.
1314 # This is useful
1315 # if you want to understand what is going on.
1316 # On the other hand, if this
1317 # tag is set to NO the size of the Perl module output will be much smaller
1318 # and Perl will parse it just the same.
1864 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1865 # formatted so it can be parsed by a human reader. This is useful if you want to
1866 # understand what is going on. On the other hand, if this tag is set to NO the
1867 # size of the Perl module output will be much smaller and Perl will parse it
1868 # just the same.
1869 # The default value is: YES.
1870 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
13191871
13201872 PERLMOD_PRETTY = YES
13211873
1322 # The names of the make variables in the generated doxyrules.make file
1323 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1324 # This is useful so different doxyrules.make files included by the same
1325 # Makefile don't overwrite each other's variables.
1874 # The names of the make variables in the generated doxyrules.make file are
1875 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1876 # so different doxyrules.make files included by the same Makefile don't
1877 # overwrite each other's variables.
1878 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
13261879
13271880 PERLMOD_MAKEVAR_PREFIX =
13281881
13301883 # Configuration options related to the preprocessor
13311884 #---------------------------------------------------------------------------
13321885
1333 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1334 # evaluate all C-preprocessor directives found in the sources and include
1335 # files.
1886 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1887 # C-preprocessor directives found in the sources and include files.
1888 # The default value is: YES.
13361889
13371890 ENABLE_PREPROCESSING = YES
13381891
1339 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1340 # names in the source code. If set to NO (the default) only conditional
1341 # compilation will be performed. Macro expansion can be done in a controlled
1342 # way by setting EXPAND_ONLY_PREDEF to YES.
1892 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1893 # in the source code. If set to NO only conditional compilation will be
1894 # performed. Macro expansion can be done in a controlled way by setting
1895 # EXPAND_ONLY_PREDEF to YES.
1896 # The default value is: NO.
1897 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
13431898
13441899 MACRO_EXPANSION = NO
13451900
1346 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1347 # then the macro expansion is limited to the macros specified with the
1348 # PREDEFINED and EXPAND_AS_DEFINED tags.
1901 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1902 # the macro expansion is limited to the macros specified with the PREDEFINED and
1903 # EXPAND_AS_DEFINED tags.
1904 # The default value is: NO.
1905 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
13491906
13501907 EXPAND_ONLY_PREDEF = NO
13511908
1352 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1353 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1909 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1910 # INCLUDE_PATH will be searched if a #include is found.
1911 # The default value is: YES.
1912 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
13541913
13551914 SEARCH_INCLUDES = YES
13561915
13571916 # The INCLUDE_PATH tag can be used to specify one or more directories that
1358 # contain include files that are not input files but should be processed by
1359 # the preprocessor.
1917 # contain include files that are not input files but should be processed by the
1918 # preprocessor.
1919 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
13601920
13611921 INCLUDE_PATH = ../include
13621922
13631923 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
13641924 # patterns (like *.h and *.hpp) to filter out the header-files in the
1365 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1366 # be used.
1925 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1926 # used.
1927 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
13671928
13681929 INCLUDE_FILE_PATTERNS =
13691930
1370 # The PREDEFINED tag can be used to specify one or more macro names that
1371 # are defined before the preprocessor is started (similar to the -D option of
1372 # gcc). The argument of the tag is a list of macros of the form: name
1373 # or name=definition (no spaces). If the definition and the = are
1374 # omitted =1 is assumed. To prevent a macro definition from being
1375 # undefined via #undef or recursively expanded use the := operator
1376 # instead of the = operator.
1931 # The PREDEFINED tag can be used to specify one or more macro names that are
1932 # defined before the preprocessor is started (similar to the -D option of e.g.
1933 # gcc). The argument of the tag is a list of macros of the form: name or
1934 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1935 # is assumed. To prevent a macro definition from being undefined via #undef or
1936 # recursively expanded use the := operator instead of the = operator.
1937 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
13771938
13781939 PREDEFINED =
13791940
1380 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1381 # this tag can be used to specify a list of macro names that should be expanded.
1382 # The macro definition that is found in the sources will be used.
1383 # Use the PREDEFINED tag if you want to use a different macro definition.
1941 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1942 # tag can be used to specify a list of macro names that should be expanded. The
1943 # macro definition that is found in the sources will be used. Use the PREDEFINED
1944 # tag if you want to use a different macro definition that overrules the
1945 # definition found in the source code.
1946 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
13841947
13851948 EXPAND_AS_DEFINED =
13861949
1387 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1388 # doxygen's preprocessor will remove all function-like macros that are alone
1389 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1390 # function macros are typically used for boiler-plate code, and will confuse
1391 # the parser if not removed.
1950 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1951 # remove all refrences to function-like macros that are alone on a line, have an
1952 # all uppercase name, and do not end with a semicolon. Such function macros are
1953 # typically used for boiler-plate code, and will confuse the parser if not
1954 # removed.
1955 # The default value is: YES.
1956 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
13921957
13931958 SKIP_FUNCTION_MACROS = YES
13941959
13951960 #---------------------------------------------------------------------------
1396 # Configuration::additions related to external references
1397 #---------------------------------------------------------------------------
1398
1399 # The TAGFILES option can be used to specify one or more tagfiles.
1400 # Optionally an initial location of the external documentation
1401 # can be added for each tagfile. The format of a tag file without
1402 # this location is as follows:
1403 #
1961 # Configuration options related to external references
1962 #---------------------------------------------------------------------------
1963
1964 # The TAGFILES tag can be used to specify one or more tag files. For each tag
1965 # file the location of the external documentation should be added. The format of
1966 # a tag file without this location is as follows:
14041967 # TAGFILES = file1 file2 ...
14051968 # Adding location for the tag files is done as follows:
1406 #
14071969 # TAGFILES = file1=loc1 "file2 = loc2" ...
1408 # where "loc1" and "loc2" can be relative or absolute paths or
1409 # URLs. If a location is present for each tag, the installdox tool
1410 # does not have to be run to correct the links.
1411 # Note that each tag file must have a unique name
1412 # (where the name does NOT include the path)
1413 # If a tag file is not located in the directory in which doxygen
1414 # is run, you must also specify the path to the tagfile here.
1970 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
1971 # section "Linking to external documentation" for more information about the use
1972 # of tag files.
1973 # Note: Each tag file must have an unique name (where the name does NOT include
1974 # the path). If a tag file is not located in the directory in which doxygen is
1975 # run, you must also specify the path to the tagfile here.
14151976
14161977 TAGFILES =
14171978
1418 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1419 # a tag file that is based on the input files it reads.
1979 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
1980 # tag file that is based on the input files it reads. See section "Linking to
1981 # external documentation" for more information about the usage of tag files.
14201982
14211983 GENERATE_TAGFILE =
14221984
1423 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1424 # in the class index. If set to NO only the inherited external classes
1425 # will be listed.
1985 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1986 # class index. If set to NO only the inherited external classes will be listed.
1987 # The default value is: NO.
14261988
14271989 ALLEXTERNALS = YES
14281990
1429 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1430 # in the modules index. If set to NO, only the current project's groups will
1991 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
1992 # the modules index. If set to NO, only the current project's groups will be
1993 # listed.
1994 # The default value is: YES.
1995
1996 EXTERNAL_GROUPS = YES
1997
1998 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
1999 # the related pages index. If set to NO, only the current project's pages will
14312000 # be listed.
1432
1433 EXTERNAL_GROUPS = YES
2001 # The default value is: YES.
2002
2003 EXTERNAL_PAGES = YES
14342004
14352005 # The PERL_PATH should be the absolute path and name of the perl script
1436 # interpreter (i.e. the result of `which perl').
1437
1438 PERL_PATH =
2006 # interpreter (i.e. the result of 'which perl').
2007 # The default file (with absolute path) is: /usr/bin/perl.
2008
2009 PERL_PATH = /usr/bin/perl
14392010
14402011 #---------------------------------------------------------------------------
14412012 # Configuration options related to the dot tool
14422013 #---------------------------------------------------------------------------
14432014
1444 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1445 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1446 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1447 # this option is superseded by the HAVE_DOT option below. This is only a
1448 # fallback. It is recommended to install and use dot, since it yields more
2015 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2016 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2017 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2018 # disabled, but it is recommended to install and use dot, since it yields more
14492019 # powerful graphs.
2020 # The default value is: YES.
14502021
14512022 CLASS_DIAGRAMS = YES
14522023
14532024 # You can define message sequence charts within doxygen comments using the \msc
1454 # command. Doxygen will then run the mscgen tool (see
1455 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
2025 # command. Doxygen will then run the mscgen tool (see:
2026 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
14562027 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
14572028 # the mscgen tool resides. If left empty the tool is assumed to be found in the
14582029 # default search path.
14592030
14602031 MSCGEN_PATH =
14612032
1462 # If set to YES, the inheritance and collaboration graphs will hide
1463 # inheritance and usage relations if the target is undocumented
1464 # or is not a class.
2033 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2034 # then run dia to produce the diagram and insert it in the documentation. The
2035 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2036 # If left empty dia is assumed to be found in the default search path.
2037
2038 DIA_PATH =
2039
2040 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2041 # and usage relations if the target is undocumented or is not a class.
2042 # The default value is: YES.
14652043
14662044 HIDE_UNDOC_RELATIONS = NO
14672045
14682046 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1469 # available from the path. This tool is part of Graphviz, a graph visualization
1470 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1471 # have no effect if this option is set to NO (the default)
2047 # available from the path. This tool is part of Graphviz (see:
2048 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2049 # Bell Labs. The other options in this section have no effect if this option is
2050 # set to NO
2051 # The default value is: NO.
14722052
14732053 HAVE_DOT = YES
14742054
1475 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1476 # allowed to run in parallel. When set to 0 (the default) doxygen will
1477 # base this on the number of processors available in the system. You can set it
1478 # explicitly to a value larger than 0 to get control over the balance
1479 # between CPU load and processing speed.
2055 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2056 # to run in parallel. When set to 0 doxygen will base this on the number of
2057 # processors available in the system. You can set it explicitly to a value
2058 # larger than 0 to get control over the balance between CPU load and processing
2059 # speed.
2060 # Minimum value: 0, maximum value: 32, default value: 0.
2061 # This tag requires that the tag HAVE_DOT is set to YES.
14802062
14812063 DOT_NUM_THREADS = 0
14822064
1483 # By default doxygen will write a font called FreeSans.ttf to the output
1484 # directory and reference it in all dot files that doxygen generates. This
1485 # font does not include all possible unicode characters however, so when you need
1486 # these (or just want a differently looking font) you can specify the font name
1487 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1488 # which can be done by putting it in a standard location or by setting the
1489 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1490 # containing the font.
2065 # When you want a differently looking font n the dot files that doxygen
2066 # generates you can specify the font name using DOT_FONTNAME. You need to make
2067 # sure dot is able to find the font, which can be done by putting it in a
2068 # standard location or by setting the DOTFONTPATH environment variable or by
2069 # setting DOT_FONTPATH to the directory containing the font.
2070 # The default value is: Helvetica.
2071 # This tag requires that the tag HAVE_DOT is set to YES.
14912072
14922073 DOT_FONTNAME = FreeSans
14932074
1494 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1495 # The default size is 10pt.
2075 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2076 # dot graphs.
2077 # Minimum value: 4, maximum value: 24, default value: 10.
2078 # This tag requires that the tag HAVE_DOT is set to YES.
14962079
14972080 DOT_FONTSIZE = 10
14982081
1499 # By default doxygen will tell dot to use the output directory to look for the
1500 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1501 # different font using DOT_FONTNAME you can set the path where dot
1502 # can find it using this tag.
2082 # By default doxygen will tell dot to use the default font as specified with
2083 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2084 # the path where dot can find it using this tag.
2085 # This tag requires that the tag HAVE_DOT is set to YES.
15032086
15042087 DOT_FONTPATH =
15052088
1506 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1507 # will generate a graph for each documented class showing the direct and
1508 # indirect inheritance relations. Setting this tag to YES will force the
1509 # the CLASS_DIAGRAMS tag to NO.
2089 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2090 # each documented class showing the direct and indirect inheritance relations.
2091 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2092 # The default value is: YES.
2093 # This tag requires that the tag HAVE_DOT is set to YES.
15102094
15112095 CLASS_GRAPH = YES
15122096
1513 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1514 # will generate a graph for each documented class showing the direct and
1515 # indirect implementation dependencies (inheritance, containment, and
1516 # class references variables) of the class with other documented classes.
2097 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2098 # graph for each documented class showing the direct and indirect implementation
2099 # dependencies (inheritance, containment, and class references variables) of the
2100 # class with other documented classes.
2101 # The default value is: YES.
2102 # This tag requires that the tag HAVE_DOT is set to YES.
15172103
15182104 COLLABORATION_GRAPH = YES
15192105
1520 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1521 # will generate a graph for groups, showing the direct groups dependencies
2106 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2107 # groups, showing the direct groups dependencies.
2108 # The default value is: YES.
2109 # This tag requires that the tag HAVE_DOT is set to YES.
15222110
15232111 GROUP_GRAPHS = YES
15242112
15252113 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
15262114 # collaboration diagrams in a style similar to the OMG's Unified Modeling
15272115 # Language.
2116 # The default value is: NO.
2117 # This tag requires that the tag HAVE_DOT is set to YES.
15282118
15292119 UML_LOOK = NO
15302120
1531 # If set to YES, the inheritance and collaboration graphs will show the
1532 # relations between templates and their instances.
2121 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2122 # class node. If there are many fields or methods and many nodes the graph may
2123 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2124 # number of items for each type to make the size more manageable. Set this to 0
2125 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2126 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2127 # but if the number exceeds 15, the total amount of fields shown is limited to
2128 # 10.
2129 # Minimum value: 0, maximum value: 100, default value: 10.
2130 # This tag requires that the tag HAVE_DOT is set to YES.
2131
2132 UML_LIMIT_NUM_FIELDS = 10
2133
2134 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2135 # collaboration graphs will show the relations between templates and their
2136 # instances.
2137 # The default value is: NO.
2138 # This tag requires that the tag HAVE_DOT is set to YES.
15332139
15342140 TEMPLATE_RELATIONS = YES
15352141
1536 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1537 # tags are set to YES then doxygen will generate a graph for each documented
1538 # file showing the direct and indirect include dependencies of the file with
1539 # other documented files.
2142 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2143 # YES then doxygen will generate a graph for each documented file showing the
2144 # direct and indirect include dependencies of the file with other documented
2145 # files.
2146 # The default value is: YES.
2147 # This tag requires that the tag HAVE_DOT is set to YES.
15402148
15412149 INCLUDE_GRAPH = YES
15422150
1543 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1544 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1545 # documented header file showing the documented files that directly or
1546 # indirectly include this file.
2151 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2152 # set to YES then doxygen will generate a graph for each documented file showing
2153 # the direct and indirect include dependencies of the file with other documented
2154 # files.
2155 # The default value is: YES.
2156 # This tag requires that the tag HAVE_DOT is set to YES.
15472157
15482158 INCLUDED_BY_GRAPH = YES
15492159
1550 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1551 # doxygen will generate a call dependency graph for every global function
1552 # or class method. Note that enabling this option will significantly increase
1553 # the time of a run. So in most cases it will be better to enable call graphs
1554 # for selected functions only using the \callgraph command.
2160 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2161 # dependency graph for every global function or class method.
2162 #
2163 # Note that enabling this option will significantly increase the time of a run.
2164 # So in most cases it will be better to enable call graphs for selected
2165 # functions only using the \callgraph command.
2166 # The default value is: NO.
2167 # This tag requires that the tag HAVE_DOT is set to YES.
15552168
15562169 CALL_GRAPH = NO
15572170
1558 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1559 # doxygen will generate a caller dependency graph for every global function
1560 # or class method. Note that enabling this option will significantly increase
1561 # the time of a run. So in most cases it will be better to enable caller
1562 # graphs for selected functions only using the \callergraph command.
2171 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2172 # dependency graph for every global function or class method.
2173 #
2174 # Note that enabling this option will significantly increase the time of a run.
2175 # So in most cases it will be better to enable caller graphs for selected
2176 # functions only using the \callergraph command.
2177 # The default value is: NO.
2178 # This tag requires that the tag HAVE_DOT is set to YES.
15632179
15642180 CALLER_GRAPH = NO
15652181
1566 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1567 # will graphical hierarchy of all classes instead of a textual one.
2182 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2183 # hierarchy of all classes instead of a textual one.
2184 # The default value is: YES.
2185 # This tag requires that the tag HAVE_DOT is set to YES.
15682186
15692187 GRAPHICAL_HIERARCHY = YES
15702188
1571 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1572 # then doxygen will show the dependencies a directory has on other directories
1573 # in a graphical way. The dependency relations are determined by the #include
1574 # relations between the files in the directories.
2189 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2190 # dependencies a directory has on other directories in a graphical way. The
2191 # dependency relations are determined by the #include relations between the
2192 # files in the directories.
2193 # The default value is: YES.
2194 # This tag requires that the tag HAVE_DOT is set to YES.
15752195
15762196 DIRECTORY_GRAPH = YES
15772197
15782198 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1579 # generated by dot. Possible values are png, jpg, or gif
1580 # If left blank png will be used.
2199 # generated by dot.
2200 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2201 # to make the SVG files visible in IE 9+ (other browsers do not have this
2202 # requirement).
2203 # Possible values are: png, jpg, gif and svg.
2204 # The default value is: png.
2205 # This tag requires that the tag HAVE_DOT is set to YES.
15812206
15822207 DOT_IMAGE_FORMAT = png
15832208
1584 # The tag DOT_PATH can be used to specify the path where the dot tool can be
2209 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2210 # enable generation of interactive SVG images that allow zooming and panning.
2211 #
2212 # Note that this requires a modern browser other than Internet Explorer. Tested
2213 # and working are Firefox, Chrome, Safari, and Opera.
2214 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2215 # the SVG files visible. Older versions of IE do not have SVG support.
2216 # The default value is: NO.
2217 # This tag requires that the tag HAVE_DOT is set to YES.
2218
2219 INTERACTIVE_SVG = NO
2220
2221 # The DOT_PATH tag can be used to specify the path where the dot tool can be
15852222 # found. If left blank, it is assumed the dot tool can be found in the path.
2223 # This tag requires that the tag HAVE_DOT is set to YES.
15862224
15872225 DOT_PATH = @DOT@
15882226
15892227 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1590 # contain dot files that are included in the documentation (see the
1591 # \dotfile command).
2228 # contain dot files that are included in the documentation (see the \dotfile
2229 # command).
2230 # This tag requires that the tag HAVE_DOT is set to YES.
15922231
15932232 DOTFILE_DIRS =
15942233
1595 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1596 # nodes that will be shown in the graph. If the number of nodes in a graph
1597 # becomes larger than this value, doxygen will truncate the graph, which is
1598 # visualized by representing a node as a red box. Note that doxygen if the
1599 # number of direct children of the root node in a graph is already larger than
1600 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1601 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2234 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2235 # contain msc files that are included in the documentation (see the \mscfile
2236 # command).
2237
2238 MSCFILE_DIRS =
2239
2240 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2241 # contain dia files that are included in the documentation (see the \diafile
2242 # command).
2243
2244 DIAFILE_DIRS =
2245
2246 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2247 # that will be shown in the graph. If the number of nodes in a graph becomes
2248 # larger than this value, doxygen will truncate the graph, which is visualized
2249 # by representing a node as a red box. Note that doxygen if the number of direct
2250 # children of the root node in a graph is already larger than
2251 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2252 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2253 # Minimum value: 0, maximum value: 10000, default value: 50.
2254 # This tag requires that the tag HAVE_DOT is set to YES.
16022255
16032256 DOT_GRAPH_MAX_NODES = 50
16042257
1605 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1606 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1607 # from the root by following a path via at most 3 edges will be shown. Nodes
1608 # that lay further from the root node will be omitted. Note that setting this
1609 # option to 1 or 2 may greatly reduce the computation time needed for large
1610 # code bases. Also note that the size of a graph can be further restricted by
2258 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2259 # generated by dot. A depth value of 3 means that only nodes reachable from the
2260 # root by following a path via at most 3 edges will be shown. Nodes that lay
2261 # further from the root node will be omitted. Note that setting this option to 1
2262 # or 2 may greatly reduce the computation time needed for large code bases. Also
2263 # note that the size of a graph can be further restricted by
16112264 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2265 # Minimum value: 0, maximum value: 1000, default value: 0.
2266 # This tag requires that the tag HAVE_DOT is set to YES.
16122267
16132268 MAX_DOT_GRAPH_DEPTH = 0
16142269
16152270 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1616 # background. This is disabled by default, because dot on Windows does not
1617 # seem to support this out of the box. Warning: Depending on the platform used,
1618 # enabling this option may lead to badly anti-aliased labels on the edges of
1619 # a graph (i.e. they become hard to read).
2271 # background. This is disabled by default, because dot on Windows does not seem
2272 # to support this out of the box.
2273 #
2274 # Warning: Depending on the platform used, enabling this option may lead to
2275 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2276 # read).
2277 # The default value is: NO.
2278 # This tag requires that the tag HAVE_DOT is set to YES.
16202279
16212280 DOT_TRANSPARENT = YES
16222281
16232282 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
16242283 # files in one run (i.e. multiple -o and -T options on the command line). This
1625 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1626 # support this, this feature is disabled by default.
1627
1628 DOT_MULTI_TARGETS = NO
1629
1630 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1631 # generate a legend page explaining the meaning of the various boxes and
1632 # arrows in the dot generated graphs.
2284 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2285 # this, this feature is disabled by default.
2286 # The default value is: NO.
2287 # This tag requires that the tag HAVE_DOT is set to YES.
2288
2289 DOT_MULTI_TARGETS = YES
2290
2291 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2292 # explaining the meaning of the various boxes and arrows in the dot generated
2293 # graphs.
2294 # The default value is: YES.
2295 # This tag requires that the tag HAVE_DOT is set to YES.
16332296
16342297 GENERATE_LEGEND = YES
16352298
1636 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1637 # remove the intermediate dot files that are used to generate
1638 # the various graphs.
2299 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2300 # files that are used to generate the various graphs.
2301 # The default value is: YES.
2302 # This tag requires that the tag HAVE_DOT is set to YES.
16392303
16402304 DOT_CLEANUP = YES
+0
-408
docs/doxygen.css less more
None BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV {
1 font-family: Verdana,Geneva,Arial,Helvetica,sans-serif;