summaryrefslogtreecommitdiffstats
path: root/pb_decode.h
diff options
context:
space:
mode:
authorPetteri Aimonen <jpa@git.mail.kapsi.fi>2014-03-16 15:52:19 +0200
committerPetteri Aimonen <jpa@git.mail.kapsi.fi>2014-03-16 15:52:19 +0200
commitab62402059ff3752660ffc9f292cf210aef59be0 (patch)
tree669db214120b26e1ea939e4e529f1c434534ec95 /pb_decode.h
parent108864963faf54762629a8bdf1f8bd614f0abd16 (diff)
Documentation updates
Diffstat (limited to 'pb_decode.h')
-rw-r--r--pb_decode.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/pb_decode.h b/pb_decode.h
index 2e1da5a6..8dc67408 100644
--- a/pb_decode.h
+++ b/pb_decode.h
@@ -73,6 +73,9 @@ bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struc
*
* This can also be used for 'merging' two messages, i.e. update only the
* fields that exist in the new message.
+ *
+ * Note: If this function returns with an error, it will not release any
+ * dynamically allocated fields. You will need to call pb_release() yourself.
*/
bool pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
@@ -84,8 +87,8 @@ bool pb_decode_delimited(pb_istream_t *stream, const pb_field_t fields[], void *
#ifdef PB_ENABLE_MALLOC
/* Release any allocated pointer fields. If you use dynamic allocation, you should
- * call this for any decoded message when you are done with it. You also need to
- * free messages even if pb_decode() returned with error.
+ * call this for any successfully decoded message when you are done with it. If
+ * pb_decode() returns with an error, the message is already released.
*/
void pb_release(const pb_field_t fields[], void *dest_struct);
#endif