diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2011-10-09 19:23:33 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2011-10-09 19:24:43 -0400 |
| commit | 7ba45cf3452123a4c08a4aa535da76b793d2eaf2 (patch) | |
| tree | dff9ac711b8d46b2740cbb5417eb6e9f8e9cc6bc /gr-uhd/include | |
| parent | 811e6f6185967656c2b044f9872a3401fea7c305 (diff) | |
docs: adding uhd Doxygen documentation page and README file.
Diffstat (limited to 'gr-uhd/include')
| -rw-r--r-- | gr-uhd/include/gr_uhd_amsg_source.h | 4 | ||||
| -rw-r--r-- | gr-uhd/include/gr_uhd_usrp_sink.h | 1 | ||||
| -rw-r--r-- | gr-uhd/include/gr_uhd_usrp_source.h | 1 |
3 files changed, 6 insertions, 0 deletions
diff --git a/gr-uhd/include/gr_uhd_amsg_source.h b/gr-uhd/include/gr_uhd_amsg_source.h index bc0feb438a..accf15ce28 100644 --- a/gr-uhd/include/gr_uhd_amsg_source.h +++ b/gr-uhd/include/gr_uhd_amsg_source.h @@ -28,6 +28,10 @@ class uhd_amsg_source; +/*! + * \brief Make a new USRP asynchronous message-based source block. + * \ingroup uhd_blk + */ GR_UHD_API boost::shared_ptr<uhd_amsg_source> uhd_make_amsg_source( const uhd::device_addr_t &device_addr, gr_msg_queue_sptr msgq diff --git a/gr-uhd/include/gr_uhd_usrp_sink.h b/gr-uhd/include/gr_uhd_usrp_sink.h index c1fc3b09eb..f11d00063b 100644 --- a/gr-uhd/include/gr_uhd_usrp_sink.h +++ b/gr-uhd/include/gr_uhd_usrp_sink.h @@ -30,6 +30,7 @@ class uhd_usrp_sink; /*! * \brief Make a new USRP sink block. + * \ingroup uhd_blk * * The USRP sink block reads a stream and transmits the samples. * The sink block also provides API calls for transmitter settings. diff --git a/gr-uhd/include/gr_uhd_usrp_source.h b/gr-uhd/include/gr_uhd_usrp_source.h index f8ac9361e2..fecc6e94d3 100644 --- a/gr-uhd/include/gr_uhd_usrp_source.h +++ b/gr-uhd/include/gr_uhd_usrp_source.h @@ -30,6 +30,7 @@ class uhd_usrp_source; /*! * \brief Make a new USRP source block. + * \ingroup uhd_blk * * The USRP source block receives samples and writes to a stream. * The source block also provides API calls for receiver settings. |