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