aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/mainpage.dox
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2014-10-14 14:51:09 +0200
committerMartin Braun <martin.braun@ettus.com>2014-10-14 14:51:09 +0200
commit2843de0a1b985bf5c8cdbc64a368e0e7d0b08fe6 (patch)
tree95c2459895cf42450972df61a069f08bd0fd67d0 /host/docs/mainpage.dox
parente82f7f0e7e49ec9b25dd65249fb603aeca6f283e (diff)
downloaduhd-2843de0a1b985bf5c8cdbc64a368e0e7d0b08fe6.tar.gz
uhd-2843de0a1b985bf5c8cdbc64a368e0e7d0b08fe6.tar.bz2
uhd-2843de0a1b985bf5c8cdbc64a368e0e7d0b08fe6.zip
docs: Cleaned up and rearranged manual structure
- Removed stray .rst files - Cleared up TOC, manual is now split into two parts
Diffstat (limited to 'host/docs/mainpage.dox')
-rw-r--r--host/docs/mainpage.dox67
1 files changed, 14 insertions, 53 deletions
diff --git a/host/docs/mainpage.dox b/host/docs/mainpage.dox
index 17f01cfc0..a12e62c9c 100644
--- a/host/docs/mainpage.dox
+++ b/host/docs/mainpage.dox
@@ -1,67 +1,28 @@
/*! \mainpage Table Of Contents
-\tableofcontents
+Welcome to the USRP Hardware Driver (UHD) manual. Here, you will find information on how to use the devices and how to use the API to connect to them through your own software.
-Welcome to the manual pages for the USRP Hardware Driver (UHD), the host driver
-for Ettus Research devices. Here, you will find information on how to use the
-devices and how to use the API to connect to them through your own software.
+This manual is split into two parts: The device manual, and the UHD/API manual. The first part describes details of our devices, mainboards and daughterboards, as well as aspects of _using_ UHD.
-# Building and Installing UHD
+The second is meant for developers writing UHD-based applications, and includes descriptions of the API, sorted by namespaces, classes and files.
-\li \subpage page_build_guide
-\li <a href="http://code.ettus.com/redmine/ettus/projects/uhd/wiki/UHD_Linux">Installation Guide (Linux)</a>
-\li <a href="http://code.ettus.com/redmine/ettus/projects/uhd/wiki/UHD_Windows">Installation Guide (Windows)</a>
-
-# General UHD Manuals
-
-\li \subpage page_general
-\li \subpage page_identification
-\li \subpage page_images
-\li \subpage page_dboards
-\li \subpage page_transport
-\li \subpage page_sync
-\li \subpage page_calibration
-
-# Device Specific Manuals
-
-## USRP N-Series Devices
-
-\li \subpage page_usrp2
-\li \subpage page_gpsdo
-
-## USRP B-Series Devices
+Follow these links to get to the section of the manual you wish to consult, or use the browser in the left sidebar. A search bar is also available at the top right, but note that this only works on API components. For information on how to build and install UHD, go to the UHD web site (see below).
-\li \subpage page_usrp_b100
-\li \subpage page_usrp_b200
-\li \subpage page_gpsdo_b2x0
-\li \subpage page_usrp1
+## Manual Parts
-## USRP E-Series Devices
+\li \subpage page_devices "Part I: Devices & Usage Manual"
+\li \subpage page_uhd "Part II: UHD Development Manual"
-\li \subpage page_usrp_e1x0
-\li \subpage page_usrp_e3x0
-\li \subpage page_gpsdo
+### Further Information
-## USRP X-Series Devices
+\li <a href="http://www.ettus.com/">Ettus Research LLC Website</a>
+\li <a href="http://code.ettus.com/redmine/ettus/projects/uhd/wiki/">UHD Wiki Page</a>
-\li \subpage page_usrp_x3x0
-\li \subpage page_gpsdo_x3x0
-\li \subpage page_gpio_api
-\li \subpage page_usrp_x3x0_config
-\li \subpage page_ni_rio_kernel
+### Building and Installing UHD
-## USRP Legacy Series
-
-\li \subpage page_usrp2
-
-## OctoClock
-
-\li \subpage page_octoclock
-
-# API Documentation
-
-\li \subpage page_coding
-\li \subpage page_stream
+\li \subpage page_build_guide
+\li <a href="http://code.ettus.com/redmine/ettus/projects/uhd/wiki/UHD_Linux">Installation Guide (Linux)</a>
+\li <a href="http://code.ettus.com/redmine/ettus/projects/uhd/wiki/UHD_Windows">Installation Guide (Windows)</a>
*/
// vim:ft=doxygen: