aboutsummaryrefslogtreecommitdiff
path: root/lib/mpack
diff options
context:
space:
mode:
authorThomasintAnker <thomasintanker1@gmail.com>2024-06-24 14:59:56 +0200
committerThomasintAnker <thomasintanker1@gmail.com>2024-06-24 14:59:56 +0200
commita0c664908b9112306c5858ccb106d1a0e5555df7 (patch)
tree8ca77d1210d1683a97f4da131c6ffac8123d4375 /lib/mpack
parent381149dd7a1f4d5f48dd5ac07186c73371ff3c04 (diff)
parentec7f5e970ed03acb33eb5dc3b67f3d52af52e6dc (diff)
merge main into wip/mc
Diffstat (limited to 'lib/mpack')
-rw-r--r--lib/mpack/mpack.h31
1 files changed, 26 insertions, 5 deletions
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
+