[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Commit-gnuradio] r11024 - gnuradio/branches/developers/eb/t367/docs/dox
|
From: |
eb |
|
Subject: |
[Commit-gnuradio] r11024 - gnuradio/branches/developers/eb/t367/docs/doxygen |
|
Date: |
Wed, 13 May 2009 20:18:09 -0600 (MDT) |
Author: eb
Date: 2009-05-13 20:18:06 -0600 (Wed, 13 May 2009)
New Revision: 11024
Modified:
gnuradio/branches/developers/eb/t367/docs/doxygen/Doxyfile.in
Log:
used doxygen -u to update Doxyfile.in (used doxygen 1.5.7.1)
Modified: gnuradio/branches/developers/eb/t367/docs/doxygen/Doxyfile.in
===================================================================
--- gnuradio/branches/developers/eb/t367/docs/doxygen/Doxyfile.in
2009-05-14 02:13:36 UTC (rev 11023)
+++ gnuradio/branches/developers/eb/t367/docs/doxygen/Doxyfile.in
2009-05-14 02:18:06 UTC (rev 11024)
@@ -1,4 +1,4 @@
-# Doxyfile 1.5.3
+# Doxyfile 1.5.7.1
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
@@ -14,11 +14,11 @@
# Project related configuration options
#---------------------------------------------------------------------------
-# This tag specifies the encoding used for all characters in the config file
that
-# follow. The default is UTF-8 which is also the encoding used for all text
before
-# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built
into
-# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the
list of
-# possible encodings.
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
DOXYFILE_ENCODING = UTF-8
@@ -54,10 +54,11 @@
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
-# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
-# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
-# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
-# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
+# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
+# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
+# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
+# Spanish, Swedish, and Ukrainian.
OUTPUT_LANGUAGE = English
@@ -154,13 +155,6 @@
MULTILINE_CPP_IS_BRIEF = YES
-# If the DETAILS_AT_TOP tag is set to YES then Doxygen
-# will output the detailed description near the top, like JavaDoc.
-# If set to NO, the detailed description appears after the member
-# documentation.
-
-DETAILS_AT_TOP = YES
-
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
# re-implements.
@@ -195,14 +189,26 @@
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
-# sources only. Doxygen will then generate output that is more tailored for
Java.
-# For instance, namespaces will be presented as packages, qualified scopes
-# will look different, etc.
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
OPTIMIZE_OUTPUT_JAVA = YES
-# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
to
-# include (a tag file for) the STL sources as input, then you should
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
# set this tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
v.s.
# func(std::string) {}). This also make the inheritance and collaboration
@@ -215,6 +221,21 @@
CPP_CLI_SUPPORT = NO
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
+# Doxygen will parse them like normal C++ but will assume all classes use
public
+# instead of private inheritance when no explicit protection keyword is
present.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate
getter
+# and setter methods for a property. Setting this option to YES (the default)
+# will make doxygen to replace the get and set methods by a property in the
+# documentation. This will only work if the methods are indeed getting or
+# setting a simple type. If this is not the case, or you want to show the
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT = YES
+
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
@@ -230,6 +251,32 @@
SUBGROUPING = YES
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a
file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all
compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is
+# probably good enough. For larger projects a too small cache size can cause
+# doxygen to be busy swapping symbols to and from disk most of the time
+# causing a significant performance penality.
+# If the system has enough physical memory increasing the cache will improve
the
+# performance by keeping more symbols in memory. Note that the value works on
+# a logarithmic scale so increasing the size by one will rougly double the
+# memory usage. The cache size is given by this formula:
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols
+
+SYMBOL_CACHE_SIZE = 0
+
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
@@ -264,10 +311,11 @@
EXTRACT_LOCAL_METHODS = YES
-# If this flag is set to YES, the members of anonymous namespaces will be
extracted
-# and appear in the documentation as a namespace called
'anonymous_namespace{file}',
-# where file will be replaced with the base name of the file that contains the
anonymous
-# namespace. By default anonymous namespace are hidden.
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base
+# name of the file that contains the anonymous namespace. By default
+# anonymous namespace are hidden.
EXTRACT_ANON_NSPACES = NO
@@ -346,6 +394,12 @@
SORT_BRIEF_DOCS = NO
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
+# hierarchy of group names into alphabetical order. If set to NO (the default)
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES = NO
+
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
# sorted by fully-qualified names, including namespaces. If set to
# NO (the default), the class list will be sorted only by class name,
@@ -407,9 +461,21 @@
SHOW_DIRECTORIES = YES
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page. This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES = YES
+
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
-# doxygen should invoke to get the current version for each file (typically
from the
-# version control system). Doxygen will invoke the program by executing (via
+# doxygen should invoke to get the current version for each file (typically
from
+# the version control system). Doxygen will invoke the program by executing
(via
# popen()) the command <command> <input-file>, where <command> is the value of
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
# provided by doxygen. Whatever the program writes to standard output
@@ -417,6 +483,15 @@
FILE_VERSION_FILTER =
+# The LAYOUT_FILE tag can be used to specify a layout file which will be
parsed by
+# doxygen. The layout file controls the global structure of the generated
output files
+# in an output format independent way. The create the layout file that
represents
+# doxygen's defaults, run doxygen with the -l option. You can optionally
specify a
+# file name after the option, if omitted DoxygenLayout.xml will be used as the
name
+# of the layout file.
+
+LAYOUT_FILE =
+
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
@@ -479,10 +554,11 @@
INPUT = @top_srcdir@
-# This tag can be used to specify the character encoding of the source files
that
-# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also
the default
-# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the
transcoding.
-# See http://www.gnu.org/software/libiconv for the list of possible encodings.
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
INPUT_ENCODING = UTF-8
@@ -491,11 +567,11 @@
# and *.h) to filter out the source-files in the directories. If left
# blank the following patterns are tested:
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
*.hxx
-# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
FILE_PATTERNS = *.h \
*.dox \
- *.cc
+ *.cc
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
@@ -507,100 +583,95 @@
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT
tag.
-# We split these by top_srcdir and top_builddir (this matters in a VPATH build)
+EXCLUDE = @abs_top_builddir@/docs \
+ @abs_top_builddir@/docs/doxygen/xml \
+ @abs_top_builddir@/docs/doxygen/xml-swig \
+ @abs_top_builddir@/dtools \
+ @abs_top_builddir@/gcell/ibm \
+ @abs_top_builddir@/gnuradio-core/doc/other/doxypy.py \
+
@abs_top_builddir@/gnuradio-core/doc/other/shared_ptr_docstub.h \
+
@abs_top_builddir@/gnuradio-core/doc/other/vector_docstub.h \
+
@abs_top_builddir@/gnuradio-core/src/lib/bug_work_around_6.cc \
+
@abs_top_builddir@/gnuradio-core/src/lib/filter/assembly.h \
+
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_all.py \
+
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_XXX.py \
+
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_filter_XXX.py \
+
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_sysconfig.py \
+
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_sysconfig_generic.py
\
+
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_util.py \
+
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_freq_xlating_fir_filter_XXX.py
\
+
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_interp_fir_filter_XXX.py
\
+
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_rational_resampler_base_XXX.py
\
+
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_utils.py \
+
@abs_top_builddir@/gnuradio-core/src/lib/filter/gr_altivec.h \
+
@abs_top_builddir@/gnuradio-core/src/lib/filter/sse_debug.h \
+
@abs_top_builddir@/gnuradio-core/src/lib/gengen/generate_all.py \
+
@abs_top_builddir@/gnuradio-core/src/lib/gengen/generate_common.py \
+
@abs_top_builddir@/gnuradio-core/src/lib/missing/bug_work_around_8.cc \
+
@abs_top_builddir@/gnuradio-core/src/lib/missing/getopt.h \
+
@abs_top_builddir@/gnuradio-core/src/lib/runtime/gr_error_handler.cc \
+ @abs_top_builddir@/gnuradio-core/src/lib/swig \
+ @abs_top_builddir@/gnuradio-core/src/python/bin \
+
@abs_top_builddir@/gnuradio-core/src/python/build_utils.py \
+
@abs_top_builddir@/gnuradio-core/src/python/build_utils_codes.py \
+
@abs_top_builddir@/gnuradio-core/src/python/gnuradio/gr/gr_threading.py \
+
@abs_top_builddir@/gnuradio-core/src/python/gnuradio/gr/gr_threading_23.py \
+
@abs_top_builddir@/gnuradio-core/src/python/gnuradio/gr/gr_threading_24.py \
+ @abs_top_builddir@/gnuradio-core/src/tests \
+ @abs_top_builddir@/gnuradio-core/src/utils \
+
@abs_top_builddir@/gnuradio-examples/python/apps/hf_radio/output.py \
+
@abs_top_builddir@/gnuradio-examples/python/apps/hf_radio/ui.py \
+ @abs_top_builddir@/gr-atsc/src/lib/atsc.cc \
+ @abs_top_builddir@/gr-atsc/src/lib/atsc.py \
+ @abs_top_builddir@/gr-atsc/src/lib/gen_encoder.py \
+ @abs_top_builddir@/gr-atsc/src/python \
+ @abs_top_builddir@/gr-atsc/src/python \
+ @abs_top_builddir@/gr-audio-alsa/src/audio-alsa.py \
+ @abs_top_builddir@/gr-audio-oss/src/audio_oss.py \
+
@abs_top_builddir@/gr-audio-osx/src/test_audio_loop.py \
+
@abs_top_builddir@/gr-cvsd-vocoder/src/lib/cvsd_vocoder.py \
+
@abs_top_builddir@/gr-cvsd-vocoder/src/python/encdec.py \
+ @abs_top_builddir@/gr-gsm-fr-vocoder/src/lib/gsm \
+
@abs_top_builddir@/gr-gsm-fr-vocoder/src/lib/gsm_full_rate.py \
+
@abs_top_builddir@/gr-gsm-fr-vocoder/src/python/encdec.py \
+ @abs_top_builddir@/gr-howto-write-a-block \
+ @abs_top_builddir@/gr-msdd6000/src/msdd.py \
+ @abs_top_builddir@/gr-pager/src/pager_swig.py \
+ @abs_top_builddir@/gr-qtgui \
+
@abs_top_builddir@/gr-radar-mono/src/python/usrp_radar_mono.py \
+ @abs_top_builddir@/gr-radio-astronomy/src/lib/ra.py \
+ @abs_top_builddir@/gr-radio-astronomy/src/python \
+
@abs_top_builddir@/gr-sounder/src/python/usrp_sounder.py \
+ @abs_top_builddir@/gr-trellis/doc \
+ @abs_top_builddir@/gr-trellis/src/lib/generate_all.py
\
+
@abs_top_builddir@/gr-trellis/src/lib/generate_trellis.py \
+ @abs_top_builddir@/gr-trellis/src/lib/trellis.py \
+ @abs_top_builddir@/gr-usrp/src/usrp1.py \
+ @abs_top_builddir@/gr-usrp2/src/usrp2.py \
+ @abs_top_builddir@/gr-video-sdl/src/video_sdl.py \
+ @abs_top_builddir@/gr-wxgui/src/python \
+ @abs_top_builddir@/grc \
+ @abs_top_builddir@/omnithread/mach.cc \
+ @abs_top_builddir@/omnithread/nt.cc \
+ @abs_top_builddir@/usrp/doc \
+ @abs_top_builddir@/usrp/firmware \
+ @abs_top_builddir@/usrp/fpga \
+ @abs_top_builddir@/usrp/host/apps \
+ @abs_top_builddir@/usrp/host/apps-inband \
+ @abs_top_builddir@/usrp/host/lib/inband \
+ @abs_top_builddir@/usrp/host/lib/legacy/ad9862.h \
+ @abs_top_builddir@/usrp/host/lib/legacy/check_data.py
\
+
@abs_top_builddir@/usrp/host/lib/legacy/circular_buffer.h \
+
@abs_top_builddir@/usrp/host/lib/legacy/circular_linked_list.h \
+ @abs_top_builddir@/usrp/host/lib/legacy/db_wbx.h \
+ @abs_top_builddir@/usrp/host/lib/legacy/dump_data.py \
+
@abs_top_builddir@/usrp/host/lib/legacy/gen_usrp_dbid.py \
+ @abs_top_builddir@/usrp/host/lib/legacy/usrp_dbid.py \
+ @abs_top_builddir@/usrp/host/misc \
+ @abs_top_builddir@/usrp/host/swig \
+ @abs_top_builddir@/usrp2/firmware \
+ @abs_top_builddir@/usrp2/fpga
-EXCLUDE = \
- @abs_top_builddir@/docs \
- @abs_top_builddir@/docs/doxygen/xml \
- @abs_top_builddir@/docs/doxygen/xml-swig \
- @abs_top_builddir@/dtools \
- @abs_top_builddir@/gcell/ibm \
- @abs_top_builddir@/gnuradio-core/doc/other/doxypy.py \
- @abs_top_builddir@/gnuradio-core/doc/other/shared_ptr_docstub.h \
- @abs_top_builddir@/gnuradio-core/doc/other/vector_docstub.h \
- @abs_top_builddir@/gnuradio-core/src/lib/bug_work_around_6.cc \
- @abs_top_builddir@/gnuradio-core/src/lib/filter/assembly.h \
- @abs_top_builddir@/gnuradio-core/src/lib/filter/generate_all.py \
- @abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_XXX.py \
-
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_filter_XXX.py \
-
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_sysconfig.py \
-
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_sysconfig_generic.py
\
- @abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_fir_util.py
\
-
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_freq_xlating_fir_filter_XXX.py
\
-
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_interp_fir_filter_XXX.py
\
-
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_gr_rational_resampler_base_XXX.py
\
- @abs_top_builddir@/gnuradio-core/src/lib/filter/generate_utils.py \
- @abs_top_builddir@/gnuradio-core/src/lib/filter/gr_altivec.h \
- @abs_top_builddir@/gnuradio-core/src/lib/filter/sse_debug.h \
- @abs_top_builddir@/gnuradio-core/src/lib/gengen/generate_all.py \
- @abs_top_builddir@/gnuradio-core/src/lib/gengen/generate_common.py \
- @abs_top_builddir@/gnuradio-core/src/lib/missing/bug_work_around_8.cc \
- @abs_top_builddir@/gnuradio-core/src/lib/missing/getopt.h \
- @abs_top_builddir@/gnuradio-core/src/lib/runtime/gr_error_handler.cc \
- @abs_top_builddir@/gnuradio-core/src/lib/swig \
- @abs_top_builddir@/gnuradio-core/src/python/bin \
- @abs_top_builddir@/gnuradio-core/src/python/build_utils.py \
- @abs_top_builddir@/gnuradio-core/src/python/build_utils_codes.py \
- @abs_top_builddir@/gnuradio-core/src/python/gnuradio/gr/gr_threading.py
\
-
@abs_top_builddir@/gnuradio-core/src/python/gnuradio/gr/gr_threading_23.py \
-
@abs_top_builddir@/gnuradio-core/src/python/gnuradio/gr/gr_threading_24.py \
- @abs_top_builddir@/gnuradio-core/src/tests \
- @abs_top_builddir@/gnuradio-core/src/utils \
- @abs_top_builddir@/gnuradio-examples/python/apps/hf_radio/output.py \
- @abs_top_builddir@/gnuradio-examples/python/apps/hf_radio/ui.py \
- @abs_top_builddir@/gr-atsc/src/lib/atsc.cc \
- @abs_top_builddir@/gr-atsc/src/lib/atsc.py \
- @abs_top_builddir@/gr-atsc/src/lib/gen_encoder.py \
- @abs_top_builddir@/gr-atsc/src/python \
- @abs_top_builddir@/gr-atsc/src/python \
- @abs_top_builddir@/gr-audio-alsa/src/audio-alsa.py \
- @abs_top_builddir@/gr-audio-oss/src/audio_oss.py \
- @abs_top_builddir@/gr-audio-osx/src/test_audio_loop.py \
- @abs_top_builddir@/gr-cvsd-vocoder/src/lib/cvsd_vocoder.py \
- @abs_top_builddir@/gr-cvsd-vocoder/src/python/encdec.py \
- @abs_top_builddir@/gr-gsm-fr-vocoder/src/lib/gsm \
- @abs_top_builddir@/gr-gsm-fr-vocoder/src/lib/gsm_full_rate.py \
- @abs_top_builddir@/gr-gsm-fr-vocoder/src/python/encdec.py \
- @abs_top_builddir@/gr-howto-write-a-block \
- @abs_top_builddir@/gr-msdd6000/src/msdd.py \
- @abs_top_builddir@/gr-pager/src/pager_swig.py \
- @abs_top_builddir@/gr-qtgui \
- @abs_top_builddir@/gr-radar-mono/src/python/usrp_radar_mono.py \
- @abs_top_builddir@/gr-radio-astronomy/src/lib/ra.py \
- @abs_top_builddir@/gr-radio-astronomy/src/python \
- @abs_top_builddir@/gr-sounder/src/python/usrp_sounder.py \
- @abs_top_builddir@/gr-trellis/doc \
- @abs_top_builddir@/gr-trellis/src/lib/generate_all.py \
- @abs_top_builddir@/gr-trellis/src/lib/generate_trellis.py \
- @abs_top_builddir@/gr-trellis/src/lib/trellis.py \
- @abs_top_builddir@/gr-usrp/src/usrp1.py \
- @abs_top_builddir@/gr-usrp2/src/usrp2.py \
- @abs_top_builddir@/gr-video-sdl/src/video_sdl.py \
- @abs_top_builddir@/gr-wxgui/src/python \
- @abs_top_builddir@/grc \
- @abs_top_builddir@/omnithread/mach.cc \
- @abs_top_builddir@/omnithread/nt.cc \
- @abs_top_builddir@/usrp/doc \
- @abs_top_builddir@/usrp/firmware \
- @abs_top_builddir@/usrp/fpga \
- @abs_top_builddir@/usrp/host/apps \
- @abs_top_builddir@/usrp/host/apps-inband \
- @abs_top_builddir@/usrp/host/lib/inband \
- @abs_top_builddir@/usrp/host/lib/legacy/ad9862.h \
- @abs_top_builddir@/usrp/host/lib/legacy/check_data.py \
- @abs_top_builddir@/usrp/host/lib/legacy/circular_buffer.h \
- @abs_top_builddir@/usrp/host/lib/legacy/circular_linked_list.h \
- @abs_top_builddir@/usrp/host/lib/legacy/db_wbx.h \
- @abs_top_builddir@/usrp/host/lib/legacy/dump_data.py \
- @abs_top_builddir@/usrp/host/lib/legacy/gen_usrp_dbid.py \
- @abs_top_builddir@/usrp/host/lib/legacy/usrp_dbid.py \
- @abs_top_builddir@/usrp/host/misc \
- @abs_top_builddir@/usrp/host/swig \
- @abs_top_builddir@/usrp2/firmware \
- @abs_top_builddir@/usrp2/fpga
-
-
-
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
# from the input.
@@ -613,48 +684,45 @@
# against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/*
-EXCLUDE_PATTERNS = \
- */.deps/* \
- */.libs/* \
- */.svn/* \
- */CVS/* \
- */__init__.py \
- */gr-atsc/src/lib/Gr* \
- */moc_*.cc \
- */omnithread/ot_* \
- */qa_*.cc \
- */qa_*.h \
- */qa_*.py
+EXCLUDE_PATTERNS = */.deps/* \
+ */.libs/* \
+ */.svn/* \
+ */CVS/* \
+ */__init__.py \
+ */gr-atsc/src/lib/Gr* \
+ */moc_*.cc \
+ */omnithread/ot_* \
+ */qa_*.cc \
+ */qa_*.h \
+ */qa_*.py
-
-
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
-# (namespaces, classes, functions, etc.) that should be excluded from the
output.
-# The symbol name can be a fully qualified name, a word, or if the wildcard *
is used,
-# a substring. Examples: ANamespace, AClass, AClass::ANamespace,
ANamespace::*Test
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
EXCLUDE_SYMBOLS = ad9862 \
- numpy \
- usrpm \
- *swig* \
- *Swig* \
- *my_top_block* \
- *my_graph* \
- *app_top_block* \
- *am_rx_graph* \
- *_queue_watcher_thread* \
- *parse* \
- *MyFrame* \
- *MyApp* \
- *PyObject* \
- *wfm_rx_block* \
- *_sptr* \
- *debug* \
- *wfm_rx_sca_block* \
- *tv_rx_block* \
- *wxapt_rx_block* \
- *example_signal*
-
+ numpy \
+ usrpm \
+ *swig* \
+ *Swig* \
+ *my_top_block* \
+ *my_graph* \
+ *app_top_block* \
+ *am_rx_graph* \
+ *_queue_watcher_thread* \
+ *parse* \
+ *MyFrame* \
+ *MyApp* \
+ *PyObject* \
+ *wfm_rx_block* \
+ *_sptr* \
+ *debug* \
+ *wfm_rx_sca_block* \
+ *tv_rx_block* \
+ *wxapt_rx_block* \
+ *example_signal*
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
@@ -700,9 +768,8 @@
# is applied to all files.
FILTER_PATTERNS = address@hidden@/gnuradio-core/doc/other/doxypy.py
-
-# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
@@ -715,9 +782,7 @@
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
# be generated. Documented entities will be cross-referenced with these
sources.
# Note: To get rid of all source code in the generated output, make sure also
-# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or
CALLER_GRAPH
-# then you must also enable this option. If you don't then doxygen will
produce
-# a warning and turn it on anyway
+# VERBATIM_HEADERS is set to NO.
SOURCE_BROWSER = YES
@@ -732,13 +797,13 @@
STRIP_CODE_COMMENTS = NO
-# If the REFERENCED_BY_RELATION tag is set to YES (the default)
+# If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented
# functions referencing it will be listed.
REFERENCED_BY_RELATION = YES
-# If the REFERENCES_RELATION tag is set to YES (the default)
+# If the REFERENCES_RELATION tag is set to YES
# then for each documented function all documented entities
# called/used by that function will be listed.
@@ -836,13 +901,6 @@
HTML_ALIGN_MEMBERS = YES
-# If the GENERATE_HTMLHELP tag is set to YES, additional index files
-# will be generated that can be used as input for tools like the
-# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
-# of the generated HTML documentation.
-
-GENERATE_HTMLHELP = NO
-
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
@@ -851,6 +909,39 @@
HTML_DYNAMIC_SECTIONS = NO
+# If the GENERATE_DOCSET tag is set to YES, additional index files
+# will be generated that can be used as input for Apple's Xcode 3
+# integrated development environment, introduced with OSX 10.5 (Leopard).
+# To create a documentation set, doxygen will generate a Makefile in the
+# HTML output directory. Running make will produce the docset in that
+# directory and running "make install" will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# it at startup.
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for
more information.
+
+GENERATE_DOCSET = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# feed. A documentation feed provides an umbrella under which multiple
+# documentation sets from a single provider (such as a company or product
suite)
+# can be grouped.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
+# should uniquely identify the documentation set bundle. This should be a
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
+# will append .docset to the name.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
# be used to specify the file name of the resulting .chm file. You
# can add a path in front of the file if the result should not be
@@ -871,6 +962,12 @@
GENERATE_CHI = NO
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING =
+
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
# controls whether a binary table of contents is generated (YES) or a
# normal table of contents (NO) in the .chm file.
@@ -882,6 +979,38 @@
TOC_EXPAND = YES
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
QHP_VIRTUAL_FOLDER
+# are set, an additional index file will be generated that can be used as
input for
+# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
+# HTML documentation.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
+# be used to specify the file name of the resulting .qch file.
+# The path specified is relative to the HTML output folder.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#namespace";>Qt Help
Project / Namespace</a>.
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders";>Qt
Help Project / Virtual Folders</a>.
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
+# be used to specify the location of Qt's qhelpgenerator.
+# If non-empty doxygen will try to run qhelpgenerator on the generated
+# .qhp file .
+
+QHG_LOCATION =
+
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it.
@@ -893,12 +1022,20 @@
ENUM_VALUES_PER_LINE = 4
-# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
-# generated containing a tree-like index structure (just like the one that
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to FRAME, a side panel will be generated
+# containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
-# probably better off using the HTML help feature.
+# probably better off using the HTML help feature. Other possible values
+# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
+# and Class Hierarchy pages using a tree view instead of an ordered list;
+# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
+# disables this behavior completely. For backwards compatibility with previous
+# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
+# respectively.
GENERATE_TREEVIEW = YES
@@ -908,6 +1045,14 @@
TREEVIEW_WIDTH = 180
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# when you change the font size after a successful doxygen run you need
+# to manually remove any form_*.png images from the HTML output directory
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE = 10
+
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
@@ -1257,10 +1402,11 @@
CLASS_DIAGRAMS = YES
# You can define message sequence charts within doxygen comments using the
\msc
-# command. Doxygen will then run the mscgen tool (see
http://www.mcternan.me.uk/mscgen/) to
-# produce the chart and insert it in the documentation. The MSCGEN_PATH tag
allows you to
-# specify the directory where the mscgen tool resides. If left empty the tool
is assumed to
-# be found in the default search path.
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in
the
+# default search path.
MSCGEN_PATH =
@@ -1277,6 +1423,29 @@
HAVE_DOT = @HAVE_DOT@
+# By default doxygen will write a font called FreeSans.ttf to the output
+# directory and reference it in all dot files that doxygen generates. This
+# font does not include all possible unicode characters however, so when you
need
+# these (or just want a differently looking font) you can specify the font
name
+# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
+# which can be done by putting it in a standard location or by setting the
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
+# containing the font.
+
+DOT_FONTNAME = FreeSans
+
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
+# The default size is 10pt.
+
+DOT_FONTSIZE = 10
+
+# By default doxygen will tell dot to use the output directory to look for the
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a
+# different font using DOT_FONTNAME you can set the path where dot
+# can find it using this tag.
+
+DOT_FONTPATH =
+
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect inheritance relations. Setting this tag to YES will force the
@@ -1321,19 +1490,19 @@
INCLUDED_BY_GRAPH = YES
-# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then
doxygen will
-# generate a call dependency graph for every global function or class method.
-# Note that enabling this option will significantly increase the time of a
run.
-# So in most cases it will be better to enable call graphs for selected
-# functions only using the \callgraph command.
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
+# doxygen will generate a call dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable call graphs
+# for selected functions only using the \callgraph command.
CALL_GRAPH = NO
-# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then
doxygen will
-# generate a caller dependency graph for every global function or class
method.
-# Note that enabling this option will significantly increase the time of a
run.
-# So in most cases it will be better to enable caller graphs for selected
-# functions only using the \callergraph command.
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
+# doxygen will generate a caller dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable caller
+# graphs for selected functions only using the \callergraph command.
CALLER_GRAPH = NO
@@ -1366,12 +1535,12 @@
DOTFILE_DIRS =
-# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
# nodes that will be shown in the graph. If the number of nodes in a graph
# becomes larger than this value, doxygen will truncate the graph, which is
-# visualized by representing a node as a red box. Note that doxygen if the
number
-# of direct children of the root node in a graph is already larger than
-# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
DOT_GRAPH_MAX_NODES = 50
@@ -1387,10 +1556,10 @@
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
-# background. This is disabled by default, which results in a white
background.
-# Warning: Depending on the platform used, enabling this option may lead to
-# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
-# read).
+# background. This is disabled by default, because dot on Windows does not
+# seem to support this out of the box. Warning: Depending on the platform
used,
+# enabling this option may lead to badly anti-aliased labels on the edges of
+# a graph (i.e. they become hard to read).
DOT_TRANSPARENT = NO
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Commit-gnuradio] r11024 - gnuradio/branches/developers/eb/t367/docs/doxygen,
eb <=