aboutsummaryrefslogtreecommitdiff
path: root/lib/pbdrv/pb-msg.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/pbdrv/pb-msg.h')
-rw-r--r--lib/pbdrv/pb-msg.h3
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);