3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
6 # All text after a hash (#) is considered a comment and will be ignored
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 (" ")
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 # by quotes) that should identify the project.
20 PROJECT_NAME = "GNU Radio @VERSION@"
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
23 # This could be handy for archiving the generated documentation or
24 # if some version control system is used.
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29 # base path where the generated documentation will be put.
30 # If a relative path is entered, it will be relative to the location
31 # where doxygen was started. If left blank the current directory will be used.
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36 # 4096 sub-directories (in 2 levels) under the output directory of each output
37 # format and will distribute the generated files over these directories.
38 # Enabling this option can be useful when feeding doxygen a huge amount of
39 # source files, where putting all generated files in the same directory would
40 # otherwise cause performance problems for the file system.
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
45 # documentation generated by doxygen is written. Doxygen will use this
46 # information to generate all constant output in the proper language.
47 # The default language is English, other supported languages are:
48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
52 # Swedish, and Ukrainian.
54 OUTPUT_LANGUAGE = English
56 # This tag can be used to specify the encoding used in the generated output.
57 # The encoding is not always determined by the language that is chosen,
58 # but also whether or not the output is meant for Windows or non-Windows users.
59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
60 # forces the Windows encoding (this is the default for the Windows binary),
61 # whereas setting the tag to NO uses a Unix-style encoding (the default for
62 # all platforms other than Windows).
64 USE_WINDOWS_ENCODING = NO
66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
67 # include brief member descriptions after the members that are listed in
68 # the file and class documentation (similar to JavaDoc).
69 # Set to NO to disable this.
71 BRIEF_MEMBER_DESC = YES
73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
74 # the brief description of a member or function before the detailed description.
75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
76 # brief descriptions will be completely suppressed.
80 # This tag implements a quasi-intelligent brief description abbreviator
81 # that is used to form the text in various listings. Each string
82 # in this list, if found as the leading text of the brief description, will be
83 # stripped from the text and the result after processing the whole list, is
84 # used as the annotated text. Otherwise, the brief description is used as-is.
85 # If left blank, the following values are used ("$name" is automatically
86 # replaced with the name of the entity): "The $name class" "The $name widget"
87 # "The $name file" "is" "provides" "specifies" "contains"
88 # "represents" "a" "an" "the"
92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
93 # Doxygen will generate a detailed section even if there is only a brief
96 ALWAYS_DETAILED_SEC = NO
98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
99 # inherited members of a class in the documentation of that class as if those
100 # members were ordinary class members. Constructors, destructors and assignment
101 # operators of the base classes will not be shown.
103 INLINE_INHERITED_MEMB = NO
105 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
106 # path before files name in the file list and in the header files. If set
107 # to NO the shortest path that makes the file name unique will be used.
111 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
112 # can be used to strip a user-defined part of the path. Stripping is
113 # only done if one of the specified strings matches the left-hand part of
114 # the path. The tag can be used to show relative paths in the file list.
115 # If left blank the directory from which doxygen is run is used as the
120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
121 # the path mentioned in the documentation of a class, which tells
122 # the reader which header file to include in order to use a class.
123 # If left blank only the name of the header file containing the class
124 # definition is used. Otherwise one should specify the include paths that
125 # are normally passed to the compiler using the -I flag.
127 STRIP_FROM_INC_PATH =
129 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
130 # (but less readable) file names. This can be useful is your file systems
131 # doesn't support long names like on DOS, Mac, or CD-ROM.
135 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
136 # will interpret the first line (until the first dot) of a JavaDoc-style
137 # comment as the brief description. If set to NO, the JavaDoc
138 # comments will behave just like the Qt-style comments (thus requiring an
139 # explicit @brief command for a brief description.
141 JAVADOC_AUTOBRIEF = NO
143 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
144 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
145 # comments) as a brief description. This used to be the default behaviour.
146 # The new default is to treat a multi-line C++ comment block as a detailed
147 # description. Set this tag to YES if you prefer the old behaviour instead.
149 MULTILINE_CPP_IS_BRIEF = NO
151 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
152 # will output the detailed description near the top, like JavaDoc.
153 # If set to NO, the detailed description appears after the member
158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159 # member inherits the documentation from any documented member that it
164 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
165 # tag is set to YES, then doxygen will reuse the documentation of the first
166 # member in the group (if any) for the other members of the group. By default
167 # all members of a group must be documented explicitly.
169 DISTRIBUTE_GROUP_DOC = NO
171 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
172 # Doxygen uses this value to replace tabs by spaces in code fragments.
176 # This tag can be used to specify a number of aliases that acts
177 # as commands in the documentation. An alias has the form "name=value".
178 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
179 # put the command \sideeffect (or @sideeffect) in the documentation, which
180 # will result in a user-defined paragraph with heading "Side Effects:".
181 # You can put \n's in the value part of an alias to insert newlines.
185 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
186 # sources only. Doxygen will then generate output that is more tailored for C.
187 # For instance, some of the names that are used will be different. The list
188 # of all members will be omitted, etc.
190 OPTIMIZE_OUTPUT_FOR_C = NO
192 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
193 # only. Doxygen will then generate output that is more tailored for Java.
194 # For instance, namespaces will be presented as packages, qualified scopes
195 # will look different, etc.
197 OPTIMIZE_OUTPUT_JAVA = NO
199 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
200 # the same type (for instance a group of public functions) to be put as a
201 # subgroup of that type (e.g. under the Public Functions section). Set it to
202 # NO to prevent subgrouping. Alternatively, this can be done per class using
203 # the \nosubgrouping command.
207 #---------------------------------------------------------------------------
208 # Build related configuration options
209 #---------------------------------------------------------------------------
211 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
212 # documentation are documented, even if no documentation was available.
213 # Private class members and static file members will be hidden unless
214 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
218 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
219 # will be included in the documentation.
223 # If the EXTRACT_STATIC tag is set to YES all static members of a file
224 # will be included in the documentation.
228 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
229 # defined locally in source files will be included in the documentation.
230 # If set to NO only classes defined in header files are included.
232 EXTRACT_LOCAL_CLASSES = YES
234 # This flag is only useful for Objective-C code. When set to YES local
235 # methods, which are defined in the implementation section but not in
236 # the interface are included in the documentation.
237 # If set to NO (the default) only methods in the interface are included.
239 EXTRACT_LOCAL_METHODS = NO
241 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
242 # undocumented members of documented classes, files or namespaces.
243 # If set to NO (the default) these members will be included in the
244 # various overviews, but no documentation section is generated.
245 # This option has no effect if EXTRACT_ALL is enabled.
247 HIDE_UNDOC_MEMBERS = NO
249 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
250 # undocumented classes that are normally visible in the class hierarchy.
251 # If set to NO (the default) these classes will be included in the various
252 # overviews. This option has no effect if EXTRACT_ALL is enabled.
254 HIDE_UNDOC_CLASSES = NO
256 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
257 # friend (class|struct|union) declarations.
258 # If set to NO (the default) these declarations will be included in the
261 HIDE_FRIEND_COMPOUNDS = NO
263 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
264 # documentation blocks found inside the body of a function.
265 # If set to NO (the default) these blocks will be appended to the
266 # function's detailed documentation block.
268 HIDE_IN_BODY_DOCS = NO
270 # The INTERNAL_DOCS tag determines if documentation
271 # that is typed after a \internal command is included. If the tag is set
272 # to NO (the default) then the documentation will be excluded.
273 # Set it to YES to include the internal documentation.
277 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
278 # file names in lower-case letters. If set to YES upper-case letters are also
279 # allowed. This is useful if you have classes or files whose names only differ
280 # in case and if your file system supports case sensitive file names. Windows
281 # and Mac users are advised to set this option to NO.
283 CASE_SENSE_NAMES = YES
285 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
286 # will show members with their full class and namespace scopes in the
287 # documentation. If set to YES the scope will be hidden.
289 HIDE_SCOPE_NAMES = NO
291 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
292 # will put a list of the files that are included by a file in the documentation
295 SHOW_INCLUDE_FILES = YES
297 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
298 # is inserted in the documentation for inline members.
302 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
303 # will sort the (detailed) documentation of file and class members
304 # alphabetically by member name. If set to NO the members will appear in
307 SORT_MEMBER_DOCS = YES
309 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
310 # brief documentation of file, namespace and class members alphabetically
311 # by member name. If set to NO (the default) the members will appear in
316 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
317 # sorted by fully-qualified names, including namespaces. If set to
318 # NO (the default), the class list will be sorted only by class name,
319 # not including the namespace part.
320 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
321 # Note: This option applies only to the class list, not to the
324 SORT_BY_SCOPE_NAME = NO
326 # The GENERATE_TODOLIST tag can be used to enable (YES) or
327 # disable (NO) the todo list. This list is created by putting \todo
328 # commands in the documentation.
330 GENERATE_TODOLIST = YES
332 # The GENERATE_TESTLIST tag can be used to enable (YES) or
333 # disable (NO) the test list. This list is created by putting \test
334 # commands in the documentation.
336 GENERATE_TESTLIST = YES
338 # The GENERATE_BUGLIST tag can be used to enable (YES) or
339 # disable (NO) the bug list. This list is created by putting \bug
340 # commands in the documentation.
342 GENERATE_BUGLIST = YES
344 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
345 # disable (NO) the deprecated list. This list is created by putting
346 # \deprecated commands in the documentation.
348 GENERATE_DEPRECATEDLIST= YES
350 # The ENABLED_SECTIONS tag can be used to enable conditional
351 # documentation sections, marked by \if sectionname ... \endif.
355 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
356 # the initial value of a variable or define consists of for it to appear in
357 # the documentation. If the initializer consists of more lines than specified
358 # here it will be hidden. Use a value of 0 to hide initializers completely.
359 # The appearance of the initializer of individual variables and defines in the
360 # documentation can be controlled using \showinitializer or \hideinitializer
361 # command in the documentation regardless of this setting.
363 MAX_INITIALIZER_LINES = 30
365 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
366 # at the bottom of the documentation of classes and structs. If set to YES the
367 # list will mention the files that were used to generate the documentation.
369 SHOW_USED_FILES = YES
371 # If the sources in your project are distributed over multiple directories
372 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
373 # in the documentation.
376 SHOW_DIRECTORIES = NO
378 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
379 # doxygen should invoke to get the current version for each file (typically from the
380 # version control system). Doxygen will invoke the program by executing (via
381 # popen()) the command <command> <input-file>, where <command> is the value of
382 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
383 # provided by doxygen. Whatever the progam writes to standard output
384 # is used as the file version. See the manual for examples.
386 FILE_VERSION_FILTER =
388 #---------------------------------------------------------------------------
389 # configuration options related to warning and progress messages
390 #---------------------------------------------------------------------------
392 # The QUIET tag can be used to turn on/off the messages that are generated
393 # by doxygen. Possible values are YES and NO. If left blank NO is used.
397 # The WARNINGS tag can be used to turn on/off the warning messages that are
398 # generated by doxygen. Possible values are YES and NO. If left blank
403 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
404 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
405 # automatically be disabled.
407 WARN_IF_UNDOCUMENTED = YES
409 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
410 # potential errors in the documentation, such as not documenting some
411 # parameters in a documented function, or documenting parameters that
412 # don't exist or using markup commands wrongly.
414 WARN_IF_DOC_ERROR = YES
416 # This WARN_NO_PARAMDOC option can be abled to get warnings for
417 # functions that are documented, but have no documentation for their parameters
418 # or return value. If set to NO (the default) doxygen will only warn about
419 # wrong or incomplete parameter documentation, but not about the absence of
422 WARN_NO_PARAMDOC = NO
424 # The WARN_FORMAT tag determines the format of the warning messages that
425 # doxygen can produce. The string should contain the $file, $line, and $text
426 # tags, which will be replaced by the file and line number from which the
427 # warning originated and the warning text. Optionally the format may contain
428 # $version, which will be replaced by the version of the file (if it could
429 # be obtained via FILE_VERSION_FILTER)
431 WARN_FORMAT = "$file:$line: $text"
433 # The WARN_LOGFILE tag can be used to specify a file to which warning
434 # and error messages should be written. If left blank the output is written
439 #---------------------------------------------------------------------------
440 # configuration options related to the input files
441 #---------------------------------------------------------------------------
443 # The INPUT tag can be used to specify the files and/or directories that contain
444 # documented source files. You may enter file names like "myfile.cpp" or
445 # directories like "/usr/src/myproject". Separate the files or directories
448 INPUT = @top_srcdir@/gnuradio-core/src/lib \
449 @top_srcdir@/gnuradio-core/src/tests \
450 @top_srcdir@/gnuradio-core/doc/other \
451 @top_srcdir@/gr-audio-alsa \
452 @top_srcdir@/gr-audio-jack \
453 @top_srcdir@/gr-audio-oss \
454 @top_srcdir@/gr-audio-osx \
455 @top_srcdir@/gr-audio-portaudio \
456 @top_srcdir@/gr-gsm-fr-vocoder \
457 @top_srcdir@/gr-pager \
458 @top_srcdir@/gr-radio-astronomy \
459 @top_srcdir@/gr-trellis \
460 @top_srcdir@/gr-usrp \
461 @top_srcdir@/gr-video-sdl \
462 @top_srcdir@/mblock \
463 @top_srcdir@/omnithread \
465 @top_srcdir@/usrp/host
468 # If the value of the INPUT tag contains directories, you can use the
469 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
470 # and *.h) to filter out the source-files in the directories. If left
471 # blank the following patterns are tested:
472 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
473 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
475 FILE_PATTERNS = *.h \
479 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
480 # should be searched for input files as well. Possible values are YES and NO.
481 # If left blank NO is used.
485 # The EXCLUDE tag can be used to specify files and/or directories that should
486 # excluded from the INPUT source files. This way you can easily exclude a
487 # subdirectory from a directory tree whose root is specified with the INPUT tag.
489 EXCLUDE = CVS .svn .libs .deps \
490 @top_builddir@/gnuradio-core/src/lib/swig/gnuradio_swig_py_filter.cc \
491 @top_builddir@/gnuradio-core/src/lib/swig/gnuradio_swig_py_general.cc \
492 @top_builddir@/gnuradio-core/src/lib/swig/gnuradio_swig_py_gengen.cc \
493 @top_builddir@/gnuradio-core/src/lib/swig/gnuradio_swig_py_io.cc \
494 @top_builddir@/gnuradio-core/src/lib/swig/gnuradio_swig_py_runtime.cc \
495 @top_builddir@/gr-atsc/src/lib/atsc.cc \
496 @top_builddir@/gr-audio-alsa/src/audio_alsa.cc \
497 @top_builddir@/gr-audio-jack/src/audio_jack.cc \
498 @top_builddir@/gr-audio-oss/src/audio_oss.cc \
499 @top_builddir@/gr-audio-osx/src/audio_osx.cc \
500 @top_builddir@/gr-audio-portaudio/src/audio_portaudio.cc \
501 @top_builddir@/gr-audio-windows/src/audio_windows.cc \
502 @top_builddir@/gr-comedi/src/comedi.cc \
503 @top_builddir@/gr-ezdop/src/lib/ezdop.cc \
504 @top_builddir@/gr-gsm-fr-vocoder/src/lib/gsm_full_rate.cc \
505 @top_builddir@/gr-howto-write-a-block/src/lib/howto.cc \
506 @top_builddir@/gr-pager/src/pager_swig.cc \
507 @top_builddir@/gr-radio-astronomy/src/lib/ra.cc \
508 @top_builddir@/gr-trellis/src/lib/trellis.cc \
509 @top_builddir@/gr-usrp/src/usrp1.cc \
510 @top_builddir@/gr-video-sdl/src/video_sdl.cc \
511 @top_builddir@/usrp/host/swig/prims.cc
514 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
515 # directories that are symbolic links (a Unix filesystem feature) are excluded
518 EXCLUDE_SYMLINKS = NO
520 # If the value of the INPUT tag contains directories, you can use the
521 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
522 # certain files from those directories.
524 EXCLUDE_PATTERNS = moc_*.cc
526 # The EXAMPLE_PATH tag can be used to specify one or more files or
527 # directories that contain example code fragments that are included (see
528 # the \include command).
532 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
533 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
534 # and *.h) to filter out the source-files in the directories. If left
535 # blank all files are included.
539 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
540 # searched for input files to be used with the \include or \dontinclude
541 # commands irrespective of the value of the RECURSIVE tag.
542 # Possible values are YES and NO. If left blank NO is used.
544 EXAMPLE_RECURSIVE = NO
546 # The IMAGE_PATH tag can be used to specify one or more files or
547 # directories that contain image that are included in the documentation (see
548 # the \image command).
552 # The INPUT_FILTER tag can be used to specify a program that doxygen should
553 # invoke to filter for each input file. Doxygen will invoke the filter program
554 # by executing (via popen()) the command <filter> <input-file>, where <filter>
555 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
556 # input file. Doxygen will then use the output that the filter program writes
557 # to standard output. If FILTER_PATTERNS is specified, this tag will be
562 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
563 # basis. Doxygen will compare the file name with each pattern and apply the
564 # filter if there is a match. The filters are a list of the form:
565 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
566 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
567 # is applied to all files.
571 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
572 # INPUT_FILTER) will be used to filter the input files when producing source
573 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
575 FILTER_SOURCE_FILES = NO
577 #---------------------------------------------------------------------------
578 # configuration options related to source browsing
579 #---------------------------------------------------------------------------
581 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
582 # be generated. Documented entities will be cross-referenced with these sources.
583 # Note: To get rid of all source code in the generated output, make sure also
584 # VERBATIM_HEADERS is set to NO.
588 # Setting the INLINE_SOURCES tag to YES will include the body
589 # of functions and classes directly in the documentation.
593 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
594 # doxygen to hide any special comment blocks from generated source code
595 # fragments. Normal C and C++ comments will always remain visible.
597 STRIP_CODE_COMMENTS = YES
599 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
600 # then for each documented function all documented
601 # functions referencing it will be listed.
603 REFERENCED_BY_RELATION = YES
605 # If the REFERENCES_RELATION tag is set to YES (the default)
606 # then for each documented function all documented entities
607 # called/used by that function will be listed.
609 REFERENCES_RELATION = YES
611 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
612 # will generate a verbatim copy of the header file for each class for
613 # which an include is specified. Set to NO to disable this.
615 VERBATIM_HEADERS = YES
617 #---------------------------------------------------------------------------
618 # configuration options related to the alphabetical class index
619 #---------------------------------------------------------------------------
621 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
622 # of all compounds will be generated. Enable this if the project
623 # contains a lot of classes, structs, unions or interfaces.
625 ALPHABETICAL_INDEX = NO
627 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
628 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
629 # in which this list will be split (can be a number in the range [1..20])
631 COLS_IN_ALPHA_INDEX = 5
633 # In case all classes in a project start with a common prefix, all
634 # classes will be put under the same header in the alphabetical index.
635 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
636 # should be ignored while generating the index headers.
640 #---------------------------------------------------------------------------
641 # configuration options related to the HTML output
642 #---------------------------------------------------------------------------
644 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
645 # generate HTML output.
649 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
650 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
651 # put in front of it. If left blank `html' will be used as the default path.
655 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
656 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
657 # doxygen will generate files with .html extension.
659 HTML_FILE_EXTENSION = .html
661 # The HTML_HEADER tag can be used to specify a personal HTML header for
662 # each generated HTML page. If it is left blank doxygen will generate a
667 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
668 # each generated HTML page. If it is left blank doxygen will generate a
673 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
674 # style sheet that is used by each HTML page. It can be used to
675 # fine-tune the look of the HTML output. If the tag is left blank doxygen
676 # will generate a default style sheet. Note that doxygen will try to copy
677 # the style sheet file to the HTML output directory, so don't put your own
678 # stylesheet in the HTML output directory as well, or it will be erased!
682 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
683 # files or namespaces will be aligned in HTML using tables. If set to
684 # NO a bullet list will be used.
686 HTML_ALIGN_MEMBERS = YES
688 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
689 # will be generated that can be used as input for tools like the
690 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
691 # of the generated HTML documentation.
693 GENERATE_HTMLHELP = NO
695 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
696 # be used to specify the file name of the resulting .chm file. You
697 # can add a path in front of the file if the result should not be
698 # written to the html output directory.
702 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
703 # be used to specify the location (absolute path including file name) of
704 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
705 # the HTML help compiler on the generated index.hhp.
709 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
710 # controls if a separate .chi index file is generated (YES) or that
711 # it should be included in the master .chm file (NO).
715 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
716 # controls whether a binary table of contents is generated (YES) or a
717 # normal table of contents (NO) in the .chm file.
721 # The TOC_EXPAND flag can be set to YES to add extra items for group members
722 # to the contents of the HTML help documentation and to the tree view.
726 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
727 # top of each HTML page. The value NO (the default) enables the index and
728 # the value YES disables it.
732 # This tag can be used to set the number of enum values (range [1..20])
733 # that doxygen will group on one line in the generated HTML documentation.
735 ENUM_VALUES_PER_LINE = 4
737 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
738 # generated containing a tree-like index structure (just like the one that
739 # is generated for HTML Help). For this to work a browser that supports
740 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
741 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
742 # probably better off using the HTML help feature.
744 GENERATE_TREEVIEW = NO
746 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
747 # used to set the initial width (in pixels) of the frame in which the tree
752 #---------------------------------------------------------------------------
753 # configuration options related to the LaTeX output
754 #---------------------------------------------------------------------------
756 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
757 # generate Latex output.
762 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
763 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
764 # put in front of it. If left blank `latex' will be used as the default path.
768 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
769 # invoked. If left blank `latex' will be used as the default command name.
771 LATEX_CMD_NAME = latex
773 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
774 # generate index for LaTeX. If left blank `makeindex' will be used as the
775 # default command name.
777 MAKEINDEX_CMD_NAME = makeindex
779 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
780 # LaTeX documents. This may be useful for small projects and may help to
781 # save some trees in general.
785 # The PAPER_TYPE tag can be used to set the paper type that is used
786 # by the printer. Possible values are: a4, a4wide, letter, legal and
787 # executive. If left blank a4wide will be used.
791 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
792 # packages that should be included in the LaTeX output.
796 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
797 # the generated latex document. The header should contain everything until
798 # the first chapter. If it is left blank doxygen will generate a
799 # standard header. Notice: only use this tag if you know what you are doing!
803 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
804 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
805 # contain links (just like the HTML output) instead of page references
806 # This makes the output suitable for online browsing using a pdf viewer.
810 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
811 # plain latex in the generated Makefile. Set this option to YES to get a
812 # higher quality PDF documentation.
816 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
817 # command to the generated LaTeX files. This will instruct LaTeX to keep
818 # running if errors occur, instead of asking the user for help.
819 # This option is also used when generating formulas in HTML.
823 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
824 # include the index chapters (such as File Index, Compound Index, etc.)
827 LATEX_HIDE_INDICES = NO
829 #---------------------------------------------------------------------------
830 # configuration options related to the RTF output
831 #---------------------------------------------------------------------------
833 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
834 # The RTF output is optimized for Word 97 and may not look very pretty with
835 # other RTF readers or editors.
839 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
840 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
841 # put in front of it. If left blank `rtf' will be used as the default path.
845 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
846 # RTF documents. This may be useful for small projects and may help to
847 # save some trees in general.
851 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
852 # will contain hyperlink fields. The RTF file will
853 # contain links (just like the HTML output) instead of page references.
854 # This makes the output suitable for online browsing using WORD or other
855 # programs which support those fields.
856 # Note: wordpad (write) and others do not support links.
860 # Load stylesheet definitions from file. Syntax is similar to doxygen's
861 # config file, i.e. a series of assignments. You only have to provide
862 # replacements, missing definitions are set to their default value.
864 RTF_STYLESHEET_FILE =
866 # Set optional variables used in the generation of an rtf document.
867 # Syntax is similar to doxygen's config file.
869 RTF_EXTENSIONS_FILE =
871 #---------------------------------------------------------------------------
872 # configuration options related to the man page output
873 #---------------------------------------------------------------------------
875 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
880 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
881 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
882 # put in front of it. If left blank `man' will be used as the default path.
886 # The MAN_EXTENSION tag determines the extension that is added to
887 # the generated man pages (default is the subroutine's section .3)
891 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
892 # then it will generate one additional man file for each entity
893 # documented in the real man page(s). These additional files
894 # only source the real man page, but without them the man command
895 # would be unable to find the correct page. The default is NO.
899 #---------------------------------------------------------------------------
900 # configuration options related to the XML output
901 #---------------------------------------------------------------------------
903 # If the GENERATE_XML tag is set to YES Doxygen will
904 # generate an XML file that captures the structure of
905 # the code including all documentation.
909 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
910 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
911 # put in front of it. If left blank `xml' will be used as the default path.
915 # The XML_SCHEMA tag can be used to specify an XML schema,
916 # which can be used by a validating XML parser to check the
917 # syntax of the XML files.
921 # The XML_DTD tag can be used to specify an XML DTD,
922 # which can be used by a validating XML parser to check the
923 # syntax of the XML files.
927 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
928 # dump the program listings (including syntax highlighting
929 # and cross-referencing information) to the XML output. Note that
930 # enabling this will significantly increase the size of the XML output.
933 XML_PROGRAMLISTING = NO
935 #---------------------------------------------------------------------------
936 # configuration options for the AutoGen Definitions output
937 #---------------------------------------------------------------------------
939 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
940 # generate an AutoGen Definitions (see autogen.sf.net) file
941 # that captures the structure of the code including all
942 # documentation. Note that this feature is still experimental
943 # and incomplete at the moment.
945 GENERATE_AUTOGEN_DEF = NO
947 #---------------------------------------------------------------------------
948 # configuration options related to the Perl module output
949 #---------------------------------------------------------------------------
951 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
952 # generate a Perl module file that captures the structure of
953 # the code including all documentation. Note that this
954 # feature is still experimental and incomplete at the
957 GENERATE_PERLMOD = NO
959 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
960 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
961 # to generate PDF and DVI output from the Perl module output.
965 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
966 # nicely formatted so it can be parsed by a human reader. This is useful
967 # if you want to understand what is going on. On the other hand, if this
968 # tag is set to NO the size of the Perl module output will be much smaller
969 # and Perl will parse it just the same.
973 # The names of the make variables in the generated doxyrules.make file
974 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
975 # This is useful so different doxyrules.make files included by the same
976 # Makefile don't overwrite each other's variables.
978 PERLMOD_MAKEVAR_PREFIX =
980 #---------------------------------------------------------------------------
981 # Configuration options related to the preprocessor
982 #---------------------------------------------------------------------------
984 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
985 # evaluate all C-preprocessor directives found in the sources and include
988 ENABLE_PREPROCESSING = YES
990 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
991 # names in the source code. If set to NO (the default) only conditional
992 # compilation will be performed. Macro expansion can be done in a controlled
993 # way by setting EXPAND_ONLY_PREDEF to YES.
997 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
998 # then the macro expansion is limited to the macros specified with the
999 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
1001 EXPAND_ONLY_PREDEF = NO
1003 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1004 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1006 SEARCH_INCLUDES = YES
1008 # The INCLUDE_PATH tag can be used to specify one or more directories that
1009 # contain include files that are not input files but should be processed by
1014 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1015 # patterns (like *.h and *.hpp) to filter out the header-files in the
1016 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1019 INCLUDE_FILE_PATTERNS =
1021 # The PREDEFINED tag can be used to specify one or more macro names that
1022 # are defined before the preprocessor is started (similar to the -D option of
1023 # gcc). The argument of the tag is a list of macros of the form: name
1024 # or name=definition (no spaces). If the definition and the = are
1025 # omitted =1 is assumed. To prevent a macro definition from being
1026 # undefined via #undef or recursively expanded use the := operator
1027 # instead of the = operator.
1031 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1032 # this tag can be used to specify a list of macro names that should be expanded.
1033 # The macro definition that is found in the sources will be used.
1034 # Use the PREDEFINED tag if you want to use a different macro definition.
1038 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1039 # doxygen's preprocessor will remove all function-like macros that are alone
1040 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1041 # function macros are typically used for boiler-plate code, and will confuse
1042 # the parser if not removed.
1044 SKIP_FUNCTION_MACROS = YES
1046 #---------------------------------------------------------------------------
1047 # Configuration::additions related to external references
1048 #---------------------------------------------------------------------------
1050 # The TAGFILES option can be used to specify one or more tagfiles.
1051 # Optionally an initial location of the external documentation
1052 # can be added for each tagfile. The format of a tag file without
1053 # this location is as follows:
1054 # TAGFILES = file1 file2 ...
1055 # Adding location for the tag files is done as follows:
1056 # TAGFILES = file1=loc1 "file2 = loc2" ...
1057 # where "loc1" and "loc2" can be relative or absolute paths or
1058 # URLs. If a location is present for each tag, the installdox tool
1059 # does not have to be run to correct the links.
1060 # Note that each tag file must have a unique name
1061 # (where the name does NOT include the path)
1062 # If a tag file is not located in the directory in which doxygen
1063 # is run, you must also specify the path to the tagfile here.
1067 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1068 # a tag file that is based on the input files it reads.
1072 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1073 # in the class index. If set to NO only the inherited external classes
1078 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1079 # in the modules index. If set to NO, only the current project's groups will
1082 EXTERNAL_GROUPS = YES
1084 # The PERL_PATH should be the absolute path and name of the perl script
1085 # interpreter (i.e. the result of `which perl').
1087 PERL_PATH = /usr/bin/perl
1089 #---------------------------------------------------------------------------
1090 # Configuration options related to the dot tool
1091 #---------------------------------------------------------------------------
1093 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1094 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1095 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1096 # this option is superseded by the HAVE_DOT option below. This is only a
1097 # fallback. It is recommended to install and use dot, since it yields more
1100 CLASS_DIAGRAMS = YES
1102 # If set to YES, the inheritance and collaboration graphs will hide
1103 # inheritance and usage relations if the target is undocumented
1104 # or is not a class.
1106 HIDE_UNDOC_RELATIONS = YES
1108 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1109 # available from the path. This tool is part of Graphviz, a graph visualization
1110 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1111 # have no effect if this option is set to NO (the default)
1113 HAVE_DOT = @HAVE_DOT@
1115 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1116 # will generate a graph for each documented class showing the direct and
1117 # indirect inheritance relations. Setting this tag to YES will force the
1118 # the CLASS_DIAGRAMS tag to NO.
1122 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1123 # will generate a graph for each documented class showing the direct and
1124 # indirect implementation dependencies (inheritance, containment, and
1125 # class references variables) of the class with other documented classes.
1127 COLLABORATION_GRAPH = YES
1129 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1130 # will generate a graph for groups, showing the direct groups dependencies
1134 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1135 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1140 # If set to YES, the inheritance and collaboration graphs will show the
1141 # relations between templates and their instances.
1143 TEMPLATE_RELATIONS = NO
1145 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1146 # tags are set to YES then doxygen will generate a graph for each documented
1147 # file showing the direct and indirect include dependencies of the file with
1148 # other documented files.
1152 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1153 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1154 # documented header file showing the documented files that directly or
1155 # indirectly include this file.
1157 INCLUDED_BY_GRAPH = YES
1159 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1160 # generate a call dependency graph for every global function or class method.
1161 # Note that enabling this option will significantly increase the time of a run.
1162 # So in most cases it will be better to enable call graphs for selected
1163 # functions only using the \callgraph command.
1167 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1168 # will graphical hierarchy of all classes instead of a textual one.
1170 GRAPHICAL_HIERARCHY = YES
1172 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1173 # then doxygen will show the dependencies a directory has on other directories
1174 # in a graphical way. The dependency relations are determined by the #include
1175 # relations between the files in the directories.
1177 DIRECTORY_GRAPH = YES
1179 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1180 # generated by dot. Possible values are png, jpg, or gif
1181 # If left blank png will be used.
1183 DOT_IMAGE_FORMAT = png
1185 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1186 # found. If left blank, it is assumed the dot tool can be found in the path.
1190 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1191 # contain dot files that are included in the documentation (see the
1192 # \dotfile command).
1196 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1197 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1198 # this value, doxygen will try to truncate the graph, so that it fits within
1199 # the specified constraint. Beware that most browsers cannot cope with very
1202 MAX_DOT_GRAPH_WIDTH = 1024
1204 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1205 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1206 # this value, doxygen will try to truncate the graph, so that it fits within
1207 # the specified constraint. Beware that most browsers cannot cope with very
1210 MAX_DOT_GRAPH_HEIGHT = 1024
1212 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1213 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1214 # from the root by following a path via at most 3 edges will be shown. Nodes
1215 # that lay further from the root node will be omitted. Note that setting this
1216 # option to 1 or 2 may greatly reduce the computation time needed for large
1217 # code bases. Also note that a graph may be further truncated if the graph's
1218 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1219 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
1220 # the graph is not depth-constrained.
1222 MAX_DOT_GRAPH_DEPTH = 0
1224 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1225 # background. This is disabled by default, which results in a white background.
1226 # Warning: Depending on the platform used, enabling this option may lead to
1227 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1230 DOT_TRANSPARENT = NO
1232 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1233 # files in one run (i.e. multiple -o and -T options on the command line). This
1234 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1235 # support this, this feature is disabled by default.
1238 DOT_MULTI_TARGETS = YES
1240 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1241 # generate a legend page explaining the meaning of the various boxes and
1242 # arrows in the dot generated graphs.
1244 GENERATE_LEGEND = YES
1246 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1247 # remove the intermediate dot files that are used to generate
1248 # the various graphs.
1252 #---------------------------------------------------------------------------
1253 # Configuration::additions related to the search engine
1254 #---------------------------------------------------------------------------
1256 # The SEARCHENGINE tag specifies whether or not a search engine should be
1257 # used. If set to NO the values of all tags below this one will be ignored.