Merge pull request #9840 from jia200x/pr/doc_serializer

doc: add `serialization` group to Doxygen
RIOT-OS · Oct 8, 2018 · bbae45c · bbae45c
2 parents f38b71b + 470cec8
commit bbae45c
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 12 deletions.
diff --git a/pkg/cayenne-lpp/doc.txt b/pkg/cayenne-lpp/doc.txt
@@ -1,7 +1,7 @@
 /**
  * @defgroup pkg_cayenne-lpp Cayenne Low Power Payload (LPP)
  * @ingroup  pkg
- * @ingroup  sys
+ * @ingroup  sys_serialization
  * @brief    Provides a RIOT support for Cayenne LPP format
  *
  * The Cayenne Low Power Payload (LPP) provides a convenient and easy way to

diff --git a/pkg/cn-cbor/doc.txt b/pkg/cn-cbor/doc.txt
@@ -1,7 +1,7 @@
 /**
  * @defgroup pkg_cn-cbor cn-cbor
  * @ingroup  pkg
- * @ingroup  sys
+ * @ingroup  sys_serialization
  * @brief    A constrained node implementation of CBOR in C
  *
  * @see      https://github.com/cabo/cn-cbor

diff --git a/pkg/jsmn/doc.txt b/pkg/jsmn/doc.txt
@@ -1,8 +1,8 @@
 /**
  * @defgroup pkg_jsmn  JSON parser library
  * @ingroup  pkg
- * @ingroup  sys
+ * @ingroup  sys_serialization
  * @brief    Provides a JSON parser library to RIOT
  *
  * @see      https://github.com/zserge/jsmn
- */
+ */
diff --git a/pkg/minmea/doc.txt b/pkg/minmea/doc.txt
@@ -1,7 +1,7 @@
 /**
  * @defgroup pkg_minmea   GPS parser library 
  * @ingroup  pkg
- * @ingroup  sys
+ * @ingroup  sys_serialization
  * @brief    Provides a GPS parser library to RIOT
  *
  * # Introduction
@@ -15,4 +15,4 @@
  * Licensed under WTFPL.
  *
  * @see      https://github.com/cloudyourcar/minmea
- */
+ */
diff --git a/sys/doc.txt b/sys/doc.txt
@@ -34,3 +34,9 @@
  * @ingroup     sys
  * @brief       Provides memory management implementations and utilities
  */
+
+/**
+ * @defgroup    sys_serialization Serialization
+ * @ingroup     sys
+ * @brief       Utilities for data serialization
+ */
diff --git a/sys/include/base64.h b/sys/include/base64.h
@@ -9,7 +9,7 @@
 
 /**
  * @defgroup    sys_base64 base64 encoder decoder
- * @ingroup     sys
+ * @ingroup     sys_serialization
  * @brief       base64 encoder and decoder
  * @{
  *

diff --git a/sys/include/ubjson.h b/sys/include/ubjson.h
@@ -17,9 +17,9 @@
  */
 
 /**
- * @defgroup    sys_ubjson Universal Binary JSON
- * @ingroup     sys
- * @brief       A library to read and write UBJSON serialized data.
+ * @defgroup sys_ubjson  Universal Binary JSON library
+ * @ingroup  sys_serialization
+ * @brief    Provides a library to read and write UBJSON serialized data
  * @{
  *
  * @file

diff --git a/sys/ubjson/ubjson-read.c b/sys/ubjson/ubjson-read.c
@@ -17,7 +17,7 @@
  */
 
 /**
- * @ingroup     sys
+ * @ingroup     sys_ubjson
  * @{
  * @file
  * @brief       Universal Binary JSON deserializer

diff --git a/sys/ubjson/ubjson-write.c b/sys/ubjson/ubjson-write.c
@@ -17,7 +17,7 @@
  */
 
 /**
- * @ingroup     sys
+ * @ingroup     sys_ubjson
  * @{
  * @file
  * @brief       Universal Binary JSON deserializer