diff options
| author | Ben Hilburn <ben.hilburn@ettus.com> | 2014-04-11 14:51:04 -0700 |
|---|---|---|
| committer | Ben Hilburn <ben.hilburn@ettus.com> | 2014-04-11 14:51:04 -0700 |
| commit | dedf16ea795443f41edefbeb1eb77e2b91cb4691 (patch) | |
| tree | 6627f42cbe0d595120621cf51fe505cb74cac525 /host/docs/coding.rst | |
| parent | 87b068edddf5862f532dbc06e7a20106e524b581 (diff) | |
| parent | 5268e0794b82fa4da095f2de9bf233e01e92ab1c (diff) | |
| download | uhd-dedf16ea795443f41edefbeb1eb77e2b91cb4691.tar.gz uhd-dedf16ea795443f41edefbeb1eb77e2b91cb4691.tar.bz2 uhd-dedf16ea795443f41edefbeb1eb77e2b91cb4691.zip | |
Merging Doxygen manual into 'master'.
Diffstat (limited to 'host/docs/coding.rst')
| -rw-r--r-- | host/docs/coding.rst | 30 |
1 files changed, 0 insertions, 30 deletions
diff --git a/host/docs/coding.rst b/host/docs/coding.rst deleted file mode 100644 index 432307cca..000000000 --- a/host/docs/coding.rst +++ /dev/null @@ -1,30 +0,0 @@ -======================================================================== -UHD - Coding to the API -======================================================================== - -.. contents:: Table of Contents - ------------------------------------------------------------------------- -Various API interfaces ------------------------------------------------------------------------- -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -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 provides ways to: - -* Discover devices that are physically connected to the host system. -* Create a device object for a particular device identified by address. -* 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. - -See the documentation in *device.hpp* for reference. - -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -High-Level: The Multi-USRP -^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The Multi-USRP class provides a fat interface to a single USRP device with -one or more channels, or multiple USRP devicess in a homogeneous setup. -See the documentation in *usrp/multi_usrp.hpp* for reference. |