aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/coding.dox
diff options
context:
space:
mode:
authorNicholas Corgan <nick.corgan@ettus.com>2014-07-31 10:19:51 -0700
committerNicholas Corgan <nick.corgan@ettus.com>2014-07-31 10:49:40 -0700
commit0a0844cf35b90c68949ae4906cb2f7f7579fbaa4 (patch)
treefb070bcc0ae882805cd7fee9c6643423bcead754 /host/docs/coding.dox
parent4999b5df50d4e859bc3c95c2cbe0efc58df5c42a (diff)
downloaduhd-0a0844cf35b90c68949ae4906cb2f7f7579fbaa4.tar.gz
uhd-0a0844cf35b90c68949ae4906cb2f7f7579fbaa4.tar.bz2
uhd-0a0844cf35b90c68949ae4906cb2f7f7579fbaa4.zip
Updated master-specfic documentation
* Updated manual URL on OctoClock documentation after manual overhaul * Improved "Coding to the API" page
Diffstat (limited to 'host/docs/coding.dox')
-rw-r--r--host/docs/coding.dox12
1 files changed, 10 insertions, 2 deletions
diff --git a/host/docs/coding.dox b/host/docs/coding.dox
index b50e55e24..32dbe944a 100644
--- a/host/docs/coding.dox
+++ b/host/docs/coding.dox
@@ -6,15 +6,22 @@
\subsection coding_api_hilevel High-Level: The Multi-USRP
-The Multi-USRP class provides a fat interface to a single USRP device
+The Multi-USRP class provides a high-level interface to a single USRP device
with one or more channels, or multiple USRP devicess in a homogeneous
setup. See the documentation for uhd::usrp::multi_usrp.
+\subsection coding_api_hilevelclock High-Level: The Multi-USRP-Clock
+
+The Multi-USRP-Clock class provides a high-level interface to a single clock
+device or set of clock devices, from which the time can be queried. See the
+documentation for uhd::usrp_clock::multi_usrp_clock.
+
\subsection coding_api_lowlevel Low-Level: The device API
A device is an abstraction for hardware that is connected to the host
system. For a USRP device, this means that the motherboard and
-everything on it would be considered to be a "device". The device API
+everything on it would be considered to be a "device". For a clock device, the
+device itself would be considered a "device" in software. The device API
provides ways to:
- Discover devices that are physically connected to the host system.
@@ -23,6 +30,7 @@ provides ways to:
- Register a device driver into the discovery and factory sub-system.
- Streaming samples with metadata into and out of the device.
- Set and get properties on the device object.
+- Access various sensors on the device.
See the documentation for uhd::device.