From 5fc3a5973f914714a15401f5732ebabbe20cc4d6 Mon Sep 17 00:00:00 2001 From: Nicholas Corgan Date: Thu, 31 Jul 2014 10:10:14 -0700 Subject: Updated documentation * Updated UHD documentation-related URL's after manual overhaul * Updated NI-USRP URL to link to NI-USRP 1.3 --- host/docs/uhd_cal_rx_iq_balance.1 | 2 +- host/docs/uhd_cal_tx_dc_offset.1 | 2 +- host/docs/uhd_cal_tx_iq_balance.1 | 2 +- host/docs/uhd_find_devices.1 | 2 +- host/docs/uhd_images_downloader.1 | 2 +- host/docs/uhd_usrp_probe.1 | 2 +- host/docs/usrp2_card_burner.1 | 2 +- host/docs/usrp_n2xx_simple_net_burner.1 | 2 +- host/docs/usrp_x3xx_fpga_burner.1 | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) (limited to 'host/docs') diff --git a/host/docs/uhd_cal_rx_iq_balance.1 b/host/docs/uhd_cal_rx_iq_balance.1 index 8c2c87ece..df77afb2c 100644 --- a/host/docs/uhd_cal_rx_iq_balance.1 +++ b/host/docs/uhd_cal_rx_iq_balance.1 @@ -43,7 +43,7 @@ Samples per data capture .PP .SH SEE ALSO UHD documentation: -.B http://files.ettus.com/uhd_docs/manual/html/index.html +.B http://files.ettus.com/manual/ .LP GR-UHD documentation: .B http://gnuradio.org/doc/doxygen/page_uhd.html diff --git a/host/docs/uhd_cal_tx_dc_offset.1 b/host/docs/uhd_cal_tx_dc_offset.1 index f0479d7ec..50d3899e8 100644 --- a/host/docs/uhd_cal_tx_dc_offset.1 +++ b/host/docs/uhd_cal_tx_dc_offset.1 @@ -43,7 +43,7 @@ Samples per data capture .PP .SH SEE ALSO UHD documentation: -.B http://files.ettus.com/uhd_docs/manual/html/index.html +.B http://files.ettus.com/manual/ .LP GR-UHD documentation: .B http://gnuradio.org/doc/doxygen/page_uhd.html diff --git a/host/docs/uhd_cal_tx_iq_balance.1 b/host/docs/uhd_cal_tx_iq_balance.1 index bb8970f4c..859cf9a84 100644 --- a/host/docs/uhd_cal_tx_iq_balance.1 +++ b/host/docs/uhd_cal_tx_iq_balance.1 @@ -43,7 +43,7 @@ Samples per data capture .PP .SH SEE ALSO UHD documentation: -.B http://files.ettus.com/uhd_docs/manual/html/index.html +.B http://files.ettus.com/manual/ .LP GR-UHD documentation: .B http://gnuradio.org/doc/doxygen/page_uhd.html diff --git a/host/docs/uhd_find_devices.1 b/host/docs/uhd_find_devices.1 index 416f807b9..405111a00 100644 --- a/host/docs/uhd_find_devices.1 +++ b/host/docs/uhd_find_devices.1 @@ -80,7 +80,7 @@ uhd_find_devices \-\-args="serial=12345678" uhd_find_devices .SH SEE ALSO UHD documentation: -.B http://files.ettus.com/uhd_docs/manual/html/index.html +.B http://files.ettus.com/manual/ .LP GR-UHD documentation: .B http://gnuradio.org/doc/doxygen/page_uhd.html diff --git a/host/docs/uhd_images_downloader.1 b/host/docs/uhd_images_downloader.1 index dd0fe208d..e6cd7d978 100644 --- a/host/docs/uhd_images_downloader.1 +++ b/host/docs/uhd_images_downloader.1 @@ -26,7 +26,7 @@ This program works best without any arguments. Set download buffer size, [default=8192] .SH SEE ALSO UHD documentation: -.B http://files.ettus.com/uhd_docs/manual/html/index.html +.B http://files.ettus.com/manual/ .LP GR-UHD documentation: .B http://gnuradio.org/doc/doxygen/page_uhd.html diff --git a/host/docs/uhd_usrp_probe.1 b/host/docs/uhd_usrp_probe.1 index ee30b2350..d26408ce6 100644 --- a/host/docs/uhd_usrp_probe.1 +++ b/host/docs/uhd_usrp_probe.1 @@ -89,7 +89,7 @@ uhd_usrp_probe \-\-args="serial=12345678" uhd_usrp_probe .SH SEE ALSO UHD documentation: -.B http://files.ettus.com/uhd_docs/manual/html/index.html +.B http://files.ettus.com/manual/ .LP GR-UHD documentation: .B http://gnuradio.org/doc/doxygen/page_uhd.html diff --git a/host/docs/usrp2_card_burner.1 b/host/docs/usrp2_card_burner.1 index b6e1954d8..b43484b99 100644 --- a/host/docs/usrp2_card_burner.1 +++ b/host/docs/usrp2_card_burner.1 @@ -27,7 +27,7 @@ usrp2_card_burner --dev=/dev/sdd1 --fw=usrp2_fw.bin --fpga=usrp2_fpga.bin .fi .SH SEE ALSO UHD documentation: -.B http://files.ettus.com/uhd_docs/manual/html/index.html +.B http://files.ettus.com/manual/ .LP GR-UHD documentation: .B http://gnuradio.org/doc/doxygen/page_uhd.html diff --git a/host/docs/usrp_n2xx_simple_net_burner.1 b/host/docs/usrp_n2xx_simple_net_burner.1 index 8df38b7bd..ca63e5698 100644 --- a/host/docs/usrp_n2xx_simple_net_burner.1 +++ b/host/docs/usrp_n2xx_simple_net_burner.1 @@ -34,7 +34,7 @@ usrp_n2xx_simple_net_burner --addr=192.168.10.3 .fi .SH SEE ALSO UHD documentation: -.B http://files.ettus.com/uhd_docs/manual/html/index.html +.B http://files.ettus.com/manual/ .LP GR-UHD documentation: .B http://gnuradio.org/doc/doxygen/page_uhd.html diff --git a/host/docs/usrp_x3xx_fpga_burner.1 b/host/docs/usrp_x3xx_fpga_burner.1 index 3a8a27e69..5c1b085b7 100644 --- a/host/docs/usrp_x3xx_fpga_burner.1 +++ b/host/docs/usrp_x3xx_fpga_burner.1 @@ -40,7 +40,7 @@ usrp_x3xx_fpga_burner --addr=192.168.10.2 --fpga=path="custom_image.bit" .fi .SH SEE ALSO UHD documentation: -.B http://files.ettus.com/uhd_docs/manual/html/index.html +.B http://files.ettus.com/manual/ .LP GR-UHD documentation: .B http://gnuradio.org/doc/doxygen/page_uhd.html -- cgit v1.2.3 From 0a0844cf35b90c68949ae4906cb2f7f7579fbaa4 Mon Sep 17 00:00:00 2001 From: Nicholas Corgan Date: Thu, 31 Jul 2014 10:19:51 -0700 Subject: Updated master-specfic documentation * Updated manual URL on OctoClock documentation after manual overhaul * Improved "Coding to the API" page --- host/docs/coding.dox | 12 ++++++++++-- host/docs/octoclock_firmware_burner.1 | 2 +- host/utils/octoclock_firmware_burner.cpp | 2 +- 3 files changed, 12 insertions(+), 4 deletions(-) (limited to 'host/docs') 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); } -- cgit v1.2.3