llvm.org GIT mirror llvm / eb13b61
Update to a newer doxygen version. PR8214. Patch by Jeremy Huddleston. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@141657 91177308-0d34-0410-b5e6-96231b3b80d8 Bill Wendling 8 years ago
1 changed file(s) with 882 addition(s) and 669 deletion(s). Raw diff Collapse all Expand all
None # Doxyfile 1.5.6
0 # Doxyfile 1.7.1
11
22 # This file describes the settings to be used by the documentation system
33 # doxygen (www.doxygen.org) for a project
1010 # Values that contain spaces should be placed between quotes (" ")
1111
1212 #---------------------------------------------------------------------------
13 # Project related configuration options
14 #---------------------------------------------------------------------------
15
16 # This tag specifies the encoding used for all characters in the config file
17 # that follow. The default is UTF-8 which is also the encoding used for all
18 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
19 # iconv built into libc) for the transcoding. See
13 # Project related configuration options
14 #---------------------------------------------------------------------------
15
16 # This tag specifies the encoding used for all characters in the config file
17 # that follow. The default is UTF-8 which is also the encoding used for all
18 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
19 # iconv built into libc) for the transcoding. See
2020 # http://www.gnu.org/software/libiconv for the list of possible encodings.
2121
2222 DOXYFILE_ENCODING = UTF-8
2323
24 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
24 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
2525 # by quotes) that should identify the project.
2626
2727 PROJECT_NAME = LLVM
2828
29 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
30 # This could be handy for archiving the generated documentation or
29 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
30 # This could be handy for archiving the generated documentation or
3131 # if some version control system is used.
3232
3333 PROJECT_NUMBER = @PACKAGE_VERSION@
3434
35 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
36 # base path where the generated documentation will be put.
37 # If a relative path is entered, it will be relative to the location
35 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
36 # base path where the generated documentation will be put.
37 # If a relative path is entered, it will be relative to the location
3838 # where doxygen was started. If left blank the current directory will be used.
3939
4040 OUTPUT_DIRECTORY = @abs_top_builddir@/docs/doxygen
4141
42 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
43 # 4096 sub-directories (in 2 levels) under the output directory of each output
44 # format and will distribute the generated files over these directories.
45 # Enabling this option can be useful when feeding doxygen a huge amount of
46 # source files, where putting all generated files in the same directory would
42 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
43 # 4096 sub-directories (in 2 levels) under the output directory of each output
44 # format and will distribute the generated files over these directories.
45 # Enabling this option can be useful when feeding doxygen a huge amount of
46 # source files, where putting all generated files in the same directory would
4747 # otherwise cause performance problems for the file system.
4848
4949 CREATE_SUBDIRS = NO
5050
51 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
52 # documentation generated by doxygen is written. Doxygen will use this
53 # information to generate all constant output in the proper language.
54 # The default language is English, other supported languages are:
55 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
56 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
57 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
58 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
59 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
60 # and Ukrainian.
51 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
52 # documentation generated by doxygen is written. Doxygen will use this
53 # information to generate all constant output in the proper language.
54 # The default language is English, other supported languages are:
55 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
56 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
57 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
58 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
59 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
60 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
6161
6262 OUTPUT_LANGUAGE = English
6363
64 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
65 # include brief member descriptions after the members that are listed in
66 # the file and class documentation (similar to JavaDoc).
64 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
65 # include brief member descriptions after the members that are listed in
66 # the file and class documentation (similar to JavaDoc).
6767 # Set to NO to disable this.
6868
6969 BRIEF_MEMBER_DESC = YES
7070
71 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
72 # the brief description of a member or function before the detailed description.
73 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
71 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
72 # the brief description of a member or function before the detailed description.
73 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
7474 # brief descriptions will be completely suppressed.
7575
7676 REPEAT_BRIEF = YES
7777
78 # This tag implements a quasi-intelligent brief description abbreviator
79 # that is used to form the text in various listings. Each string
80 # in this list, if found as the leading text of the brief description, will be
81 # stripped from the text and the result after processing the whole list, is
82 # used as the annotated text. Otherwise, the brief description is used as-is.
83 # If left blank, the following values are used ("$name" is automatically
84 # replaced with the name of the entity): "The $name class" "The $name widget"
85 # "The $name file" "is" "provides" "specifies" "contains"
78 # This tag implements a quasi-intelligent brief description abbreviator
79 # that is used to form the text in various listings. Each string
80 # in this list, if found as the leading text of the brief description, will be
81 # stripped from the text and the result after processing the whole list, is
82 # used as the annotated text. Otherwise, the brief description is used as-is.
83 # If left blank, the following values are used ("$name" is automatically
84 # replaced with the name of the entity): "The $name class" "The $name widget"
85 # "The $name file" "is" "provides" "specifies" "contains"
8686 # "represents" "a" "an" "the"
8787
88 ABBREVIATE_BRIEF =
89
90 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
91 # Doxygen will generate a detailed section even if there is only a brief
88 ABBREVIATE_BRIEF =
89
90 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
91 # Doxygen will generate a detailed section even if there is only a brief
9292 # description.
9393
9494 ALWAYS_DETAILED_SEC = NO
9595
96 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
97 # inherited members of a class in the documentation of that class as if those
98 # members were ordinary class members. Constructors, destructors and assignment
96 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
97 # inherited members of a class in the documentation of that class as if those
98 # members were ordinary class members. Constructors, destructors and assignment
9999 # operators of the base classes will not be shown.
100100
101101 INLINE_INHERITED_MEMB = NO
102102
103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
104 # path before files name in the file list and in the header files. If set
103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
104 # path before files name in the file list and in the header files. If set
105105 # to NO the shortest path that makes the file name unique will be used.
106106
107107 FULL_PATH_NAMES = NO
108108
109 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
110 # can be used to strip a user-defined part of the path. Stripping is
111 # only done if one of the specified strings matches the left-hand part of
112 # the path. The tag can be used to show relative paths in the file list.
113 # If left blank the directory from which doxygen is run is used as the
109 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
110 # can be used to strip a user-defined part of the path. Stripping is
111 # only done if one of the specified strings matches the left-hand part of
112 # the path. The tag can be used to show relative paths in the file list.
113 # If left blank the directory from which doxygen is run is used as the
114114 # path to strip.
115115
116116 STRIP_FROM_PATH = ../..
117117
118 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
119 # the path mentioned in the documentation of a class, which tells
120 # the reader which header file to include in order to use a class.
121 # If left blank only the name of the header file containing the class
122 # definition is used. Otherwise one should specify the include paths that
118 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
119 # the path mentioned in the documentation of a class, which tells
120 # the reader which header file to include in order to use a class.
121 # If left blank only the name of the header file containing the class
122 # definition is used. Otherwise one should specify the include paths that
123123 # are normally passed to the compiler using the -I flag.
124124
125 STRIP_FROM_INC_PATH =
126
127 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
128 # (but less readable) file names. This can be useful is your file systems
125 STRIP_FROM_INC_PATH =
126
127 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
128 # (but less readable) file names. This can be useful is your file systems
129129 # doesn't support long names like on DOS, Mac, or CD-ROM.
130130
131131 SHORT_NAMES = NO
132132
133 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
134 # will interpret the first line (until the first dot) of a JavaDoc-style
135 # comment as the brief description. If set to NO, the JavaDoc
136 # comments will behave just like regular Qt-style comments
133 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
134 # will interpret the first line (until the first dot) of a JavaDoc-style
135 # comment as the brief description. If set to NO, the JavaDoc
136 # comments will behave just like regular Qt-style comments
137137 # (thus requiring an explicit @brief command for a brief description.)
138138
139139 JAVADOC_AUTOBRIEF = NO
140140
141 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
142 # interpret the first line (until the first dot) of a Qt-style
143 # comment as the brief description. If set to NO, the comments
144 # will behave just like regular Qt-style comments (thus requiring
141 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
142 # interpret the first line (until the first dot) of a Qt-style
143 # comment as the brief description. If set to NO, the comments
144 # will behave just like regular Qt-style comments (thus requiring
145145 # an explicit \brief command for a brief description.)
146146
147147 QT_AUTOBRIEF = NO
148148
149 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
150 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
151 # comments) as a brief description. This used to be the default behaviour.
152 # The new default is to treat a multi-line C++ comment block as a detailed
149 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
150 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
151 # comments) as a brief description. This used to be the default behaviour.
152 # The new default is to treat a multi-line C++ comment block as a detailed
153153 # description. Set this tag to YES if you prefer the old behaviour instead.
154154
155155 MULTILINE_CPP_IS_BRIEF = NO
156156
157 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
158 # will output the detailed description near the top, like JavaDoc.
159 # If set to NO, the detailed description appears after the member
160 # documentation.
161
162 DETAILS_AT_TOP = NO
163
164 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
165 # member inherits the documentation from any documented member that it
157 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
158 # member inherits the documentation from any documented member that it
166159 # re-implements.
167160
168161 INHERIT_DOCS = YES
169162
170 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
171 # a new page for each member. If set to NO, the documentation of a member will
163 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
164 # a new page for each member. If set to NO, the documentation of a member will
172165 # be part of the file/class/namespace that contains it.
173166
174167 SEPARATE_MEMBER_PAGES = NO
175168
176 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
169 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
177170 # Doxygen uses this value to replace tabs by spaces in code fragments.
178171
179172 TAB_SIZE = 2
180173
181 # This tag can be used to specify a number of aliases that acts
182 # as commands in the documentation. An alias has the form "name=value".
183 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
184 # put the command \sideeffect (or @sideeffect) in the documentation, which
185 # will result in a user-defined paragraph with heading "Side Effects:".
174 # This tag can be used to specify a number of aliases that acts
175 # as commands in the documentation. An alias has the form "name=value".
176 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
177 # put the command \sideeffect (or @sideeffect) in the documentation, which
178 # will result in a user-defined paragraph with heading "Side Effects:".
186179 # You can put \n's in the value part of an alias to insert newlines.
187180
188 ALIASES =
189
190 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
191 # sources only. Doxygen will then generate output that is more tailored for C.
192 # For instance, some of the names that are used will be different. The list
181 ALIASES =
182
183 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
184 # sources only. Doxygen will then generate output that is more tailored for C.
185 # For instance, some of the names that are used will be different. The list
193186 # of all members will be omitted, etc.
194187
195188 OPTIMIZE_OUTPUT_FOR_C = NO
196189
197 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
198 # sources only. Doxygen will then generate output that is more tailored for
199 # Java. For instance, namespaces will be presented as packages, qualified
190 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
191 # sources only. Doxygen will then generate output that is more tailored for
192 # Java. For instance, namespaces will be presented as packages, qualified
200193 # scopes will look different, etc.
201194
202195 OPTIMIZE_OUTPUT_JAVA = NO
203196
204 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
205 # sources only. Doxygen will then generate output that is more tailored for
197 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
198 # sources only. Doxygen will then generate output that is more tailored for
206199 # Fortran.
207200
208201 OPTIMIZE_FOR_FORTRAN = NO
209202
210 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
211 # sources. Doxygen will then generate output that is tailored for
203 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
204 # sources. Doxygen will then generate output that is tailored for
212205 # VHDL.
213206
214207 OPTIMIZE_OUTPUT_VHDL = NO
215208
216 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
217 # to include (a tag file for) the STL sources as input, then you should
218 # set this tag to YES in order to let doxygen match functions declarations and
219 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
220 # func(std::string) {}). This also make the inheritance and collaboration
209 # Doxygen selects the parser to use depending on the extension of the files it
210 # parses. With this tag you can assign which parser to use for a given extension.
211 # Doxygen has a built-in mapping, but you can override or extend it using this
212 # tag. The format is ext=language, where ext is a file extension, and language
213 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
214 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
215 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
216 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
217 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
218
219 EXTENSION_MAPPING =
220
221 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
222 # to include (a tag file for) the STL sources as input, then you should
223 # set this tag to YES in order to let doxygen match functions declarations and
224 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
225 # func(std::string) {}). This also make the inheritance and collaboration
221226 # diagrams that involve STL classes more complete and accurate.
222227
223228 BUILTIN_STL_SUPPORT = NO
227232
228233 CPP_CLI_SUPPORT = NO
229234
230 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
231 # Doxygen will parse them like normal C++ but will assume all classes use public
235 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
236 # Doxygen will parse them like normal C++ but will assume all classes use public
232237 # instead of private inheritance when no explicit protection keyword is present.
233238
234239 SIP_SUPPORT = NO
235240
236 # For Microsoft's IDL there are propget and propput attributes to indicate getter
237 # and setter methods for a property. Setting this option to YES (the default)
238 # will make doxygen to replace the get and set methods by a property in the
239 # documentation. This will only work if the methods are indeed getting or
240 # setting a simple type. If this is not the case, or you want to show the
241 # For Microsoft's IDL there are propget and propput attributes to indicate getter
242 # and setter methods for a property. Setting this option to YES (the default)
243 # will make doxygen to replace the get and set methods by a property in the
244 # documentation. This will only work if the methods are indeed getting or
245 # setting a simple type. If this is not the case, or you want to show the
241246 # methods anyway, you should set this option to NO.
242247
243248 IDL_PROPERTY_SUPPORT = YES
244249
245 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
246 # tag is set to YES, then doxygen will reuse the documentation of the first
247 # member in the group (if any) for the other members of the group. By default
250 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
251 # tag is set to YES, then doxygen will reuse the documentation of the first
252 # member in the group (if any) for the other members of the group. By default
248253 # all members of a group must be documented explicitly.
249254
250255 DISTRIBUTE_GROUP_DOC = NO
251256
252 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
253 # the same type (for instance a group of public functions) to be put as a
254 # subgroup of that type (e.g. under the Public Functions section). Set it to
255 # NO to prevent subgrouping. Alternatively, this can be done per class using
257 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
258 # the same type (for instance a group of public functions) to be put as a
259 # subgroup of that type (e.g. under the Public Functions section). Set it to
260 # NO to prevent subgrouping. Alternatively, this can be done per class using
256261 # the \nosubgrouping command.
257262
258263 SUBGROUPING = YES
259264
260 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
261 # is documented as struct, union, or enum with the name of the typedef. So
262 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
263 # with name TypeT. When disabled the typedef will appear as a member of a file,
264 # namespace, or class. And the struct will be named TypeS. This can typically
265 # be useful for C code in case the coding convention dictates that all compound
265 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
266 # is documented as struct, union, or enum with the name of the typedef. So
267 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
268 # with name TypeT. When disabled the typedef will appear as a member of a file,
269 # namespace, or class. And the struct will be named TypeS. This can typically
270 # be useful for C code in case the coding convention dictates that all compound
266271 # types are typedef'ed and only the typedef is referenced, never the tag name.
267272
268273 TYPEDEF_HIDES_STRUCT = NO
269274
275 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
276 # determine which symbols to keep in memory and which to flush to disk.
277 # When the cache is full, less often used symbols will be written to disk.
278 # For small to medium size projects (<1000 input files) the default value is
279 # probably good enough. For larger projects a too small cache size can cause
280 # doxygen to be busy swapping symbols to and from disk most of the time
281 # causing a significant performance penality.
282 # If the system has enough physical memory increasing the cache will improve the
283 # performance by keeping more symbols in memory. Note that the value works on
284 # a logarithmic scale so increasing the size by one will rougly double the
285 # memory usage. The cache size is given by this formula:
286 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
287 # corresponding to a cache size of 2^16 = 65536 symbols
288
289 SYMBOL_CACHE_SIZE = 0
290
270291 #---------------------------------------------------------------------------
271292 # Build related configuration options
272293 #---------------------------------------------------------------------------
273294
274 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
275 # documentation are documented, even if no documentation was available.
276 # Private class members and static file members will be hidden unless
295 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
296 # documentation are documented, even if no documentation was available.
297 # Private class members and static file members will be hidden unless
277298 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
278299
279300 EXTRACT_ALL = YES
280301
281 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
302 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
282303 # will be included in the documentation.
283304
284305 EXTRACT_PRIVATE = NO
285306
286 # If the EXTRACT_STATIC tag is set to YES all static members of a file
307 # If the EXTRACT_STATIC tag is set to YES all static members of a file
287308 # will be included in the documentation.
288309
289310 EXTRACT_STATIC = YES
290311
291 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
292 # defined locally in source files will be included in the documentation.
312 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
313 # defined locally in source files will be included in the documentation.
293314 # If set to NO only classes defined in header files are included.
294315
295316 EXTRACT_LOCAL_CLASSES = YES
296317
297 # This flag is only useful for Objective-C code. When set to YES local
298 # methods, which are defined in the implementation section but not in
299 # the interface are included in the documentation.
318 # This flag is only useful for Objective-C code. When set to YES local
319 # methods, which are defined in the implementation section but not in
320 # the interface are included in the documentation.
300321 # If set to NO (the default) only methods in the interface are included.
301322
302323 EXTRACT_LOCAL_METHODS = NO
303324
304 # If this flag is set to YES, the members of anonymous namespaces will be
305 # extracted and appear in the documentation as a namespace called
306 # 'anonymous_namespace{file}', where file will be replaced with the base
307 # name of the file that contains the anonymous namespace. By default
325 # If this flag is set to YES, the members of anonymous namespaces will be
326 # extracted and appear in the documentation as a namespace called
327 # 'anonymous_namespace{file}', where file will be replaced with the base
328 # name of the file that contains the anonymous namespace. By default
308329 # anonymous namespace are hidden.
309330
310331 EXTRACT_ANON_NSPACES = NO
311332
312 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
313 # undocumented members of documented classes, files or namespaces.
314 # If set to NO (the default) these members will be included in the
315 # various overviews, but no documentation section is generated.
333 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
334 # undocumented members of documented classes, files or namespaces.
335 # If set to NO (the default) these members will be included in the
336 # various overviews, but no documentation section is generated.
316337 # This option has no effect if EXTRACT_ALL is enabled.
317338
318339 HIDE_UNDOC_MEMBERS = NO
319340
320 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
321 # undocumented classes that are normally visible in the class hierarchy.
322 # If set to NO (the default) these classes will be included in the various
341 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
342 # undocumented classes that are normally visible in the class hierarchy.
343 # If set to NO (the default) these classes will be included in the various
323344 # overviews. This option has no effect if EXTRACT_ALL is enabled.
324345
325346 HIDE_UNDOC_CLASSES = NO
326347
327 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
328 # friend (class|struct|union) declarations.
329 # If set to NO (the default) these declarations will be included in the
348 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
349 # friend (class|struct|union) declarations.
350 # If set to NO (the default) these declarations will be included in the
330351 # documentation.
331352
332353 HIDE_FRIEND_COMPOUNDS = NO
333354
334 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
335 # documentation blocks found inside the body of a function.
336 # If set to NO (the default) these blocks will be appended to the
355 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
356 # documentation blocks found inside the body of a function.
357 # If set to NO (the default) these blocks will be appended to the
337358 # function's detailed documentation block.
338359
339360 HIDE_IN_BODY_DOCS = NO
340361
341 # The INTERNAL_DOCS tag determines if documentation
342 # that is typed after a \internal command is included. If the tag is set
343 # to NO (the default) then the documentation will be excluded.
362 # The INTERNAL_DOCS tag determines if documentation
363 # that is typed after a \internal command is included. If the tag is set
364 # to NO (the default) then the documentation will be excluded.
344365 # Set it to YES to include the internal documentation.
345366
346367 INTERNAL_DOCS = NO
347368
348 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
349 # file names in lower-case letters. If set to YES upper-case letters are also
350 # allowed. This is useful if you have classes or files whose names only differ
351 # in case and if your file system supports case sensitive file names. Windows
369 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
370 # file names in lower-case letters. If set to YES upper-case letters are also
371 # allowed. This is useful if you have classes or files whose names only differ
372 # in case and if your file system supports case sensitive file names. Windows
352373 # and Mac users are advised to set this option to NO.
353374
354375 CASE_SENSE_NAMES = YES
355376
356 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
357 # will show members with their full class and namespace scopes in the
377 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
378 # will show members with their full class and namespace scopes in the
358379 # documentation. If set to YES the scope will be hidden.
359380
360381 HIDE_SCOPE_NAMES = NO
361382
362 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
363 # will put a list of the files that are included by a file in the documentation
383 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
384 # will put a list of the files that are included by a file in the documentation
364385 # of that file.
365386
366387 SHOW_INCLUDE_FILES = YES
367388
368 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
389 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
390 # will list include files with double quotes in the documentation
391 # rather than with sharp brackets.
392
393 FORCE_LOCAL_INCLUDES = NO
394
395 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
369396 # is inserted in the documentation for inline members.
370397
371398 INLINE_INFO = YES
372399
373 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
374 # will sort the (detailed) documentation of file and class members
375 # alphabetically by member name. If set to NO the members will appear in
400 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
401 # will sort the (detailed) documentation of file and class members
402 # alphabetically by member name. If set to NO the members will appear in
376403 # declaration order.
377404
378405 SORT_MEMBER_DOCS = YES
379406
380 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
381 # brief documentation of file, namespace and class members alphabetically
382 # by member name. If set to NO (the default) the members will appear in
407 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
408 # brief documentation of file, namespace and class members alphabetically
409 # by member name. If set to NO (the default) the members will appear in
383410 # declaration order.
384411
385412 SORT_BRIEF_DOCS = NO
386413
387 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
388 # hierarchy of group names into alphabetical order. If set to NO (the default)
414 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
415 # will sort the (brief and detailed) documentation of class members so that
416 # constructors and destructors are listed first. If set to NO (the default)
417 # the constructors will appear in the respective orders defined by
418 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
419 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
420 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
421
422 SORT_MEMBERS_CTORS_1ST = NO
423
424 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
425 # hierarchy of group names into alphabetical order. If set to NO (the default)
389426 # the group names will appear in their defined order.
390427
391428 SORT_GROUP_NAMES = NO
392429
393 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
394 # sorted by fully-qualified names, including namespaces. If set to
395 # NO (the default), the class list will be sorted only by class name,
396 # not including the namespace part.
430 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
431 # sorted by fully-qualified names, including namespaces. If set to
432 # NO (the default), the class list will be sorted only by class name,
433 # not including the namespace part.
397434 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
398 # Note: This option applies only to the class list, not to the
435 # Note: This option applies only to the class list, not to the
399436 # alphabetical list.
400437
401438 SORT_BY_SCOPE_NAME = NO
402439
403 # The GENERATE_TODOLIST tag can be used to enable (YES) or
404 # disable (NO) the todo list. This list is created by putting \todo
440 # The GENERATE_TODOLIST tag can be used to enable (YES) or
441 # disable (NO) the todo list. This list is created by putting \todo
405442 # commands in the documentation.
406443
407444 GENERATE_TODOLIST = YES
408445
409 # The GENERATE_TESTLIST tag can be used to enable (YES) or
410 # disable (NO) the test list. This list is created by putting \test
446 # The GENERATE_TESTLIST tag can be used to enable (YES) or
447 # disable (NO) the test list. This list is created by putting \test
411448 # commands in the documentation.
412449
413450 GENERATE_TESTLIST = YES
414451
415 # The GENERATE_BUGLIST tag can be used to enable (YES) or
416 # disable (NO) the bug list. This list is created by putting \bug
452 # The GENERATE_BUGLIST tag can be used to enable (YES) or
453 # disable (NO) the bug list. This list is created by putting \bug
417454 # commands in the documentation.
418455
419456 GENERATE_BUGLIST = YES
420457
421 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
422 # disable (NO) the deprecated list. This list is created by putting
458 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
459 # disable (NO) the deprecated list. This list is created by putting
423460 # \deprecated commands in the documentation.
424461
425462 GENERATE_DEPRECATEDLIST= YES
426463
427 # The ENABLED_SECTIONS tag can be used to enable conditional
464 # The ENABLED_SECTIONS tag can be used to enable conditional
428465 # documentation sections, marked by \if sectionname ... \endif.
429466
430 ENABLED_SECTIONS =
431
432 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
433 # the initial value of a variable or define consists of for it to appear in
434 # the documentation. If the initializer consists of more lines than specified
435 # here it will be hidden. Use a value of 0 to hide initializers completely.
436 # The appearance of the initializer of individual variables and defines in the
437 # documentation can be controlled using \showinitializer or \hideinitializer
467 ENABLED_SECTIONS =
468
469 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
470 # the initial value of a variable or define consists of for it to appear in
471 # the documentation. If the initializer consists of more lines than specified
472 # here it will be hidden. Use a value of 0 to hide initializers completely.
473 # The appearance of the initializer of individual variables and defines in the
474 # documentation can be controlled using \showinitializer or \hideinitializer
438475 # command in the documentation regardless of this setting.
439476
440477 MAX_INITIALIZER_LINES = 30
441478
442 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
443 # at the bottom of the documentation of classes and structs. If set to YES the
479 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
480 # at the bottom of the documentation of classes and structs. If set to YES the
444481 # list will mention the files that were used to generate the documentation.
445482
446483 SHOW_USED_FILES = YES
447484
448 # If the sources in your project are distributed over multiple directories
449 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
485 # If the sources in your project are distributed over multiple directories
486 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
450487 # in the documentation. The default is NO.
451488
452489 SHOW_DIRECTORIES = YES
453490
454491 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
455 # This will remove the Files entry from the Quick Index and from the
492 # This will remove the Files entry from the Quick Index and from the
456493 # Folder Tree View (if specified). The default is YES.
457494
458495 SHOW_FILES = YES
459496
460 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
461 # Namespaces page. This will remove the Namespaces entry from the Quick Index
497 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
498 # Namespaces page.
499 # This will remove the Namespaces entry from the Quick Index
462500 # and from the Folder Tree View (if specified). The default is YES.
463501
464502 SHOW_NAMESPACES = YES
465503
466 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
467 # doxygen should invoke to get the current version for each file (typically from
468 # the version control system). Doxygen will invoke the program by executing (via
469 # popen()) the command , where is the value of
470 # the FILE_VERSION_FILTER tag, and is the name of an input file
471 # provided by doxygen. Whatever the program writes to standard output
504 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
505 # doxygen should invoke to get the current version for each file (typically from
506 # the version control system). Doxygen will invoke the program by executing (via
507 # popen()) the command , where is the value of
508 # the FILE_VERSION_FILTER tag, and is the name of an input file
509 # provided by doxygen. Whatever the program writes to standard output
472510 # is used as the file version. See the manual for examples.
473511
474 FILE_VERSION_FILTER =
512 FILE_VERSION_FILTER =
513
514 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
515 # by doxygen. The layout file controls the global structure of the generated
516 # output files in an output format independent way. The create the layout file
517 # that represents doxygen's defaults, run doxygen with the -l option.
518 # You can optionally specify a file name after the option, if omitted
519 # DoxygenLayout.xml will be used as the name of the layout file.
520
521 LAYOUT_FILE =
475522
476523 #---------------------------------------------------------------------------
477524 # configuration options related to warning and progress messages
478525 #---------------------------------------------------------------------------
479526
480 # The QUIET tag can be used to turn on/off the messages that are generated
527 # The QUIET tag can be used to turn on/off the messages that are generated
481528 # by doxygen. Possible values are YES and NO. If left blank NO is used.
482529
483530 QUIET = NO
484531
485 # The WARNINGS tag can be used to turn on/off the warning messages that are
486 # generated by doxygen. Possible values are YES and NO. If left blank
532 # The WARNINGS tag can be used to turn on/off the warning messages that are
533 # generated by doxygen. Possible values are YES and NO. If left blank
487534 # NO is used.
488535
489536 WARNINGS = NO
490537
491 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
492 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
538 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
539 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
493540 # automatically be disabled.
494541
495542 WARN_IF_UNDOCUMENTED = NO
496543
497 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
498 # potential errors in the documentation, such as not documenting some
499 # parameters in a documented function, or documenting parameters that
544 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
545 # potential errors in the documentation, such as not documenting some
546 # parameters in a documented function, or documenting parameters that
500547 # don't exist or using markup commands wrongly.
501548
502549 WARN_IF_DOC_ERROR = YES
503550
504 # This WARN_NO_PARAMDOC option can be abled to get warnings for
505 # functions that are documented, but have no documentation for their parameters
506 # or return value. If set to NO (the default) doxygen will only warn about
507 # wrong or incomplete parameter documentation, but not about the absence of
551 # This WARN_NO_PARAMDOC option can be abled to get warnings for
552 # functions that are documented, but have no documentation for their parameters
553 # or return value. If set to NO (the default) doxygen will only warn about
554 # wrong or incomplete parameter documentation, but not about the absence of
508555 # documentation.
509556
510557 WARN_NO_PARAMDOC = NO
511558
512 # The WARN_FORMAT tag determines the format of the warning messages that
513 # doxygen can produce. The string should contain the $file, $line, and $text
514 # tags, which will be replaced by the file and line number from which the
515 # warning originated and the warning text. Optionally the format may contain
516 # $version, which will be replaced by the version of the file (if it could
559 # The WARN_FORMAT tag determines the format of the warning messages that
560 # doxygen can produce. The string should contain the $file, $line, and $text
561 # tags, which will be replaced by the file and line number from which the
562 # warning originated and the warning text. Optionally the format may contain
563 # $version, which will be replaced by the version of the file (if it could
517564 # be obtained via FILE_VERSION_FILTER)
518565
519 WARN_FORMAT =
520
521 # The WARN_LOGFILE tag can be used to specify a file to which warning
522 # and error messages should be written. If left blank the output is written
566 WARN_FORMAT =
567
568 # The WARN_LOGFILE tag can be used to specify a file to which warning
569 # and error messages should be written. If left blank the output is written
523570 # to stderr.
524571
525 WARN_LOGFILE =
572 WARN_LOGFILE =
526573
527574 #---------------------------------------------------------------------------
528575 # configuration options related to the input files
529576 #---------------------------------------------------------------------------
530577
531 # The INPUT tag can be used to specify the files and/or directories that contain
532 # documented source files. You may enter file names like "myfile.cpp" or
533 # directories like "/usr/src/myproject". Separate the files or directories
578 # The INPUT tag can be used to specify the files and/or directories that contain
579 # documented source files. You may enter file names like "myfile.cpp" or
580 # directories like "/usr/src/myproject". Separate the files or directories
534581 # with spaces.
535582
536583 INPUT = @abs_top_srcdir@/include \
537584 @abs_top_srcdir@/lib \
538585 @abs_top_srcdir@/docs/doxygen.intro
539586
540 # This tag can be used to specify the character encoding of the source files
541 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
542 # also the default input encoding. Doxygen uses libiconv (or the iconv built
543 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
587 # This tag can be used to specify the character encoding of the source files
588 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
589 # also the default input encoding. Doxygen uses libiconv (or the iconv built
590 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
544591 # the list of possible encodings.
545592
546593 INPUT_ENCODING = UTF-8
547594
548 # If the value of the INPUT tag contains directories, you can use the
549 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
550 # and *.h) to filter out the source-files in the directories. If left
551 # blank the following patterns are tested:
552 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
595 # If the value of the INPUT tag contains directories, you can use the
596 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
597 # and *.h) to filter out the source-files in the directories. If left
598 # blank the following patterns are tested:
599 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
553600 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
554601
555 FILE_PATTERNS =
556
557 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
558 # should be searched for input files as well. Possible values are YES and NO.
602 FILE_PATTERNS =
603
604 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
605 # should be searched for input files as well. Possible values are YES and NO.
559606 # If left blank NO is used.
560607
561608 RECURSIVE = YES
562609
563 # The EXCLUDE tag can be used to specify files and/or directories that should
564 # excluded from the INPUT source files. This way you can easily exclude a
610 # The EXCLUDE tag can be used to specify files and/or directories that should
611 # excluded from the INPUT source files. This way you can easily exclude a
565612 # subdirectory from a directory tree whose root is specified with the INPUT tag.
566613
567 EXCLUDE =
568
569 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
570 # directories that are symbolic links (a Unix filesystem feature) are excluded
614 EXCLUDE =
615
616 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
617 # directories that are symbolic links (a Unix filesystem feature) are excluded
571618 # from the input.
572619
573620 EXCLUDE_SYMLINKS = NO
574621
575 # If the value of the INPUT tag contains directories, you can use the
576 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
577 # certain files from those directories. Note that the wildcards are matched
578 # against the file with absolute path, so to exclude all test directories
622 # If the value of the INPUT tag contains directories, you can use the
623 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
624 # certain files from those directories. Note that the wildcards are matched
625 # against the file with absolute path, so to exclude all test directories
579626 # for example use the pattern */test/*
580627
581 EXCLUDE_PATTERNS =
582
583 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
584 # (namespaces, classes, functions, etc.) that should be excluded from the
585 # output. The symbol name can be a fully qualified name, a word, or if the
586 # wildcard * is used, a substring. Examples: ANamespace, AClass,
628 EXCLUDE_PATTERNS =
629
630 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
631 # (namespaces, classes, functions, etc.) that should be excluded from the
632 # output. The symbol name can be a fully qualified name, a word, or if the
633 # wildcard * is used, a substring. Examples: ANamespace, AClass,
587634 # AClass::ANamespace, ANamespace::*Test
588635
589 EXCLUDE_SYMBOLS =
590
591 # The EXAMPLE_PATH tag can be used to specify one or more files or
592 # directories that contain example code fragments that are included (see
636 EXCLUDE_SYMBOLS =
637
638 # The EXAMPLE_PATH tag can be used to specify one or more files or
639 # directories that contain example code fragments that are included (see
593640 # the \include command).
594641
595642 EXAMPLE_PATH = @abs_top_srcdir@/examples
596643
597 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
598 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
599 # and *.h) to filter out the source-files in the directories. If left
644 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
645 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
646 # and *.h) to filter out the source-files in the directories. If left
600647 # blank all files are included.
601648
602 EXAMPLE_PATTERNS =
603
604 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
605 # searched for input files to be used with the \include or \dontinclude
606 # commands irrespective of the value of the RECURSIVE tag.
649 EXAMPLE_PATTERNS =
650
651 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
652 # searched for input files to be used with the \include or \dontinclude
653 # commands irrespective of the value of the RECURSIVE tag.
607654 # Possible values are YES and NO. If left blank NO is used.
608655
609656 EXAMPLE_RECURSIVE = YES
610657
611 # The IMAGE_PATH tag can be used to specify one or more files or
612 # directories that contain image that are included in the documentation (see
658 # The IMAGE_PATH tag can be used to specify one or more files or
659 # directories that contain image that are included in the documentation (see
613660 # the \image command).
614661
615662 IMAGE_PATH = @abs_top_srcdir@/docs/img
616663
617 # The INPUT_FILTER tag can be used to specify a program that doxygen should
618 # invoke to filter for each input file. Doxygen will invoke the filter program
619 # by executing (via popen()) the command , where
620 # is the value of the INPUT_FILTER tag, and is the name of an
621 # input file. Doxygen will then use the output that the filter program writes
622 # to standard output. If FILTER_PATTERNS is specified, this tag will be
664 # The INPUT_FILTER tag can be used to specify a program that doxygen should
665 # invoke to filter for each input file. Doxygen will invoke the filter program
666 # by executing (via popen()) the command , where
667 # is the value of the INPUT_FILTER tag, and is the name of an
668 # input file. Doxygen will then use the output that the filter program writes
669 # to standard output.
670 # If FILTER_PATTERNS is specified, this tag will be
623671 # ignored.
624672
625 INPUT_FILTER =
626
627 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
628 # basis. Doxygen will compare the file name with each pattern and apply the
629 # filter if there is a match. The filters are a list of the form:
630 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
631 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
673 INPUT_FILTER =
674
675 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
676 # basis.
677 # Doxygen will compare the file name with each pattern and apply the
678 # filter if there is a match.
679 # The filters are a list of the form:
680 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
681 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
632682 # is applied to all files.
633683
634 FILTER_PATTERNS =
635
636 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
637 # INPUT_FILTER) will be used to filter the input files when producing source
684 FILTER_PATTERNS =
685
686 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
687 # INPUT_FILTER) will be used to filter the input files when producing source
638688 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
639689
640690 FILTER_SOURCE_FILES = NO
643693 # configuration options related to source browsing
644694 #---------------------------------------------------------------------------
645695
646 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
647 # be generated. Documented entities will be cross-referenced with these sources.
648 # Note: To get rid of all source code in the generated output, make sure also
696 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
697 # be generated. Documented entities will be cross-referenced with these sources.
698 # Note: To get rid of all source code in the generated output, make sure also
649699 # VERBATIM_HEADERS is set to NO.
650700
651701 SOURCE_BROWSER = YES
652702
653 # Setting the INLINE_SOURCES tag to YES will include the body
703 # Setting the INLINE_SOURCES tag to YES will include the body
654704 # of functions and classes directly in the documentation.
655705
656706 INLINE_SOURCES = NO
657707
658 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
659 # doxygen to hide any special comment blocks from generated source code
708 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
709 # doxygen to hide any special comment blocks from generated source code
660710 # fragments. Normal C and C++ comments will always remain visible.
661711
662712 STRIP_CODE_COMMENTS = NO
663713
664 # If the REFERENCED_BY_RELATION tag is set to YES
665 # then for each documented function all documented
714 # If the REFERENCED_BY_RELATION tag is set to YES
715 # then for each documented function all documented
666716 # functions referencing it will be listed.
667717
668718 REFERENCED_BY_RELATION = YES
669719
670 # If the REFERENCES_RELATION tag is set to YES
671 # then for each documented function all documented entities
720 # If the REFERENCES_RELATION tag is set to YES
721 # then for each documented function all documented entities
672722 # called/used by that function will be listed.
673723
674724 REFERENCES_RELATION = YES
676726 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
677727 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
678728 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
679 # link to the source code. Otherwise they will link to the documentstion.
729 # link to the source code.
730 # Otherwise they will link to the documentation.
680731
681732 REFERENCES_LINK_SOURCE = YES
682733
683 # If the USE_HTAGS tag is set to YES then the references to source code
684 # will point to the HTML generated by the htags(1) tool instead of doxygen
685 # built-in source browser. The htags tool is part of GNU's global source
686 # tagging system (see http://www.gnu.org/software/global/global.html). You
734 # If the USE_HTAGS tag is set to YES then the references to source code
735 # will point to the HTML generated by the htags(1) tool instead of doxygen
736 # built-in source browser. The htags tool is part of GNU's global source
737 # tagging system (see http://www.gnu.org/software/global/global.html). You
687738 # will need version 4.8.6 or higher.
688739
689740 USE_HTAGS = NO
690741
691 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
692 # will generate a verbatim copy of the header file for each class for
742 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
743 # will generate a verbatim copy of the header file for each class for
693744 # which an include is specified. Set to NO to disable this.
694745
695746 VERBATIM_HEADERS = YES
698749 # configuration options related to the alphabetical class index
699750 #---------------------------------------------------------------------------
700751
701 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
702 # of all compounds will be generated. Enable this if the project
752 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
753 # of all compounds will be generated. Enable this if the project
703754 # contains a lot of classes, structs, unions or interfaces.
704755
705756 ALPHABETICAL_INDEX = YES
706757
707 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
708 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
758 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
759 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
709760 # in which this list will be split (can be a number in the range [1..20])
710761
711762 COLS_IN_ALPHA_INDEX = 4
712763
713 # In case all classes in a project start with a common prefix, all
714 # classes will be put under the same header in the alphabetical index.
715 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
764 # In case all classes in a project start with a common prefix, all
765 # classes will be put under the same header in the alphabetical index.
766 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
716767 # should be ignored while generating the index headers.
717768
718769 IGNORE_PREFIX = llvm::
721772 # configuration options related to the HTML output
722773 #---------------------------------------------------------------------------
723774
724 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
775 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
725776 # generate HTML output.
726777
727778 GENERATE_HTML = YES
728779
729 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
730 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
780 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
781 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
731782 # put in front of it. If left blank `html' will be used as the default path.
732783
733784 HTML_OUTPUT = html
734785
735 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
736 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
786 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
787 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
737788 # doxygen will generate files with .html extension.
738789
739790 HTML_FILE_EXTENSION = .html
740791
741 # The HTML_HEADER tag can be used to specify a personal HTML header for
742 # each generated HTML page. If it is left blank doxygen will generate a
792 # The HTML_HEADER tag can be used to specify a personal HTML header for
793 # each generated HTML page. If it is left blank doxygen will generate a
743794 # standard header.
744795
745796 HTML_HEADER = @abs_top_srcdir@/docs/doxygen.header
746797
747 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
748 # each generated HTML page. If it is left blank doxygen will generate a
798 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
799 # each generated HTML page. If it is left blank doxygen will generate a
749800 # standard footer.
750801
751802 HTML_FOOTER = @abs_top_srcdir@/docs/doxygen.footer
752803
753 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
754 # style sheet that is used by each HTML page. It can be used to
755 # fine-tune the look of the HTML output. If the tag is left blank doxygen
756 # will generate a default style sheet. Note that doxygen will try to copy
757 # the style sheet file to the HTML output directory, so don't put your own
804 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
805 # style sheet that is used by each HTML page. It can be used to
806 # fine-tune the look of the HTML output. If the tag is left blank doxygen
807 # will generate a default style sheet. Note that doxygen will try to copy
808 # the style sheet file to the HTML output directory, so don't put your own
758809 # stylesheet in the HTML output directory as well, or it will be erased!
759810
760811 HTML_STYLESHEET = @abs_top_srcdir@/docs/doxygen.css
761812
762 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
763 # files or namespaces will be aligned in HTML using tables. If set to
813 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
814 # Doxygen will adjust the colors in the stylesheet and background images
815 # according to this color. Hue is specified as an angle on a colorwheel,
816 # see http://en.wikipedia.org/wiki/Hue for more information.
817 # For instance the value 0 represents red, 60 is yellow, 120 is green,
818 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
819 # The allowed range is 0 to 359.
820
821 HTML_COLORSTYLE_HUE = 220
822
823 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
824 # the colors in the HTML output. For a value of 0 the output will use
825 # grayscales only. A value of 255 will produce the most vivid colors.
826
827 HTML_COLORSTYLE_SAT = 100
828
829 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
830 # the luminance component of the colors in the HTML output. Values below
831 # 100 gradually make the output lighter, whereas values above 100 make
832 # the output darker. The value divided by 100 is the actual gamma applied,
833 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
834 # and 100 does not change the gamma.
835
836 HTML_COLORSTYLE_GAMMA = 80
837
838 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
839 # page will contain the date and time when the page was generated. Setting
840 # this to NO can help when comparing the output of multiple runs.
841
842 HTML_TIMESTAMP = YES
843
844 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
845 # files or namespaces will be aligned in HTML using tables. If set to
764846 # NO a bullet list will be used.
765847
766848 HTML_ALIGN_MEMBERS = YES
767849
768 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
769 # will be generated that can be used as input for tools like the
770 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
850 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
851 # documentation will contain sections that can be hidden and shown after the
852 # page has loaded. For this to work a browser that supports
853 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
854 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
855
856 HTML_DYNAMIC_SECTIONS = NO
857
858 # If the GENERATE_DOCSET tag is set to YES, additional index files
859 # will be generated that can be used as input for Apple's Xcode 3
860 # integrated development environment, introduced with OSX 10.5 (Leopard).
861 # To create a documentation set, doxygen will generate a Makefile in the
862 # HTML output directory. Running make will produce the docset in that
863 # directory and running "make install" will install the docset in
864 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
865 # it at startup.
866 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
867 # for more information.
868
869 GENERATE_DOCSET = NO
870
871 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
872 # feed. A documentation feed provides an umbrella under which multiple
873 # documentation sets from a single provider (such as a company or product suite)
874 # can be grouped.
875
876 DOCSET_FEEDNAME = "Doxygen generated docs"
877
878 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
879 # should uniquely identify the documentation set bundle. This should be a
880 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
881 # will append .docset to the name.
882
883 DOCSET_BUNDLE_ID = org.doxygen.Project
884
885 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
886 # the documentation publisher. This should be a reverse domain-name style
887 # string, e.g. com.mycompany.MyDocSet.documentation.
888
889 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
890
891 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
892
893 DOCSET_PUBLISHER_NAME = Publisher
894
895 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
896 # will be generated that can be used as input for tools like the
897 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
771898 # of the generated HTML documentation.
772899
773900 GENERATE_HTMLHELP = NO
774901
775 # If the GENERATE_DOCSET tag is set to YES, additional index files
776 # will be generated that can be used as input for Apple's Xcode 3
777 # integrated development environment, introduced with OSX 10.5 (Leopard).
778 # To create a documentation set, doxygen will generate a Makefile in the
779 # HTML output directory. Running make will produce the docset in that
780 # directory and running "make install" will install the docset in
781 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
782 # it at startup.
783
784 GENERATE_DOCSET = NO
785
786 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
787 # feed. A documentation feed provides an umbrella under which multiple
788 # documentation sets from a single provider (such as a company or product suite)
789 # can be grouped.
790
791 DOCSET_FEEDNAME = "Doxygen generated docs"
792
793 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
794 # should uniquely identify the documentation set bundle. This should be a
795 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
796 # will append .docset to the name.
797
798 DOCSET_BUNDLE_ID = org.doxygen.Project
799
800 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
801 # documentation will contain sections that can be hidden and shown after the
802 # page has loaded. For this to work a browser that supports
803 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
804 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
805
806 HTML_DYNAMIC_SECTIONS = NO
807
808 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
809 # be used to specify the file name of the resulting .chm file. You
810 # can add a path in front of the file if the result should not be
902 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
903 # be used to specify the file name of the resulting .chm file. You
904 # can add a path in front of the file if the result should not be
811905 # written to the html output directory.
812906
813 CHM_FILE =
814
815 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
816 # be used to specify the location (absolute path including file name) of
817 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
907 CHM_FILE =
908
909 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
910 # be used to specify the location (absolute path including file name) of
911 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
818912 # the HTML help compiler on the generated index.hhp.
819913
820 HHC_LOCATION =
821
822 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
823 # controls if a separate .chi index file is generated (YES) or that
914 HHC_LOCATION =
915
916 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
917 # controls if a separate .chi index file is generated (YES) or that
824918 # it should be included in the master .chm file (NO).
825919
826920 GENERATE_CHI = NO
829923 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
830924 # content.
831925
832 CHM_INDEX_ENCODING =
833
834 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
835 # controls whether a binary table of contents is generated (YES) or a
926 CHM_INDEX_ENCODING =
927
928 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
929 # controls whether a binary table of contents is generated (YES) or a
836930 # normal table of contents (NO) in the .chm file.
837931
838932 BINARY_TOC = NO
839933
840 # The TOC_EXPAND flag can be set to YES to add extra items for group members
934 # The TOC_EXPAND flag can be set to YES to add extra items for group members
841935 # to the contents of the HTML help documentation and to the tree view.
842936
843937 TOC_EXPAND = NO
844938
845 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
846 # top of each HTML page. The value NO (the default) enables the index and
939 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
940 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
941 # that can be used as input for Qt's qhelpgenerator to generate a
942 # Qt Compressed Help (.qch) of the generated HTML documentation.
943
944 GENERATE_QHP = NO
945
946 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
947 # be used to specify the file name of the resulting .qch file.
948 # The path specified is relative to the HTML output folder.
949
950 QCH_FILE =
951
952 # The QHP_NAMESPACE tag specifies the namespace to use when generating
953 # Qt Help Project output. For more information please see
954 # http://doc.trolltech.com/qthelpproject.html#namespace
955
956 QHP_NAMESPACE = org.doxygen.Project
957
958 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
959 # Qt Help Project output. For more information please see
960 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
961
962 QHP_VIRTUAL_FOLDER = doc
963
964 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
965 # add. For more information please see
966 # http://doc.trolltech.com/qthelpproject.html#custom-filters
967
968 QHP_CUST_FILTER_NAME =
969
970 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
971 # custom filter to add. For more information please see
972 #
973 # Qt Help Project / Custom Filters.
974
975 QHP_CUST_FILTER_ATTRS =
976
977 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
978 # project's
979 # filter section matches.
980 #
981 # Qt Help Project / Filter Attributes.
982
983 QHP_SECT_FILTER_ATTRS =
984
985 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
986 # be used to specify the location of Qt's qhelpgenerator.
987 # If non-empty doxygen will try to run qhelpgenerator on the generated
988 # .qhp file.
989
990 QHG_LOCATION =
991
992 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
993 # will be generated, which together with the HTML files, form an Eclipse help
994 # plugin. To install this plugin and make it available under the help contents
995 # menu in Eclipse, the contents of the directory containing the HTML and XML
996 # files needs to be copied into the plugins directory of eclipse. The name of
997 # the directory within the plugins directory should be the same as
998 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
999 # the help appears.
1000
1001 GENERATE_ECLIPSEHELP = NO
1002
1003 # A unique identifier for the eclipse help plugin. When installing the plugin
1004 # the directory name containing the HTML and XML files should also have
1005 # this name.
1006
1007 ECLIPSE_DOC_ID = org.doxygen.Project
1008
1009 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1010 # top of each HTML page. The value NO (the default) enables the index and
8471011 # the value YES disables it.
8481012
8491013 DISABLE_INDEX = NO
8501014
851 # This tag can be used to set the number of enum values (range [1..20])
1015 # This tag can be used to set the number of enum values (range [1..20])
8521016 # that doxygen will group on one line in the generated HTML documentation.
8531017
8541018 ENUM_VALUES_PER_LINE = 4
8551019
8561020 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
8571021 # structure should be generated to display hierarchical information.
858 # If the tag value is set to FRAME, a side panel will be generated
859 # containing a tree-like index structure (just like the one that
860 # is generated for HTML Help). For this to work a browser that supports
861 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
862 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
863 # probably better off using the HTML help feature. Other possible values
864 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
865 # and Class Hiererachy pages using a tree view instead of an ordered list;
866 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
867 # disables this behavior completely. For backwards compatibility with previous
868 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
869 # respectively.
1022 # If the tag value is set to YES, a side panel will be generated
1023 # containing a tree-like index structure (just like the one that
1024 # is generated for HTML Help). For this to work a browser that supports
1025 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1026 # Windows users are probably better off using the HTML help feature.
8701027
8711028 GENERATE_TREEVIEW = NO
8721029
873 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
874 # used to set the initial width (in pixels) of the frame in which the tree
1030 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1031 # and Class Hierarchy pages using a tree view instead of an ordered list.
1032
1033 USE_INLINE_TREES = NO
1034
1035 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1036 # used to set the initial width (in pixels) of the frame in which the tree
8751037 # is shown.
8761038
8771039 TREEVIEW_WIDTH = 250
8781040
879 # Use this tag to change the font size of Latex formulas included
880 # as images in the HTML documentation. The default is 10. Note that
881 # when you change the font size after a successful doxygen run you need
882 # to manually remove any form_*.png images from the HTML output directory
1041 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1042 # links to external symbols imported via tag files in a separate window.
1043
1044 EXT_LINKS_IN_WINDOW = NO
1045
1046 # Use this tag to change the font size of Latex formulas included
1047 # as images in the HTML documentation. The default is 10. Note that
1048 # when you change the font size after a successful doxygen run you need
1049 # to manually remove any form_*.png images from the HTML output directory
8831050 # to force them to be regenerated.
8841051
8851052 FORMULA_FONTSIZE = 10
8861053
1054 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1055 # generated for formulas are transparent PNGs. Transparent PNGs are
1056 # not supported properly for IE 6.0, but are supported on all modern browsers.
1057 # Note that when changing this option you need to delete any form_*.png files
1058 # in the HTML output before the changes have effect.
1059
1060 FORMULA_TRANSPARENT = YES
1061
1062 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1063 # for the HTML output. The underlying search engine uses javascript
1064 # and DHTML and should work on any modern browser. Note that when using
1065 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1066 # (GENERATE_DOCSET) there is already a search function so this one should
1067 # typically be disabled. For large projects the javascript based search engine
1068 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1069
1070 SEARCHENGINE = NO
1071
1072 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1073 # implemented using a PHP enabled web server instead of at the web client
1074 # using Javascript. Doxygen will generate the search PHP script and index
1075 # file to put on the web server. The advantage of the server
1076 # based approach is that it scales better to large projects and allows
1077 # full text search. The disadvances is that it is more difficult to setup
1078 # and does not have live searching capabilities.
1079
1080 SERVER_BASED_SEARCH = NO
1081
8871082 #---------------------------------------------------------------------------
8881083 # configuration options related to the LaTeX output
8891084 #---------------------------------------------------------------------------
8901085
891 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1086 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
8921087 # generate Latex output.
8931088
8941089 GENERATE_LATEX = NO
8951090
896 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
897 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1091 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1092 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
8981093 # put in front of it. If left blank `latex' will be used as the default path.
8991094
900 LATEX_OUTPUT =
901
902 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1095 LATEX_OUTPUT =
1096
1097 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
9031098 # invoked. If left blank `latex' will be used as the default command name.
1099 # Note that when enabling USE_PDFLATEX this option is only used for
1100 # generating bitmaps for formulas in the HTML output, but not in the
1101 # Makefile that is written to the output directory.
9041102
9051103 LATEX_CMD_NAME = latex
9061104
907 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
908 # generate index for LaTeX. If left blank `makeindex' will be used as the
1105 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1106 # generate index for LaTeX. If left blank `makeindex' will be used as the
9091107 # default command name.
9101108
9111109 MAKEINDEX_CMD_NAME = makeindex
9121110
913 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
914 # LaTeX documents. This may be useful for small projects and may help to
1111 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1112 # LaTeX documents. This may be useful for small projects and may help to
9151113 # save some trees in general.
9161114
9171115 COMPACT_LATEX = NO
9181116
919 # The PAPER_TYPE tag can be used to set the paper type that is used
920 # by the printer. Possible values are: a4, a4wide, letter, legal and
1117 # The PAPER_TYPE tag can be used to set the paper type that is used
1118 # by the printer. Possible values are: a4, a4wide, letter, legal and
9211119 # executive. If left blank a4wide will be used.
9221120
9231121 PAPER_TYPE = letter
9241122
925 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1123 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
9261124 # packages that should be included in the LaTeX output.
9271125
928 EXTRA_PACKAGES =
929
930 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
931 # the generated latex document. The header should contain everything until
932 # the first chapter. If it is left blank doxygen will generate a
1126 EXTRA_PACKAGES =
1127
1128 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1129 # the generated latex document. The header should contain everything until
1130 # the first chapter. If it is left blank doxygen will generate a
9331131 # standard header. Notice: only use this tag if you know what you are doing!
9341132
935 LATEX_HEADER =
936
937 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
938 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
939 # contain links (just like the HTML output) instead of page references
1133 LATEX_HEADER =
1134
1135 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1136 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1137 # contain links (just like the HTML output) instead of page references
9401138 # This makes the output suitable for online browsing using a pdf viewer.
9411139
9421140 PDF_HYPERLINKS = NO
9431141
944 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
945 # plain latex in the generated Makefile. Set this option to YES to get a
1142 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1143 # plain latex in the generated Makefile. Set this option to YES to get a
9461144 # higher quality PDF documentation.
9471145
9481146 USE_PDFLATEX = NO
9491147
950 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
951 # command to the generated LaTeX files. This will instruct LaTeX to keep
952 # running if errors occur, instead of asking the user for help.
1148 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1149 # command to the generated LaTeX files. This will instruct LaTeX to keep
1150 # running if errors occur, instead of asking the user for help.
9531151 # This option is also used when generating formulas in HTML.
9541152
9551153 LATEX_BATCHMODE = NO
9561154
957 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
958 # include the index chapters (such as File Index, Compound Index, etc.)
1155 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1156 # include the index chapters (such as File Index, Compound Index, etc.)
9591157 # in the output.
9601158
9611159 LATEX_HIDE_INDICES = NO
9621160
1161 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1162 # source code with syntax highlighting in the LaTeX output.
1163 # Note that which sources are shown also depends on other settings
1164 # such as SOURCE_BROWSER.
1165
1166 LATEX_SOURCE_CODE = NO
1167
9631168 #---------------------------------------------------------------------------
9641169 # configuration options related to the RTF output
9651170 #---------------------------------------------------------------------------
9661171
967 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
968 # The RTF output is optimized for Word 97 and may not look very pretty with
1172 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1173 # The RTF output is optimized for Word 97 and may not look very pretty with
9691174 # other RTF readers or editors.
9701175
9711176 GENERATE_RTF = NO
9721177
973 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
974 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1178 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1179 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
9751180 # put in front of it. If left blank `rtf' will be used as the default path.
9761181
977 RTF_OUTPUT =
978
979 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
980 # RTF documents. This may be useful for small projects and may help to
1182 RTF_OUTPUT =
1183
1184 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1185 # RTF documents. This may be useful for small projects and may help to
9811186 # save some trees in general.
9821187
9831188 COMPACT_RTF = NO
9841189
985 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
986 # will contain hyperlink fields. The RTF file will
987 # contain links (just like the HTML output) instead of page references.
988 # This makes the output suitable for online browsing using WORD or other
989 # programs which support those fields.
1190 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1191 # will contain hyperlink fields. The RTF file will
1192 # contain links (just like the HTML output) instead of page references.
1193 # This makes the output suitable for online browsing using WORD or other
1194 # programs which support those fields.
9901195 # Note: wordpad (write) and others do not support links.
9911196
9921197 RTF_HYPERLINKS = NO
9931198
994 # Load stylesheet definitions from file. Syntax is similar to doxygen's
995 # config file, i.e. a series of assignments. You only have to provide
1199 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1200 # config file, i.e. a series of assignments. You only have to provide
9961201 # replacements, missing definitions are set to their default value.
9971202
998 RTF_STYLESHEET_FILE =
999
1000 # Set optional variables used in the generation of an rtf document.
1203 RTF_STYLESHEET_FILE =
1204
1205 # Set optional variables used in the generation of an rtf document.
10011206 # Syntax is similar to doxygen's config file.
10021207
1003 RTF_EXTENSIONS_FILE =
1208 RTF_EXTENSIONS_FILE =
10041209
10051210 #---------------------------------------------------------------------------
10061211 # configuration options related to the man page output
10071212 #---------------------------------------------------------------------------
10081213
1009 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1214 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
10101215 # generate man pages
10111216
10121217 GENERATE_MAN = NO
10131218
1014 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1015 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1219 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1220 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
10161221 # put in front of it. If left blank `man' will be used as the default path.
10171222
1018 MAN_OUTPUT =
1019
1020 # The MAN_EXTENSION tag determines the extension that is added to
1223 MAN_OUTPUT =
1224
1225 # The MAN_EXTENSION tag determines the extension that is added to
10211226 # the generated man pages (default is the subroutine's section .3)
10221227
1023 MAN_EXTENSION =
1024
1025 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1026 # then it will generate one additional man file for each entity
1027 # documented in the real man page(s). These additional files
1028 # only source the real man page, but without them the man command
1228 MAN_EXTENSION =
1229
1230 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1231 # then it will generate one additional man file for each entity
1232 # documented in the real man page(s). These additional files
1233 # only source the real man page, but without them the man command
10291234 # would be unable to find the correct page. The default is NO.
10301235
10311236 MAN_LINKS = NO
10341239 # configuration options related to the XML output
10351240 #---------------------------------------------------------------------------
10361241
1037 # If the GENERATE_XML tag is set to YES Doxygen will
1038 # generate an XML file that captures the structure of
1242 # If the GENERATE_XML tag is set to YES Doxygen will
1243 # generate an XML file that captures the structure of
10391244 # the code including all documentation.
10401245
10411246 GENERATE_XML = NO
10421247
1043 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1044 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1248 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1249 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
10451250 # put in front of it. If left blank `xml' will be used as the default path.
10461251
10471252 XML_OUTPUT = xml
10481253
1049 # The XML_SCHEMA tag can be used to specify an XML schema,
1050 # which can be used by a validating XML parser to check the
1254 # The XML_SCHEMA tag can be used to specify an XML schema,
1255 # which can be used by a validating XML parser to check the
10511256 # syntax of the XML files.
10521257
1053 XML_SCHEMA =
1054
1055 # The XML_DTD tag can be used to specify an XML DTD,
1056 # which can be used by a validating XML parser to check the
1258 XML_SCHEMA =
1259
1260 # The XML_DTD tag can be used to specify an XML DTD,
1261 # which can be used by a validating XML parser to check the
10571262 # syntax of the XML files.
10581263
1059 XML_DTD =
1060
1061 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1062 # dump the program listings (including syntax highlighting
1063 # and cross-referencing information) to the XML output. Note that
1264 XML_DTD =
1265
1266 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1267 # dump the program listings (including syntax highlighting
1268 # and cross-referencing information) to the XML output. Note that
10641269 # enabling this will significantly increase the size of the XML output.
10651270
10661271 XML_PROGRAMLISTING = YES
10691274 # configuration options for the AutoGen Definitions output
10701275 #---------------------------------------------------------------------------
10711276
1072 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1073 # generate an AutoGen Definitions (see autogen.sf.net) file
1074 # that captures the structure of the code including all
1075 # documentation. Note that this feature is still experimental
1277 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1278 # generate an AutoGen Definitions (see autogen.sf.net) file
1279 # that captures the structure of the code including all
1280 # documentation. Note that this feature is still experimental
10761281 # and incomplete at the moment.
10771282
10781283 GENERATE_AUTOGEN_DEF = NO
10811286 # configuration options related to the Perl module output
10821287 #---------------------------------------------------------------------------
10831288
1084 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1085 # generate a Perl module file that captures the structure of
1086 # the code including all documentation. Note that this
1087 # feature is still experimental and incomplete at the
1289 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1290 # generate a Perl module file that captures the structure of
1291 # the code including all documentation. Note that this
1292 # feature is still experimental and incomplete at the
10881293 # moment.
10891294
10901295 GENERATE_PERLMOD = NO
10911296
1092 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1093 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1297 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1298 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
10941299 # to generate PDF and DVI output from the Perl module output.
10951300
10961301 PERLMOD_LATEX = NO
10971302
1098 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1099 # nicely formatted so it can be parsed by a human reader. This is useful
1100 # if you want to understand what is going on. On the other hand, if this
1101 # tag is set to NO the size of the Perl module output will be much smaller
1303 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1304 # nicely formatted so it can be parsed by a human reader.
1305 # This is useful
1306 # if you want to understand what is going on.
1307 # On the other hand, if this
1308 # tag is set to NO the size of the Perl module output will be much smaller
11021309 # and Perl will parse it just the same.
11031310
11041311 PERLMOD_PRETTY = YES
11051312
1106 # The names of the make variables in the generated doxyrules.make file
1107 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1108 # This is useful so different doxyrules.make files included by the same
1313 # The names of the make variables in the generated doxyrules.make file
1314 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1315 # This is useful so different doxyrules.make files included by the same
11091316 # Makefile don't overwrite each other's variables.
11101317
1111 PERLMOD_MAKEVAR_PREFIX =
1112
1113 #---------------------------------------------------------------------------
1114 # Configuration options related to the preprocessor
1115 #---------------------------------------------------------------------------
1116
1117 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1118 # evaluate all C-preprocessor directives found in the sources and include
1318 PERLMOD_MAKEVAR_PREFIX =
1319
1320 #---------------------------------------------------------------------------
1321 # Configuration options related to the preprocessor
1322 #---------------------------------------------------------------------------
1323
1324 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1325 # evaluate all C-preprocessor directives found in the sources and include
11191326 # files.
11201327
11211328 ENABLE_PREPROCESSING = YES
11221329
1123 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1124 # names in the source code. If set to NO (the default) only conditional
1125 # compilation will be performed. Macro expansion can be done in a controlled
1330 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1331 # names in the source code. If set to NO (the default) only conditional
1332 # compilation will be performed. Macro expansion can be done in a controlled
11261333 # way by setting EXPAND_ONLY_PREDEF to YES.
11271334
11281335 MACRO_EXPANSION = NO
11291336
1130 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1131 # then the macro expansion is limited to the macros specified with the
1337 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1338 # then the macro expansion is limited to the macros specified with the
11321339 # PREDEFINED and EXPAND_AS_DEFINED tags.
11331340
11341341 EXPAND_ONLY_PREDEF = NO
11351342
1136 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1343 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
11371344 # in the INCLUDE_PATH (see below) will be search if a #include is found.
11381345
11391346 SEARCH_INCLUDES = YES
11401347
1141 # The INCLUDE_PATH tag can be used to specify one or more directories that
1142 # contain include files that are not input files but should be processed by
1348 # The INCLUDE_PATH tag can be used to specify one or more directories that
1349 # contain include files that are not input files but should be processed by
11431350 # the preprocessor.
11441351
11451352 INCLUDE_PATH = ../include
11461353
1147 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1148 # patterns (like *.h and *.hpp) to filter out the header-files in the
1149 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1354 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1355 # patterns (like *.h and *.hpp) to filter out the header-files in the
1356 # directories. If left blank, the patterns specified with FILE_PATTERNS will
11501357 # be used.
11511358
1152 INCLUDE_FILE_PATTERNS =
1153
1154 # The PREDEFINED tag can be used to specify one or more macro names that
1155 # are defined before the preprocessor is started (similar to the -D option of
1156 # gcc). The argument of the tag is a list of macros of the form: name
1157 # or name=definition (no spaces). If the definition and the = are
1158 # omitted =1 is assumed. To prevent a macro definition from being
1159 # undefined via #undef or recursively expanded use the := operator
1359 INCLUDE_FILE_PATTERNS =
1360
1361 # The PREDEFINED tag can be used to specify one or more macro names that
1362 # are defined before the preprocessor is started (similar to the -D option of
1363 # gcc). The argument of the tag is a list of macros of the form: name
1364 # or name=definition (no spaces). If the definition and the = are
1365 # omitted =1 is assumed. To prevent a macro definition from being
1366 # undefined via #undef or recursively expanded use the := operator
11601367 # instead of the = operator.
11611368
1162 PREDEFINED =
1163
1164 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1165 # this tag can be used to specify a list of macro names that should be expanded.
1166 # The macro definition that is found in the sources will be used.
1369 PREDEFINED =
1370
1371 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1372 # this tag can be used to specify a list of macro names that should be expanded.
1373 # The macro definition that is found in the sources will be used.
11671374 # Use the PREDEFINED tag if you want to use a different macro definition.
11681375
1169 EXPAND_AS_DEFINED =
1170
1171 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1172 # doxygen's preprocessor will remove all function-like macros that are alone
1173 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1174 # function macros are typically used for boiler-plate code, and will confuse
1376 EXPAND_AS_DEFINED =
1377
1378 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1379 # doxygen's preprocessor will remove all function-like macros that are alone
1380 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1381 # function macros are typically used for boiler-plate code, and will confuse
11751382 # the parser if not removed.
11761383
11771384 SKIP_FUNCTION_MACROS = YES
11781385
11791386 #---------------------------------------------------------------------------
1180 # Configuration::additions related to external references
1181 #---------------------------------------------------------------------------
1182
1183 # The TAGFILES option can be used to specify one or more tagfiles.
1184 # Optionally an initial location of the external documentation
1185 # can be added for each tagfile. The format of a tag file without
1186 # this location is as follows:
1187 # TAGFILES = file1 file2 ...
1188 # Adding location for the tag files is done as follows:
1189 # TAGFILES = file1=loc1 "file2 = loc2" ...
1190 # where "loc1" and "loc2" can be relative or absolute paths or
1191 # URLs. If a location is present for each tag, the installdox tool
1387 # Configuration::additions related to external references
1388 #---------------------------------------------------------------------------
1389
1390 # The TAGFILES option can be used to specify one or more tagfiles.
1391 # Optionally an initial location of the external documentation
1392 # can be added for each tagfile. The format of a tag file without
1393 # this location is as follows:
1394 #
1395 # TAGFILES = file1 file2 ...
1396 # Adding location for the tag files is done as follows:
1397 #
1398 # TAGFILES = file1=loc1 "file2 = loc2" ...
1399 # where "loc1" and "loc2" can be relative or absolute paths or
1400 # URLs. If a location is present for each tag, the installdox tool
11921401 # does not have to be run to correct the links.
11931402 # Note that each tag file must have a unique name
11941403 # (where the name does NOT include the path)
1195 # If a tag file is not located in the directory in which doxygen
1404 # If a tag file is not located in the directory in which doxygen
11961405 # is run, you must also specify the path to the tagfile here.
11971406
1198 TAGFILES =
1199
1200 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1407 TAGFILES =
1408
1409 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
12011410 # a tag file that is based on the input files it reads.
12021411
1203 GENERATE_TAGFILE =
1204
1205 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1206 # in the class index. If set to NO only the inherited external classes
1412 GENERATE_TAGFILE =
1413
1414 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1415 # in the class index. If set to NO only the inherited external classes
12071416 # will be listed.
12081417
12091418 ALLEXTERNALS = YES
12101419
1211 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1212 # in the modules index. If set to NO, only the current project's groups will
1420 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1421 # in the modules index. If set to NO, only the current project's groups will
12131422 # be listed.
12141423
12151424 EXTERNAL_GROUPS = YES
12161425
1217 # The PERL_PATH should be the absolute path and name of the perl script
1426 # The PERL_PATH should be the absolute path and name of the perl script
12181427 # interpreter (i.e. the result of `which perl').
12191428
1220 PERL_PATH =
1221
1222 #---------------------------------------------------------------------------
1223 # Configuration options related to the dot tool
1224 #---------------------------------------------------------------------------
1225
1226 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1227 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1228 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1229 # this option is superseded by the HAVE_DOT option below. This is only a
1230 # fallback. It is recommended to install and use dot, since it yields more
1429 PERL_PATH =
1430
1431 #---------------------------------------------------------------------------
1432 # Configuration options related to the dot tool
1433 #---------------------------------------------------------------------------
1434
1435 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1436 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1437 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1438 # this option is superseded by the HAVE_DOT option below. This is only a
1439 # fallback. It is recommended to install and use dot, since it yields more
12311440 # powerful graphs.
12321441
12331442 CLASS_DIAGRAMS = YES
12341443
1235 # You can define message sequence charts within doxygen comments using the \msc
1236 # command. Doxygen will then run the mscgen tool (see
1237 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1238 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1239 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1444 # You can define message sequence charts within doxygen comments using the \msc
1445 # command. Doxygen will then run the mscgen tool (see
1446 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1447 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1448 # the mscgen tool resides. If left empty the tool is assumed to be found in the
12401449 # default search path.
12411450
1242 MSCGEN_PATH =
1243
1244 # If set to YES, the inheritance and collaboration graphs will hide
1245 # inheritance and usage relations if the target is undocumented
1451 MSCGEN_PATH =
1452
1453 # If set to YES, the inheritance and collaboration graphs will hide
1454 # inheritance and usage relations if the target is undocumented
12461455 # or is not a class.
12471456
12481457 HIDE_UNDOC_RELATIONS = NO
12491458
1250 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1251 # available from the path. This tool is part of Graphviz, a graph visualization
1252 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1459 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1460 # available from the path. This tool is part of Graphviz, a graph visualization
1461 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
12531462 # have no effect if this option is set to NO (the default)
12541463
12551464 HAVE_DOT = YES
12561465
1257 # By default doxygen will write a font called FreeSans.ttf to the output
1258 # directory and reference it in all dot files that doxygen generates. This
1259 # font does not include all possible unicode characters however, so when you need
1260 # these (or just want a differently looking font) you can specify the font name
1261 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1262 # which can be done by putting it in a standard location or by setting the
1263 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1466 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1467 # allowed to run in parallel. When set to 0 (the default) doxygen will
1468 # base this on the number of processors available in the system. You can set it
1469 # explicitly to a value larger than 0 to get control over the balance
1470 # between CPU load and processing speed.
1471
1472 DOT_NUM_THREADS = 0
1473
1474 # By default doxygen will write a font called FreeSans.ttf to the output
1475 # directory and reference it in all dot files that doxygen generates. This
1476 # font does not include all possible unicode characters however, so when you need
1477 # these (or just want a differently looking font) you can specify the font name
1478 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1479 # which can be done by putting it in a standard location or by setting the
1480 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
12641481 # containing the font.
12651482
12661483 DOT_FONTNAME = FreeSans
12671484
1268 # By default doxygen will tell dot to use the output directory to look for the
1269 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1270 # different font using DOT_FONTNAME you can set the path where dot
1485 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1486 # The default size is 10pt.
1487
1488 DOT_FONTSIZE = 10
1489
1490 # By default doxygen will tell dot to use the output directory to look for the
1491 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1492 # different font using DOT_FONTNAME you can set the path where dot
12711493 # can find it using this tag.
12721494
1273 DOT_FONTPATH =
1274
1275 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1276 # will generate a graph for each documented class showing the direct and
1277 # indirect inheritance relations. Setting this tag to YES will force the
1495 DOT_FONTPATH =
1496
1497 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1498 # will generate a graph for each documented class showing the direct and
1499 # indirect inheritance relations. Setting this tag to YES will force the
12781500 # the CLASS_DIAGRAMS tag to NO.
12791501
12801502 CLASS_GRAPH = YES
12811503
1282 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1283 # will generate a graph for each documented class showing the direct and
1284 # indirect implementation dependencies (inheritance, containment, and
1504 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1505 # will generate a graph for each documented class showing the direct and
1506 # indirect implementation dependencies (inheritance, containment, and
12851507 # class references variables) of the class with other documented classes.
12861508
12871509 COLLABORATION_GRAPH = YES
12881510
1289 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1511 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
12901512 # will generate a graph for groups, showing the direct groups dependencies
12911513
12921514 GROUP_GRAPHS = YES
12931515
1294 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1295 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1516 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1517 # collaboration diagrams in a style similar to the OMG's Unified Modeling
12961518 # Language.
12971519
12981520 UML_LOOK = NO
12991521
1300 # If set to YES, the inheritance and collaboration graphs will show the
1522 # If set to YES, the inheritance and collaboration graphs will show the
13011523 # relations between templates and their instances.
13021524
13031525 TEMPLATE_RELATIONS = YES
13041526
1305 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1306 # tags are set to YES then doxygen will generate a graph for each documented
1307 # file showing the direct and indirect include dependencies of the file with
1527 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1528 # tags are set to YES then doxygen will generate a graph for each documented
1529 # file showing the direct and indirect include dependencies of the file with
13081530 # other documented files.
13091531
13101532 INCLUDE_GRAPH = YES
13111533
1312 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1313 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1314 # documented header file showing the documented files that directly or
1534 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1535 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1536 # documented header file showing the documented files that directly or
13151537 # indirectly include this file.
13161538
13171539 INCLUDED_BY_GRAPH = YES
13181540
1319 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1320 # doxygen will generate a call dependency graph for every global function
1321 # or class method. Note that enabling this option will significantly increase
1322 # the time of a run. So in most cases it will be better to enable call graphs
1541 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1542 # doxygen will generate a call dependency graph for every global function
1543 # or class method. Note that enabling this option will significantly increase
1544 # the time of a run. So in most cases it will be better to enable call graphs
13231545 # for selected functions only using the \callgraph command.
13241546
13251547 CALL_GRAPH = NO
13261548
1327 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1328 # doxygen will generate a caller dependency graph for every global function
1329 # or class method. Note that enabling this option will significantly increase
1330 # the time of a run. So in most cases it will be better to enable caller
1549 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1550 # doxygen will generate a caller dependency graph for every global function
1551 # or class method. Note that enabling this option will significantly increase
1552 # the time of a run. So in most cases it will be better to enable caller
13311553 # graphs for selected functions only using the \callergraph command.
13321554
13331555 CALLER_GRAPH = NO
13341556
1335 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1557 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
13361558 # will graphical hierarchy of all classes instead of a textual one.
13371559
13381560 GRAPHICAL_HIERARCHY = YES
13391561
1340 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1341 # then doxygen will show the dependencies a directory has on other directories
1562 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1563 # then doxygen will show the dependencies a directory has on other directories
13421564 # in a graphical way. The dependency relations are determined by the #include
13431565 # relations between the files in the directories.
13441566
13451567 DIRECTORY_GRAPH = YES
13461568
1347 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1569 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
13481570 # generated by dot. Possible values are png, jpg, or gif
13491571 # If left blank png will be used.
13501572
13511573 DOT_IMAGE_FORMAT = png
13521574
1353 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1575 # The tag DOT_PATH can be used to specify the path where the dot tool can be
13541576 # found. If left blank, it is assumed the dot tool can be found in the path.
13551577
13561578 DOT_PATH = @DOT@
13571579
1358 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1359 # contain dot files that are included in the documentation (see the
1580 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1581 # contain dot files that are included in the documentation (see the
13601582 # \dotfile command).
13611583
1362 DOTFILE_DIRS =
1363
1364 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1365 # nodes that will be shown in the graph. If the number of nodes in a graph
1366 # becomes larger than this value, doxygen will truncate the graph, which is
1367 # visualized by representing a node as a red box. Note that doxygen if the
1368 # number of direct children of the root node in a graph is already larger than
1369 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1584 DOTFILE_DIRS =
1585
1586 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1587 # nodes that will be shown in the graph. If the number of nodes in a graph
1588 # becomes larger than this value, doxygen will truncate the graph, which is
1589 # visualized by representing a node as a red box. Note that doxygen if the
1590 # number of direct children of the root node in a graph is already larger than
1591 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
13701592 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
13711593
13721594 DOT_GRAPH_MAX_NODES = 50
13731595
1374 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1375 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1376 # from the root by following a path via at most 3 edges will be shown. Nodes
1377 # that lay further from the root node will be omitted. Note that setting this
1378 # option to 1 or 2 may greatly reduce the computation time needed for large
1379 # code bases. Also note that the size of a graph can be further restricted by
1596 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1597 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1598 # from the root by following a path via at most 3 edges will be shown. Nodes
1599 # that lay further from the root node will be omitted. Note that setting this
1600 # option to 1 or 2 may greatly reduce the computation time needed for large
1601 # code bases. Also note that the size of a graph can be further restricted by
13801602 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
13811603
13821604 MAX_DOT_GRAPH_DEPTH = 0
13831605
1384 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1385 # background. This is enabled by default, which results in a transparent
1386 # background. Warning: Depending on the platform used, enabling this option
1387 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1388 # become hard to read).
1606 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1607 # background. This is disabled by default, because dot on Windows does not
1608 # seem to support this out of the box. Warning: Depending on the platform used,
1609 # enabling this option may lead to badly anti-aliased labels on the edges of
1610 # a graph (i.e. they become hard to read).
13891611
13901612 DOT_TRANSPARENT = YES
13911613
1392 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1393 # files in one run (i.e. multiple -o and -T options on the command line). This
1394 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1614 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1615 # files in one run (i.e. multiple -o and -T options on the command line). This
1616 # makes dot run faster, but since only newer versions of dot (>1.8.10)
13951617 # support this, this feature is disabled by default.
13961618
13971619 DOT_MULTI_TARGETS = NO
13981620
1399 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1400 # generate a legend page explaining the meaning of the various boxes and
1621 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1622 # generate a legend page explaining the meaning of the various boxes and
14011623 # arrows in the dot generated graphs.
14021624
14031625 GENERATE_LEGEND = YES
14041626
1405 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1406 # remove the intermediate dot files that are used to generate
1627 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1628 # remove the intermediate dot files that are used to generate
14071629 # the various graphs.
14081630
14091631 DOT_CLEANUP = YES
1410
1411 #---------------------------------------------------------------------------
1412 # Configuration::additions related to the search engine
1413 #---------------------------------------------------------------------------
1414
1415 # The SEARCHENGINE tag specifies whether or not a search engine should be
1416 # used. If set to NO the values of all tags below this one will be ignored.
1417
1418 SEARCHENGINE = NO