Commit c8209ddb authored by Sven Neumann's avatar Sven Neumann

Revert "pdb: update documentation for all pdb functions whose return can be...

Revert "pdb: update documentation for all pdb functions whose return can be freed with g_strfreev()."

Such comment should not be included in the general PDB
documentation as it is specific to the C bindings and can
be easily added by the pdbgen infrastructure.

This reverts commit c9888f22.
parent 3477fc0b
......@@ -297,7 +297,7 @@ register_brushes_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string_array ("brush-list",
"brush list",
"The list of brush names. The returned value must be freed with g_strfreev()",
"The list of brush names",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......
......@@ -317,7 +317,7 @@ register_buffer_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string_array ("buffer-list",
"buffer list",
"The list of buffer names. The returned value must be freed with g_strfreev()",
"The list of buffer names",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......
......@@ -2072,7 +2072,7 @@ register_context_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string_array ("paint-methods",
"paint methods",
"The names of the available paint methods. The returned value must be freed with g_strfreev()",
"The names of the available paint methods",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......
......@@ -137,7 +137,7 @@ register_dynamics_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string_array ("dynamics-list",
"dynamics list",
"The list of paint dynamics names. The returned value must be freed with g_strfreev()",
"The list of paint dynamics names",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......
......@@ -137,7 +137,7 @@ register_fonts_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string_array ("font-list",
"font list",
"The list of font names. The returned value must be freed with g_strfreev()",
"The list of font names",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......
......@@ -370,7 +370,7 @@ register_gimp_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string_array ("parasites",
"parasites",
"The names of currently attached parasites. The returned value must be freed with g_strfreev()",
"The names of currently attached parasites",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......
......@@ -340,7 +340,7 @@ register_gradients_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string_array ("gradient-list",
"gradient list",
"The list of gradient names. The returned value must be freed with g_strfreev()",
"The list of gradient names",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......
......@@ -5749,7 +5749,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string_array ("parasites",
"parasites",
"The names of currently attached parasites. The returned value must be freed with g_strfreev()",
"The names of currently attached parasites",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......
......@@ -1736,7 +1736,7 @@ register_item_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string_array ("parasites",
"parasites",
"The names of currently attached parasites. The returned value must be freed with g_strfreev()",
"The names of currently attached parasites",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......
......@@ -237,7 +237,7 @@ register_palettes_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string_array ("palette-list",
"palette list",
"The list of palette names. The returned value must be freed with g_strfreev()",
"The list of palette names",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......
......@@ -720,7 +720,7 @@ register_paths_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string_array ("path-list",
"path list",
"List of the paths belonging to this image. The returned value must be freed with g_strfreev()",
"List of the paths belonging to this image.",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......
......@@ -238,7 +238,7 @@ register_patterns_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string_array ("pattern-list",
"pattern list",
"The list of pattern names. The returned value must be freed with g_strfreev()",
"The list of pattern names",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......
......@@ -601,7 +601,7 @@ register_procedural_db_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string_array ("procedure-names",
"procedure names",
"The list of procedure names. The returned value must be freed with g_strfreev()",
"The list of procedure names",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......
......@@ -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. The returned value must be freed with g_strfreev().
* Returns: The names of currently attached parasites.
*
* 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. The returned value must be freed with g_strfreev().
* Returns: The list of brush names.
**/
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. The returned value must be freed with g_strfreev().
* Returns: The list of buffer names.
*
* Since: GIMP 2.4
**/
......
......@@ -133,7 +133,7 @@ gimp_context_set_defaults (void)
/**
* gimp_context_list_paint_methods:
* @num_paint_methods: The number of the available paint methods.
* @paint_methods: The names of the available paint methods. The returned value must be freed with g_strfreev().
* @paint_methods: The names of the available paint methods.
*
* Lists the available paint methods.
*
......
......@@ -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. The returned value must be freed with g_strfreev().
* Returns: The list of paint dynamics names.
*
* 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. The returned value must be freed with g_strfreev().
* Returns: The list of font names.
**/
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. The returned value must be freed with g_strfreev().
* Returns: The list of gradient names.
**/
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. The returned value must be freed with g_strfreev().
* Returns: The names of currently attached parasites.
*
* 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. The returned value must be freed with g_strfreev().
* Returns: The names of currently attached parasites.
*
* 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. The returned value must be freed with g_strfreev().
* Returns: The list of palette names.
**/
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. The returned value must be freed with g_strfreev().
* Returns: List of the paths belonging to this image.
**/
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. The returned value must be freed with g_strfreev().
* Returns: The list of pattern names.
**/
gchar **
gimp_patterns_get_list (const gchar *filter,
......
......@@ -107,7 +107,7 @@ gimp_procedural_db_dump (const gchar *filename)
* @date: The regex for procedure date.
* @proc_type: The regex for procedure type: { 'Internal GIMP procedure', 'GIMP Plug-In', 'GIMP Extension', 'Temporary Procedure' }.
* @num_matches: The number of matching procedures.
* @procedure_names: The list of procedure names. The returned value must be freed with g_strfreev().
* @procedure_names: The list of procedure names.
*
* Queries the procedural database for its contents using regular
* expression matching.
......
......@@ -53,7 +53,7 @@ HELP
@outargs = (
{ name => 'brush_list', type => 'stringarray',
desc => 'The list of brush names. The returned value must be freed with g_strfreev()',
desc => 'The list of brush names',
array => { name => 'num_brushes',
desc => 'The number of brushes in the brush list' } }
);
......
......@@ -32,7 +32,7 @@ HELP
@outargs = (
{ name => 'buffer_list', type => 'stringarray',
desc => 'The list of buffer names. The returned value must be freed with g_strfreev()',
desc => 'The list of buffer names',
array => { name => 'num_buffers',
desc => 'The number of buffers' } }
);
......
......@@ -170,7 +170,7 @@ HELP
@outargs = (
{ name => 'paint_methods', type => 'stringarray', void_ret => 1,
desc => 'The names of the available paint methods. The returned value must be freed with g_strfreev()',
desc => 'The names of the available paint methods',
array => { desc => 'The number of the available paint methods' } }
);
......
......@@ -53,7 +53,7 @@ HELP
@outargs = (
{ name => 'dynamics_list', type => 'stringarray',
desc => 'The list of paint dynamics names. The returned value must be freed with g_strfreev()',
desc => 'The list of paint dynamics names',
array => { name => 'num_dynamics',
desc => 'The number of available paint dynamics' } }
);
......
......@@ -51,7 +51,7 @@ HELP
@outargs = (
{ name => 'font_list', type => 'stringarray',
desc => 'The list of font names. The returned value must be freed with g_strfreev()',
desc => 'The list of font names',
array => { name => 'num_fonts',
desc => 'The number of available fonts' } }
);
......
......@@ -174,7 +174,7 @@ sub get_parasite_list {
@outargs = (
{ name => 'parasites', type => 'stringarray',
desc => 'The names of currently attached parasites. The returned value must be freed with g_strfreev()',
desc => 'The names of currently attached parasites',
array => { desc => 'The number of attached parasites' } }
);
......
......@@ -53,7 +53,7 @@ HELP
@outargs = (
{ name => 'gradient_list', type => 'stringarray',
desc => 'The list of gradient names. The returned value must be freed with g_strfreev()',
desc => 'The list of gradient names',
array => { name => 'num_gradients',
desc => 'The number of loaded gradients' } }
);
......
......@@ -2878,7 +2878,7 @@ sub image_get_parasite_list {
@outargs = (
{ name => 'parasites', type => 'stringarray',
desc => 'The names of currently attached parasites. The returned value must be freed with g_strfreev()',
desc => 'The names of currently attached parasites',
array => { desc => 'The number of attached parasites' } }
);
......
......@@ -830,7 +830,7 @@ sub item_get_parasite_list {
@outargs = (
{ name => 'parasites', type => 'stringarray',
desc => 'The names of currently attached parasites. The returned value must be freed with g_strfreev()',
desc => 'The names of currently attached parasites',
array => { desc => 'The number of attached parasites' } }
);
......
......@@ -52,7 +52,7 @@ HELP
@outargs = (
{ name => 'palette_list', type => 'stringarray',
desc => 'The list of palette names. The returned value must be freed with g_strfreev()',
desc => 'The list of palette names',
array => { name => 'num_palettes',
desc => 'The number of palettes in the list' } }
);
......
......@@ -26,7 +26,7 @@ sub path_list {
@outargs = (
{ name => 'path_list', type => 'stringarray',
desc => 'List of the paths belonging to this image. The returned value must be freed with g_strfreev()',
desc => 'List of the paths belonging to this image.',
array => { name => 'num_paths',
desc => 'The number of paths returned.' } }
);
......
......@@ -52,7 +52,7 @@ HELP
@outargs = (
{ name => 'pattern_list', type => 'stringarray',
desc => 'The list of pattern names. The returned value must be freed with g_strfreev()',
desc => 'The list of pattern names',
array => { name => 'num_patterns',
desc => 'The number of patterns in the pattern list' } }
);
......
......@@ -112,7 +112,7 @@ HELP
@outargs = (
{ name => 'procedure_names', type => 'stringarray', void_ret => 1,
desc => 'The list of procedure names. The returned value must be freed with g_strfreev()',
desc => 'The list of procedure names',
array => { name => 'num_matches',
desc => 'The number of matching procedures' } }
);
......
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