diff options
| author |   Petteri Aimonen <jpa@git.mail.kapsi.fi> | 2016-02-07 10:50:02 +0200 |
|---|---|---|
| committer | Petteri Aimonen <jpa@git.mail.kapsi.fi> | 2016-02-07 10:50:02 +0200 |
| commit | 6f0dfe1b3fd52c2d141fff412b70b64ebcaf5ad8 (patch) | |
| tree | d669386b5863d30dc4fa0c57199d151f85ab566d /docs | |
| parent | 65e7760c9c16f7451974ebc7275c4eb572ccf04c (diff) | |
Update pb_release docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/reference.rst | 4 |
1 files changed, 2 insertions, 2 deletions
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. |