Commit 9b2e301c authored by Sven Neumann's avatar Sven Neumann

pdbgen: programmatically add hint about using g_strfreev()

Add the note about the need to free the returned string array
to the generated libgimp code. This way it will show up in the
libgimp documentation but not in the general PDB API.
parent c8209ddb
......@@ -196,7 +196,7 @@ gimp_get_parasite (const gchar *name)
*
* Returns a list of all currently attached global parasites.
*
* Returns: The names of currently attached parasites.
* Returns: The names of currently attached parasites The returned value must be freed with g_strfreev().
*
* Since: GIMP 2.8
**/
......
......@@ -75,7 +75,7 @@ gimp_brushes_refresh (void)
* Each name returned can be used as input to the
* gimp_context_set_brush() procedure.
*
* Returns: The list of brush names.
* Returns: The list of brush names The returned value must be freed with g_strfreev().
**/
gchar **
gimp_brushes_get_list (const gchar *filter,
......
......@@ -44,7 +44,7 @@
* This procedure returns a complete listing of available named
* buffers.
*
* Returns: The list of buffer names.
* Returns: The list of buffer names The returned value must be freed with g_strfreev().
*
* Since: GIMP 2.4
**/
......
......@@ -75,7 +75,7 @@ gimp_dynamics_refresh (void)
* This procedure returns a list of the paint dynamics that are
* currently available.
*
* Returns: The list of paint dynamics names.
* Returns: The list of paint dynamics names The returned value must be freed with g_strfreev().
*
* Since: GIMP 2.8
**/
......
......@@ -72,7 +72,7 @@ gimp_fonts_refresh (void)
* This procedure returns a list of the fonts that are currently
* available.
*
* Returns: The list of font names.
* Returns: The list of font names The returned value must be freed with g_strfreev().
**/
gchar **
gimp_fonts_get_list (const gchar *filter,
......
......@@ -75,7 +75,7 @@ gimp_gradients_refresh (void)
* loaded. You can later use the gimp_context_set_gradient() function
* to set the active gradient.
*
* Returns: The list of gradient names.
* Returns: The list of gradient names The returned value must be freed with g_strfreev().
**/
gchar **
gimp_gradients_get_list (const gchar *filter,
......
......@@ -3086,7 +3086,7 @@ gimp_image_get_parasite (gint32 image_ID,
*
* Returns a list of all currently attached parasites.
*
* Returns: The names of currently attached parasites.
* Returns: The names of currently attached parasites The returned value must be freed with g_strfreev().
*
* Since: GIMP 2.8
**/
......
......@@ -982,7 +982,7 @@ gimp_item_get_parasite (gint32 item_ID,
*
* Returns a list of all parasites currently attached the an item.
*
* Returns: The names of currently attached parasites.
* Returns: The names of currently attached parasites The returned value must be freed with g_strfreev().
*
* Since: GIMP 2.8
**/
......
......@@ -73,7 +73,7 @@ gimp_palettes_refresh (void)
* Each name returned can be used as input to the command
* gimp_context_set_palette().
*
* Returns: The list of palette names.
* Returns: The list of palette names The returned value must be freed with g_strfreev().
**/
gchar **
gimp_palettes_get_list (const gchar *filter,
......
......@@ -43,7 +43,7 @@
*
* Deprecated: Use gimp_image_get_vectors() instead.
*
* Returns: List of the paths belonging to this image.
* Returns: List of the paths belonging to this image. The returned value must be freed with g_strfreev().
**/
gchar **
gimp_path_list (gint32 image_ID,
......
......@@ -75,7 +75,7 @@ gimp_patterns_refresh (void)
* patterns. Each name returned can be used as input to the
* gimp_context_set_pattern().
*
* Returns: The list of pattern names.
* Returns: The list of pattern names The returned value must be freed with g_strfreev().
**/
gchar **
gimp_patterns_get_list (const gchar *filter,
......
......@@ -121,6 +121,10 @@ sub generate {
$retarg->{retval} = 1;
$retdesc = exists $retarg->{desc} ? $retarg->{desc} : "";
if ($retarg->{type} eq 'stringarray') {
$retdesc .= " The returned value must be freed with g_strfreev().";
}
}
else {
# No return values
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment