diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2011-10-09 16:55:33 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2011-10-09 16:55:33 -0400 |
| commit | 34c8a8e591ec0dabe6e9bab0d65d3eae27ebb2db (patch) | |
| tree | 80d15e725fb87ed292f3b59a4121b2173911d707 /gr-digital/doc/digital.dox | |
| parent | 1ccc199c649c4d391eb544de7d29e292023125a3 (diff) | |
docs: This adds documentation to gr-digital in the form of a README.digital and a digital modulation page for the Doxygen manual. The manual's main page has been updated to link to the new digital modulation page.
Diffstat (limited to 'gr-digital/doc/digital.dox')
| -rw-r--r-- | gr-digital/doc/digital.dox | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/gr-digital/doc/digital.dox b/gr-digital/doc/digital.dox new file mode 100644 index 0000000000..dc92ccc47e --- /dev/null +++ b/gr-digital/doc/digital.dox @@ -0,0 +1,23 @@ +/*! \page page_digital Digital Modulation + +\section Introduction +This is the gr-digital package. It contains all of the digital +modulation blocks, utilities, and examples. To use the digital blocks, +the Python namespaces is in gnuradio.digital, which would be normally +imported as: + +\code + from gnuradio import digital +\endcode + +See the Doxygen documentation for details about the blocks available +in this package. The relavent blocks are listed in the \ref digital group. + +A quick listing of the details can be found in Python after importing +by using: + +\code + help(digital) +\endcode + +*/ |