diff options
| author | eb | 2009-05-22 16:11:15 +0000 |
|---|---|---|
| committer | eb | 2009-05-22 16:11:15 +0000 |
| commit | ed236703145cb56e7e69c5605c5fbf01a1ab3878 (patch) | |
| tree | 5d60748c9548b39aa2de4b45a99edabc3f155f0c /usrp/host/lib/legacy | |
| parent | b0bb34bafba903f06c7c9021739a316f5d76eaf7 (diff) | |
| download | gnuradio-ed236703145cb56e7e69c5605c5fbf01a1ab3878.tar.gz gnuradio-ed236703145cb56e7e69c5605c5fbf01a1ab3878.tar.bz2 gnuradio-ed236703145cb56e7e69c5605c5fbf01a1ab3878.zip | |
doc fixes! work-in-progress
git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@11085 221aa14e-8319-0410-a670-987f0aec2ac5
Diffstat (limited to 'usrp/host/lib/legacy')
| -rw-r--r-- | usrp/host/lib/legacy/db_base.h | 4 | ||||
| -rw-r--r-- | usrp/host/lib/legacy/usrp_basic.h | 3 | ||||
| -rw-r--r-- | usrp/host/lib/legacy/usrp_standard.h | 15 |
3 files changed, 19 insertions, 3 deletions
diff --git a/usrp/host/lib/legacy/db_base.h b/usrp/host/lib/legacy/db_base.h index 3448fbc19..35470891a 100644 --- a/usrp/host/lib/legacy/db_base.h +++ b/usrp/host/lib/legacy/db_base.h @@ -42,6 +42,10 @@ struct freq_result_t /******************************************************************************/ +/*! + * \brief Abstract base class for all USRP daughterboards + * \ingroup usrp + */ class db_base { protected: diff --git a/usrp/host/lib/legacy/usrp_basic.h b/usrp/host/lib/legacy/usrp_basic.h index 2caac7b66..f77b9adc9 100644 --- a/usrp/host/lib/legacy/usrp_basic.h +++ b/usrp/host/lib/legacy/usrp_basic.h @@ -57,6 +57,7 @@ enum txrx_t { /*! * \brief abstract base class for usrp operations + * \ingroup usrp */ class usrp_basic : boost::noncopyable { @@ -764,6 +765,7 @@ public: /*! * \brief class for accessing the receive side of the USRP + * \ingroup usrp */ class usrp_basic_rx : public usrp_basic { @@ -871,6 +873,7 @@ public: /*! * \brief class for accessing the transmit side of the USRP + * \ingroup usrp */ class usrp_basic_tx : public usrp_basic { diff --git a/usrp/host/lib/legacy/usrp_standard.h b/usrp/host/lib/legacy/usrp_standard.h index 1e018c74d..6dee62f30 100644 --- a/usrp/host/lib/legacy/usrp_standard.h +++ b/usrp/host/lib/legacy/usrp_standard.h @@ -33,6 +33,9 @@ class usrp_standard_rx; typedef boost::shared_ptr<usrp_standard_tx> usrp_standard_tx_sptr; typedef boost::shared_ptr<usrp_standard_rx> usrp_standard_rx_sptr; +/*! + * \ingroup usrp + */ class usrp_standard_common { int d_fpga_caps; // capability register val @@ -79,9 +82,11 @@ public: }; /*! - * \brief standard usrp RX class. + * \brief The C++ interface the receive side of the USRP + * \ingroup usrp * - * Assumes digital down converter in FPGA + * This is the recommended interface to USRP receive functionality + * for applications that use the USRP but not GNU Radio. */ class usrp_standard_rx : public usrp_basic_rx, public usrp_standard_common { @@ -272,7 +277,11 @@ class usrp_standard_rx : public usrp_basic_rx, public usrp_standard_common // ---------------------------------------------------------------- /*! - * \brief standard usrp TX class. + * \brief The C++ interface the transmit side of the USRP + * \ingroup usrp + * + * This is the recommended interface to USRP transmit functionality + * for applications that use the USRP but not GNU Radio. * * Uses digital upconverter (coarse & fine modulators) in AD9862... */ |