tinycbor: add doc.txt

This commit is contained in:
Koen Zandberg 2018-09-19 18:52:52 +02:00
parent dc8653363c
commit 180917e108
No known key found for this signature in database
GPG Key ID: 0895A893E6D2985B

29
pkg/tinycbor/doc.txt Normal file
View File

@ -0,0 +1,29 @@
/**
* @defgroup pkg_tinycbor TinyCBOR library
* @ingroup pkg
* @brief Provides the TinyCBOR (Concise Binary Object Representation)
* library
* @see https://github.com/intel/tinycbor/
*
* # TinyCBOR
*
* TinyCBOR is a CBOR encoder and decoder with a very small footprint, optimized
* for very fast operation.
*
* The main encoder and decoder functions don't use dynamic memory allocation.
*
* # Usage
*
* Just add it as a package in your application's Makefile:
*
* ```makefile
* USEPKG += tinycbor
* ```
*
* TinyCBOR has optional floating point support. In RIOT-OS this is enabled by
* adding the following line to your application's Makefile:
*
* ```makefile
* USEMODULE += tinycbor_float
* ```
*/