From: Petteri Aimonen Date: Sun, 7 Feb 2016 08:50:02 +0000 (+0200) Subject: Update pb_release docs X-Git-Tag: 5.0.2~186^2~83 X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=commitdiff_plain;ds=sidebyside;h=6f0dfe1b3fd52c2d141fff412b70b64ebcaf5ad8;p=apps%2Fagl-service-can-low-level.git Update pb_release docs --- diff --git a/docs/reference.rst b/docs/reference.rst index be6567ee..6968c81b 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -630,10 +630,10 @@ pb_release ---------- Releases any dynamically allocated fields. - void pb_release(const pb_field_t fields[], void *dest_struct); + void pb_release(const pb_field_t fields[], void \*dest_struct); :fields: A field description array. Usually autogenerated. -:dest_struct: Pointer to structure where data will be stored. +:dest_struct: Pointer to structure where data is stored. If NULL, function does nothing. This function is only available if *PB_ENABLE_MALLOC* is defined. It will release any pointer type fields in the structure and set the pointers to NULL.