Commit graph

10 commits

Author SHA1 Message Date
Rey Tucker
2c950ad246 host: libbladeRF: clang-format doc examples (#56) 2018-05-30 15:27:07 -04:00
Vanya A. Sergeev
64a69f569b libbladeRF: update docs and examples with new API 2017-12-21 12:55:04 -05:00
Jon Szymaniak
ef797fd412 libbladeRF/doc: Fixed typos and touched up timestamp calculations
- The calculation for advancing 150 ms was incorrect
- Compute timestamp increment constants to be more clear
2015-12-23 23:14:31 -05:00
Jon Szymaniak
2b7bb2a8f0 libbladeRF/doc: Clarified use of zero-sample in example 2015-07-25 15:30:19 -04:00
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
Jon Szymaniak
625e0f4fbe libbladeRF: Removed unnecessary -lm and math.h from example program 2014-11-14 16:40:02 -05:00
Jon Szymaniak
64275e768f host: Updated and moved Windows C99 compatibility headers
Visual Studio 2013 now includes these headers, so they have
been moved as not to conflict (even though they are intended to
be equivalent.)

Our stdbool.h was providing an incorrect typedef; sizeof(bool)
should have been 1, not sizeof(int).

Per http://msdn.microsoft.com/en-us/library/tf4dy80a.aspx:
    "In Visual C++4.2, the Standard C++ header files contained a typedef
    that equated bool with int. In Visual C++ 5.0 and later, bool is
    implemented as a built-in type with a size of 1 byte. That means
    that for Visual C++ 4.2, a call of sizeof(bool) yields 4, while in
    Visual C++ 5.0 and later, the same call yields 1. This can cause
    memory corruption problems if you have defined structure members of
    type bool in Visual C++ 4.2 and are mixing object files (OBJ) and/or
    DLLs built with the 4.2 and 5.0 or later compilers."
2014-11-14 15:19:18 -05:00
Jon Szymaniak
3f2a9519cb libbladeRF: Removed dead-assignment in example program 2014-11-11 11:54:58 -05:00
Jon Szymaniak
79d6894356 libbladeRF: Fixed Windows build issues in doc examples 2014-11-11 11:10:26 -05:00
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