Skip to content

Commit

Permalink
tinycbor: add doc.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
bergzand committed Sep 19, 2018
1 parent 5bb988a commit 47f3529
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions pkg/tinycbor/doc.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/**
* @defgroup pkg_tinycbor TinyCBOR CBOR library
* @ingroup pkg
* @brief Provides the TinyCBOR Concise Binary Object Representation (CBOR)
* Library
* @see https://github.com/intel/tinycbor/
*
* # TinyCBOR
*
* TinyCBOR is a small CBOR encoder and decoder, optimized for very fast
* operation with very small footprint.
*
* The main encoder and decoder function don't use dynamic memory allocation.
*
* # Usage
*
* Just add it as a package in your application:
*
* ```makefile
* USEPKG += tinycbor
* ```
*
* TinyCBOR has optional floating point support. In RIOT-os this is enabled by
* adding to your application:
*
* ```makefile
* USEMODULE += tinycbor_float
* ```
*/

0 comments on commit 47f3529

Please sign in to comment.