##// END OF EJS Templates
added Doxyfile to the repository...
paul -
r44:8114be49d057 default
parent child
Show More
This diff has been collapsed as it changes many lines, (1902 lines changed) Show them Hide them
@@ -0,0 +1,1902
1 # Doxyfile 1.8.3.1
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 = DEV_PLE
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 = /opt/DEV_PLE/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 = YES
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 = YES
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 = YES
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 = YES
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 section-label ... \endif
558 # and \cond section-label ... \endcond blocks.
559
560 ENABLED_SECTIONS =
561
562 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
563 # the initial value of a variable or macro consists of for it to appear in
564 # the documentation. If the initializer consists of more lines than specified
565 # here it will be hidden. Use a value of 0 to hide initializers completely.
566 # The appearance of the initializer of individual variables and macros in the
567 # documentation can be controlled using \showinitializer or \hideinitializer
568 # command in the documentation regardless of this setting.
569
570 MAX_INITIALIZER_LINES = 30
571
572 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
573 # at the bottom of the documentation of classes and structs. If set to YES the
574 # list will mention the files that were used to generate the documentation.
575
576 SHOW_USED_FILES = YES
577
578 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
579 # This will remove the Files entry from the Quick Index and from the
580 # Folder Tree View (if specified). The default is YES.
581
582 SHOW_FILES = YES
583
584 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
585 # Namespaces page. This will remove the Namespaces entry from the Quick Index
586 # and from the Folder Tree View (if specified). The default is YES.
587
588 SHOW_NAMESPACES = YES
589
590 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
591 # doxygen should invoke to get the current version for each file (typically from
592 # the version control system). Doxygen will invoke the program by executing (via
593 # popen()) the command <command> <input-file>, where <command> is the value of
594 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
595 # provided by doxygen. Whatever the program writes to standard output
596 # is used as the file version. See the manual for examples.
597
598 FILE_VERSION_FILTER =
599
600 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
601 # by doxygen. The layout file controls the global structure of the generated
602 # output files in an output format independent way. To create the layout file
603 # that represents doxygen's defaults, run doxygen with the -l option.
604 # You can optionally specify a file name after the option, if omitted
605 # DoxygenLayout.xml will be used as the name of the layout file.
606
607 LAYOUT_FILE =
608
609 # The CITE_BIB_FILES tag can be used to specify one or more bib files
610 # containing the references data. This must be a list of .bib files. The
611 # .bib extension is automatically appended if omitted. Using this command
612 # requires the bibtex tool to be installed. See also
613 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
614 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
615 # feature you need bibtex and perl available in the search path. Do not use
616 # file names with spaces, bibtex cannot handle them.
617
618 CITE_BIB_FILES =
619
620 #---------------------------------------------------------------------------
621 # configuration options related to warning and progress messages
622 #---------------------------------------------------------------------------
623
624 # The QUIET tag can be used to turn on/off the messages that are generated
625 # by doxygen. Possible values are YES and NO. If left blank NO is used.
626
627 QUIET = NO
628
629 # The WARNINGS tag can be used to turn on/off the warning messages that are
630 # generated by doxygen. Possible values are YES and NO. If left blank
631 # NO is used.
632
633 WARNINGS = YES
634
635 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
636 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
637 # automatically be disabled.
638
639 WARN_IF_UNDOCUMENTED = YES
640
641 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
642 # potential errors in the documentation, such as not documenting some
643 # parameters in a documented function, or documenting parameters that
644 # don't exist or using markup commands wrongly.
645
646 WARN_IF_DOC_ERROR = YES
647
648 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
649 # functions that are documented, but have no documentation for their parameters
650 # or return value. If set to NO (the default) doxygen will only warn about
651 # wrong or incomplete parameter documentation, but not about the absence of
652 # documentation.
653
654 WARN_NO_PARAMDOC = NO
655
656 # The WARN_FORMAT tag determines the format of the warning messages that
657 # doxygen can produce. The string should contain the $file, $line, and $text
658 # tags, which will be replaced by the file and line number from which the
659 # warning originated and the warning text. Optionally the format may contain
660 # $version, which will be replaced by the version of the file (if it could
661 # be obtained via FILE_VERSION_FILTER)
662
663 WARN_FORMAT = "$file:$line: $text"
664
665 # The WARN_LOGFILE tag can be used to specify a file to which warning
666 # and error messages should be written. If left blank the output is written
667 # to stderr.
668
669 WARN_LOGFILE =
670
671 #---------------------------------------------------------------------------
672 # configuration options related to the input files
673 #---------------------------------------------------------------------------
674
675 # The INPUT tag can be used to specify the files and/or directories that contain
676 # documented source files. You may enter file names like "myfile.cpp" or
677 # directories like "/usr/src/myproject". Separate the files or directories
678 # with spaces.
679
680 INPUT = ../
681
682 # This tag can be used to specify the character encoding of the source files
683 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
684 # also the default input encoding. Doxygen uses libiconv (or the iconv built
685 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
686 # the list of possible encodings.
687
688 INPUT_ENCODING = UTF-8
689
690 # If the value of the INPUT tag contains directories, you can use the
691 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
692 # and *.h) to filter out the source-files in the directories. If left
693 # blank the following patterns are tested:
694 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
695 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
696 # *.f90 *.f *.for *.vhd *.vhdl
697
698 FILE_PATTERNS = *.c \
699 *.cc \
700 *.cxx \
701 *.cpp \
702 *.c++ \
703 *.d \
704 *.java \
705 *.ii \
706 *.ixx \
707 *.ipp \
708 *.i++ \
709 *.inl \
710 *.h \
711 *.hh \
712 *.hxx \
713 *.hpp \
714 *.h++ \
715 *.idl \
716 *.odl \
717 *.cs \
718 *.php \
719 *.php3 \
720 *.inc \
721 *.m \
722 *.markdown \
723 *.md \
724 *.mm \
725 *.dox \
726 *.py \
727 *.f90 \
728 *.f \
729 *.for \
730 *.vhd \
731 *.vhdl
732
733 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
734 # should be searched for input files as well. Possible values are YES and NO.
735 # If left blank NO is used.
736
737 RECURSIVE = YES
738
739 # The EXCLUDE tag can be used to specify files and/or directories that should be
740 # excluded from the INPUT source files. This way you can easily exclude a
741 # subdirectory from a directory tree whose root is specified with the INPUT tag.
742 # Note that relative paths are relative to the directory from which doxygen is
743 # run.
744
745 EXCLUDE =
746
747 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
748 # directories that are symbolic links (a Unix file system feature) are excluded
749 # from the input.
750
751 EXCLUDE_SYMLINKS = NO
752
753 # If the value of the INPUT tag contains directories, you can use the
754 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
755 # certain files from those directories. Note that the wildcards are matched
756 # against the file with absolute path, so to exclude all test directories
757 # for example use the pattern */test/*
758
759 EXCLUDE_PATTERNS =
760
761 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
762 # (namespaces, classes, functions, etc.) that should be excluded from the
763 # output. The symbol name can be a fully qualified name, a word, or if the
764 # wildcard * is used, a substring. Examples: ANamespace, AClass,
765 # AClass::ANamespace, ANamespace::*Test
766
767 EXCLUDE_SYMBOLS =
768
769 # The EXAMPLE_PATH tag can be used to specify one or more files or
770 # directories that contain example code fragments that are included (see
771 # the \include command).
772
773 EXAMPLE_PATH =
774
775 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
776 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
777 # and *.h) to filter out the source-files in the directories. If left
778 # blank all files are included.
779
780 EXAMPLE_PATTERNS = *
781
782 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
783 # searched for input files to be used with the \include or \dontinclude
784 # commands irrespective of the value of the RECURSIVE tag.
785 # Possible values are YES and NO. If left blank NO is used.
786
787 EXAMPLE_RECURSIVE = NO
788
789 # The IMAGE_PATH tag can be used to specify one or more files or
790 # directories that contain image that are included in the documentation (see
791 # the \image command).
792
793 IMAGE_PATH =
794
795 # The INPUT_FILTER tag can be used to specify a program that doxygen should
796 # invoke to filter for each input file. Doxygen will invoke the filter program
797 # by executing (via popen()) the command <filter> <input-file>, where <filter>
798 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
799 # input file. Doxygen will then use the output that the filter program writes
800 # to standard output. If FILTER_PATTERNS is specified, this tag will be
801 # ignored.
802
803 INPUT_FILTER =
804
805 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
806 # basis. Doxygen will compare the file name with each pattern and apply the
807 # filter if there is a match. The filters are a list of the form:
808 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
809 # info on how filters are used. If FILTER_PATTERNS is empty or if
810 # non of the patterns match the file name, INPUT_FILTER is applied.
811
812 FILTER_PATTERNS =
813
814 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
815 # INPUT_FILTER) will be used to filter the input files when producing source
816 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
817
818 FILTER_SOURCE_FILES = NO
819
820 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
821 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
822 # and it is also possible to disable source filtering for a specific pattern
823 # using *.ext= (so without naming a filter). This option only has effect when
824 # FILTER_SOURCE_FILES is enabled.
825
826 FILTER_SOURCE_PATTERNS =
827
828 # If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
829 # is part of the input, its contents will be placed on the main page (index.html).
830 # This can be useful if you have a project on for instance GitHub and want reuse
831 # the introduction page also for the doxygen output.
832
833 USE_MDFILE_AS_MAINPAGE =
834
835 #---------------------------------------------------------------------------
836 # configuration options related to source browsing
837 #---------------------------------------------------------------------------
838
839 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
840 # be generated. Documented entities will be cross-referenced with these sources.
841 # Note: To get rid of all source code in the generated output, make sure also
842 # VERBATIM_HEADERS is set to NO.
843
844 SOURCE_BROWSER = YES
845
846 # Setting the INLINE_SOURCES tag to YES will include the body
847 # of functions and classes directly in the documentation.
848
849 INLINE_SOURCES = NO
850
851 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
852 # doxygen to hide any special comment blocks from generated source code
853 # fragments. Normal C, C++ and Fortran comments will always remain visible.