luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-24 03:02:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

goption: document that some option args need to be freed by the callee

Browse Source 
Option arguments where the result is stored in a string or string array need to
be freed by the owner of the option group. Fixes #578363.
This commit is contained in:
Stefan Kost 2009-04-14 11:32:59 +03:00
parent 2026c232b3
commit 57bd24dc49
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
glib/goption.c
View File

@ -349,6 +349,9 @@ g_option_context_new (const gchar *parameter_string)
* Frees context and all the groups which have been
* added to it.
*
* Please note that parsed arguments need to be freed separately (see
* #GOptionEntry).
*
* Since: 2.6
*/
void g_option_context_free (GOptionContext *context)

5
glib/goption.h
View File

@ -259,6 +259,11 @@ GQuark g_option_error_quark (void);
* <listitem><para>%gdouble</para></listitem>
* </varlistentry>
* </variablelist>
* If @arg type is %G_OPTION_ARG_STRING or %G_OPTION_ARG_FILENAME the location
* will contain a newly allocated string if the option was given. That string
* needs to be freed by the callee using g_free(). Likewise if @arg type is
* %G_OPTION_ARG_STRING_ARRAY or %G_OPTION_ARG_FILENAME_ARRAY, the data should
* be freed using g_strfreev().
* @description: the description for the option in <option>--help</option>
* output. The @description is translated using the @translate_func of the
* group, see g_option_group_set_translation_domain().