bladeRF/host/libraries/libbladeRF/doc/examples/README
Jon Szymaniak f7a4345257 libbladeRF: Added more complete examples for the synchronous interface
The existing bladerf_sync_rx() snippet in the libbladeRF API docs has
been replaced by a more complete snippet in libbladeRF/doc/examples.

From now on, major snippets and examples to be included in
Doxygen-generated documentation shall now be placed in the
libbladeRF/doc/examples directory, and must be buildable and testable.

The Doxygen "snippet" command to shall be used to include the relevant
code from the example program.

libbladeRF: [WIP] Use a simple delay to wait for TX samples in example
2014-10-21 08:01:28 -04:00

10 lines
390 B
Text

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.