Commit d8456b5d authored by Jehan's avatar Jehan

pdb - update documentation comments the right way.

PDB functions must be updated from *.pdb files as *_pdb.c files are
generated by make.
parent 5c6c55e5
......@@ -2930,7 +2930,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_int32_array ("image-ids",
"image ids",
"The list of images currently open",
"The list of images currently open. The returned value must be freed with g_free()",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......@@ -3504,7 +3504,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_int32_array ("layer-ids",
"layer ids",
"The list of layers contained in the image",
"The list of layers contained in the image. The returned value must be freed with g_free()",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......@@ -3538,7 +3538,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_int32_array ("channel-ids",
"channel ids",
"The list of channels contained in the image",
"The list of channels contained in the image. The returned value must be freed with g_free()",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......@@ -3572,7 +3572,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_int32_array ("vector-ids",
"vector ids",
"The list of vectors contained in the image",
"The list of vectors contained in the image. The returned value must be freed with g_free()",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......@@ -4512,7 +4512,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_int8_array ("colormap",
"colormap",
"The image's colormap",
"The image's colormap. The returned value must be freed with g_free()",
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
g_object_unref (procedure);
......@@ -5037,7 +5037,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string ("filename",
"filename",
"The filename",
"The filename. The returned value must be freed with g_free()",
FALSE, FALSE, FALSE,
NULL,
GIMP_PARAM_READWRITE));
......@@ -5097,7 +5097,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string ("uri",
"uri",
"The URI",
"The URI. The returned value must be freed with g_free()",
FALSE, FALSE, FALSE,
NULL,
GIMP_PARAM_READWRITE));
......@@ -5127,7 +5127,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string ("uri",
"uri",
"The imported URI",
"The imported URI. The returned value must be freed with g_free()",
FALSE, FALSE, FALSE,
NULL,
GIMP_PARAM_READWRITE));
......@@ -5157,7 +5157,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string ("uri",
"uri",
"The imported URI",
"The imported URI. The returned value must be freed with g_free()",
FALSE, FALSE, FALSE,
NULL,
GIMP_PARAM_READWRITE));
......@@ -5187,7 +5187,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string ("uri",
"uri",
"The exported URI",
"The exported URI. The returned value must be freed with g_free()",
FALSE, FALSE, FALSE,
NULL,
GIMP_PARAM_READWRITE));
......@@ -5217,7 +5217,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string ("name",
"name",
"The name",
"The name. The returned value must be freed with g_free()",
FALSE, FALSE, FALSE,
NULL,
GIMP_PARAM_READWRITE));
......
......@@ -78,8 +78,7 @@ gimp_image_is_valid (gint32 image_ID)
*
* This procedure returns the list of images currently open in GIMP.
*
* Returns: The list of images currently open.
* The returned value must be freed with g_free().
* Returns: The list of images currently open. The returned value must be freed with g_free().
**/
gint *
gimp_image_list (gint *num_images)
......@@ -689,8 +688,7 @@ gimp_image_rotate (gint32 image_ID,
* This procedure returns the list of layers contained in the specified
* image. The order of layers is from topmost to bottommost.
*
* Returns: The list of layers contained in the image.
* The returned value must be freed with g_free().
* Returns: The list of layers contained in the image. The returned value must be freed with g_free().
**/
gint *
gimp_image_get_layers (gint32 image_ID,
......@@ -732,8 +730,7 @@ gimp_image_get_layers (gint32 image_ID,
* specified image. This does not include the selection mask, or layer
* masks. The order is from topmost to bottommost.
*
* Returns: The list of channels contained in the image.
* The returned value must be freed with g_free().
* Returns: The list of channels contained in the image. The returned value must be freed with g_free().
**/
gint *
gimp_image_get_channels (gint32 image_ID,
......@@ -774,8 +771,7 @@ gimp_image_get_channels (gint32 image_ID,
* This procedure returns the list of vectors contained in the
* specified image.
*
* Returns: The list of vectors contained in the image.
* The returned value must be freed with g_free().
* Returns: The list of vectors contained in the image. The returned value must be freed with g_free().
*
* Since: GIMP 2.4
**/
......@@ -1722,8 +1718,7 @@ gimp_image_merge_down (gint32 image_ID,
* 3. If the image is not in Indexed color mode, no colormap is
* returned.
*
* Returns: The image's colormap.
* The returned value must be freed with g_free().
* Returns: The image's colormap. The returned value must be freed with g_free().
**/
guint8 *
_gimp_image_get_colormap (gint32 image_ID,
......@@ -2313,8 +2308,7 @@ gimp_image_set_component_visible (gint32 image_ID,
* Otherwise, this function returns %NULL. See also
* gimp_image_get_uri().
*
* Returns: The filename.
* The returned value must be freed with g_free().
* Returns: The filename. The returned value must be freed with g_free().
**/
gchar *
gimp_image_get_filename (gint32 image_ID)
......@@ -2383,8 +2377,7 @@ gimp_image_set_filename (gint32 image_ID,
* and not yet saved, or gimp-image-get-exported-uri if the image has
* been exported to a non-GIMP file format.
*
* Returns: The URI.
* The returned value must be freed with g_free().
* Returns: The URI. The returned value must be freed with g_free().
*
* Since: GIMP 2.8
**/
......@@ -2417,8 +2410,7 @@ gimp_image_get_uri (gint32 image_ID)
* This procedure returns the XCF URI associated with the image. If
* there is no such URI, this procedure returns %NULL.
*
* Returns: The imported URI.
* The returned value must be freed with g_free().
* Returns: The imported URI. The returned value must be freed with g_free().
*
* Since: GIMP 2.8
**/
......@@ -2453,8 +2445,7 @@ gimp_image_get_xcf_uri (gint32 image_ID)
* image was not imported, or has since been saved in the native Gimp
* format, this procedure returns %NULL.
*
* Returns: The imported URI.
* The returned value must be freed with g_free().
* Returns: The imported URI. The returned value must be freed with g_free().
*
* Since: GIMP 2.8
**/
......@@ -2488,8 +2479,7 @@ gimp_image_get_imported_uri (gint32 image_ID)
* if the image was exported a non-native GIMP format. If the image was
* not exported, this procedure returns %NULL.
*
* Returns: The exported URI.
* The returned value must be freed with g_free().
* Returns: The exported URI. The returned value must be freed with g_free().
*
* Since: GIMP 2.8
**/
......@@ -2523,8 +2513,7 @@ gimp_image_get_exported_uri (gint32 image_ID)
* or an URI, then this is the base name (the last component of the
* path). Otherwise it is the translated string \"Untitled\".
*
* Returns: The name.
* The returned value must be freed with g_free().
* Returns: The name. The returned value must be freed with g_free().
**/
gchar *
gimp_image_get_name (gint32 image_ID)
......@@ -3098,8 +3087,6 @@ gimp_image_get_parasite (gint32 image_ID,
* Returns a list of all currently attached parasites.
*
* Returns: The names of currently attached parasites.
* The returned list must be freed with g_free(), as well as each
* item of the list.
*
* Since: GIMP 2.8
**/
......
......@@ -56,7 +56,7 @@ HELP
@outargs = (
{ name => 'image_ids', type => 'int32array',
desc => 'The list of images currently open',
desc => 'The list of images currently open. The returned value must be freed with g_free()',
array => { name => 'num_images',
desc => 'The number of images currently open' } }
);
......@@ -509,7 +509,7 @@ HELP
@outargs = (
{ name => 'layer_ids', type => 'int32array',
desc => 'The list of layers contained in the image',
desc => 'The list of layers contained in the image. The returned value must be freed with g_free()',
array => { name => 'num_layers',
desc => 'The number of layers contained in the image' } }
);
......@@ -553,7 +553,7 @@ HELP
@outargs = (
{ name => 'channel_ids', type => 'int32array',
desc => 'The list of channels contained in the image',
desc => 'The list of channels contained in the image. The returned value must be freed with g_free()',
array => { name => 'num_channels',
desc => 'The number of channels contained in the image' } }
);
......@@ -595,7 +595,7 @@ HELP
@outargs = (
{ name => 'vector_ids', type => 'int32array',
desc => 'The list of vectors contained in the image',
desc => 'The list of vectors contained in the image. The returned value must be freed with g_free()',
array => { name => 'num_vectors',
desc => 'The number of vectors contained in the image' } }
);
......@@ -1572,7 +1572,7 @@ HELP
@outargs = (
{ name => 'colormap', type => 'int8array', wrap => 1,
desc => "The image's colormap",
desc => "The image's colormap. The returned value must be freed with g_free()",
array => { name => 'num_bytes',
desc => 'Number of bytes in the colormap array' } }
);
......@@ -2178,7 +2178,7 @@ HELP
@outargs = (
{ name => 'filename', type => 'string',
desc => 'The filename' }
desc => 'The filename. The returned value must be freed with g_free()' }
);
%invoke = (
......@@ -2258,7 +2258,7 @@ HELP
@outargs = (
{ name => 'uri', type => 'string',
desc => 'The URI' }
desc => 'The URI. The returned value must be freed with g_free()' }
);
%invoke = (
......@@ -2290,7 +2290,7 @@ HELP
@outargs = (
{ name => 'uri', type => 'string',
desc => 'The imported URI' }
desc => 'The imported URI. The returned value must be freed with g_free()' }
);
%invoke = (
......@@ -2324,7 +2324,7 @@ HELP
@outargs = (
{ name => 'uri', type => 'string',
desc => 'The imported URI' }
desc => 'The imported URI. The returned value must be freed with g_free()' }
);
%invoke = (
......@@ -2357,7 +2357,7 @@ HELP
@outargs = (
{ name => 'uri', type => 'string',
desc => 'The exported URI' }
desc => 'The exported URI. The returned value must be freed with g_free()' }
);
%invoke = (
......@@ -2386,7 +2386,7 @@ HELP
@outargs = (
{ name => 'name', type => 'string',
desc => 'The name' }
desc => 'The name. The returned value must be freed with g_free()' }
);
%invoke = (
......
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