From 180917e108df6f12de72a1d8664ba8c04dd9080e Mon Sep 17 00:00:00 2001 From: Koen Zandberg Date: Wed, 19 Sep 2018 18:52:52 +0200 Subject: [PATCH] tinycbor: add doc.txt --- pkg/tinycbor/doc.txt | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 pkg/tinycbor/doc.txt diff --git a/pkg/tinycbor/doc.txt b/pkg/tinycbor/doc.txt new file mode 100644 index 0000000000..dbdbc6429e --- /dev/null +++ b/pkg/tinycbor/doc.txt @@ -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 + * ``` + */