From 33d17dbab86c1277a1327273fb9753b2c98b7b03 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Sat, 22 Jun 2024 14:32:19 +0200
Subject: more documentation

---
 lib/i2ctcp/i2ctcpv1.h |  2 ++
 lib/mpack/mpack.h     | 31 ++++++++++++++++++++++++++-----
 2 files changed, 28 insertions(+), 5 deletions(-)

(limited to 'lib')

diff --git a/lib/i2ctcp/i2ctcpv1.h b/lib/i2ctcp/i2ctcpv1.h
index d7bb29e..e9bc0d9 100644
--- a/lib/i2ctcp/i2ctcpv1.h
+++ b/lib/i2ctcp/i2ctcpv1.h
@@ -91,6 +91,8 @@ void i2ctcp_read_reset(i2ctcp_msg_t * target);
  */
 bool i2ctcp_write(const i2ctcp_msg_t * target, char ** buf, size_t * buf_sz);
 
+/// \}
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/lib/mpack/mpack.h b/lib/mpack/mpack.h
index 7c0c089..33521c4 100644
--- a/lib/mpack/mpack.h
+++ b/lib/mpack/mpack.h
@@ -2,18 +2,39 @@
 
 #include "src/src/mpack/mpack.h"
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * \defgroup mpack mpack
+ * \brief Mpack extensions specific to this project
+ *
+ * The mpack folder under `lib/` contains a CMakeLists.txt for integrating the
+ * mapck library with CMake, and includes an extension in the form of an
+ * additional utility function.
+ *
+ * \{
+ */
+
 /**
- * \brief read remaining bytes in reader without opening a tag first
+ * \brief Read remaining bytes in reader without opening a tag first
  *
- * \param reader  pointer to mpack reader object
- * \param p  pointer to write data to
- * \param count  maximum number of bytes to read
+ * \param reader  Pointer to mpack reader object
+ * \param p  Pointer to write data to
+ * \param count  Maximum number of bytes to read
  *
  * This function reads *up to* the amount of bytes specified in \p count, or
  * less if there is less remaining data in the buffer. If \p count is equal to
  * 0, all remaining data in the buffer is read.
  *
- * \return amount of bytes read
+ * \return Amount of bytes read
  */
 size_t mpack_read_remaining_bytes(mpack_reader_t * reader, char * p, size_t count);
 
+/// \}
+
+#ifdef __cplusplus
+}
+#endif
+
-- 
cgit v1.2.3