summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoreb2009-05-14 18:29:26 +0000
committereb2009-05-14 18:29:26 +0000
commit349331a884594a9e242231bffb03112b8943883c (patch)
tree9d765ce9484f84eeb95e74facb1c522dd1ff90e2
parent18f685853b2bf1914148cb07a9c6df76f5063ff3 (diff)
downloadgnuradio-349331a884594a9e242231bffb03112b8943883c.tar.gz
gnuradio-349331a884594a9e242231bffb03112b8943883c.tar.bz2
gnuradio-349331a884594a9e242231bffb03112b8943883c.zip
Doc fixes. Merged eb/t367 -r11020:11025 to trunk. This changeset
moves the primary doxygen configuration under the top-level docs directory. It creates a new "docs" top-level component that can be enabled/disabled using the configure --disable-docs option. At this time, the --enable-doxygen option is still required to enable the generation of the doxygen documents. I think the flag should probably be removed, and default to "yes" if we find doxygen on the path. The user can disable the doc generation using --disable-docs if desired. The doxygen config file has been modified such that doxygen is now only run on the C++ sources. No attempt is made to process the python code using doxygen. This results in a less confusing set of docs for the the C++ API. Straightening out the python docs is left for later. Many classes are currently misclassified (\ingroup <wrong>). That will probably require another day of work, that I can't get to right now. git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@11027 221aa14e-8319-0410-a670-987f0aec2ac5
-rw-r--r--config/Makefile.am1
-rw-r--r--config/grc_docs.m433
-rw-r--r--config/grc_gnuradio_core.m44
-rw-r--r--configure.ac1
-rw-r--r--docs/Makefile.am23
-rw-r--r--docs/doxygen/Doxyfile.in (renamed from gnuradio-core/doc/Doxyfile.in)601
-rw-r--r--docs/doxygen/Makefile.am (renamed from gnuradio-core/doc/Makefile.am)0
-rw-r--r--docs/doxygen/other/Makefile.am (renamed from gnuradio-core/doc/other/Makefile.am)0
-rwxr-xr-xdocs/doxygen/other/doxypy.py (renamed from gnuradio-core/doc/other/doxypy.py)0
-rw-r--r--docs/doxygen/other/group_defs.dox (renamed from gnuradio-core/doc/other/group_defs.dox)0
-rw-r--r--docs/doxygen/other/main_page.dox (renamed from gnuradio-core/doc/other/main_page.dox)0
-rw-r--r--docs/doxygen/other/omnithread.html (renamed from gnuradio-core/doc/other/omnithread.html)0
-rw-r--r--docs/doxygen/other/omnithread.pdf (renamed from gnuradio-core/doc/other/omnithread.pdf)bin126474 -> 126474 bytes
-rw-r--r--docs/doxygen/other/omnithread.ps (renamed from gnuradio-core/doc/other/omnithread.ps)0
-rwxr-xr-xdocs/doxygen/other/shared_ptr_docstub.h (renamed from gnuradio-core/doc/other/shared_ptr_docstub.h)0
-rw-r--r--docs/doxygen/other/tv-channel-frequencies (renamed from gnuradio-core/doc/other/tv-channel-frequencies)0
-rw-r--r--docs/doxygen/other/vector_docstub.h (renamed from gnuradio-core/doc/other/vector_docstub.h)0
-rw-r--r--docs/doxygen/xml-swig/Makefile.am (renamed from gnuradio-core/doc/xml-swig/Makefile.am)0
-rw-r--r--docs/doxygen/xml-swig/README (renamed from gnuradio-core/doc/xml-swig/README)0
-rw-r--r--docs/doxygen/xml-swig/doxy2swig.py (renamed from gnuradio-core/doc/xml-swig/doxy2swig.py)0
-rw-r--r--docs/doxygen/xml-swig/swig.xsl (renamed from gnuradio-core/doc/xml-swig/swig.xsl)0
-rw-r--r--gnuradio-core/Makefile.am4
-rw-r--r--gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t5
-rw-r--r--gr-audio-portaudio/src/audio_portaudio_sink.h3
-rw-r--r--gr-audio-portaudio/src/audio_portaudio_source.h3
-rw-r--r--mblock/src/include/mblock/mblock.h2
-rw-r--r--mblock/src/include/mblock/port.h2
-rw-r--r--mblock/src/lib/mb_mblock_impl.h2
-rw-r--r--mblock/src/lib/mb_port_simple.h2
-rw-r--r--mblock/src/lib/mb_runtime_base.h4
-rw-r--r--mblock/src/lib/mb_runtime_thread_per_block.h2
-rw-r--r--mblock/src/lib/mb_worker.h2
-rw-r--r--pmt/src/lib/pmt.h28
33 files changed, 472 insertions, 250 deletions
diff --git a/config/Makefile.am b/config/Makefile.am
index 22de44b9f..881a64d8a 100644
--- a/config/Makefile.am
+++ b/config/Makefile.am
@@ -45,6 +45,7 @@ m4macros = \
bnv_have_qt.m4 \
cppunit.m4 \
grc_build.m4 \
+ grc_docs.m4 \
grc_gcell.m4 \
grc_gnuradio_core.m4 \
grc_gnuradio_examples.m4 \
diff --git a/config/grc_docs.m4 b/config/grc_docs.m4
new file mode 100644
index 000000000..86b31ae02
--- /dev/null
+++ b/config/grc_docs.m4
@@ -0,0 +1,33 @@
+dnl Copyright 2009 Free Software Foundation, Inc.
+dnl
+dnl This file is part of GNU Radio
+dnl
+dnl GNU Radio is free software; you can redistribute it and/or modify
+dnl it under the terms of the GNU General Public License as published by
+dnl the Free Software Foundation; either version 3, or (at your option)
+dnl any later version.
+dnl
+dnl GNU Radio is distributed in the hope that it will be useful,
+dnl but WITHOUT ANY WARRANTY; without even the implied warranty of
+dnl MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+dnl GNU General Public License for more details.
+dnl
+dnl You should have received a copy of the GNU General Public License
+dnl along with GNU Radio; see the file COPYING. If not, write to
+dnl the Free Software Foundation, Inc., 51 Franklin Street,
+dnl Boston, MA 02110-1301, USA.
+
+AC_DEFUN([GRC_DOCS],[
+ GRC_ENABLE(docs)
+
+ AC_CONFIG_FILES([ \
+ docs/Makefile \
+ docs/doxygen/Doxyfile \
+ docs/doxygen/Makefile \
+ docs/doxygen/other/Makefile \
+ docs/doxygen/xml-swig/Makefile \
+ ])
+
+ GRC_BUILD_CONDITIONAL(docs)
+
+])
diff --git a/config/grc_gnuradio_core.m4 b/config/grc_gnuradio_core.m4
index ff05d46cf..a1724aea9 100644
--- a/config/grc_gnuradio_core.m4
+++ b/config/grc_gnuradio_core.m4
@@ -80,10 +80,6 @@ AC_DEFUN([GRC_GNURADIO_CORE],[
AC_CONFIG_FILES([ \
gnuradio-core/Makefile
gnuradio-core/gnuradio-core.pc \
- gnuradio-core/doc/Doxyfile \
- gnuradio-core/doc/Makefile \
- gnuradio-core/doc/other/Makefile \
- gnuradio-core/doc/xml-swig/Makefile \
gnuradio-core/src/Makefile \
gnuradio-core/src/gen_interpolator_taps/Makefile \
gnuradio-core/src/lib/Makefile \
diff --git a/configure.ac b/configure.ac
index c5257300f..de32033e3 100644
--- a/configure.ac
+++ b/configure.ac
@@ -330,6 +330,7 @@ GRC_GR_SOUNDER dnl this must come after GRC_USRP
GRC_GR_UTILS dnl this must come after GRC_GR_WXGUI
GRC_GNURADIO_EXAMPLES dnl must come after all GRC_GR_*
GRC_GRC
+GRC_DOCS dnl must be last
# Each component is now either to be built, was skipped, will be
# included from pre-installed libraries and includes, or failed
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 000000000..31461cdc8
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,23 @@
+#
+# Copyright 2009 Free Software Foundation, Inc.
+#
+# This file is part of GNU Radio
+#
+# GNU Radio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3, or (at your option)
+# any later version.
+#
+# GNU Radio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+include $(top_srcdir)/Makefile.common
+
+SUBDIRS = doxygen
diff --git a/gnuradio-core/doc/Doxyfile.in b/docs/doxygen/Doxyfile.in
index 048c0806c..bf9b0ef47 100644
--- a/gnuradio-core/doc/Doxyfile.in
+++ b/docs/doxygen/Doxyfile.in
@@ -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,18 +14,18 @@
# 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
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
-PROJECT_NAME = "GNU Radio @VERSION@ API"
+PROJECT_NAME = "GNU Radio @VERSION@ C++ API"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
@@ -54,10 +54,11 @@ CREATE_SUBDIRS = NO
# 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 @@ QT_AUTOBRIEF = NO
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 @@ ALIASES =
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 = NO
-OPTIMIZE_OUTPUT_JAVA = YES
+# 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.
-# 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
+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 @@ BUILTIN_STL_SUPPORT = YES
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 @@ DISTRIBUTE_GROUP_DOC = NO
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 = 4
+
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
@@ -262,12 +309,13 @@ EXTRACT_LOCAL_CLASSES = YES
# the interface are included in the documentation.
# If set to NO (the default) only methods in the interface are included.
-EXTRACT_LOCAL_METHODS = YES
+EXTRACT_LOCAL_METHODS = NO
-# 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_MEMBER_DOCS = YES
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,
@@ -354,31 +408,31 @@ SORT_BRIEF_DOCS = NO
# Note: This option applies only to the class list, not to the
# alphabetical list.
-SORT_BY_SCOPE_NAME = YES
+SORT_BY_SCOPE_NAME = NO
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
# commands in the documentation.
-GENERATE_TODOLIST = YES
+GENERATE_TODOLIST = NO
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
# commands in the documentation.
-GENERATE_TESTLIST = YES
+GENERATE_TESTLIST = NO
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
# commands in the documentation.
-GENERATE_BUGLIST = YES
+GENERATE_BUGLIST = NO
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
# \deprecated commands in the documentation.
-GENERATE_DEPRECATEDLIST= YES
+GENERATE_DEPRECATEDLIST= NO
# The ENABLED_SECTIONS tag can be used to enable conditional
# documentation sections, marked by \if sectionname ... \endif.
@@ -405,11 +459,23 @@ SHOW_USED_FILES = YES
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO.
-SHOW_DIRECTORIES = YES
+SHOW_DIRECTORIES = NO
+
+# 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 = NO
# 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 @@ SHOW_DIRECTORIES = YES
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 @@ WARN_LOGFILE =
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,12 +567,10 @@ INPUT_ENCODING = UTF-8
# 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 \
- *.py \
- *.cc
+ *.dox
# 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.
@@ -508,100 +582,93 @@ RECURSIVE = YES
# 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@/gnuradio-core/src/lib/swig \
- @abs_top_builddir@/gr-atsc/src/lib/atsc.cc \
- @abs_top_builddir@/gr-atsc/src/lib/atsc.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-pager/src/pager_swig.py \
- @abs_top_builddir@/gr-radar-mono/src/python/usrp_radar_mono.py \
- @abs_top_builddir@/gr-trellis/src/lib/trellis.py \
- @abs_top_builddir@/gr-usrp/src/usrp1.py \
- @abs_top_builddir@/gr-video-sdl/src/video_sdl.py \
- @abs_top_builddir@/usrp/host/swig \
- @abs_top_builddir@/docs \
- @abs_top_builddir@/dtools \
- @abs_top_builddir@/gnuradio-core/doc/other/doxypy.py \
- @abs_top_builddir@/gnuradio-core/doc/xml \
- @abs_top_builddir@/gnuradio-core/doc/xml-swig \
- @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/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/runtime/gr_error_handler.cc \
- @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@/gr-atsc/src/lib/gen_encoder.py \
- @abs_top_builddir@/gr-atsc/src/python \
- @abs_top_builddir@/gr-howto-write-a-block \
- @abs_top_builddir@/gr-qtgui \
- @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@/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/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@/grc \
- @abs_top_builddir@/gr-wxgui/src/python \
- @abs_top_builddir@/gr-radio-astronomy/src/python \
- @abs_top_builddir@/omnithread/nt.cc \
- @abs_top_builddir@/omnithread/mach.cc \
- @abs_top_builddir@/gr-audio-alsa/src/audio-alsa.py \
- @abs_top_builddir@/gr-msdd6000/src/msdd.py \
- @abs_top_builddir@/gr-usrp2/src/usrp2.py \
- @abs_top_builddir@/usrp/host/lib/legacy/db_flexrf.h \
- @abs_top_builddir@/usrp/host/lib/legacy/db_flexrf_mimo.h \
- @abs_top_builddir@/usrp/host/lib/legacy/db_wbx.h \
- @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/missing/getopt.h \
- @abs_top_builddir@/gnuradio-core/src/lib/filter/gr_altivec.h \
- @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-radio-astronomy/src/lib/ra.py \
- @abs_top_builddir@/gcell/ibm/sync/ppu_source/cond.h \
- @abs_top_builddir@/gcell/ibm/sync/ppu_source/libsync.h \
- @abs_top_builddir@/gcell/ibm/sync/spu_source/sync_utils.h
-
+EXCLUDE = @abs_top_builddir@/docs/doxygen/html \
+ @abs_top_builddir@/docs/doxygen/xml \
+ @abs_top_builddir@/docs/doxygen/xml-swig \
+ @abs_top_builddir@/docs/doxygen/other/doxypy.py \
+ @abs_top_builddir@/dtools \
+ @abs_top_builddir@/gcell/ibm \
+ @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/db_wbx.cc \
+ @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
@@ -615,48 +682,45 @@ EXCLUDE_SYMLINKS = NO
# 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
@@ -702,9 +766,8 @@ INPUT_FILTER =
# is applied to all files.
FILTER_PATTERNS = *.py=@top_srcdir@/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).
@@ -717,11 +780,9 @@ FILTER_SOURCE_FILES = NO
# 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
+SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body
# of functions and classes directly in the documentation.
@@ -734,13 +795,13 @@ INLINE_SOURCES = NO
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.
@@ -838,13 +899,6 @@ HTML_STYLESHEET =
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
@@ -853,6 +907,39 @@ GENERATE_HTMLHELP = NO
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
@@ -873,6 +960,12 @@ HHC_LOCATION =
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.
@@ -884,6 +977,38 @@ BINARY_TOC = NO
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.
@@ -895,12 +1020,20 @@ DISABLE_INDEX = YES
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
@@ -910,6 +1043,14 @@ GENERATE_TREEVIEW = YES
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
#---------------------------------------------------------------------------
@@ -1259,10 +1400,11 @@ PERL_PATH = /usr/bin/perl
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 =
@@ -1279,6 +1421,29 @@ HIDE_UNDOC_RELATIONS = YES
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
@@ -1291,7 +1456,7 @@ CLASS_GRAPH = YES
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.
-COLLABORATION_GRAPH = YES
+COLLABORATION_GRAPH = NO
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for groups, showing the direct groups dependencies
@@ -1323,19 +1488,19 @@ INCLUDE_GRAPH = YES
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
@@ -1368,12 +1533,12 @@ DOT_PATH =
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
@@ -1389,10 +1554,10 @@ DOT_GRAPH_MAX_NODES = 50
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
diff --git a/gnuradio-core/doc/Makefile.am b/docs/doxygen/Makefile.am
index 3a67fb6d4..3a67fb6d4 100644
--- a/gnuradio-core/doc/Makefile.am
+++ b/docs/doxygen/Makefile.am
diff --git a/gnuradio-core/doc/other/Makefile.am b/docs/doxygen/other/Makefile.am
index 5e05d5d36..5e05d5d36 100644
--- a/gnuradio-core/doc/other/Makefile.am
+++ b/docs/doxygen/other/Makefile.am
diff --git a/gnuradio-core/doc/other/doxypy.py b/docs/doxygen/other/doxypy.py
index 82fdb6bea..82fdb6bea 100755
--- a/gnuradio-core/doc/other/doxypy.py
+++ b/docs/doxygen/other/doxypy.py
diff --git a/gnuradio-core/doc/other/group_defs.dox b/docs/doxygen/other/group_defs.dox
index 7373236ce..7373236ce 100644
--- a/gnuradio-core/doc/other/group_defs.dox
+++ b/docs/doxygen/other/group_defs.dox
diff --git a/gnuradio-core/doc/other/main_page.dox b/docs/doxygen/other/main_page.dox
index 5c37905fa..5c37905fa 100644
--- a/gnuradio-core/doc/other/main_page.dox
+++ b/docs/doxygen/other/main_page.dox
diff --git a/gnuradio-core/doc/other/omnithread.html b/docs/doxygen/other/omnithread.html
index 5682d1d0b..5682d1d0b 100644
--- a/gnuradio-core/doc/other/omnithread.html
+++ b/docs/doxygen/other/omnithread.html
diff --git a/gnuradio-core/doc/other/omnithread.pdf b/docs/doxygen/other/omnithread.pdf
index b54218744..b54218744 100644
--- a/gnuradio-core/doc/other/omnithread.pdf
+++ b/docs/doxygen/other/omnithread.pdf
Binary files differ
diff --git a/gnuradio-core/doc/other/omnithread.ps b/docs/doxygen/other/omnithread.ps
index 9e858f0b7..9e858f0b7 100644
--- a/gnuradio-core/doc/other/omnithread.ps
+++ b/docs/doxygen/other/omnithread.ps
diff --git a/gnuradio-core/doc/other/shared_ptr_docstub.h b/docs/doxygen/other/shared_ptr_docstub.h
index 428dd03f1..428dd03f1 100755
--- a/gnuradio-core/doc/other/shared_ptr_docstub.h
+++ b/docs/doxygen/other/shared_ptr_docstub.h
diff --git a/gnuradio-core/doc/other/tv-channel-frequencies b/docs/doxygen/other/tv-channel-frequencies
index e2780eca9..e2780eca9 100644
--- a/gnuradio-core/doc/other/tv-channel-frequencies
+++ b/docs/doxygen/other/tv-channel-frequencies
diff --git a/gnuradio-core/doc/other/vector_docstub.h b/docs/doxygen/other/vector_docstub.h
index 139ce651d..139ce651d 100644
--- a/gnuradio-core/doc/other/vector_docstub.h
+++ b/docs/doxygen/other/vector_docstub.h
diff --git a/gnuradio-core/doc/xml-swig/Makefile.am b/docs/doxygen/xml-swig/Makefile.am
index f508deb20..f508deb20 100644
--- a/gnuradio-core/doc/xml-swig/Makefile.am
+++ b/docs/doxygen/xml-swig/Makefile.am
diff --git a/gnuradio-core/doc/xml-swig/README b/docs/doxygen/xml-swig/README
index e5187df28..e5187df28 100644
--- a/gnuradio-core/doc/xml-swig/README
+++ b/docs/doxygen/xml-swig/README
diff --git a/gnuradio-core/doc/xml-swig/doxy2swig.py b/docs/doxygen/xml-swig/doxy2swig.py
index 1e379d943..1e379d943 100644
--- a/gnuradio-core/doc/xml-swig/doxy2swig.py
+++ b/docs/doxygen/xml-swig/doxy2swig.py
diff --git a/gnuradio-core/doc/xml-swig/swig.xsl b/docs/doxygen/xml-swig/swig.xsl
index 6163c2d9f..6163c2d9f 100644
--- a/gnuradio-core/doc/xml-swig/swig.xsl
+++ b/docs/doxygen/xml-swig/swig.xsl
diff --git a/gnuradio-core/Makefile.am b/gnuradio-core/Makefile.am
index e05a3f75b..c9cf1b1ba 100644
--- a/gnuradio-core/Makefile.am
+++ b/gnuradio-core/Makefile.am
@@ -1,5 +1,5 @@
#
-# Copyright 2001,2006 Free Software Foundation, Inc.
+# Copyright 2001,2006,2009 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
@@ -24,7 +24,7 @@ include $(top_srcdir)/Makefile.common
EXTRA_DIST = \
gnuradio-core.pc.in
-SUBDIRS = src doc
+SUBDIRS = src
pkgconfigdir = $(libdir)/pkgconfig
pkgconfig_DATA = gnuradio-core.pc
diff --git a/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t b/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t
index ee61808f2..c0d0c8173 100644
--- a/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t
+++ b/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t
@@ -35,9 +35,10 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@;
/*!
* \brief output is the moving sum of the last N samples, scaled by the scale factor
- * \ingroup filter. max_iter limits how long we go without flushing the accumulator
- * This is necessary to avoid numerical instability for float and complex.
+ * \ingroup filter
*
+ * max_iter limits how long we go without flushing the accumulator
+ * This is necessary to avoid numerical instability for float and complex.
*/
class @NAME@ : public gr_sync_block
{
diff --git a/gr-audio-portaudio/src/audio_portaudio_sink.h b/gr-audio-portaudio/src/audio_portaudio_sink.h
index 1ac8edc84..a0155367d 100644
--- a/gr-audio-portaudio/src/audio_portaudio_sink.h
+++ b/gr-audio-portaudio/src/audio_portaudio_sink.h
@@ -34,7 +34,8 @@ class audio_portaudio_sink;
typedef boost::shared_ptr<audio_portaudio_sink> audio_portaudio_sink_sptr;
/*!
- * \PORTAUDIO audio sink.
+ * \brief PORTAUDIO audio sink.
+ *
* \param sampling_rate sampling rate in Hz
* \param dev PORTAUDIO device name, e.g., "pa:"
* \param ok_to_block true if it's ok for us to block
diff --git a/gr-audio-portaudio/src/audio_portaudio_source.h b/gr-audio-portaudio/src/audio_portaudio_source.h
index 8bb4a02a7..cea631c70 100644
--- a/gr-audio-portaudio/src/audio_portaudio_source.h
+++ b/gr-audio-portaudio/src/audio_portaudio_source.h
@@ -34,7 +34,8 @@ class audio_portaudio_source;
typedef boost::shared_ptr<audio_portaudio_source> audio_portaudio_source_sptr;
/*!
- * \PORTAUDIO audio source.
+ * \brief PORTAUDIO audio source.
+ *
* \param sampling_rate sampling rate in Hz
* \param dev PORTAUDIO device name, e.g., "pa:"
* \param ok_to_block true if it's ok for us to block
diff --git a/mblock/src/include/mblock/mblock.h b/mblock/src/include/mblock/mblock.h
index 14517ffcc..bbc40f1ef 100644
--- a/mblock/src/include/mblock/mblock.h
+++ b/mblock/src/include/mblock/mblock.h
@@ -307,7 +307,7 @@ public:
walk_tree(mb_visitor *visitor);
- //! \implementation
+ //! \internal
// internal use only
mb_mblock_impl_sptr
impl() const { return d_impl; }
diff --git a/mblock/src/include/mblock/port.h b/mblock/src/include/mblock/port.h
index 892a1dd97..782bb1285 100644
--- a/mblock/src/include/mblock/port.h
+++ b/mblock/src/include/mblock/port.h
@@ -85,7 +85,7 @@ public:
/*
* \brief Invalidate any cached peer resolutions
- * \implementation
+ * \internal
*/
virtual void invalidate_cache() = 0;
};
diff --git a/mblock/src/lib/mb_mblock_impl.h b/mblock/src/lib/mb_mblock_impl.h
index ed8059b00..991457912 100644
--- a/mblock/src/lib/mb_mblock_impl.h
+++ b/mblock/src/lib/mb_mblock_impl.h
@@ -216,7 +216,7 @@ private:
/*!
* \brief walk mblock tree and invalidate all port resolution caches.
- * \implementation
+ * \internal
*/
void
invalidate_all_port_caches();
diff --git a/mblock/src/lib/mb_port_simple.h b/mblock/src/lib/mb_port_simple.h
index 3041239ad..87b7654b0 100644
--- a/mblock/src/lib/mb_port_simple.h
+++ b/mblock/src/lib/mb_port_simple.h
@@ -63,7 +63,7 @@ public:
/*
* \brief Invalidate any cached peer resolutions
- * \implementation
+ * \internal
*/
void invalidate_cache();
diff --git a/mblock/src/lib/mb_runtime_base.h b/mblock/src/lib/mb_runtime_base.h
index b88a9ca4e..98b5f3e0a 100644
--- a/mblock/src/lib/mb_runtime_base.h
+++ b/mblock/src/lib/mb_runtime_base.h
@@ -40,13 +40,13 @@ public:
/*!
* \brief lock the big runtime lock
- * \implementation
+ * \internal
*/
inline void lock() { d_brl.lock(); }
/*!
* \brief unlock the big runtime lock
- * \implementation
+ * \internal
*/
inline void unlock() { d_brl.unlock(); }
diff --git a/mblock/src/lib/mb_runtime_thread_per_block.h b/mblock/src/lib/mb_runtime_thread_per_block.h
index ef962911e..185ed32b5 100644
--- a/mblock/src/lib/mb_runtime_thread_per_block.h
+++ b/mblock/src/lib/mb_runtime_thread_per_block.h
@@ -28,7 +28,7 @@
/*!
* \brief Concrete runtime that uses a thread per mblock
- * \implementation
+ * \internal
*
* These are all implementation details.
*/
diff --git a/mblock/src/lib/mb_worker.h b/mblock/src/lib/mb_worker.h
index 9831de926..59d12545c 100644
--- a/mblock/src/lib/mb_worker.h
+++ b/mblock/src/lib/mb_worker.h
@@ -34,7 +34,7 @@ class mb_runtime_thread_per_block;
/*!
* \brief Worker thread for thread_per_block runtime
- * \implementation
+ * \internal
*/
class mb_worker : public omni_thread
{
diff --git a/pmt/src/lib/pmt.h b/pmt/src/lib/pmt.h
index 57945f70e..a69d24a05 100644
--- a/pmt/src/lib/pmt.h
+++ b/pmt/src/lib/pmt.h
@@ -1,6 +1,6 @@
/* -*- c++ -*- */
/*
- * Copyright 2006 Free Software Foundation, Inc.
+ * Copyright 2006,2009 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
@@ -83,19 +83,19 @@ public:
* I.e., there is a single false value, #f.
* ------------------------------------------------------------------------
*/
-extern const pmt_t PMT_T; //< #t : boolean true constant
-extern const pmt_t PMT_F; //< #f : boolean false constant
+extern const pmt_t PMT_T; //< \#t : boolean true constant
+extern const pmt_t PMT_F; //< \#f : boolean false constant
-//! Return true if obj is #t or #f, else return false.
+//! Return true if obj is \#t or \#f, else return false.
bool pmt_is_bool(pmt_t obj);
-//! Return false if obj is #f, else return true.
+//! Return false if obj is \#f, else return true.
bool pmt_is_true(pmt_t obj);
-//! Return true if obj is #f, else return true.
+//! Return true if obj is \#f, else return true.
bool pmt_is_false(pmt_t obj);
-//! Return #f is val is false, else return #t.
+//! Return \#f is val is false, else return \#t.
pmt_t pmt_from_bool(bool val);
//! Return true if val is PMT_T, return false when val is PMT_F,
@@ -457,7 +457,7 @@ bool pmt_eq(pmt_t x, pmt_t y);
* <pre>
* eqv returns true if:
* x and y are the same object.
- * x and y are both #t or both #f.
+ * x and y are both \#t or both \#f.
* x and y are both symbols and their names are the same.
* x and y are both numbers, and are numerically equal.
* x and y are both the empty list (nil).
@@ -483,7 +483,7 @@ size_t pmt_length(pmt_t v);
* and return that pair.
*
* \p alist (for "association list") must be a list of pairs. If no pair
- * in \p alist has \p obj as its car then #f is returned.
+ * in \p alist has \p obj as its car then \#f is returned.
* Uses pmt_eq to compare \p obj with car fields of the pairs in \p alist.
*/
pmt_t pmt_assq(pmt_t obj, pmt_t alist);
@@ -493,7 +493,7 @@ pmt_t pmt_assq(pmt_t obj, pmt_t alist);
* and return that pair.
*
* \p alist (for "association list") must be a list of pairs. If no pair
- * in \p alist has \p obj as its car then #f is returned.
+ * in \p alist has \p obj as its car then \#f is returned.
* Uses pmt_eqv to compare \p obj with car fields of the pairs in \p alist.
*/
pmt_t pmt_assv(pmt_t obj, pmt_t alist);
@@ -503,7 +503,7 @@ pmt_t pmt_assv(pmt_t obj, pmt_t alist);
* and return that pair.
*
* \p alist (for "association list") must be a list of pairs. If no pair
- * in \p alist has \p obj as its car then #f is returned.
+ * in \p alist has \p obj as its car then \#f is returned.
* Uses pmt_equal to compare \p obj with car fields of the pairs in \p alist.
*/
pmt_t pmt_assoc(pmt_t obj, pmt_t alist);
@@ -553,21 +553,21 @@ pmt_t pmt_nthcdr(size_t n, pmt_t list);
/*!
* \brief Return the first sublist of \p list whose car is \p obj.
- * If \p obj does not occur in \p list, then #f is returned.
+ * If \p obj does not occur in \p list, then \#f is returned.
* pmt_memq use pmt_eq to compare \p obj with the elements of \p list.
*/
pmt_t pmt_memq(pmt_t obj, pmt_t list);
/*!
* \brief Return the first sublist of \p list whose car is \p obj.
- * If \p obj does not occur in \p list, then #f is returned.
+ * If \p obj does not occur in \p list, then \#f is returned.
* pmt_memv use pmt_eqv to compare \p obj with the elements of \p list.
*/
pmt_t pmt_memv(pmt_t obj, pmt_t list);
/*!
* \brief Return the first sublist of \p list whose car is \p obj.
- * If \p obj does not occur in \p list, then #f is returned.
+ * If \p obj does not occur in \p list, then \#f is returned.
* pmt_member use pmt_equal to compare \p obj with the elements of \p list.
*/
pmt_t pmt_member(pmt_t obj, pmt_t list);