aboutsummaryrefslogtreecommitdiff
path: root/lib/pbdrv/pb-buf.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/pbdrv/pb-buf.h')
-rw-r--r--lib/pbdrv/pb-buf.h20
1 files changed, 18 insertions, 2 deletions
diff --git a/lib/pbdrv/pb-buf.h b/lib/pbdrv/pb-buf.h
index 78ee380..8b4bb10 100644
--- a/lib/pbdrv/pb-buf.h
+++ b/lib/pbdrv/pb-buf.h
@@ -6,14 +6,30 @@
extern "C" {
#endif
+/**
+ * \ingroup pbdrv
+ * \ingroup pbdrv-mod
+ * \defgroup pb_buf Buffer
+ * \brief Binary data buffer type used in \ref pbdrv
+ * \{
+ */
+
//! binary buffer struct
typedef struct {
- char * data; //! pointer to data
- size_t size; //! size of data
+ char * data; //!< pointer to data
+ size_t size; //!< size of data
} pb_buf_t;
+/**
+ * \brief free a \c pb_buf_t
+ *
+ * This function calls \c pb_free() on the \c data member of a \c pb_buf_t
+ * struct if it is not equal to \c NULL.
+ */
void pb_buf_free(pb_buf_t * buf);
+/// \}
+
#ifdef __cplusplus
}
#endif