diff options
| author | Martin Braun <martin.braun@ettus.com> | 2018-07-19 16:39:57 -0700 |
|---|---|---|
| committer | Martin Braun <martin.braun@ettus.com> | 2018-07-19 16:39:57 -0700 |
| commit | 6580c85d1a620c4aa722edfc92b1fd9f189b077a (patch) | |
| tree | 6d7eeeb4f53f8104d135fb07110b4d9a8ed914fe /host/docs/capi.dox | |
| parent | 5aa541a9e87019895dc4c11d0045ed269a247e04 (diff) | |
| download | uhd-6580c85d1a620c4aa722edfc92b1fd9f189b077a.tar.gz uhd-6580c85d1a620c4aa722edfc92b1fd9f189b077a.tar.bz2 uhd-6580c85d1a620c4aa722edfc92b1fd9f189b077a.zip | |
docs: Add page for the C API
Diffstat (limited to 'host/docs/capi.dox')
| -rw-r--r-- | host/docs/capi.dox | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/host/docs/capi.dox b/host/docs/capi.dox new file mode 100644 index 000000000..717f5a78b --- /dev/null +++ b/host/docs/capi.dox @@ -0,0 +1,24 @@ +/*! \page page_python C API + +UHD supports a C API, in case the C++ or Python APIs are not the right solution +for your application. + +\section capi_install Installing the C API + +In order to install the C API when building UHD from source, make sure you have +the CMake variable `ENABLE_C_API` set to ON (e.g., by running +`cmake -DENABLE_C_API=ON`). + +\section capi_usage Using the C API + +The C API mirrors the C++ API, so the C++ reference manual can be used to +understand the behaviour of the Python API as well. + +The `examples/` subdirectory provides several examples on how to use the C API. +See also the usrp.h include file, which provides all the functionality that +would be provided by uhd::usrp::multi_usrp in the C++ case. + + +*/ +// vim:ft=doxygen: + |