libamxs  0.6.0
Data Model Synchronization C API
libamxs.doxy
Go to the documentation of this file.
1 # Doxyfile 1.5.7.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 a sequence of words surrounded
26 # by quotes) that should identify the project.
27 
28 PROJECT_NAME = "libamxs"
29 
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
32 # if some version control system is used.
33 
34 PROJECT_NUMBER = "$(VERSION)"
35 
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
40 
41 OUTPUT_DIRECTORY = output/doc/
42 
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
49 
50 CREATE_SUBDIRS = YES
51 
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 # documentation generated by doxygen is written. Doxygen will use this
54 # information to generate all constant output in the proper language.
55 # The default language is English, other supported languages are:
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60 # Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
61 # Spanish, Swedish, and Ukrainian.
62 
63 OUTPUT_LANGUAGE = English
64 
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66 # include brief member descriptions after the members that are listed in
67 # the file and class documentation (similar to JavaDoc).
68 # Set to NO to disable this.
69 
70 BRIEF_MEMBER_DESC = YES
71 
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73 # the brief description of a member or function before the detailed description.
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75 # brief descriptions will be completely suppressed.
76 
77 REPEAT_BRIEF = YES
78 
79 # This tag implements a quasi-intelligent brief description abbreviator
80 # that is used to form the text in various listings. Each string
81 # in this list, if found as the leading text of the brief description, will be
82 # stripped from the text and the result after processing the whole list, is
83 # used as the annotated text. Otherwise, the brief description is used as-is.
84 # If left blank, the following values are used ("$name" is automatically
85 # replaced with the name of the entity): "The $name class" "The $name widget"
86 # "The $name file" "is" "provides" "specifies" "contains"
87 # "represents" "a" "an" "the"
88 
89 ABBREVIATE_BRIEF = "The $name class" \
90  "The $name widget" \
91  "The $name file" \
92  is \
93  provides \
94  specifies \
95  contains \
96  represents \
97  a \
98  an \
99  the
100 
101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102 # Doxygen will generate a detailed section even if there is only a brief
103 # description.
104 
105 ALWAYS_DETAILED_SEC = NO
106 
107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108 # inherited members of a class in the documentation of that class as if those
109 # members were ordinary class members. Constructors, destructors and assignment
110 # operators of the base classes will not be shown.
111 
112 INLINE_INHERITED_MEMB = NO
113 
114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115 # path before files name in the file list and in the header files. If set
116 # to NO the shortest path that makes the file name unique will be used.
117 
118 FULL_PATH_NAMES = NO
119 
120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121 # can be used to strip a user-defined part of the path. Stripping is
122 # only done if one of the specified strings matches the left-hand part of
123 # the path. The tag can be used to show relative paths in the file list.
124 # If left blank the directory from which doxygen is run is used as the
125 # path to strip.
126 
127 STRIP_FROM_PATH =
128 
129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130 # the path mentioned in the documentation of a class, which tells
131 # the reader which header file to include in order to use a class.
132 # If left blank only the name of the header file containing the class
133 # definition is used. Otherwise one should specify the include paths that
134 # are normally passed to the compiler using the -I flag.
135 
136 STRIP_FROM_INC_PATH =
137 
138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139 # (but less readable) file names. This can be useful is your file systems
140 # doesn't support long names like on DOS, Mac, or CD-ROM.
141 
142 SHORT_NAMES = YES
143 
144 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
145 # will interpret the first line (until the first dot) of a JavaDoc-style
146 # comment as the brief description. If set to NO, the JavaDoc
147 # comments will behave just like regular Qt-style comments
148 # (thus requiring an explicit @brief command for a brief description.)
149 
150 JAVADOC_AUTOBRIEF = NO
151 
152 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
153 # interpret the first line (until the first dot) of a Qt-style
154 # comment as the brief description. If set to NO, the comments
155 # will behave just like regular Qt-style comments (thus requiring
156 # an explicit \brief command for a brief description.)
157 
158 QT_AUTOBRIEF = NO
159 
160 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
161 # treat a multi-line C++ special comment block (i.e. a block of
162 # comments) as a brief description. This used to be the default behaviour.
163 # The new default is to treat a multi-line C++ comment block as a detailed
164 # description. Set this tag to YES if you prefer the old behaviour instead.
165 
166 MULTILINE_CPP_IS_BRIEF = NO
167 
168 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
169 # member inherits the documentation from any documented member that it
170 # re-implements.
171 
172 INHERIT_DOCS = YES
173 
174 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175 # a new page for each member. If set to NO, the documentation of a member will
176 # be part of the file/class/namespace that contains it.
177 
178 SEPARATE_MEMBER_PAGES = NO
179 
180 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
181 # Doxygen uses this value to replace tabs by spaces in code fragments.
182 
183 TAB_SIZE = 8
184 
185 # This tag can be used to specify a number of aliases that acts
186 # as commands in the documentation. An alias has the form "name=value".
187 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
188 # put the command \sideeffect (or @sideeffect) in the documentation, which
189 # will result in a user-defined paragraph with heading "Side Effects:".
190 # You can put \n's in the value part of an alias to insert newlines.
191 
192 ALIASES =
193 
194 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
195 # sources only. Doxygen will then generate output that is more tailored for C.
196 # For instance, some of the names that are used will be different. The list
197 # of all members will be omitted, etc.
198 
199 OPTIMIZE_OUTPUT_FOR_C = YES
200 
201 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
202 # sources only. Doxygen will then generate output that is more tailored for
203 # Java. For instance, namespaces will be presented as packages, qualified
204 # scopes will look different, etc.
205 
206 OPTIMIZE_OUTPUT_JAVA = NO
207 
208 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
209 # sources only. Doxygen will then generate output that is more tailored for
210 # Fortran.
211 
212 OPTIMIZE_FOR_FORTRAN = NO
213 
214 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
215 # sources. Doxygen will then generate output that is tailored for
216 # VHDL.
217 
218 OPTIMIZE_OUTPUT_VHDL = NO
219 
220 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
221 # to include (a tag file for) the STL sources as input, then you should
222 # set this tag to YES in order to let doxygen match functions declarations and
223 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
224 # func(std::string) {}). This also make the inheritance and collaboration
225 # diagrams that involve STL classes more complete and accurate.
226 
227 BUILTIN_STL_SUPPORT = NO
228 
229 # If you use Microsoft's C++/CLI language, you should set this option to YES to
230 # enable parsing support.
231 
232 CPP_CLI_SUPPORT = NO
233 
234 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
235 # Doxygen will parse them like normal C++ but will assume all classes use public
236 # instead of private inheritance when no explicit protection keyword is present.
237 
238 SIP_SUPPORT = NO
239 
240 # For Microsoft's IDL there are propget and propput attributes to indicate getter
241 # and setter methods for a property. Setting this option to YES (the default)
242 # will make doxygen to replace the get and set methods by a property in the
243 # documentation. This will only work if the methods are indeed getting or
244 # setting a simple type. If this is not the case, or you want to show the
245 # methods anyway, you should set this option to NO.
246 
247 IDL_PROPERTY_SUPPORT = NO
248 
249 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
250 # tag is set to YES, then doxygen will reuse the documentation of the first
251 # member in the group (if any) for the other members of the group. By default
252 # all members of a group must be documented explicitly.
253 
254 DISTRIBUTE_GROUP_DOC = YES
255 
256 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
257 # the same type (for instance a group of public functions) to be put as a
258 # subgroup of that type (e.g. under the Public Functions section). Set it to
259 # NO to prevent subgrouping. Alternatively, this can be done per class using
260 # the \nosubgrouping command.
261 
262 SUBGROUPING = YES
263 
264 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
265 # is documented as struct, union, or enum with the name of the typedef. So
266 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
267 # with name TypeT. When disabled the typedef will appear as a member of a file,
268 # namespace, or class. And the struct will be named TypeS. This can typically
269 # be useful for C code in case the coding convention dictates that all compound
270 # types are typedef'ed and only the typedef is referenced, never the tag name.
271 
272 TYPEDEF_HIDES_STRUCT = YES
273 
274 #---------------------------------------------------------------------------
275 # Build related configuration options
276 #---------------------------------------------------------------------------
277 
278 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
279 # documentation are documented, even if no documentation was available.
280 # Private class members and static file members will be hidden unless
281 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
282 
283 EXTRACT_ALL = NO
284 
285 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
286 # will be included in the documentation.
287 
288 EXTRACT_PRIVATE = NO
289 
290 # If the EXTRACT_STATIC tag is set to YES all static members of a file
291 # will be included in the documentation.
292 
293 EXTRACT_STATIC = NO
294 
295 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
296 # defined locally in source files will be included in the documentation.
297 # If set to NO only classes defined in header files are included.
298 
299 EXTRACT_LOCAL_CLASSES = NO
300 
301 # This flag is only useful for Objective-C code. When set to YES local
302 # methods, which are defined in the implementation section but not in
303 # the interface are included in the documentation.
304 # If set to NO (the default) only methods in the interface are included.
305 
306 EXTRACT_LOCAL_METHODS = NO
307 
308 # If this flag is set to YES, the members of anonymous namespaces will be
309 # extracted and appear in the documentation as a namespace called
310 # 'anonymous_namespace{file}', where file will be replaced with the base
311 # name of the file that contains the anonymous namespace. By default
312 # anonymous namespace are hidden.
313 
314 EXTRACT_ANON_NSPACES = NO
315 
316 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
317 # undocumented members of documented classes, files or namespaces.
318 # If set to NO (the default) these members will be included in the
319 # various overviews, but no documentation section is generated.
320 # This option has no effect if EXTRACT_ALL is enabled.
321 
322 HIDE_UNDOC_MEMBERS = YES
323 
324 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
325 # undocumented classes that are normally visible in the class hierarchy.
326 # If set to NO (the default) these classes will be included in the various
327 # overviews. This option has no effect if EXTRACT_ALL is enabled.
328 
329 HIDE_UNDOC_CLASSES = YES
330 
331 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
332 # friend (class|struct|union) declarations.
333 # If set to NO (the default) these declarations will be included in the
334 # documentation.
335 
336 HIDE_FRIEND_COMPOUNDS = YES
337 
338 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
339 # documentation blocks found inside the body of a function.
340 # If set to NO (the default) these blocks will be appended to the
341 # function's detailed documentation block.
342 
343 HIDE_IN_BODY_DOCS = YES
344 
345 # The INTERNAL_DOCS tag determines if documentation
346 # that is typed after a \internal command is included. If the tag is set
347 # to NO (the default) then the documentation will be excluded.
348 # Set it to YES to include the internal documentation.
349 
350 INTERNAL_DOCS = NO
351 
352 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
353 # file names in lower-case letters. If set to YES upper-case letters are also
354 # allowed. This is useful if you have classes or files whose names only differ
355 # in case and if your file system supports case sensitive file names. Windows
356 # and Mac users are advised to set this option to NO.
357 
358 CASE_SENSE_NAMES = NO
359 
360 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
361 # will show members with their full class and namespace scopes in the
362 # documentation. If set to YES the scope will be hidden.
363 
364 HIDE_SCOPE_NAMES = NO
365 
366 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
367 # will put a list of the files that are included by a file in the documentation
368 # of that file.
369 
370 SHOW_INCLUDE_FILES = NO
371 
372 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
373 # is inserted in the documentation for inline members.
374 
375 INLINE_INFO = YES
376 
377 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
378 # will sort the (detailed) documentation of file and class members
379 # alphabetically by member name. If set to NO the members will appear in
380 # declaration order.
381 
382 SORT_MEMBER_DOCS = YES
383 
384 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
385 # brief documentation of file, namespace and class members alphabetically
386 # by member name. If set to NO (the default) the members will appear in
387 # declaration order.
388 
389 SORT_BRIEF_DOCS = YES
390 
391 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
392 # hierarchy of group names into alphabetical order. If set to NO (the default)
393 # the group names will appear in their defined order.
394 
395 SORT_GROUP_NAMES = YES
396 
397 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
398 # sorted by fully-qualified names, including namespaces. If set to
399 # NO (the default), the class list will be sorted only by class name,
400 # not including the namespace part.
401 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
402 # Note: This option applies only to the class list, not to the
403 # alphabetical list.
404 
405 SORT_BY_SCOPE_NAME = NO
406 
407 # The GENERATE_TODOLIST tag can be used to enable (YES) or
408 # disable (NO) the todo list. This list is created by putting \todo
409 # commands in the documentation.
410 
411 GENERATE_TODOLIST = YES
412 
413 # The GENERATE_TESTLIST tag can be used to enable (YES) or
414 # disable (NO) the test list. This list is created by putting \test
415 # commands in the documentation.
416 
417 GENERATE_TESTLIST = YES
418 
419 # The GENERATE_BUGLIST tag can be used to enable (YES) or
420 # disable (NO) the bug list. This list is created by putting \bug
421 # commands in the documentation.
422 
423 GENERATE_BUGLIST = YES
424 
425 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
426 # disable (NO) the deprecated list. This list is created by putting
427 # \deprecated commands in the documentation.
428 
429 GENERATE_DEPRECATEDLIST= YES
430 
431 # The ENABLED_SECTIONS tag can be used to enable conditional
432 # documentation sections, marked by \if sectionname ... \endif.
433 
434 ENABLED_SECTIONS = ONLY_HTML
435 
436 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
437 # the initial value of a variable or define consists of for it to appear in
438 # the documentation. If the initializer consists of more lines than specified
439 # here it will be hidden. Use a value of 0 to hide initializers completely.
440 # The appearance of the initializer of individual variables and defines in the
441 # documentation can be controlled using \showinitializer or \hideinitializer
442 # command in the documentation regardless of this setting.
443 
444 MAX_INITIALIZER_LINES = 30
445 
446 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
447 # at the bottom of the documentation of classes and structs. If set to YES the
448 # list will mention the files that were used to generate the documentation.
449 
450 SHOW_USED_FILES = NO
451 
452 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
453 # This will remove the Files entry from the Quick Index and from the
454 # Folder Tree View (if specified). The default is YES.
455 
456 SHOW_FILES = NO
457 
458 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
459 # Namespaces page. This will remove the Namespaces entry from the Quick Index
460 # and from the Folder Tree View (if specified). The default is YES.
461 
462 SHOW_NAMESPACES = YES
463 
464 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
465 # doxygen should invoke to get the current version for each file (typically from
466 # the version control system). Doxygen will invoke the program by executing (via
467 # popen()) the command <command> <input-file>, where <command> is the value of
468 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
469 # provided by doxygen. Whatever the program writes to standard output
470 # is used as the file version. See the manual for examples.
471 
472 FILE_VERSION_FILTER =
473 
474 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
475 # doxygen. The layout file controls the global structure of the generated output files
476 # in an output format independent way. The create the layout file that represents
477 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
478 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
479 # of the layout file.
480 
481 LAYOUT_FILE =
482 
483 #---------------------------------------------------------------------------
484 # configuration options related to warning and progress messages
485 #---------------------------------------------------------------------------
486 
487 # The QUIET tag can be used to turn on/off the messages that are generated
488 # by doxygen. Possible values are YES and NO. If left blank NO is used.
489 
490 QUIET = NO
491 
492 # The WARNINGS tag can be used to turn on/off the warning messages that are
493 # generated by doxygen. Possible values are YES and NO. If left blank
494 # NO is used.
495 
496 WARNINGS = YES
497 
498 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
499 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
500 # automatically be disabled.
501 
502 WARN_IF_UNDOCUMENTED = YES
503 
504 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
505 # potential errors in the documentation, such as not documenting some
506 # parameters in a documented function, or documenting parameters that
507 # don't exist or using markup commands wrongly.
508 
509 WARN_IF_DOC_ERROR = YES
510 
511 # This WARN_NO_PARAMDOC option can be abled to get warnings for
512 # functions that are documented, but have no documentation for their parameters
513 # or return value. If set to NO (the default) doxygen will only warn about
514 # wrong or incomplete parameter documentation, but not about the absence of
515 # documentation.
516 
517 WARN_NO_PARAMDOC = YES
518 
519 # The WARN_FORMAT tag determines the format of the warning messages that
520 # doxygen can produce. The string should contain the $file, $line, and $text
521 # tags, which will be replaced by the file and line number from which the
522 # warning originated and the warning text. Optionally the format may contain
523 # $version, which will be replaced by the version of the file (if it could
524 # be obtained via FILE_VERSION_FILTER)
525 
526 WARN_FORMAT = "$file:$line: $text"
527 
528 # The WARN_LOGFILE tag can be used to specify a file to which warning
529 # and error messages should be written. If left blank the output is written
530 # to stderr.
531 
532 WARN_LOGFILE =
533 
534 #---------------------------------------------------------------------------
535 # configuration options related to the input files
536 #---------------------------------------------------------------------------
537 
538 # The INPUT tag can be used to specify the files and/or directories that contain
539 # documented source files. You may enter file names like "myfile.cpp" or
540 # directories like "/usr/src/myproject". Separate the files or directories
541 # with spaces.
542 
543 INPUT = include/ src/
544 
545 # This tag can be used to specify the character encoding of the source files
546 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
547 # also the default input encoding. Doxygen uses libiconv (or the iconv built
548 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
549 # the list of possible encodings.
550 
551 INPUT_ENCODING = UTF-8
552 
553 # If the value of the INPUT tag contains directories, you can use the
554 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
555 # and *.h) to filter out the source-files in the directories. If left
556 # blank the following patterns are tested:
557 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
558 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
559 
560 FILE_PATTERNS =
561 
562 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
563 # should be searched for input files as well. Possible values are YES and NO.
564 # If left blank NO is used.
565 
566 RECURSIVE = YES
567 
568 # The EXCLUDE tag can be used to specify files and/or directories that should
569 # excluded from the INPUT source files. This way you can easily exclude a
570 # subdirectory from a directory tree whose root is specified with the INPUT tag.
571 
572 EXCLUDE =
573 
574 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
575 # directories that are symbolic links (a Unix filesystem feature) are excluded
576 # from the input.
577 
578 EXCLUDE_SYMLINKS = YES
579 
580 # If the value of the INPUT tag contains directories, you can use the
581 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
582 # certain files from those directories. Note that the wildcards are matched
583 # against the file with absolute path, so to exclude all test directories
584 # for example use the pattern */test/*
585 
586 EXCLUDE_PATTERNS =
587 
588 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
589 # (namespaces, classes, functions, etc.) that should be excluded from the
590 # output. The symbol name can be a fully qualified name, a word, or if the
591 # wildcard * is used, a substring. Examples: ANamespace, AClass,
592 # AClass::ANamespace, ANamespace::*Test
593 
594 EXCLUDE_SYMBOLS = amxc_var_add_type \
595  amxc_var_remove_type \
596  amxc_variant_get_types_array \
597  amxc_var_default_copy \
598  amxc_var_default_convert_to_null \
599  amxc_var_default_convert_to_list \
600  amxc_var_default_convert_to_htable
601 
602 # The EXAMPLE_PATH tag can be used to specify one or more files or
603 # directories that contain example code fragments that are included (see
604 # the \include command).
605 
606 EXAMPLE_PATH =
607 
608 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
609 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
610 # and *.h) to filter out the source-files in the directories. If left
611 # blank all files are included.
612 
613 EXAMPLE_PATTERNS = *
614 
615 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
616 # searched for input files to be used with the \include or \dontinclude
617 # commands irrespective of the value of the RECURSIVE tag.
618 # Possible values are YES and NO. If left blank NO is used.
619 
620 EXAMPLE_RECURSIVE = YES
621 
622 # The IMAGE_PATH tag can be used to specify one or more files or
623 # directories that contain image that are included in the documentation (see
624 # the \image command).
625 
626 IMAGE_PATH = ./images
627 
628 # The INPUT_FILTER tag can be used to specify a program that doxygen should
629 # invoke to filter for each input file. Doxygen will invoke the filter program
630 # by executing (via popen()) the command <filter> <input-file>, where <filter>
631 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
632 # input file. Doxygen will then use the output that the filter program writes
633 # to standard output. If FILTER_PATTERNS is specified, this tag will be
634 # ignored.
635 
636 INPUT_FILTER =
637 
638 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
639 # basis. Doxygen will compare the file name with each pattern and apply the
640 # filter if there is a match. The filters are a list of the form:
641 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
642 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
643 # is applied to all files.
644 
645 FILTER_PATTERNS =
646 
647 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
648 # INPUT_FILTER) will be used to filter the input files when producing source
649 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
650 
651 FILTER_SOURCE_FILES = NO
652 
653 #---------------------------------------------------------------------------
654 # configuration options related to source browsing
655 #---------------------------------------------------------------------------
656 
657 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
658 # be generated. Documented entities will be cross-referenced with these sources.
659 # Note: To get rid of all source code in the generated output, make sure also
660 # VERBATIM_HEADERS is set to NO.
661 
662 SOURCE_BROWSER = YES
663 
664 # Setting the INLINE_SOURCES tag to YES will include the body
665 # of functions and classes directly in the documentation.
666 
667 INLINE_SOURCES = NO
668 
669 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
670 # doxygen to hide any special comment blocks from generated source code
671 # fragments. Normal C and C++ comments will always remain visible.
672 
673 STRIP_CODE_COMMENTS = YES
674 
675 # If the REFERENCED_BY_RELATION tag is set to YES
676 # then for each documented function all documented
677 # functions referencing it will be listed.
678 
679 REFERENCED_BY_RELATION = NO
680 
681 # If the REFERENCES_RELATION tag is set to YES
682 # then for each documented function all documented entities
683 # called/used by that function will be listed.
684 
685 REFERENCES_RELATION = NO
686 
687 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
688 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
689 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
690 # link to the source code. Otherwise they will link to the documentstion.
691 
692 REFERENCES_LINK_SOURCE = YES
693 
694 # If the USE_HTAGS tag is set to YES then the references to source code
695 # will point to the HTML generated by the htags(1) tool instead of doxygen
696 # built-in source browser. The htags tool is part of GNU's global source
697 # tagging system (see http://www.gnu.org/software/global/global.html). You
698 # will need version 4.8.6 or higher.
699 
700 USE_HTAGS = NO
701 
702 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
703 # will generate a verbatim copy of the header file for each class for
704 # which an include is specified. Set to NO to disable this.
705 
706 VERBATIM_HEADERS = YES
707 
708 #---------------------------------------------------------------------------
709 # configuration options related to the alphabetical class index
710 #---------------------------------------------------------------------------
711 
712 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
713 # of all compounds will be generated. Enable this if the project
714 # contains a lot of classes, structs, unions or interfaces.
715 
716 ALPHABETICAL_INDEX = YES
717 
718 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
719 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
720 # in which this list will be split (can be a number in the range [1..20])
721 
722 COLS_IN_ALPHA_INDEX = 5
723 
724 # In case all classes in a project start with a common prefix, all
725 # classes will be put under the same header in the alphabetical index.
726 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
727 # should be ignored while generating the index headers.
728 
729 IGNORE_PREFIX =
730 
731 #---------------------------------------------------------------------------
732 # configuration options related to the HTML output
733 #---------------------------------------------------------------------------
734 
735 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
736 # generate HTML output.
737 
738 GENERATE_HTML = YES
739 
740 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
741 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
742 # put in front of it. If left blank `html' will be used as the default path.
743 
744 HTML_OUTPUT = doxy-html
745 
746 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
747 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
748 # doxygen will generate files with .html extension.
749 
750 HTML_FILE_EXTENSION = .html
751 
752 # The HTML_HEADER tag can be used to specify a personal HTML header for
753 # each generated HTML page. If it is left blank doxygen will generate a
754 # standard header.
755 
756 HTML_HEADER =
757 
758 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
759 # each generated HTML page. If it is left blank doxygen will generate a
760 # standard footer.
761 
762 HTML_FOOTER =
763 
764 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
765 # style sheet that is used by each HTML page. It can be used to
766 # fine-tune the look of the HTML output. If the tag is left blank doxygen
767 # will generate a default style sheet. Note that doxygen will try to copy
768 # the style sheet file to the HTML output directory, so don't put your own
769 # stylesheet in the HTML output directory as well, or it will be erased!
770 
771 HTML_STYLESHEET =
772 
773 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
774 # documentation will contain sections that can be hidden and shown after the
775 # page has loaded. For this to work a browser that supports
776 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
777 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
778 
779 HTML_DYNAMIC_SECTIONS = YES
780 
781 # If the GENERATE_DOCSET tag is set to YES, additional index files
782 # will be generated that can be used as input for Apple's Xcode 3
783 # integrated development environment, introduced with OSX 10.5 (Leopard).
784 # To create a documentation set, doxygen will generate a Makefile in the
785 # HTML output directory. Running make will produce the docset in that
786 # directory and running "make install" will install the docset in
787 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
788 # it at startup.
789 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
790 
791 GENERATE_DOCSET = NO
792 
793 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
794 # feed. A documentation feed provides an umbrella under which multiple
795 # documentation sets from a single provider (such as a company or product suite)
796 # can be grouped.
797 
798 DOCSET_FEEDNAME = "Doxygen generated docs"
799 
800 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
801 # should uniquely identify the documentation set bundle. This should be a
802 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
803 # will append .docset to the name.
804 
805 DOCSET_BUNDLE_ID = org.doxygen.Project
806 
807 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
808 # will be generated that can be used as input for tools like the
809 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
810 # of the generated HTML documentation.
811 
812 GENERATE_HTMLHELP = NO
813 
814 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
815 # be used to specify the file name of the resulting .chm file. You
816 # can add a path in front of the file if the result should not be
817 # written to the html output directory.
818 
819 CHM_FILE =
820 
821 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
822 # be used to specify the location (absolute path including file name) of
823 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
824 # the HTML help compiler on the generated index.hhp.
825 
826 HHC_LOCATION =
827 
828 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
829 # controls if a separate .chi index file is generated (YES) or that
830 # it should be included in the master .chm file (NO).
831 
832 GENERATE_CHI = NO
833 
834 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
835 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
836 # content.
837 
838 CHM_INDEX_ENCODING =
839 
840 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
841 # controls whether a binary table of contents is generated (YES) or a
842 # normal table of contents (NO) in the .chm file.
843 
844 BINARY_TOC = NO
845 
846 # The TOC_EXPAND flag can be set to YES to add extra items for group members
847 # to the contents of the HTML help documentation and to the tree view.
848 
849 TOC_EXPAND = NO
850 
851 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
852 # are set, an additional index file will be generated that can be used as input for
853 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
854 # HTML documentation.
855 
856 GENERATE_QHP = NO
857 
858 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
859 # be used to specify the file name of the resulting .qch file.
860 # The path specified is relative to the HTML output folder.
861 
862 QCH_FILE =
863 
864 # The QHP_NAMESPACE tag specifies the namespace to use when generating
865 # Qt Help Project output. For more information please see
866 # <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.
867 
868 QHP_NAMESPACE =
869 
870 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
871 # Qt Help Project output. For more information please see
872 # <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.
873 
874 QHP_VIRTUAL_FOLDER =
875 
876 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
877 # be used to specify the location of Qt's qhelpgenerator.
878 # If non-empty doxygen will try to run qhelpgenerator on the generated
879 # .qhp file .
880 
881 QHG_LOCATION =
882 
883 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
884 # top of each HTML page. The value NO (the default) enables the index and
885 # the value YES disables it.
886 
887 DISABLE_INDEX = NO
888 
889 # This tag can be used to set the number of enum values (range [1..20])
890 # that doxygen will group on one line in the generated HTML documentation.
891 
892 ENUM_VALUES_PER_LINE = 1
893 
894 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
895 # structure should be generated to display hierarchical information.
896 # If the tag value is set to FRAME, a side panel will be generated
897 # containing a tree-like index structure (just like the one that
898 # is generated for HTML Help). For this to work a browser that supports
899 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
900 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
901 # probably better off using the HTML help feature. Other possible values
902 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
903 # and Class Hierarchy pages using a tree view instead of an ordered list;
904 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
905 # disables this behavior completely. For backwards compatibility with previous
906 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
907 # respectively.
908 
909 GENERATE_TREEVIEW = YES
910 
911 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
912 # used to set the initial width (in pixels) of the frame in which the tree
913 # is shown.
914 
915 TREEVIEW_WIDTH = 250
916 
917 # Use this tag to change the font size of Latex formulas included
918 # as images in the HTML documentation. The default is 10. Note that
919 # when you change the font size after a successful doxygen run you need
920 # to manually remove any form_*.png images from the HTML output directory
921 # to force them to be regenerated.
922 
923 FORMULA_FONTSIZE = 10
924 
925 #---------------------------------------------------------------------------
926 # configuration options related to the LaTeX output
927 #---------------------------------------------------------------------------
928 
929 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
930 # generate Latex output.
931 
932 GENERATE_LATEX = NO
933 
934 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
935 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
936 # put in front of it. If left blank `latex' will be used as the default path.
937 
938 LATEX_OUTPUT = latex
939 
940 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
941 # invoked. If left blank `latex' will be used as the default command name.
942 
943 LATEX_CMD_NAME = latex
944 
945 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
946 # generate index for LaTeX. If left blank `makeindex' will be used as the
947 # default command name.
948 
949 MAKEINDEX_CMD_NAME = makeindex
950 
951 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
952 # LaTeX documents. This may be useful for small projects and may help to
953 # save some trees in general.
954 
955 COMPACT_LATEX = NO
956 
957 # The PAPER_TYPE tag can be used to set the paper type that is used
958 # by the printer. Possible values are: a4, a4wide, letter, legal and
959 # executive. If left blank a4wide will be used.
960 
961 PAPER_TYPE = a4wide
962 
963 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
964 # packages that should be included in the LaTeX output.
965 
966 EXTRA_PACKAGES =
967 
968 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
969 # the generated latex document. The header should contain everything until
970 # the first chapter. If it is left blank doxygen will generate a
971 # standard header. Notice: only use this tag if you know what you are doing!
972 
973 LATEX_HEADER =
974 
975 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
976 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
977 # contain links (just like the HTML output) instead of page references
978 # This makes the output suitable for online browsing using a pdf viewer.
979 
980 PDF_HYPERLINKS = YES
981 
982 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
983 # plain latex in the generated Makefile. Set this option to YES to get a
984 # higher quality PDF documentation.
985 
986 USE_PDFLATEX = YES
987 
988 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
989 # command to the generated LaTeX files. This will instruct LaTeX to keep
990 # running if errors occur, instead of asking the user for help.
991 # This option is also used when generating formulas in HTML.
992 
993 LATEX_BATCHMODE = NO
994 
995 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
996 # include the index chapters (such as File Index, Compound Index, etc.)
997 # in the output.
998 
999 LATEX_HIDE_INDICES = NO
1000 
1001 #---------------------------------------------------------------------------
1002 # configuration options related to the RTF output
1003 #---------------------------------------------------------------------------
1004 
1005 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1006 # The RTF output is optimized for Word 97 and may not look very pretty with
1007 # other RTF readers or editors.
1008 
1009 GENERATE_RTF = NO
1010 
1011 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1012 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1013 # put in front of it. If left blank `rtf' will be used as the default path.
1014 
1015 RTF_OUTPUT = rtf
1016 
1017 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1018 # RTF documents. This may be useful for small projects and may help to
1019 # save some trees in general.
1020 
1021 COMPACT_RTF = NO
1022 
1023 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1024 # will contain hyperlink fields. The RTF file will
1025 # contain links (just like the HTML output) instead of page references.
1026 # This makes the output suitable for online browsing using WORD or other
1027 # programs which support those fields.
1028 # Note: wordpad (write) and others do not support links.
1029 
1030 RTF_HYPERLINKS = NO
1031 
1032 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1033 # config file, i.e. a series of assignments. You only have to provide
1034 # replacements, missing definitions are set to their default value.
1035 
1036 RTF_STYLESHEET_FILE =
1037 
1038 # Set optional variables used in the generation of an rtf document.
1039 # Syntax is similar to doxygen's config file.
1040 
1041 RTF_EXTENSIONS_FILE =
1042 
1043 #---------------------------------------------------------------------------
1044 # configuration options related to the man page output
1045 #---------------------------------------------------------------------------
1046 
1047 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1048 # generate man pages
1049 
1050 GENERATE_MAN = NO
1051 
1052 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1053 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1054 # put in front of it. If left blank `man' will be used as the default path.
1055 
1056 MAN_OUTPUT = man
1057 
1058 # The MAN_EXTENSION tag determines the extension that is added to
1059 # the generated man pages (default is the subroutine's section .3)
1060 
1061 MAN_EXTENSION = .3
1062 
1063 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1064 # then it will generate one additional man file for each entity
1065 # documented in the real man page(s). These additional files
1066 # only source the real man page, but without them the man command
1067 # would be unable to find the correct page. The default is NO.
1068 
1069 MAN_LINKS = NO
1070 
1071 #---------------------------------------------------------------------------
1072 # configuration options related to the XML output
1073 #---------------------------------------------------------------------------
1074 
1075 # If the GENERATE_XML tag is set to YES Doxygen will
1076 # generate an XML file that captures the structure of
1077 # the code including all documentation.
1078 
1079 GENERATE_XML = YES
1080 
1081 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1082 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1083 # put in front of it. If left blank `xml' will be used as the default path.
1084 
1085 XML_OUTPUT = doxy-xml
1086 
1087 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1088 # dump the program listings (including syntax highlighting
1089 # and cross-referencing information) to the XML output. Note that
1090 # enabling this will significantly increase the size of the XML output.
1091 
1092 XML_PROGRAMLISTING = NO
1093 
1094 #---------------------------------------------------------------------------
1095 # configuration options for the AutoGen Definitions output
1096 #---------------------------------------------------------------------------
1097 
1098 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1099 # generate an AutoGen Definitions (see autogen.sf.net) file
1100 # that captures the structure of the code including all
1101 # documentation. Note that this feature is still experimental
1102 # and incomplete at the moment.
1103 
1104 GENERATE_AUTOGEN_DEF = NO
1105 
1106 #---------------------------------------------------------------------------
1107 # configuration options related to the Perl module output
1108 #---------------------------------------------------------------------------
1109 
1110 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1111 # generate a Perl module file that captures the structure of
1112 # the code including all documentation. Note that this
1113 # feature is still experimental and incomplete at the
1114 # moment.
1115 
1116 GENERATE_PERLMOD = NO
1117 
1118 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1119 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1120 # to generate PDF and DVI output from the Perl module output.
1121 
1122 PERLMOD_LATEX = NO
1123 
1124 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1125 # nicely formatted so it can be parsed by a human reader. This is useful
1126 # if you want to understand what is going on. On the other hand, if this
1127 # tag is set to NO the size of the Perl module output will be much smaller
1128 # and Perl will parse it just the same.
1129 
1130 PERLMOD_PRETTY = YES
1131 
1132 # The names of the make variables in the generated doxyrules.make file
1133 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1134 # This is useful so different doxyrules.make files included by the same
1135 # Makefile don't overwrite each other's variables.
1136 
1137 PERLMOD_MAKEVAR_PREFIX =
1138 
1139 #---------------------------------------------------------------------------
1140 # Configuration options related to the preprocessor
1141 #---------------------------------------------------------------------------
1142 
1143 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1144 # evaluate all C-preprocessor directives found in the sources and include
1145 # files.
1146 
1147 ENABLE_PREPROCESSING = YES
1148 
1149 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1150 # names in the source code. If set to NO (the default) only conditional
1151 # compilation will be performed. Macro expansion can be done in a controlled
1152 # way by setting EXPAND_ONLY_PREDEF to YES.
1153 
1154 MACRO_EXPANSION = YES
1155 
1156 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1157 # then the macro expansion is limited to the macros specified with the
1158 # PREDEFINED and EXPAND_AS_DEFINED tags.
1159 
1160 EXPAND_ONLY_PREDEF = NO
1161 
1162 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1163 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1164 
1165 SEARCH_INCLUDES = YES
1166 
1167 # The INCLUDE_PATH tag can be used to specify one or more directories that
1168 # contain include files that are not input files but should be processed by
1169 # the preprocessor.
1170 
1171 INCLUDE_PATH =
1172 
1173 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1174 # patterns (like *.h and *.hpp) to filter out the header-files in the
1175 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1176 # be used.
1177 
1178 INCLUDE_FILE_PATTERNS =
1179 
1180 # The PREDEFINED tag can be used to specify one or more macro names that
1181 # are defined before the preprocessor is started (similar to the -D option of
1182 # gcc). The argument of the tag is a list of macros of the form: name
1183 # or name=definition (no spaces). If the definition and the = are
1184 # omitted =1 is assumed. To prevent a macro definition from being
1185 # undefined via #undef or recursively expanded use the := operator
1186 # instead of the = operator.
1187 
1188 PREDEFINED = USE_DOXYGEN
1189 
1190 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1191 # this tag can be used to specify a list of macro names that should be expanded.
1192 # The macro definition that is found in the sources will be used.
1193 # Use the PREDEFINED tag if you want to use a different macro definition.
1194 
1195 EXPAND_AS_DEFINED =
1196 
1197 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1198 # doxygen's preprocessor will remove all function-like macros that are alone
1199 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1200 # function macros are typically used for boiler-plate code, and will confuse
1201 # the parser if not removed.
1202 
1203 SKIP_FUNCTION_MACROS = YES
1204 
1205 #---------------------------------------------------------------------------
1206 # Configuration::additions related to external references
1207 #---------------------------------------------------------------------------
1208 
1209 # The TAGFILES option can be used to specify one or more tagfiles.
1210 # Optionally an initial location of the external documentation
1211 # can be added for each tagfile. The format of a tag file without
1212 # this location is as follows:
1213 # TAGFILES = file1 file2 ...
1214 # Adding location for the tag files is done as follows:
1215 # TAGFILES = file1=loc1 "file2 = loc2" ...
1216 # where "loc1" and "loc2" can be relative or absolute paths or
1217 # URLs. If a location is present for each tag, the installdox tool
1218 # does not have to be run to correct the links.
1219 # Note that each tag file must have a unique name
1220 # (where the name does NOT include the path)
1221 # If a tag file is not located in the directory in which doxygen
1222 # is run, you must also specify the path to the tagfile here.
1223 
1224 TAGFILES =
1225 
1226 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1227 # a tag file that is based on the input files it reads.
1228 
1229 GENERATE_TAGFILE =
1230 
1231 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1232 # in the class index. If set to NO only the inherited external classes
1233 # will be listed.
1234 
1235 ALLEXTERNALS = NO
1236 
1237 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1238 # in the modules index. If set to NO, only the current project's groups will
1239 # be listed.
1240 
1241 EXTERNAL_GROUPS = YES
1242 
1243 # The PERL_PATH should be the absolute path and name of the perl script
1244 # interpreter (i.e. the result of `which perl').
1245 
1246 PERL_PATH = /usr/bin/perl
1247 
1248 #---------------------------------------------------------------------------
1249 # Configuration options related to the dot tool
1250 #---------------------------------------------------------------------------
1251 
1252 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1253 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1254 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1255 # this option is superseded by the HAVE_DOT option below. This is only a
1256 # fallback. It is recommended to install and use dot, since it yields more
1257 # powerful graphs.
1258 
1259 CLASS_DIAGRAMS = NO
1260 
1261 # You can define message sequence charts within doxygen comments using the \msc
1262 # command. Doxygen will then run the mscgen tool (see
1263 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1264 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1265 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1266 # default search path.
1267 
1268 MSCGEN_PATH =
1269 
1270 # If set to YES, the inheritance and collaboration graphs will hide
1271 # inheritance and usage relations if the target is undocumented
1272 # or is not a class.
1273 
1274 HIDE_UNDOC_RELATIONS = YES
1275 
1276 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1277 # available from the path. This tool is part of Graphviz, a graph visualization
1278 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1279 # have no effect if this option is set to NO (the default)
1280 
1281 HAVE_DOT = YES
1282 
1283 # By default doxygen will write a font called FreeSans.ttf to the output
1284 # directory and reference it in all dot files that doxygen generates. This
1285 # font does not include all possible unicode characters however, so when you need
1286 # these (or just want a differently looking font) you can specify the font name
1287 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1288 # which can be done by putting it in a standard location or by setting the
1289 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1290 # containing the font.
1291 
1292 DOT_FONTNAME =
1293 
1294 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1295 # The default size is 10pt.
1296 
1297 DOT_FONTSIZE = 12
1298 
1299 # By default doxygen will tell dot to use the output directory to look for the
1300 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1301 # different font using DOT_FONTNAME you can set the path where dot
1302 # can find it using this tag.
1303 
1304 DOT_FONTPATH =
1305 
1306 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1307 # will generate a graph for each documented class showing the direct and
1308 # indirect inheritance relations. Setting this tag to YES will force the
1309 # the CLASS_DIAGRAMS tag to NO.
1310 
1311 CLASS_GRAPH = NO
1312 
1313 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1314 # will generate a graph for each documented class showing the direct and
1315 # indirect implementation dependencies (inheritance, containment, and
1316 # class references variables) of the class with other documented classes.
1317 
1318 COLLABORATION_GRAPH = NO
1319 
1320 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1321 # will generate a graph for groups, showing the direct groups dependencies
1322 
1323 GROUP_GRAPHS = NO
1324 
1325 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1326 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1327 # Language.
1328 
1329 UML_LOOK = NO
1330 
1331 # If set to YES, the inheritance and collaboration graphs will show the
1332 # relations between templates and their instances.
1333 
1334 TEMPLATE_RELATIONS = NO
1335 
1336 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1337 # tags are set to YES then doxygen will generate a graph for each documented
1338 # file showing the direct and indirect include dependencies of the file with
1339 # other documented files.
1340 
1341 INCLUDE_GRAPH = NO
1342 
1343 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1344 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1345 # documented header file showing the documented files that directly or
1346 # indirectly include this file.
1347 
1348 INCLUDED_BY_GRAPH = NO
1349 
1350 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1351 # doxygen will generate a call dependency graph for every global function
1352 # or class method. Note that enabling this option will significantly increase
1353 # the time of a run. So in most cases it will be better to enable call graphs
1354 # for selected functions only using the \callgraph command.
1355 
1356 CALL_GRAPH = NO
1357 
1358 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1359 # doxygen will generate a caller dependency graph for every global function
1360 # or class method. Note that enabling this option will significantly increase
1361 # the time of a run. So in most cases it will be better to enable caller
1362 # graphs for selected functions only using the \callergraph command.
1363 
1364 CALLER_GRAPH = NO
1365 
1366 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1367 # will graphical hierarchy of all classes instead of a textual one.
1368 
1369 GRAPHICAL_HIERARCHY = YES
1370 
1371 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1372 # then doxygen will show the dependencies a directory has on other directories
1373 # in a graphical way. The dependency relations are determined by the #include
1374 # relations between the files in the directories.
1375 
1376 DIRECTORY_GRAPH = NO
1377 
1378 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1379 # generated by dot. Possible values are png, jpg, or gif
1380 # If left blank png will be used.
1381 
1382 DOT_IMAGE_FORMAT = png
1383 
1384 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1385 # found. If left blank, it is assumed the dot tool can be found in the path.
1386 
1387 DOT_PATH =
1388 
1389 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1390 # contain dot files that are included in the documentation (see the
1391 # \dotfile command).
1392 
1393 DOTFILE_DIRS =
1394 
1395 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1396 # nodes that will be shown in the graph. If the number of nodes in a graph
1397 # becomes larger than this value, doxygen will truncate the graph, which is
1398 # visualized by representing a node as a red box. Note that doxygen if the
1399 # number of direct children of the root node in a graph is already larger than
1400 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1401 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1402 
1403 DOT_GRAPH_MAX_NODES = 50
1404 
1405 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1406 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1407 # from the root by following a path via at most 3 edges will be shown. Nodes
1408 # that lay further from the root node will be omitted. Note that setting this
1409 # option to 1 or 2 may greatly reduce the computation time needed for large
1410 # code bases. Also note that the size of a graph can be further restricted by
1411 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1412 
1413 MAX_DOT_GRAPH_DEPTH = 1000
1414 
1415 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1416 # background. This is disabled by default, because dot on Windows does not
1417 # seem to support this out of the box. Warning: Depending on the platform used,
1418 # enabling this option may lead to badly anti-aliased labels on the edges of
1419 # a graph (i.e. they become hard to read).
1420 
1421 DOT_TRANSPARENT = YES
1422 
1423 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1424 # files in one run (i.e. multiple -o and -T options on the command line). This
1425 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1426 # support this, this feature is disabled by default.
1427 
1428 DOT_MULTI_TARGETS = NO
1429 
1430 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1431 # generate a legend page explaining the meaning of the various boxes and
1432 # arrows in the dot generated graphs.
1433 
1434 GENERATE_LEGEND = YES
1435 
1436 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1437 # remove the intermediate dot files that are used to generate
1438 # the various graphs.
1439 
1440 DOT_CLEANUP = YES
1441 
1442 #---------------------------------------------------------------------------
1443 # Configuration::additions related to the search engine
1444 #---------------------------------------------------------------------------
1445 
1446 # The SEARCHENGINE tag specifies whether or not a search engine should be
1447 # used. If set to NO the values of all tags below this one will be ignored.
1448 
1449 SEARCHENGINE = YES