diff options
author | Elwin Hammer <elwinhammer@gmail.com> | 2024-06-22 22:32:30 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-06-22 22:32:30 +0200 |
commit | a9eb2013e6b7297cfce4116179f4ab2d58d1c8d6 (patch) | |
tree | 0f16b75795d9926c5ea4a8ef52a695365837a8e4 /lib/pbdrv/pb-buf.h | |
parent | f121de7c7e3ca8f0dc526973a5ee2586485aad22 (diff) | |
parent | d6440954806d381dae5b3df65b43192f897018c6 (diff) |
Merge pull request #21 from lonkaars/master
Updating branch
Diffstat (limited to 'lib/pbdrv/pb-buf.h')
-rw-r--r-- | lib/pbdrv/pb-buf.h | 20 |
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 |