diff options
| author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-06-22 13:01:42 +0200 |
|---|---|---|
| committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-06-22 13:01:42 +0200 |
| commit | bb63040692c94ffa662b0af7eb14f3c5951aa6e6 (patch) | |
| tree | 73cc719db8db857ccc012ff2002655bdad400be6 /lib/pbdrv/pb-msg.h | |
| parent | bad32f876ab99fe0820fd310a4826378d0b11fe7 (diff) | |
even more doxygen documentation
Diffstat (limited to 'lib/pbdrv/pb-msg.h')
| -rw-r--r-- | lib/pbdrv/pb-msg.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/pbdrv/pb-msg.h b/lib/pbdrv/pb-msg.h index 33b697a..ff5bcde 100644 --- a/lib/pbdrv/pb-msg.h +++ b/lib/pbdrv/pb-msg.h @@ -46,6 +46,9 @@ pb_buf_t pb_msg_write(const pb_msg_t * msg); pb_msg_t * pb_msg_read(const pb_buf_t * buf); /** * \brief Recursively free fields of a \c pb_msg_t + * + * \note The \p msg pointer itself is also free'd by this function. You should + * set it to NULL afterwards to avoid confusion. */ void pb_msg_free(pb_msg_t * msg); |