aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--host/docs/build.dox.in18
-rw-r--r--host/include/uhd/rfnoc/block_id.hpp2
-rw-r--r--host/include/uhd/rfnoc/mb_controller.hpp1
-rw-r--r--host/include/uhd/rfnoc/node.hpp8
-rw-r--r--host/include/uhd/rfnoc/radio_control.hpp3
-rw-r--r--host/include/uhd/rfnoc/register_iface.hpp1
-rw-r--r--host/include/uhd/usrp/multi_usrp.hpp8
-rw-r--r--host/include/uhd/utils/gain_group.hpp1
-rw-r--r--host/include/uhd/utils/graph_utils.hpp3
9 files changed, 25 insertions, 20 deletions
diff --git a/host/docs/build.dox.in b/host/docs/build.dox.in
index e3e7c50de..a06b857e4 100644
--- a/host/docs/build.dox.in
+++ b/host/docs/build.dox.in
@@ -70,7 +70,7 @@ The directory to which you extract libusb must not contain spaces. This is to sa
- **Comments for Windows Users:**
- The Python binary installer must be selected to match the system processor. Although, the 32-bit Python version can be used with 32-bit or 64-bit Windows system, it is recommended to match between Python and Windows installers. If the system is occupied with 64-bit Windows and x64-based processor, the `Windows x86-64 MSI Installer -> python-version.amd64.msi` needs to be used.
- The Python path needs to be added to the environment variables.
- - Install fundamental packages for Python: On Windows Terminal, navigate to Python scripts folder, e.g. `C:\\local\\Python37\\Scripts`, and execute the following commands to install requests, numpy and six packages, respectively:
+ - Install fundamental packages for Python: On Windows Terminal, navigate to Python scripts folder, e.g. `C:\local\Python37\Scripts`, and execute the following commands to install requests, numpy and six packages, respectively:
pip install requests
pip install numpy
@@ -93,7 +93,7 @@ The directory to which you extract libusb must not contain spaces. This is to sa
- **Minimum Version:** @PY_MAKO_MIN_VERSION@
- **Usage:** build time (required)
- **Download URL:** http://www.makotemplates.org/download.html
-- **Alternative method:** You can use `pip` or `easy_install` to install Mako from PyPi. To install it using 'pip' on Windows, navigate to Python scripts folder, e.g. ´C:\\local\\Python37\\Scripts`, and run the following command:
+- **Alternative method:** You can use `pip` or `easy_install` to install Mako from PyPi. To install it using 'pip' on Windows, navigate to Python scripts folder, e.g. `C:\local\Python37\Scripts`, and run the following command:
pip install mako
@@ -224,7 +224,7 @@ extensions:
want it to be (check the PYTHON_VERSION variable)
- Open the CMake GUI.
- Set the path to the source code: `<uhd-repo-path>/host`.
-- Set the path to the build directory (this may require creating the folder \build\): `<uhd-repo-path>/host/build`.
+- Set the path to the build directory (this may require creating the folder \\build\\): `<uhd-repo-path>\host\build`.
- Make sure that the paths do not contain spaces.
- Check the Advanced checkbox.
- Click "Configure".
@@ -242,7 +242,7 @@ extensions:
- Click on "Generate", and a project file will be created in the build directory.
\subsection msvc_generate Compile and Install with Visual Studio
-- Open the `<uhd-repo-path>\\host\\build\\ALL_BUILD.vcxproj` in visual studio, generate the project. Watch the output console for errors.
+- Open the `<uhd-repo-path>\host\build\ALL_BUILD.vcxproj` in visual studio, generate the project. Watch the output console for errors.
- If you did not specify a `CMAKE_INSTALL_PREFIX` where your user has write privileges, you must close Visual Studio, run it again with Administrator Privileges, and open `ALL_BUILD.vcxproj`.
- Right click on the **INSTALL** project in the project explorer, generate it. Watch the output console for errors.
@@ -252,15 +252,15 @@ On Windows, CMake does not have the advantage of `pkg-config`,
so we must manually tell CMake how to locate the LibUSB header and lib.
- From the CMake GUI, select "Advanced View".
-- Set or add the following entry with type PATH `LIBUSB_INCLUDE_DIRS` to the directory for `libusb.h`, e.g. `C:\\local\\libusb-1.0.22\\include\\libusb-1.0`.
-- Set or add the following entry with type FILEPATH `LIBUSB_LIBRARIES` to the full path for `libusb-1.0.lib`, e.g. `C:\\local\\libusb-1.0.22\\MS64\\dll\\libusb-1.0.lib`.
+- Set or add the following entry with type PATH `LIBUSB_INCLUDE_DIRS` to the directory for `libusb.h`, e.g. `C:\local\libusb-1.0.22\include\libusb-1.0`.
+- Set or add the following entry with type FILEPATH `LIBUSB_LIBRARIES` to the full path for `libusb-1.0.lib`, e.g. `C:\local\libusb-1.0.22\MS64\dll\libusb-1.0.lib`.
- Recommend the static `libusb-1.0.lib` to simplify runtime dependencies.
- Check the box to enable USB support, click "Configure" and "Generate".
<b>Note:</b> On Windows, LibUSB v1.0.19 is required to use most USB3 controllers.
\subsection build_in_msvc Build the project in MSVC
-- Open the generated project file in MSVC, e.g. `C:\\cygwin64\\home\\admin\\uhd\\host\\build\\UHD.sln`.
+- Open the generated project file in MSVC, e.g. `C:\cygwin64\home\admin\uhd\host\build\UHD.sln`.
- Change the build type from "Debug" to "Release".
- Select the "Build All" target, right-click, and choose "Build".
- Select the install target, right-click, and choose "Build".
@@ -272,7 +272,7 @@ You need to be an administrator or to run MSVC as administrator.
\subsection build_msvc_cmd_line Build the project in MSVC (command line)
Open the Visual Studio Command Prompt Shorcut:
- cd <uhd-repo-path>\\host\\build
+ cd <uhd-repo-path>\host\build
DevEnv uhd.sln /build Release /project ALL_BUILD
DevEnv uhd.sln /build Release /project INSTALL
@@ -281,7 +281,7 @@ Open the Visual Studio Command Prompt Shorcut:
- Select the "PACKAGE" project in the Solution Explorer, right-click, and choose "Build".
\subsection path_env Setup the PATH environment variable
-* Add the UHD bin path to `%PATH%` (usually `C:\\Program Files\\UHD\\bin`)
+* Add the UHD bin path to `%PATH%` (usually `C:\Program Files\UHD\bin`)
<b>Note:</b>
The default interface for editing environment variable paths in Windows is very poor.
diff --git a/host/include/uhd/rfnoc/block_id.hpp b/host/include/uhd/rfnoc/block_id.hpp
index d15220aa7..113124eea 100644
--- a/host/include/uhd/rfnoc/block_id.hpp
+++ b/host/include/uhd/rfnoc/block_id.hpp
@@ -26,7 +26,7 @@ namespace rfnoc {
*
* The rules for formatting such a string are:
*
- * DEVICE/BLOCKNAME#COUNTER
+ * DEVICE/BLOCKNAME\#COUNTER
*
* DEVICE: Identifies the device (usually the motherboard index)
* BLOCKNAME: A name given to this block
diff --git a/host/include/uhd/rfnoc/mb_controller.hpp b/host/include/uhd/rfnoc/mb_controller.hpp
index 0269301ff..e6276d39c 100644
--- a/host/include/uhd/rfnoc/mb_controller.hpp
+++ b/host/include/uhd/rfnoc/mb_controller.hpp
@@ -345,6 +345,7 @@ public:
* motherboard controller are removed from the list.
* On return, the list should be (ideally) identical
* to its value at call time.
+ * \param time_spec Time specification to syncrhonize \p mb_controllers to
* \param quiet If true, don't print any errors or warnings if
* synchronization fails.
* \returns true if all motherboards that were removed from \p mb_controllers
diff --git a/host/include/uhd/rfnoc/node.hpp b/host/include/uhd/rfnoc/node.hpp
index 33831a4d7..9424a6b58 100644
--- a/host/include/uhd/rfnoc/node.hpp
+++ b/host/include/uhd/rfnoc/node.hpp
@@ -114,7 +114,7 @@ public:
* be of a different type than \p prop_data_t due to the usage of runtime
* type information (RTTI), a lookup_error is thrown.
*
- * \param prop_data_t The data type of the property
+ * \tparam prop_data_t The data type of the property
* \param id The identifier of the property to write. To find out which
* values of \p id are valid, call get_property_ids()
* \param instance The instance number of this property
@@ -148,7 +148,7 @@ public:
* This is because internally, it can resolve properties, which may cause
* changes within the object.
*
- * \param prop_data_t The data type of the property
+ * \tparam prop_data_t The data type of the property
* \param id The identifier of the property to write.
* \param instance The instance number of this property
* \return The value of the property.
@@ -279,7 +279,7 @@ protected:
* This is like set_property(), but it also allows setting edge properties.
* All comments from set_property() still apply.
*
- * \param prop_data_t The data type of the property
+ * \tparam prop_data_t The data type of the property
* \param id The identifier of the property to write. To find out which
* values of \p id are valid, call get_property_ids()
* \param val The new value of the property.
@@ -294,7 +294,7 @@ protected:
* This is like get_property(), but it also allows reading edge properties.
* All comments from get_property() still apply.
*
- * \param prop_data_t The data type of the property
+ * \tparam prop_data_t The data type of the property
* \param id The identifier of the property to write.
* \param src_info Source info of this property
* \return The value of the property.
diff --git a/host/include/uhd/rfnoc/radio_control.hpp b/host/include/uhd/rfnoc/radio_control.hpp
index 4b1bd3d82..01fcb1d48 100644
--- a/host/include/uhd/rfnoc/radio_control.hpp
+++ b/host/include/uhd/rfnoc/radio_control.hpp
@@ -554,7 +554,7 @@ public:
/*! Enable/disable the automatic IQ imbalance correction.
*
- * \param enb true to enable automatic IQ balance correction
+ * \param correction the complex correction (1.0 is full-scale)
* \param chan the channel index 0 to N-1
*/
virtual void set_rx_iq_balance(
@@ -582,7 +582,6 @@ public:
* \param bank the name of a GPIO bank (e.g., FP0)
* \param attr the name of a GPIO attribute (e.g., CTRL)
* \param value the new value for this GPIO bank
- * \param mask the bit mask to effect which pins are changed
*/
virtual void set_gpio_attr(const std::string& bank,
const std::string& attr,
diff --git a/host/include/uhd/rfnoc/register_iface.hpp b/host/include/uhd/rfnoc/register_iface.hpp
index 23f24b242..5d95e6aae 100644
--- a/host/include/uhd/rfnoc/register_iface.hpp
+++ b/host/include/uhd/rfnoc/register_iface.hpp
@@ -84,6 +84,7 @@ public:
* (truncated to 20 bits).
* \param data New value of the register(s).
* \param time The time at which the transaction should be executed.
+ * \param ack Should transaction completion be acknowledged?
*
* \throws op_failed if the transaction fails
* \throws op_timeout if no response is received
diff --git a/host/include/uhd/usrp/multi_usrp.hpp b/host/include/uhd/usrp/multi_usrp.hpp
index 4efc062b0..9742a8ab6 100644
--- a/host/include/uhd/usrp/multi_usrp.hpp
+++ b/host/include/uhd/usrp/multi_usrp.hpp
@@ -1539,13 +1539,14 @@ public:
* Enumerate the available filters in the RX signal path.
* \param chan RX channel index 0 to N-1
* \return a vector of strings representing the selected filter names.
- * \returnblock Filter names will follow the pattern BLOCK_ID:FILTER_NAME. For example, "0/Radio#0:HB_0"
+ * \return Filter names will follow the pattern BLOCK_ID:FILTER_NAME. For example, "0/Radio#0:HB_0"
*/
virtual std::vector<std::string> get_rx_filter_names(const size_t chan) = 0;
/*!
* Return the filter object for the given RX filter name.
* \param name the name of the filter as returned from get_rx_filter_names().
+ * \param chan RX channel index 0 to N-1
* \return a filter_info_base::sptr.
*/
virtual uhd::filter_info_base::sptr get_rx_filter(const std::string& name, const size_t chan) = 0;
@@ -1555,6 +1556,7 @@ public:
* This filter can be a modified version of the originally returned one.
* \param name the name of the filter as returned from get_rx_filter_names().
* \param filter the filter_info_base::sptr of the filter object to be written
+ * \param chan RX channel index 0 to N-1
*/
virtual void set_rx_filter(
const std::string& name, uhd::filter_info_base::sptr filter, const size_t chan) = 0;
@@ -1564,13 +1566,14 @@ public:
* Enumerate the available filters in the TX signal path.
* \param chan TX channel index 0 to N-1
* \return a vector of strings representing the selected filter names.
- * \returnblock Filter names will follow the pattern BLOCK_ID:FILTER_NAME. For example, "0/Radio#0:HB_0"
+ * \return Filter names will follow the pattern BLOCK_ID:FILTER_NAME. For example, "0/Radio#0:HB_0"
*/
virtual std::vector<std::string> get_tx_filter_names(const size_t chan) = 0;
/*!
* Return the filter object for the given TX filter name.
* \param name the name of the filter as returned from get_tx_filter_names().
+ * \param chan TX channel index 0 to N-1
* \return a filter_info_base::sptr.
*/
virtual uhd::filter_info_base::sptr get_tx_filter(const std::string& name, const size_t chan) = 0;
@@ -1580,6 +1583,7 @@ public:
* This filter can be a modified version of the originally returned one.
* \param name the name of the filter as returned from get_tx_filter_names().
* \param filter the filter_info_base::sptr of the filter object to be written
+ * \param chan TX channel index 0 to N-1
*/
virtual void set_tx_filter(
const std::string& name, uhd::filter_info_base::sptr filter, const size_t chan) = 0;
diff --git a/host/include/uhd/utils/gain_group.hpp b/host/include/uhd/utils/gain_group.hpp
index bfc6a94a6..5901d71bb 100644
--- a/host/include/uhd/utils/gain_group.hpp
+++ b/host/include/uhd/utils/gain_group.hpp
@@ -94,7 +94,6 @@ public:
/*!
* Make a new gain group with all zero values.
- * \param name the name of the (only and zero-valued) gain element
* \return a gain group object populated with zeroes
*/
static sptr make_zero();
diff --git a/host/include/uhd/utils/graph_utils.hpp b/host/include/uhd/utils/graph_utils.hpp
index b2c61f78f..1cdfe389c 100644
--- a/host/include/uhd/utils/graph_utils.hpp
+++ b/host/include/uhd/utils/graph_utils.hpp
@@ -39,7 +39,7 @@ static const std::vector<block_port_def> TERMINATOR_BLOCKS{
* \param graph The rfnoc_graph that is being examined
* \param start_block The block we begin to build the chain from
* \param port The block port of `src_port` that the path will begin at
- * \param source_block Whether or not the `start_block` is a source (or a destination).
+ * \param source_chain Whether or not the `start_block` is a source (or a destination).
* If true, the chain will start at `start_block`'s output port. If
* false, the chain will start with `start_block`'s output port.
* \return The edge list representing the data path requested
@@ -52,6 +52,7 @@ std::vector<graph_edge_t> UHD_API get_block_chain(const rfnoc_graph::sptr graph,
/*! Connect desired blocks by whatever path that can be found
*
+ * \param graph The rfnoc_graph that is being examined
* \param src_blk Source block's ID
* \param src_port Block port where the path starts
* \param dst_blk Destination block's ID
generated by cgit v1.2.3 (git 2.46.0) at 2025-11-04 04:47:06 +0000