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 # 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.
23 DOXYFILE_ENCODING = UTF-8
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
28 PROJECT_NAME = "GNU Radio @VERSION@ C++ API"
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.
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.
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.
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.
63 OUTPUT_LANGUAGE = English
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.
70 BRIEF_MEMBER_DESC = YES
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.
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"
91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92 # Doxygen will generate a detailed section even if there is only a brief
95 ALWAYS_DETAILED_SEC = YES
97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98 # inherited members of a class in the documentation of that class as if those
99 # members were ordinary class members. Constructors, destructors and assignment
100 # operators of the base classes will not be shown.
102 INLINE_INHERITED_MEMB = NO
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105 # path before files name in the file list and in the header files. If set
106 # to NO the shortest path that makes the file name unique will be used.
110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111 # can be used to strip a user-defined part of the path. Stripping is
112 # only done if one of the specified strings matches the left-hand part of
113 # the path. The tag can be used to show relative paths in the file list.
114 # If left blank the directory from which doxygen is run is used as the
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120 # the path mentioned in the documentation of a class, which tells
121 # the reader which header file to include in order to use a class.
122 # If left blank only the name of the header file containing the class
123 # definition is used. Otherwise one should specify the include paths that
124 # are normally passed to the compiler using the -I flag.
126 STRIP_FROM_INC_PATH =
128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129 # (but less readable) file names. This can be useful is your file systems
130 # doesn't support long names like on DOS, Mac, or CD-ROM.
134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135 # will interpret the first line (until the first dot) of a JavaDoc-style
136 # comment as the brief description. If set to NO, the JavaDoc
137 # comments will behave just like regular Qt-style comments
138 # (thus requiring an explicit @brief command for a brief description.)
140 JAVADOC_AUTOBRIEF = NO
142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143 # interpret the first line (until the first dot) of a Qt-style
144 # comment as the brief description. If set to NO, the comments
145 # will behave just like regular Qt-style comments (thus requiring
146 # an explicit \brief command for a brief description.)
150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
152 # comments) as a brief description. This used to be the default behaviour.
153 # The new default is to treat a multi-line C++ comment block as a detailed
154 # description. Set this tag to YES if you prefer the old behaviour instead.
156 MULTILINE_CPP_IS_BRIEF = YES
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 the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165 # a new page for each member. If set to NO, the documentation of a member will
166 # be part of the file/class/namespace that contains it.
168 SEPARATE_MEMBER_PAGES = NO
170 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
171 # Doxygen uses this value to replace tabs by spaces in code fragments.
175 # This tag can be used to specify a number of aliases that acts
176 # as commands in the documentation. An alias has the form "name=value".
177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
178 # put the command \sideeffect (or @sideeffect) in the documentation, which
179 # will result in a user-defined paragraph with heading "Side Effects:".
180 # You can put \n's in the value part of an alias to insert newlines.
184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185 # sources only. Doxygen will then generate output that is more tailored for C.
186 # For instance, some of the names that are used will be different. The list
187 # of all members will be omitted, etc.
189 OPTIMIZE_OUTPUT_FOR_C = NO
191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192 # sources only. Doxygen will then generate output that is more tailored for
193 # Java. For instance, namespaces will be presented as packages, qualified
194 # scopes will look different, etc.
196 OPTIMIZE_OUTPUT_JAVA = NO
198 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
199 # sources only. Doxygen will then generate output that is more tailored for
202 OPTIMIZE_FOR_FORTRAN = NO
204 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
205 # sources. Doxygen will then generate output that is tailored for
208 OPTIMIZE_OUTPUT_VHDL = NO
210 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
211 # to include (a tag file for) the STL sources as input, then you should
212 # set this tag to YES in order to let doxygen match functions declarations and
213 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
214 # func(std::string) {}). This also make the inheritance and collaboration
215 # diagrams that involve STL classes more complete and accurate.
217 BUILTIN_STL_SUPPORT = YES
219 # If you use Microsoft's C++/CLI language, you should set this option to YES to
220 # enable parsing support.
224 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
225 # Doxygen will parse them like normal C++ but will assume all classes use public
226 # instead of private inheritance when no explicit protection keyword is present.
230 # For Microsoft's IDL there are propget and propput attributes to indicate getter
231 # and setter methods for a property. Setting this option to YES (the default)
232 # will make doxygen to replace the get and set methods by a property in the
233 # documentation. This will only work if the methods are indeed getting or
234 # setting a simple type. If this is not the case, or you want to show the
235 # methods anyway, you should set this option to NO.
237 IDL_PROPERTY_SUPPORT = YES
239 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
240 # tag is set to YES, then doxygen will reuse the documentation of the first
241 # member in the group (if any) for the other members of the group. By default
242 # all members of a group must be documented explicitly.
244 DISTRIBUTE_GROUP_DOC = NO
246 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
247 # the same type (for instance a group of public functions) to be put as a
248 # subgroup of that type (e.g. under the Public Functions section). Set it to
249 # NO to prevent subgrouping. Alternatively, this can be done per class using
250 # the \nosubgrouping command.
254 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
255 # is documented as struct, union, or enum with the name of the typedef. So
256 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
257 # with name TypeT. When disabled the typedef will appear as a member of a file,
258 # namespace, or class. And the struct will be named TypeS. This can typically
259 # be useful for C code in case the coding convention dictates that all compound
260 # types are typedef'ed and only the typedef is referenced, never the tag name.
262 TYPEDEF_HIDES_STRUCT = NO
264 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
265 # determine which symbols to keep in memory and which to flush to disk.
266 # When the cache is full, less often used symbols will be written to disk.
267 # For small to medium size projects (<1000 input files) the default value is
268 # probably good enough. For larger projects a too small cache size can cause
269 # doxygen to be busy swapping symbols to and from disk most of the time
270 # causing a significant performance penality.
271 # If the system has enough physical memory increasing the cache will improve the
272 # performance by keeping more symbols in memory. Note that the value works on
273 # a logarithmic scale so increasing the size by one will rougly double the
274 # memory usage. The cache size is given by this formula:
275 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
276 # corresponding to a cache size of 2^16 = 65536 symbols
278 SYMBOL_CACHE_SIZE = 4
280 #---------------------------------------------------------------------------
281 # Build related configuration options
282 #---------------------------------------------------------------------------
284 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
285 # documentation are documented, even if no documentation was available.
286 # Private class members and static file members will be hidden unless
287 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
291 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
292 # will be included in the documentation.
296 # If the EXTRACT_STATIC tag is set to YES all static members of a file
297 # will be included in the documentation.
301 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
302 # defined locally in source files will be included in the documentation.
303 # If set to NO only classes defined in header files are included.
305 EXTRACT_LOCAL_CLASSES = YES
307 # This flag is only useful for Objective-C code. When set to YES local
308 # methods, which are defined in the implementation section but not in
309 # the interface are included in the documentation.
310 # If set to NO (the default) only methods in the interface are included.
312 EXTRACT_LOCAL_METHODS = NO
314 # If this flag is set to YES, the members of anonymous namespaces will be
315 # extracted and appear in the documentation as a namespace called
316 # 'anonymous_namespace{file}', where file will be replaced with the base
317 # name of the file that contains the anonymous namespace. By default
318 # anonymous namespace are hidden.
320 EXTRACT_ANON_NSPACES = NO
322 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
323 # undocumented members of documented classes, files or namespaces.
324 # If set to NO (the default) these members will be included in the
325 # various overviews, but no documentation section is generated.
326 # This option has no effect if EXTRACT_ALL is enabled.
328 HIDE_UNDOC_MEMBERS = NO
330 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
331 # undocumented classes that are normally visible in the class hierarchy.
332 # If set to NO (the default) these classes will be included in the various
333 # overviews. This option has no effect if EXTRACT_ALL is enabled.
335 HIDE_UNDOC_CLASSES = NO
337 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
338 # friend (class|struct|union) declarations.
339 # If set to NO (the default) these declarations will be included in the
342 HIDE_FRIEND_COMPOUNDS = NO
344 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
345 # documentation blocks found inside the body of a function.
346 # If set to NO (the default) these blocks will be appended to the
347 # function's detailed documentation block.
349 HIDE_IN_BODY_DOCS = NO
351 # The INTERNAL_DOCS tag determines if documentation
352 # that is typed after a \internal command is included. If the tag is set
353 # to NO (the default) then the documentation will be excluded.
354 # Set it to YES to include the internal documentation.
358 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
359 # file names in lower-case letters. If set to YES upper-case letters are also
360 # allowed. This is useful if you have classes or files whose names only differ
361 # in case and if your file system supports case sensitive file names. Windows
362 # and Mac users are advised to set this option to NO.
364 CASE_SENSE_NAMES = YES
366 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
367 # will show members with their full class and namespace scopes in the
368 # documentation. If set to YES the scope will be hidden.
370 HIDE_SCOPE_NAMES = NO
372 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
373 # will put a list of the files that are included by a file in the documentation
376 SHOW_INCLUDE_FILES = YES
378 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
379 # is inserted in the documentation for inline members.
383 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
384 # will sort the (detailed) documentation of file and class members
385 # alphabetically by member name. If set to NO the members will appear in
388 SORT_MEMBER_DOCS = YES
390 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
391 # brief documentation of file, namespace and class members alphabetically
392 # by member name. If set to NO (the default) the members will appear in
397 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
398 # hierarchy of group names into alphabetical order. If set to NO (the default)
399 # the group names will appear in their defined order.
401 SORT_GROUP_NAMES = NO
403 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
404 # sorted by fully-qualified names, including namespaces. If set to
405 # NO (the default), the class list will be sorted only by class name,
406 # not including the namespace part.
407 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
408 # Note: This option applies only to the class list, not to the
411 SORT_BY_SCOPE_NAME = NO
413 # The GENERATE_TODOLIST tag can be used to enable (YES) or
414 # disable (NO) the todo list. This list is created by putting \todo
415 # commands in the documentation.
417 GENERATE_TODOLIST = NO
419 # The GENERATE_TESTLIST tag can be used to enable (YES) or
420 # disable (NO) the test list. This list is created by putting \test
421 # commands in the documentation.
423 GENERATE_TESTLIST = NO
425 # The GENERATE_BUGLIST tag can be used to enable (YES) or
426 # disable (NO) the bug list. This list is created by putting \bug
427 # commands in the documentation.
429 GENERATE_BUGLIST = NO
431 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
432 # disable (NO) the deprecated list. This list is created by putting
433 # \deprecated commands in the documentation.
435 GENERATE_DEPRECATEDLIST= NO
437 # The ENABLED_SECTIONS tag can be used to enable conditional
438 # documentation sections, marked by \if sectionname ... \endif.
442 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
443 # the initial value of a variable or define consists of for it to appear in
444 # the documentation. If the initializer consists of more lines than specified
445 # here it will be hidden. Use a value of 0 to hide initializers completely.
446 # The appearance of the initializer of individual variables and defines in the
447 # documentation can be controlled using \showinitializer or \hideinitializer
448 # command in the documentation regardless of this setting.
450 MAX_INITIALIZER_LINES = 30
452 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
453 # at the bottom of the documentation of classes and structs. If set to YES the
454 # list will mention the files that were used to generate the documentation.
456 SHOW_USED_FILES = YES
458 # If the sources in your project are distributed over multiple directories
459 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
460 # in the documentation. The default is NO.
462 SHOW_DIRECTORIES = NO
464 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
465 # This will remove the Files entry from the Quick Index and from the
466 # Folder Tree View (if specified). The default is YES.
470 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
471 # Namespaces page. This will remove the Namespaces entry from the Quick Index
472 # and from the Folder Tree View (if specified). The default is YES.
476 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
477 # doxygen should invoke to get the current version for each file (typically from
478 # the version control system). Doxygen will invoke the program by executing (via
479 # popen()) the command <command> <input-file>, where <command> is the value of
480 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
481 # provided by doxygen. Whatever the program writes to standard output
482 # is used as the file version. See the manual for examples.
484 FILE_VERSION_FILTER =
486 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
487 # doxygen. The layout file controls the global structure of the generated output files
488 # in an output format independent way. The create the layout file that represents
489 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
490 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
491 # of the layout file.
495 #---------------------------------------------------------------------------
496 # configuration options related to warning and progress messages
497 #---------------------------------------------------------------------------
499 # The QUIET tag can be used to turn on/off the messages that are generated
500 # by doxygen. Possible values are YES and NO. If left blank NO is used.
504 # The WARNINGS tag can be used to turn on/off the warning messages that are
505 # generated by doxygen. Possible values are YES and NO. If left blank
510 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
511 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
512 # automatically be disabled.
514 WARN_IF_UNDOCUMENTED = YES
516 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
517 # potential errors in the documentation, such as not documenting some
518 # parameters in a documented function, or documenting parameters that
519 # don't exist or using markup commands wrongly.
521 WARN_IF_DOC_ERROR = YES
523 # This WARN_NO_PARAMDOC option can be abled to get warnings for
524 # functions that are documented, but have no documentation for their parameters
525 # or return value. If set to NO (the default) doxygen will only warn about
526 # wrong or incomplete parameter documentation, but not about the absence of
529 WARN_NO_PARAMDOC = NO
531 # The WARN_FORMAT tag determines the format of the warning messages that
532 # doxygen can produce. The string should contain the $file, $line, and $text
533 # tags, which will be replaced by the file and line number from which the
534 # warning originated and the warning text. Optionally the format may contain
535 # $version, which will be replaced by the version of the file (if it could
536 # be obtained via FILE_VERSION_FILTER)
538 WARN_FORMAT = "$file:$line: $text "
540 # The WARN_LOGFILE tag can be used to specify a file to which warning
541 # and error messages should be written. If left blank the output is written
546 #---------------------------------------------------------------------------
547 # configuration options related to the input files
548 #---------------------------------------------------------------------------
550 # The INPUT tag can be used to specify the files and/or directories that contain
551 # documented source files. You may enter file names like "myfile.cpp" or
552 # directories like "/usr/src/myproject". Separate the files or directories
557 # This tag can be used to specify the character encoding of the source files
558 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
559 # also the default input encoding. Doxygen uses libiconv (or the iconv built
560 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
561 # the list of possible encodings.
563 INPUT_ENCODING = UTF-8
565 # If the value of the INPUT tag contains directories, you can use the
566 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
567 # and *.h) to filter out the source-files in the directories. If left
568 # blank the following patterns are tested:
569 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
570 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
572 FILE_PATTERNS = *.h \
575 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
576 # should be searched for input files as well. Possible values are YES and NO.
577 # If left blank NO is used.
581 # The EXCLUDE tag can be used to specify files and/or directories that should
582 # excluded from the INPUT source files. This way you can easily exclude a
583 # subdirectory from a directory tree whose root is specified with the INPUT tag.
585 EXCLUDE = @abs_top_builddir@/docs/doxygen/html \
586 @abs_top_builddir@/docs/doxygen/xml \
587 @abs_top_builddir@/docs/doxygen/xml-swig \
588 @abs_top_builddir@/docs/doxygen/other/doxypy.py \
589 @abs_top_builddir@/dtools \
590 @abs_top_builddir@/gcell/ibm \
591 @abs_top_builddir@/gnuradio-core/src/lib/bug_work_around_6.cc \
592 @abs_top_builddir@/gnuradio-core/src/lib/filter/assembly.h \
593 @abs_top_builddir@/gnuradio-core/src/lib/filter/generate_all.py \
594 @abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_XXX.py \
595 @abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_filter_XXX.py \
596 @abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_sysconfig.py \
597 @abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_sysconfig_generic.py \
598 @abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_util.py \
599 @abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_freq_xlating_fir_filter_XXX.py \
600 @abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_interp_fir_filter_XXX.py \
601 @abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_rational_resampler_base_XXX.py \
602 @abs_top_builddir@/gnuradio-core/src/lib/filter/generate_utils.py \
603 @abs_top_builddir@/gnuradio-core/src/lib/filter/gr_altivec.h \
604 @abs_top_builddir@/gnuradio-core/src/lib/filter/sse_debug.h \
605 @abs_top_builddir@/gnuradio-core/src/lib/gengen/generate_all.py \
606 @abs_top_builddir@/gnuradio-core/src/lib/gengen/generate_common.py \
607 @abs_top_builddir@/gnuradio-core/src/lib/missing/bug_work_around_8.cc \
608 @abs_top_builddir@/gnuradio-core/src/lib/missing/getopt.h \
609 @abs_top_builddir@/gnuradio-core/src/lib/runtime/gr_error_handler.cc \
610 @abs_top_builddir@/gnuradio-core/src/lib/swig \
611 @abs_top_builddir@/gnuradio-core/src/python/bin \
612 @abs_top_builddir@/gnuradio-core/src/python/build_utils.py \
613 @abs_top_builddir@/gnuradio-core/src/python/build_utils_codes.py \
614 @abs_top_builddir@/gnuradio-core/src/python/gnuradio/gr/gr_threading.py \
615 @abs_top_builddir@/gnuradio-core/src/python/gnuradio/gr/gr_threading_23.py \
616 @abs_top_builddir@/gnuradio-core/src/python/gnuradio/gr/gr_threading_24.py \
617 @abs_top_builddir@/gnuradio-core/src/tests \
618 @abs_top_builddir@/gnuradio-core/src/utils \
619 @abs_top_builddir@/gnuradio-examples/python/apps/hf_radio/output.py \
620 @abs_top_builddir@/gnuradio-examples/python/apps/hf_radio/ui.py \
621 @abs_top_builddir@/gr-atsc/src/lib/atsc.cc \
622 @abs_top_builddir@/gr-atsc/src/lib/atsc.py \
623 @abs_top_builddir@/gr-atsc/src/lib/gen_encoder.py \
624 @abs_top_builddir@/gr-atsc/src/python \
625 @abs_top_builddir@/gr-atsc/src/python \
626 @abs_top_builddir@/gr-audio-alsa/src/audio-alsa.py \
627 @abs_top_builddir@/gr-audio-oss/src/audio_oss.py \
628 @abs_top_builddir@/gr-audio-osx/src/test_audio_loop.py \
629 @abs_top_builddir@/gr-cvsd-vocoder/src/lib/cvsd_vocoder.py \
630 @abs_top_builddir@/gr-cvsd-vocoder/src/python/encdec.py \
631 @abs_top_builddir@/gr-gsm-fr-vocoder/src/lib/gsm \
632 @abs_top_builddir@/gr-gsm-fr-vocoder/src/lib/gsm_full_rate.py \
633 @abs_top_builddir@/gr-gsm-fr-vocoder/src/python/encdec.py \
634 @abs_top_builddir@/gr-howto-write-a-block \
635 @abs_top_builddir@/gr-msdd6000/src/msdd.py \
636 @abs_top_builddir@/gr-pager/src/pager_swig.py \
637 @abs_top_builddir@/gr-qtgui \
638 @abs_top_builddir@/gr-radar-mono/src/python/usrp_radar_mono.py \
639 @abs_top_builddir@/gr-radio-astronomy/src/lib/ra.py \
640 @abs_top_builddir@/gr-radio-astronomy/src/python \
641 @abs_top_builddir@/gr-sounder/src/python/usrp_sounder.py \
642 @abs_top_builddir@/gr-trellis/doc \
643 @abs_top_builddir@/gr-trellis/src/lib/generate_all.py \
644 @abs_top_builddir@/gr-trellis/src/lib/generate_trellis.py \
645 @abs_top_builddir@/gr-trellis/src/lib/trellis.py \
646 @abs_top_builddir@/gr-usrp/src/usrp1.py \
647 @abs_top_builddir@/gr-usrp2/src/usrp2.py \
648 @abs_top_builddir@/gr-video-sdl/src/video_sdl.py \
649 @abs_top_builddir@/gr-wxgui/src/python \
650 @abs_top_builddir@/grc \
651 @abs_top_builddir@/usrp/doc \
652 @abs_top_builddir@/usrp/firmware \
653 @abs_top_builddir@/usrp/fpga \
654 @abs_top_builddir@/usrp/host/apps \
655 @abs_top_builddir@/usrp/host/apps-inband \
656 @abs_top_builddir@/usrp/host/lib/inband \
657 @abs_top_builddir@/usrp/host/lib/legacy/ad9862.h \
658 @abs_top_builddir@/usrp/host/lib/legacy/check_data.py \
659 @abs_top_builddir@/usrp/host/lib/legacy/circular_buffer.h \
660 @abs_top_builddir@/usrp/host/lib/legacy/circular_linked_list.h \
661 @abs_top_builddir@/usrp/host/lib/legacy/db_wbx.h \
662 @abs_top_builddir@/usrp/host/lib/legacy/db_wbx.cc \
663 @abs_top_builddir@/usrp/host/lib/legacy/dump_data.py \
664 @abs_top_builddir@/usrp/host/lib/legacy/gen_usrp_dbid.py \
665 @abs_top_builddir@/usrp/host/lib/legacy/usrp_dbid.py \
666 @abs_top_builddir@/usrp/host/misc \
667 @abs_top_builddir@/usrp/host/swig \
668 @abs_top_builddir@/usrp2/firmware \
669 @abs_top_builddir@/usrp2/fpga
671 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
672 # directories that are symbolic links (a Unix filesystem feature) are excluded
675 EXCLUDE_SYMLINKS = NO
677 # If the value of the INPUT tag contains directories, you can use the
678 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
679 # certain files from those directories. Note that the wildcards are matched
680 # against the file with absolute path, so to exclude all test directories
681 # for example use the pattern */test/*
683 EXCLUDE_PATTERNS = */.deps/* \
688 */gr-atsc/src/lib/Gr* \
694 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
695 # (namespaces, classes, functions, etc.) that should be excluded from the
696 # output. The symbol name can be a fully qualified name, a word, or if the
697 # wildcard * is used, a substring. Examples: ANamespace, AClass,
698 # AClass::ANamespace, ANamespace::*Test
700 EXCLUDE_SYMBOLS = ad9862 \
709 *_queue_watcher_thread* \
722 # The EXAMPLE_PATH tag can be used to specify one or more files or
723 # directories that contain example code fragments that are included (see
724 # the \include command).
728 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
729 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
730 # and *.h) to filter out the source-files in the directories. If left
731 # blank all files are included.
735 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
736 # searched for input files to be used with the \include or \dontinclude
737 # commands irrespective of the value of the RECURSIVE tag.
738 # Possible values are YES and NO. If left blank NO is used.
740 EXAMPLE_RECURSIVE = NO
742 # The IMAGE_PATH tag can be used to specify one or more files or
743 # directories that contain image that are included in the documentation (see
744 # the \image command).
748 # The INPUT_FILTER tag can be used to specify a program that doxygen should
749 # invoke to filter for each input file. Doxygen will invoke the filter program
750 # by executing (via popen()) the command <filter> <input-file>, where <filter>
751 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
752 # input file. Doxygen will then use the output that the filter program writes
753 # to standard output. If FILTER_PATTERNS is specified, this tag will be
758 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
759 # basis. Doxygen will compare the file name with each pattern and apply the
760 # filter if there is a match. The filters are a list of the form:
761 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
762 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
763 # is applied to all files.
765 FILTER_PATTERNS = *.py=@top_srcdir@/gnuradio-core/doc/other/doxypy.py
767 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
768 # INPUT_FILTER) will be used to filter the input files when producing source
769 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
771 FILTER_SOURCE_FILES = NO
773 #---------------------------------------------------------------------------
774 # configuration options related to source browsing
775 #---------------------------------------------------------------------------
777 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
778 # be generated. Documented entities will be cross-referenced with these sources.
779 # Note: To get rid of all source code in the generated output, make sure also
780 # VERBATIM_HEADERS is set to NO.
784 # Setting the INLINE_SOURCES tag to YES will include the body
785 # of functions and classes directly in the documentation.
789 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
790 # doxygen to hide any special comment blocks from generated source code
791 # fragments. Normal C and C++ comments will always remain visible.
793 STRIP_CODE_COMMENTS = NO
795 # If the REFERENCED_BY_RELATION tag is set to YES
796 # then for each documented function all documented
797 # functions referencing it will be listed.
799 REFERENCED_BY_RELATION = YES
801 # If the REFERENCES_RELATION tag is set to YES
802 # then for each documented function all documented entities
803 # called/used by that function will be listed.
805 REFERENCES_RELATION = YES
807 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
808 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
809 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
810 # link to the source code. Otherwise they will link to the documentstion.
812 REFERENCES_LINK_SOURCE = YES
814 # If the USE_HTAGS tag is set to YES then the references to source code
815 # will point to the HTML generated by the htags(1) tool instead of doxygen
816 # built-in source browser. The htags tool is part of GNU's global source
817 # tagging system (see http://www.gnu.org/software/global/global.html). You
818 # will need version 4.8.6 or higher.
822 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
823 # will generate a verbatim copy of the header file for each class for
824 # which an include is specified. Set to NO to disable this.
826 VERBATIM_HEADERS = YES
828 #---------------------------------------------------------------------------
829 # configuration options related to the alphabetical class index
830 #---------------------------------------------------------------------------
832 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
833 # of all compounds will be generated. Enable this if the project
834 # contains a lot of classes, structs, unions or interfaces.
836 ALPHABETICAL_INDEX = YES
838 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
839 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
840 # in which this list will be split (can be a number in the range [1..20])
842 COLS_IN_ALPHA_INDEX = 5
844 # In case all classes in a project start with a common prefix, all
845 # classes will be put under the same header in the alphabetical index.
846 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
847 # should be ignored while generating the index headers.
851 #---------------------------------------------------------------------------
852 # configuration options related to the HTML output
853 #---------------------------------------------------------------------------
855 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
856 # generate HTML output.
858 GENERATE_HTML = @enable_html_docs@
860 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
861 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
862 # put in front of it. If left blank `html' will be used as the default path.
866 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
867 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
868 # doxygen will generate files with .html extension.
870 HTML_FILE_EXTENSION = .html
872 # The HTML_HEADER tag can be used to specify a personal HTML header for
873 # each generated HTML page. If it is left blank doxygen will generate a
878 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
879 # each generated HTML page. If it is left blank doxygen will generate a
884 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
885 # style sheet that is used by each HTML page. It can be used to
886 # fine-tune the look of the HTML output. If the tag is left blank doxygen
887 # will generate a default style sheet. Note that doxygen will try to copy
888 # the style sheet file to the HTML output directory, so don't put your own
889 # stylesheet in the HTML output directory as well, or it will be erased!
893 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
894 # files or namespaces will be aligned in HTML using tables. If set to
895 # NO a bullet list will be used.
897 HTML_ALIGN_MEMBERS = YES
899 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
900 # documentation will contain sections that can be hidden and shown after the
901 # page has loaded. For this to work a browser that supports
902 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
903 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
905 HTML_DYNAMIC_SECTIONS = NO
907 # If the GENERATE_DOCSET tag is set to YES, additional index files
908 # will be generated that can be used as input for Apple's Xcode 3
909 # integrated development environment, introduced with OSX 10.5 (Leopard).
910 # To create a documentation set, doxygen will generate a Makefile in the
911 # HTML output directory. Running make will produce the docset in that
912 # directory and running "make install" will install the docset in
913 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
915 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
919 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
920 # feed. A documentation feed provides an umbrella under which multiple
921 # documentation sets from a single provider (such as a company or product suite)
924 DOCSET_FEEDNAME = "Doxygen generated docs"
926 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
927 # should uniquely identify the documentation set bundle. This should be a
928 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
929 # will append .docset to the name.
931 DOCSET_BUNDLE_ID = org.doxygen.Project
933 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
934 # will be generated that can be used as input for tools like the
935 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
936 # of the generated HTML documentation.
938 GENERATE_HTMLHELP = NO
940 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
941 # be used to specify the file name of the resulting .chm file. You
942 # can add a path in front of the file if the result should not be
943 # written to the html output directory.
947 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
948 # be used to specify the location (absolute path including file name) of
949 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
950 # the HTML help compiler on the generated index.hhp.
954 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
955 # controls if a separate .chi index file is generated (YES) or that
956 # it should be included in the master .chm file (NO).
960 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
961 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
966 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
967 # controls whether a binary table of contents is generated (YES) or a
968 # normal table of contents (NO) in the .chm file.
972 # The TOC_EXPAND flag can be set to YES to add extra items for group members
973 # to the contents of the HTML help documentation and to the tree view.
977 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
978 # are set, an additional index file will be generated that can be used as input for
979 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
980 # HTML documentation.
984 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
985 # be used to specify the file name of the resulting .qch file.
986 # The path specified is relative to the HTML output folder.
990 # The QHP_NAMESPACE tag specifies the namespace to use when generating
991 # Qt Help Project output. For more information please see
992 # <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.
994 QHP_NAMESPACE = org.doxygen.Project
996 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
997 # Qt Help Project output. For more information please see
998 # <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.
1000 QHP_VIRTUAL_FOLDER = doc
1002 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1003 # be used to specify the location of Qt's qhelpgenerator.
1004 # If non-empty doxygen will try to run qhelpgenerator on the generated
1009 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1010 # top of each HTML page. The value NO (the default) enables the index and
1011 # the value YES disables it.
1015 # This tag can be used to set the number of enum values (range [1..20])
1016 # that doxygen will group on one line in the generated HTML documentation.
1018 ENUM_VALUES_PER_LINE = 4
1020 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1021 # structure should be generated to display hierarchical information.
1022 # If the tag value is set to FRAME, a side panel will be generated
1023 # containing a tree-like index structure (just like the one that
1024 # is generated for HTML Help). For this to work a browser that supports
1025 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
1026 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
1027 # probably better off using the HTML help feature. Other possible values
1028 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
1029 # and Class Hierarchy pages using a tree view instead of an ordered list;
1030 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
1031 # disables this behavior completely. For backwards compatibility with previous
1032 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
1035 GENERATE_TREEVIEW = YES
1037 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1038 # used to set the initial width (in pixels) of the frame in which the tree
1041 TREEVIEW_WIDTH = 180
1043 # Use this tag to change the font size of Latex formulas included
1044 # as images in the HTML documentation. The default is 10. Note that
1045 # when you change the font size after a successful doxygen run you need
1046 # to manually remove any form_*.png images from the HTML output directory
1047 # to force them to be regenerated.
1049 FORMULA_FONTSIZE = 10
1051 #---------------------------------------------------------------------------
1052 # configuration options related to the LaTeX output
1053 #---------------------------------------------------------------------------
1055 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1056 # generate Latex output.
1058 GENERATE_LATEX = @enable_latex_docs@
1060 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1061 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1062 # put in front of it. If left blank `latex' will be used as the default path.
1064 LATEX_OUTPUT = latex
1066 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1067 # invoked. If left blank `latex' will be used as the default command name.
1069 LATEX_CMD_NAME = latex
1071 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1072 # generate index for LaTeX. If left blank `makeindex' will be used as the
1073 # default command name.
1075 MAKEINDEX_CMD_NAME = makeindex
1077 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1078 # LaTeX documents. This may be useful for small projects and may help to
1079 # save some trees in general.
1083 # The PAPER_TYPE tag can be used to set the paper type that is used
1084 # by the printer. Possible values are: a4, a4wide, letter, legal and
1085 # executive. If left blank a4wide will be used.
1089 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1090 # packages that should be included in the LaTeX output.
1094 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1095 # the generated latex document. The header should contain everything until
1096 # the first chapter. If it is left blank doxygen will generate a
1097 # standard header. Notice: only use this tag if you know what you are doing!
1101 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1102 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1103 # contain links (just like the HTML output) instead of page references
1104 # This makes the output suitable for online browsing using a pdf viewer.
1106 PDF_HYPERLINKS = YES
1108 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1109 # plain latex in the generated Makefile. Set this option to YES to get a
1110 # higher quality PDF documentation.
1114 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1115 # command to the generated LaTeX files. This will instruct LaTeX to keep
1116 # running if errors occur, instead of asking the user for help.
1117 # This option is also used when generating formulas in HTML.
1119 LATEX_BATCHMODE = NO
1121 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1122 # include the index chapters (such as File Index, Compound Index, etc.)
1125 LATEX_HIDE_INDICES = NO
1127 #---------------------------------------------------------------------------
1128 # configuration options related to the RTF output
1129 #---------------------------------------------------------------------------
1131 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1132 # The RTF output is optimized for Word 97 and may not look very pretty with
1133 # other RTF readers or editors.
1137 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1138 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1139 # put in front of it. If left blank `rtf' will be used as the default path.
1143 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1144 # RTF documents. This may be useful for small projects and may help to
1145 # save some trees in general.
1149 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1150 # will contain hyperlink fields. The RTF file will
1151 # contain links (just like the HTML output) instead of page references.
1152 # This makes the output suitable for online browsing using WORD or other
1153 # programs which support those fields.
1154 # Note: wordpad (write) and others do not support links.
1158 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1159 # config file, i.e. a series of assignments. You only have to provide
1160 # replacements, missing definitions are set to their default value.
1162 RTF_STYLESHEET_FILE =
1164 # Set optional variables used in the generation of an rtf document.
1165 # Syntax is similar to doxygen's config file.
1167 RTF_EXTENSIONS_FILE =
1169 #---------------------------------------------------------------------------
1170 # configuration options related to the man page output
1171 #---------------------------------------------------------------------------
1173 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1174 # generate man pages
1178 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1179 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1180 # put in front of it. If left blank `man' will be used as the default path.
1184 # The MAN_EXTENSION tag determines the extension that is added to
1185 # the generated man pages (default is the subroutine's section .3)
1189 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1190 # then it will generate one additional man file for each entity
1191 # documented in the real man page(s). These additional files
1192 # only source the real man page, but without them the man command
1193 # would be unable to find the correct page. The default is NO.
1197 #---------------------------------------------------------------------------
1198 # configuration options related to the XML output
1199 #---------------------------------------------------------------------------
1201 # If the GENERATE_XML tag is set to YES Doxygen will
1202 # generate an XML file that captures the structure of
1203 # the code including all documentation.
1205 GENERATE_XML = @enable_xml_docs@
1207 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1208 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1209 # put in front of it. If left blank `xml' will be used as the default path.
1213 # The XML_SCHEMA tag can be used to specify an XML schema,
1214 # which can be used by a validating XML parser to check the
1215 # syntax of the XML files.
1219 # The XML_DTD tag can be used to specify an XML DTD,
1220 # which can be used by a validating XML parser to check the
1221 # syntax of the XML files.
1225 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1226 # dump the program listings (including syntax highlighting
1227 # and cross-referencing information) to the XML output. Note that
1228 # enabling this will significantly increase the size of the XML output.
1230 XML_PROGRAMLISTING = NO
1232 #---------------------------------------------------------------------------
1233 # configuration options for the AutoGen Definitions output
1234 #---------------------------------------------------------------------------
1236 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1237 # generate an AutoGen Definitions (see autogen.sf.net) file
1238 # that captures the structure of the code including all
1239 # documentation. Note that this feature is still experimental
1240 # and incomplete at the moment.
1242 GENERATE_AUTOGEN_DEF = NO
1244 #---------------------------------------------------------------------------
1245 # configuration options related to the Perl module output
1246 #---------------------------------------------------------------------------
1248 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1249 # generate a Perl module file that captures the structure of
1250 # the code including all documentation. Note that this
1251 # feature is still experimental and incomplete at the
1254 GENERATE_PERLMOD = NO
1256 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1257 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1258 # to generate PDF and DVI output from the Perl module output.
1262 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1263 # nicely formatted so it can be parsed by a human reader. This is useful
1264 # if you want to understand what is going on. On the other hand, if this
1265 # tag is set to NO the size of the Perl module output will be much smaller
1266 # and Perl will parse it just the same.
1268 PERLMOD_PRETTY = YES
1270 # The names of the make variables in the generated doxyrules.make file
1271 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1272 # This is useful so different doxyrules.make files included by the same
1273 # Makefile don't overwrite each other's variables.
1275 PERLMOD_MAKEVAR_PREFIX =
1277 #---------------------------------------------------------------------------
1278 # Configuration options related to the preprocessor
1279 #---------------------------------------------------------------------------
1281 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1282 # evaluate all C-preprocessor directives found in the sources and include
1285 ENABLE_PREPROCESSING = YES
1287 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1288 # names in the source code. If set to NO (the default) only conditional
1289 # compilation will be performed. Macro expansion can be done in a controlled
1290 # way by setting EXPAND_ONLY_PREDEF to YES.
1292 MACRO_EXPANSION = NO
1294 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1295 # then the macro expansion is limited to the macros specified with the
1296 # PREDEFINED and EXPAND_AS_DEFINED tags.
1298 EXPAND_ONLY_PREDEF = NO
1300 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1301 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1303 SEARCH_INCLUDES = YES
1305 # The INCLUDE_PATH tag can be used to specify one or more directories that
1306 # contain include files that are not input files but should be processed by
1311 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1312 # patterns (like *.h and *.hpp) to filter out the header-files in the
1313 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1316 INCLUDE_FILE_PATTERNS =
1318 # The PREDEFINED tag can be used to specify one or more macro names that
1319 # are defined before the preprocessor is started (similar to the -D option of
1320 # gcc). The argument of the tag is a list of macros of the form: name
1321 # or name=definition (no spaces). If the definition and the = are
1322 # omitted =1 is assumed. To prevent a macro definition from being
1323 # undefined via #undef or recursively expanded use the := operator
1324 # instead of the = operator.
1328 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1329 # this tag can be used to specify a list of macro names that should be expanded.
1330 # The macro definition that is found in the sources will be used.
1331 # Use the PREDEFINED tag if you want to use a different macro definition.
1335 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1336 # doxygen's preprocessor will remove all function-like macros that are alone
1337 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1338 # function macros are typically used for boiler-plate code, and will confuse
1339 # the parser if not removed.
1341 SKIP_FUNCTION_MACROS = YES
1343 #---------------------------------------------------------------------------
1344 # Configuration::additions related to external references
1345 #---------------------------------------------------------------------------
1347 # The TAGFILES option can be used to specify one or more tagfiles.
1348 # Optionally an initial location of the external documentation
1349 # can be added for each tagfile. The format of a tag file without
1350 # this location is as follows:
1351 # TAGFILES = file1 file2 ...
1352 # Adding location for the tag files is done as follows:
1353 # TAGFILES = file1=loc1 "file2 = loc2" ...
1354 # where "loc1" and "loc2" can be relative or absolute paths or
1355 # URLs. If a location is present for each tag, the installdox tool
1356 # does not have to be run to correct the links.
1357 # Note that each tag file must have a unique name
1358 # (where the name does NOT include the path)
1359 # If a tag file is not located in the directory in which doxygen
1360 # is run, you must also specify the path to the tagfile here.
1364 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1365 # a tag file that is based on the input files it reads.
1369 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1370 # in the class index. If set to NO only the inherited external classes
1375 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1376 # in the modules index. If set to NO, only the current project's groups will
1379 EXTERNAL_GROUPS = YES
1381 # The PERL_PATH should be the absolute path and name of the perl script
1382 # interpreter (i.e. the result of `which perl').
1384 PERL_PATH = /usr/bin/perl
1386 #---------------------------------------------------------------------------
1387 # Configuration options related to the dot tool
1388 #---------------------------------------------------------------------------
1390 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1391 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1392 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1393 # this option is superseded by the HAVE_DOT option below. This is only a
1394 # fallback. It is recommended to install and use dot, since it yields more
1397 CLASS_DIAGRAMS = YES
1399 # You can define message sequence charts within doxygen comments using the \msc
1400 # command. Doxygen will then run the mscgen tool (see
1401 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1402 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1403 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1404 # default search path.
1408 # If set to YES, the inheritance and collaboration graphs will hide
1409 # inheritance and usage relations if the target is undocumented
1410 # or is not a class.
1412 HIDE_UNDOC_RELATIONS = YES
1414 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1415 # available from the path. This tool is part of Graphviz, a graph visualization
1416 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1417 # have no effect if this option is set to NO (the default)
1419 HAVE_DOT = @HAVE_DOT@
1421 # By default doxygen will write a font called FreeSans.ttf to the output
1422 # directory and reference it in all dot files that doxygen generates. This
1423 # font does not include all possible unicode characters however, so when you need
1424 # these (or just want a differently looking font) you can specify the font name
1425 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1426 # which can be done by putting it in a standard location or by setting the
1427 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1428 # containing the font.
1430 DOT_FONTNAME = FreeSans
1432 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1433 # The default size is 10pt.
1437 # By default doxygen will tell dot to use the output directory to look for the
1438 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1439 # different font using DOT_FONTNAME you can set the path where dot
1440 # can find it using this tag.
1444 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1445 # will generate a graph for each documented class showing the direct and
1446 # indirect inheritance relations. Setting this tag to YES will force the
1447 # the CLASS_DIAGRAMS tag to NO.
1451 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1452 # will generate a graph for each documented class showing the direct and
1453 # indirect implementation dependencies (inheritance, containment, and
1454 # class references variables) of the class with other documented classes.
1456 COLLABORATION_GRAPH = NO
1458 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1459 # will generate a graph for groups, showing the direct groups dependencies
1463 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1464 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1469 # If set to YES, the inheritance and collaboration graphs will show the
1470 # relations between templates and their instances.
1472 TEMPLATE_RELATIONS = NO
1474 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1475 # tags are set to YES then doxygen will generate a graph for each documented
1476 # file showing the direct and indirect include dependencies of the file with
1477 # other documented files.
1481 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1482 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1483 # documented header file showing the documented files that directly or
1484 # indirectly include this file.
1486 INCLUDED_BY_GRAPH = YES
1488 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1489 # doxygen will generate a call dependency graph for every global function
1490 # or class method. Note that enabling this option will significantly increase
1491 # the time of a run. So in most cases it will be better to enable call graphs
1492 # for selected functions only using the \callgraph command.
1496 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1497 # doxygen will generate a caller dependency graph for every global function
1498 # or class method. Note that enabling this option will significantly increase
1499 # the time of a run. So in most cases it will be better to enable caller
1500 # graphs for selected functions only using the \callergraph command.
1504 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1505 # will graphical hierarchy of all classes instead of a textual one.
1507 GRAPHICAL_HIERARCHY = YES
1509 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1510 # then doxygen will show the dependencies a directory has on other directories
1511 # in a graphical way. The dependency relations are determined by the #include
1512 # relations between the files in the directories.
1514 DIRECTORY_GRAPH = YES
1516 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1517 # generated by dot. Possible values are png, jpg, or gif
1518 # If left blank png will be used.
1520 DOT_IMAGE_FORMAT = png
1522 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1523 # found. If left blank, it is assumed the dot tool can be found in the path.
1527 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1528 # contain dot files that are included in the documentation (see the
1529 # \dotfile command).
1533 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1534 # nodes that will be shown in the graph. If the number of nodes in a graph
1535 # becomes larger than this value, doxygen will truncate the graph, which is
1536 # visualized by representing a node as a red box. Note that doxygen if the
1537 # number of direct children of the root node in a graph is already larger than
1538 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1539 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1541 DOT_GRAPH_MAX_NODES = 50
1543 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1544 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1545 # from the root by following a path via at most 3 edges will be shown. Nodes
1546 # that lay further from the root node will be omitted. Note that setting this
1547 # option to 1 or 2 may greatly reduce the computation time needed for large
1548 # code bases. Also note that the size of a graph can be further restricted by
1549 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1551 MAX_DOT_GRAPH_DEPTH = 0
1553 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1554 # background. This is disabled by default, because dot on Windows does not
1555 # seem to support this out of the box. Warning: Depending on the platform used,
1556 # enabling this option may lead to badly anti-aliased labels on the edges of
1557 # a graph (i.e. they become hard to read).
1559 DOT_TRANSPARENT = NO
1561 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1562 # files in one run (i.e. multiple -o and -T options on the command line). This
1563 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1564 # support this, this feature is disabled by default.
1566 DOT_MULTI_TARGETS = YES
1568 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1569 # generate a legend page explaining the meaning of the various boxes and
1570 # arrows in the dot generated graphs.
1572 GENERATE_LEGEND = YES
1574 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1575 # remove the intermediate dot files that are used to generate
1576 # the various graphs.
1580 #---------------------------------------------------------------------------
1581 # Configuration::additions related to the search engine
1582 #---------------------------------------------------------------------------
1584 # The SEARCHENGINE tag specifies whether or not a search engine should be
1585 # used. If set to NO the values of all tags below this one will be ignored.