more documentation

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
+