diff options
Diffstat (limited to 'gr-vocoder/doc')
| -rw-r--r-- | gr-vocoder/doc/Makefile.am | 3 | ||||
| -rw-r--r-- | gr-vocoder/doc/README.vocoder | 12 | ||||
| -rw-r--r-- | gr-vocoder/doc/vocoder.dox | 24 |
3 files changed, 39 insertions, 0 deletions
diff --git a/gr-vocoder/doc/Makefile.am b/gr-vocoder/doc/Makefile.am index b1c7b44d5..a277264fe 100644 --- a/gr-vocoder/doc/Makefile.am +++ b/gr-vocoder/doc/Makefile.am @@ -22,3 +22,6 @@ 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 + +*/ |