From 91ace5a39a171ec7367c4030a1739d2f709eaed6 Mon Sep 17 00:00:00 2001
From: Josh Blum
Date: Thu, 22 Sep 2011 20:03:47 -0700
Subject: uhd: added documentation and tag implementations

---
 gr-uhd/include/gr_uhd_usrp_source.h | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'gr-uhd/include/gr_uhd_usrp_source.h')

diff --git a/gr-uhd/include/gr_uhd_usrp_source.h b/gr-uhd/include/gr_uhd_usrp_source.h
index 6e51a1423..432cbee15 100644
--- a/gr-uhd/include/gr_uhd_usrp_source.h
+++ b/gr-uhd/include/gr_uhd_usrp_source.h
@@ -28,6 +28,29 @@
 
 class uhd_usrp_source;
 
+/*!
+ * \brief Make a new USRP source block.
+ *
+ * The USRP source block receives samples and writes to a stream.
+ * The source block also provides API calls for receiver settings.
+ *
+ * Stream tagging:
+ *
+ * The following tag keys will be produced by the work function:
+ *  - pmt::pmt_string_to_symbol("rx_time")
+ *
+ * The timstamp tag value is a pmt tuple of the following:
+ * (uint64 seconds, and double fractional seconds).
+ * A timestamp tag is produced at start() and after overflows.
+ *
+ * See the UHD manual for more detailed documentation:
+ * http://code.ettus.com/redmine/ettus/projects/uhd/wiki
+ *
+ * \param device_addr the address to identify the hardware
+ * \param io_type the desired output data type
+ * \param num_channels number of stream from the device
+ * \return a new USRP source block object
+ */
 GR_UHD_API boost::shared_ptr<uhd_usrp_source> uhd_make_usrp_source(
     const uhd::device_addr_t &device_addr,
     const uhd::io_type_t &io_type,
-- 
cgit 


From 7da9d688406db097f518b3eed2047fde60e1aa0e Mon Sep 17 00:00:00 2001
From: Josh Blum
Date: Fri, 23 Sep 2011 13:51:31 -0700
Subject: uhd: tweaks + tested working tags implementation

---
 gr-uhd/include/gr_uhd_usrp_source.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'gr-uhd/include/gr_uhd_usrp_source.h')

diff --git a/gr-uhd/include/gr_uhd_usrp_source.h b/gr-uhd/include/gr_uhd_usrp_source.h
index 432cbee15..f8ac9361e 100644
--- a/gr-uhd/include/gr_uhd_usrp_source.h
+++ b/gr-uhd/include/gr_uhd_usrp_source.h
@@ -34,7 +34,7 @@ class uhd_usrp_source;
  * The USRP source block receives samples and writes to a stream.
  * The source block also provides API calls for receiver settings.
  *
- * Stream tagging:
+ * RX Stream tagging:
  *
  * The following tag keys will be produced by the work function:
  *  - pmt::pmt_string_to_symbol("rx_time")
-- 
cgit