procyberian/gimp
2
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/gimp.git synced 2025-07-03 17:33:25 +00:00
Code Issues 1 Projects 1 Releases Packages Wiki Activity Actions

pdb, libgimp: improve function documentation for sample points

Browse source 
- gimp_image_add_sample_point: guide is a left-over from copy-pasting and
add apostrophe
- gimp_image_get_sample_point_position: it was not clear that the
parameter was the y-offset and the return value the x-offset
This commit is contained in:
Jacob Boerema 2023-04-09 21:31:51 -04:00
parent c3c991c527
commit ef7f955e1e
3 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

8
app/pdb/image-sample-points-cmds.c
View file

@ -227,13 +227,13 @@ register_image_sample_points_procs (GimpPDB *pdb)
gimp_procedure_add_argument (procedure, gimp_procedure_add_argument (procedure,
g_param_spec_int ("position-x", g_param_spec_int ("position-x",
"position x", "position x",
"The guide'sample points x-offset from left of image", "The sample point's x-offset from left of image",
0, G_MAXINT32, 0, 0, G_MAXINT32, 0,
GIMP_PARAM_READWRITE)); GIMP_PARAM_READWRITE));
gimp_procedure_add_argument (procedure, gimp_procedure_add_argument (procedure,
g_param_spec_int ("position-y", g_param_spec_int ("position-y",
"position y", "position y",
"The guide'sample points y-offset from top of image", "The sample point's y-offset from top of image",
0, G_MAXINT32, 0, 0, G_MAXINT32, 0,
GIMP_PARAM_READWRITE)); GIMP_PARAM_READWRITE));
gimp_procedure_add_return_value (procedure, gimp_procedure_add_return_value (procedure,
@ -338,13 +338,13 @@ register_image_sample_points_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure, gimp_procedure_add_return_value (procedure,
g_param_spec_int ("position-x", g_param_spec_int ("position-x",
"position x", "position x",
"The sample points's position relative to top of image", "The sample point's x-offset relative to left of image",
G_MININT32, G_MAXINT32, 0, G_MININT32, G_MAXINT32, 0,
GIMP_PARAM_READWRITE)); GIMP_PARAM_READWRITE));
gimp_procedure_add_return_value (procedure, gimp_procedure_add_return_value (procedure,
g_param_spec_int ("position-y", g_param_spec_int ("position-y",
"position y", "position y",
"The sample points's position relative to top of image", "The sample point's y-offset relative to top of image",
G_MININT32, G_MAXINT32, 0, G_MININT32, G_MAXINT32, 0,
GIMP_PARAM_READWRITE)); GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure); gimp_pdb_register_procedure (pdb, procedure);

8
libgimp/gimpimagesamplepoints_pdb.c
View file

@ -39,8 +39,8 @@
/** /**
* gimp_image_add_sample_point: * gimp_image_add_sample_point:
* @image: The image. * @image: The image.
* @position_x: The guide'sample points x-offset from left of image. * @position_x: The sample point's x-offset from left of image.
* @position_y: The guide'sample points y-offset from top of image. * @position_y: The sample point's y-offset from top of image.
* *
* Add a sample point to an image. * Add a sample point to an image.
* *
@ -167,7 +167,7 @@ gimp_image_find_next_sample_point (GimpImage *image,
* gimp_image_get_sample_point_position: * gimp_image_get_sample_point_position:
* @image: The image. * @image: The image.
* @sample_point: The guide. * @sample_point: The guide.
* @position_y: (out): The sample points's position relative to top of image. * @position_y: (out): The sample point's y-offset relative to top of image.
* *
* Get position of a sample point on an image. * Get position of a sample point on an image.
* *
@ -175,7 +175,7 @@ gimp_image_find_next_sample_point (GimpImage *image,
* returns the position of the sample point relative to the top and * returns the position of the sample point relative to the top and
* left of the image. * left of the image.
* *
* Returns: The sample points's position relative to top of image. * Returns: The sample point's x-offset relative to left of image.
* *
* Since: 2.10 * Since: 2.10
**/ **/

8
pdb/groups/image_sample_points.pdb
View file

@ -31,9 +31,9 @@ HELP
{ name => 'image', type => 'image', { name => 'image', type => 'image',
desc => 'The image' }, desc => 'The image' },
{ name => 'position_x', type => '0 <= int32', { name => 'position_x', type => '0 <= int32',
desc => "The guide'sample points x-offset from left of image" }, desc => "The sample point's x-offset from left of image" },
{ name => 'position_y', type => '0 <= int32', { name => 'position_y', type => '0 <= int32',
desc => "The guide'sample points y-offset from top of image" } desc => "The sample point's y-offset from top of image" }
); );
@outargs = ( @outargs = (
@ -159,10 +159,10 @@ HELP
@outargs = ( @outargs = (
{ name => 'position_x', type => 'int32', { name => 'position_x', type => 'int32',
libdef => 'G_MININT', libdef => 'G_MININT',
desc => "The sample points's position relative to top of image" }, desc => "The sample point's x-offset relative to left of image" },
{ name => 'position_y', type => 'int32', { name => 'position_y', type => 'int32',
libdef => 'G_MININT', libdef => 'G_MININT',
desc => "The sample points's position relative to top of image" } desc => "The sample point's y-offset relative to top of image" }
); );
%invoke = ( %invoke = (