bladeRF/host/libraries/libbladeRF/doc/examples
Jon Szymaniak 3cdf642614 libbladeRF/doc: Overhauled API docs main page and added examples
The main landing page in the Doxygen is now filled out with
some general information.

Existing examples have been simplified and moved to
dedicated pages that are linked to from the main page and
relevant sections of the documentation elsewhere.
2015-06-06 17:01:19 -04:00
..
boilerplate.c libbladeRF/doc: Overhauled API docs main page and added examples 2015-06-06 17:01:19 -04:00
CMakeLists.txt libbladeRF/doc: Overhauled API docs main page and added examples 2015-06-06 17:01:19 -04:00
example_common.c libbladeRF: Added more complete examples for the synchronous interface 2014-10-21 08:01:28 -04:00
example_common.h libbladeRF: Added more complete examples for the synchronous interface 2014-10-21 08:01:28 -04:00
open_via_serial.c host: Updated and moved Windows C99 compatibility headers 2014-11-14 15:19:18 -05:00
README libbladeRF: Added more complete examples for the synchronous interface 2014-10-21 08:01:28 -04:00
sync_rx_meta.c libbladeRF/doc: Overhauled API docs main page and added examples 2015-06-06 17:01:19 -04:00
sync_rxtx.c libbladeRF/doc: Overhauled API docs main page and added examples 2015-06-06 17:01:19 -04:00
sync_tx_meta.c libbladeRF/doc: Overhauled API docs main page and added examples 2015-06-06 17:01:19 -04:00

This directory contains example snippets to be included in Doxygen-generated
documents. These are built when the host system has Doxygen installed and the
following CMake variables are set:
    BUILD_DOCUMENTATION=ON
    BUILD_LIBBLADERF_DOCUMENATION=ON
    BUILD_LIBBLADERF_DOC_EXAMPLES=ON


For more involved programs, see the libbladeRF tests/ directory
and the bladeRF-cli source code.