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/coding.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/coding.dox')
| -rw-r--r-- | host/docs/coding.dox | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/host/docs/coding.dox b/host/docs/coding.dox new file mode 100644 index 000000000..b50e55e24 --- /dev/null +++ b/host/docs/coding.dox @@ -0,0 +1,30 @@ +/*! \page page_coding Coding to the API + +\tableofcontents + +\section coding_api Various API interfaces + +\subsection coding_api_hilevel 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 for uhd::usrp::multi_usrp. + +\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 +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 for uhd::device. + +*/ +// vim:ft=doxygen: |