From c77bd0c46a598d5e69b179d76a3df6091e982129 Mon Sep 17 00:00:00 2001 From: sugandhagupta Date: Thu, 29 Jun 2017 15:10:27 -0700 Subject: docs: Fixed doxygen warnings --- host/include/uhd/rfnoc/block_ctrl_base.hpp | 8 +++++--- host/include/uhd/rfnoc/source_block_ctrl_base.hpp | 3 ++- 2 files changed, 7 insertions(+), 4 deletions(-) (limited to 'host/include') diff --git a/host/include/uhd/rfnoc/block_ctrl_base.hpp b/host/include/uhd/rfnoc/block_ctrl_base.hpp index 0be3f6053..481716ce6 100644 --- a/host/include/uhd/rfnoc/block_ctrl_base.hpp +++ b/host/include/uhd/rfnoc/block_ctrl_base.hpp @@ -173,6 +173,7 @@ public: * * \param reg The settings register to write to. * \param data New value of this register. + * \param port Port on which to write */ void sr_write(const uint32_t reg, const uint32_t data, const size_t port = 0); @@ -224,7 +225,7 @@ public: * instead of a numeric address. The register name must be * defined in the block definition file. * - * \param addr The user register address. + * \param reg The user register address. * \param port Port on which to read * \returns the readback value. * \throws uhd::key_error if \p reg is not a valid register name @@ -252,6 +253,7 @@ public: * \param reg The user register name. * \returns the readback value. * \throws uhd::key_error if \p reg is not a valid register name + * \param port Port from which to read */ uint32_t user_reg_read32(const std::string ®, const size_t port = 0); @@ -271,8 +273,8 @@ public: /*! Sets a tick rate for the command timebase. * - * \param the tick rate in Hz - * \port port Port + * \param tick_rate The tick rate in Hz + * \param port Port */ void set_command_tick_rate(const double tick_rate, const size_t port = ANY_PORT); diff --git a/host/include/uhd/rfnoc/source_block_ctrl_base.hpp b/host/include/uhd/rfnoc/source_block_ctrl_base.hpp index 7d90bb2f0..9d98e6a0c 100644 --- a/host/include/uhd/rfnoc/source_block_ctrl_base.hpp +++ b/host/include/uhd/rfnoc/source_block_ctrl_base.hpp @@ -60,6 +60,7 @@ public: * See also register_upstream_block(). * * \param stream_cmd The stream command. + * \param chan Channel */ virtual void issue_stream_cmd(const uhd::stream_cmd_t &stream_cmd, const size_t chan=0); @@ -109,7 +110,7 @@ public: * \param buf_size_pkts The size of the downstream block's input FIFO size in number of packets. Setting * this to zero disables flow control. The block will then produce data as fast as it can. * \b Warning: This can cause head-of-line blocking, and potentially lock up your device! - * \param Specify on which outgoing port this setting is valid. + * \param block_port Specify on which outgoing port this setting is valid. * \param sid The SID for which this is valid. This is meant for cases where the outgoing block port is * not sufficient to set the flow control, and as such is rarely used. */ -- cgit v1.2.3