RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-17 05:12:57 +01:00
Code Releases Activity

Merge pull request #9968 from bergzand/pr/tinycbor/readme

Browse Source 
tinycbor: add doc.txt file
This commit is contained in:
Gaëtan Harter 2018-10-01 15:31:07 +02:00 committed by GitHub
commit be1c44e4d4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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
* ```
*/