aboutsummaryrefslogtreecommitdiffstats
path: root/host/include
diff options
context:
space:
mode:
authorNicholas Corgan <nick.corgan@ettus.com>2015-06-22 13:58:38 -0700
committerNicholas Corgan <nick.corgan@ettus.com>2015-06-22 13:58:38 -0700
commitfd432e3765fcb27a2d170b1366f6d88528eb9812 (patch)
tree18fe1f140b15f348ff3cd4e5be09ed7c5c8d2485 /host/include
parenta4d01f09687d63193719888ba1e797f2a4822794 (diff)
downloaduhd-fd432e3765fcb27a2d170b1366f6d88528eb9812.tar.gz
uhd-fd432e3765fcb27a2d170b1366f6d88528eb9812.tar.bz2
uhd-fd432e3765fcb27a2d170b1366f6d88528eb9812.zip
docs: added missing parameter descriptions
Diffstat (limited to 'host/include')
-rw-r--r--host/include/uhd/device.hpp1
-rw-r--r--host/include/uhd/utils/paths.hpp6
2 files changed, 4 insertions, 3 deletions
diff --git a/host/include/uhd/device.hpp b/host/include/uhd/device.hpp
index 5ca48f8e9..894b48c47 100644
--- a/host/include/uhd/device.hpp
+++ b/host/include/uhd/device.hpp
@@ -55,6 +55,7 @@ public:
*
* \param find a function that discovers devices
* \param make a factory function that makes a device
+ * \param filter include only USRP devices, clock devices, or both
*/
static void register_device(
const find_t &find,
diff --git a/host/include/uhd/utils/paths.hpp b/host/include/uhd/utils/paths.hpp
index 8edb87546..0dbee3446 100644
--- a/host/include/uhd/utils/paths.hpp
+++ b/host/include/uhd/utils/paths.hpp
@@ -1,5 +1,5 @@
//
-// Copyright 2011-2012 Ettus Research LLC
+// Copyright 2011-2012,2015 Ettus Research LLC
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
@@ -77,8 +77,8 @@ namespace uhd {
/*!
* Search for the location of a particular UHD utility.
* The utility must be installed in the `uhd/utils` directory.
- * \param the name of the utility to search for
- * \return the full system path to @param
+ * \param name the name of the utility to search for
+ * \return the full system path to the given utility
*/
UHD_API std::string find_utility(std::string name);