diff options
| author | Martin Braun <martin.braun@ettus.com> | 2014-03-23 15:11:26 +0100 |
|---|---|---|
| committer | Martin Braun <martin.braun@ettus.com> | 2014-04-09 17:25:09 +0200 |
| commit | a74919c2a89a6b1ae40b526c4ceadf1108bfd186 (patch) | |
| tree | 79cb43c5d7ed3caa1fe8b695001267f0cc8286bf /host/docs/mainpage.dox | |
| parent | 47bf17b50a305228cfd07ff6fbaff3ac4a30e811 (diff) | |
| download | uhd-a74919c2a89a6b1ae40b526c4ceadf1108bfd186.tar.gz uhd-a74919c2a89a6b1ae40b526c4ceadf1108bfd186.tar.bz2 uhd-a74919c2a89a6b1ae40b526c4ceadf1108bfd186.zip | |
docs: Moved manual to Doxygen
Diffstat (limited to 'host/docs/mainpage.dox')
| -rw-r--r-- | host/docs/mainpage.dox | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/host/docs/mainpage.dox b/host/docs/mainpage.dox new file mode 100644 index 000000000..535a00e22 --- /dev/null +++ b/host/docs/mainpage.dox @@ -0,0 +1,59 @@ +/*! \mainpage Table Of Contents + +\tableofcontents + +Welcome to the manual pages for the Universal Software Radio Peripherals (USRP) and their driver suite, the USRP Hardware Driver (UHD). Here, you will find information on how to use the USRPs and how to use the API to connect to them through your own software. + +# Building and Installing UHD + +\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 + +\li \subpage page_usrp_b100 +\li \subpage page_usrp_b200 +\li \subpage page_gpsdo_b2x0 +\li \subpage page_usrp1 + +## USRP E-Series Devices + +\li \subpage page_usrp_e1x0 +\li \subpage page_gpsdo + +## USRP X-Series Devices + +\li \subpage page_usrp_x3x0 +\li \subpage page_gpsdo_x3x0 +\li \subpage page_gpio_api +\li \subpage page_usrp_x3x0_config + +## USRP Legacy Series + +\li \subpage page_usrp2 + +# API Documentation + +\li \subpage page_coding +\li \subpage page_stream + +*/ +// vim:ft=doxygen: |