diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2011-10-09 17:10:12 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2011-10-09 17:10:12 -0400 |
| commit | 2656ad175c70322902b960db5ac649c7bbfa0572 (patch) | |
| tree | bf7c5eb83fb9948be31d43fb86f69b3709449e27 /gr-vocoder/doc/vocoder.dox | |
| parent | 34c8a8e591ec0dabe6e9bab0d65d3eae27ebb2db (diff) | |
docs: adding README.vocoder and a Doxygen page for the vocoder block.
Diffstat (limited to 'gr-vocoder/doc/vocoder.dox')
| -rw-r--r-- | gr-vocoder/doc/vocoder.dox | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/gr-vocoder/doc/vocoder.dox b/gr-vocoder/doc/vocoder.dox new file mode 100644 index 0000000000..d98532ffbf --- /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 relavent 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 + +*/ |