aboutsummaryrefslogtreecommitdiffstats
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
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
-rw-r--r--host/docs/coding.dox12
-rw-r--r--host/docs/octoclock_firmware_burner.12
-rw-r--r--host/utils/octoclock_firmware_burner.cpp2
3 files changed, 12 insertions, 4 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.
diff --git a/host/docs/octoclock_firmware_burner.1 b/host/docs/octoclock_firmware_burner.1
index 0494b3b37..44ff47a85 100644
--- a/host/docs/octoclock_firmware_burner.1
+++ b/host/docs/octoclock_firmware_burner.1
@@ -23,7 +23,7 @@ octoclock_firmware_burner --addr=192.168.10.3 --fw-path=~/custom_octoclock_image
.fi
.SH SEE ALSO
UHD documentation:
-.B http://files.ettus.com/uhd_docs/manual/html/index.html
+.B http://files.ettus.com/manual/
.LP
Other UHD programs:
.sp
diff --git a/host/utils/octoclock_firmware_burner.cpp b/host/utils/octoclock_firmware_burner.cpp
index b8b8a3c1d..bc91f22f9 100644
--- a/host/utils/octoclock_firmware_burner.cpp
+++ b/host/utils/octoclock_firmware_burner.cpp
@@ -64,7 +64,7 @@ void sig_int_handler(int){
}
else{
std::cout << std::endl << "Aborting. Your OctoClock device will be bricked." << std::endl
- << "Refer to http://files.ettus.com/uhd_docs/doxymanual/html/octoclock.html" << std::endl
+ << "Refer to http://files.ettus.com/manual/page_octoclock.html#bootloader" << std::endl
<< "for details on restoring your device." << std::endl;
exit(EXIT_FAILURE);
}