summaryrefslogtreecommitdiff
path: root/gr-vocoder/doc
diff options
context:
space:
mode:
Diffstat (limited to 'gr-vocoder/doc')
-rw-r--r--gr-vocoder/doc/.gitignore2
-rw-r--r--gr-vocoder/doc/Makefile.am27
-rw-r--r--gr-vocoder/doc/README.vocoder12
-rw-r--r--gr-vocoder/doc/vocoder.dox24
4 files changed, 65 insertions, 0 deletions
diff --git a/gr-vocoder/doc/.gitignore b/gr-vocoder/doc/.gitignore
new file mode 100644
index 000000000..b336cc7ce
--- /dev/null
+++ b/gr-vocoder/doc/.gitignore
@@ -0,0 +1,2 @@
+/Makefile
+/Makefile.in
diff --git a/gr-vocoder/doc/Makefile.am b/gr-vocoder/doc/Makefile.am
new file mode 100644
index 000000000..a277264fe
--- /dev/null
+++ b/gr-vocoder/doc/Makefile.am
@@ -0,0 +1,27 @@
+#
+# Copyright 2011 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 GNU Radio; see the file COPYING. If not, write to
+# the Free Software Foundation, Inc., 51 Franklin Street,
+# Boston, MA 02110-1301, USA.
+#
+
+include $(top_srcdir)/Makefile.common
+
+SUBDIRS =
+
+dist_gr_doc_DATA = \
+ README.vocoder
diff --git a/gr-vocoder/doc/README.vocoder b/gr-vocoder/doc/README.vocoder
new file mode 100644
index 000000000..912d664ad
--- /dev/null
+++ b/gr-vocoder/doc/README.vocoder
@@ -0,0 +1,12 @@
+This is the gr-vocoder package. This package includes the various
+vocoder blocks in GNU Radio. To use the vocoder blocks, the Python
+namespaces is in gnuradio.vocoder, which would be normally imported
+as:
+
+ from gnuradio import vocoder
+
+See the Doxygen documentation for details about the blocks available
+in this package. A quick listing of the details can be found in Python
+after importing by using:
+
+ help(vocoder)
diff --git a/gr-vocoder/doc/vocoder.dox b/gr-vocoder/doc/vocoder.dox
new file mode 100644
index 000000000..ff1c4b9dd
--- /dev/null
+++ b/gr-vocoder/doc/vocoder.dox
@@ -0,0 +1,24 @@
+/*! \page page_vocoder Voice Coders and Decoders (Vocoders)
+
+\section Introduction
+
+This is the gr-vocoder package. It contains all available vocoders in
+GNU Radio. The Python namespaces is in gnuradio.vocoder, which would be
+normally imported as:
+
+\code
+ from gnuradio import vocoder
+\endcode
+
+See the Doxygen documentation for details about the blocks available
+in this package. The relevant blocks are listed in the \ref
+vocoder_blk group.
+
+A quick listing of the details can be found in Python after importing
+by using:
+
+\code
+ help(vocoder)
+\endcode
+
+*/