dnrops
/
gimp
mirror of https://github.com/GNOME/gimp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fixed error and some typos in the PDB documentation. 

2008-09-24  Sven Neumann  <sven@gimp.org>

	* tools/pdbgen/pdb/image.pdb: fixed error and some typos in the
	PDB documentation.

	* app/pdb/image-cmds.c
	* libgimp/gimpimage_pdb.c: regenerated.


svn path=/trunk/; revision=27038
This commit is contained in:
Sven Neumann 2008-09-24 07:47:58 +00:00 committed by Sven Neumann
parent aff23edfd7
commit c01408279c
4 changed files with 89 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
ChangeLog
View File

@ -1,3 +1,11 @@
2008-09-24 Sven Neumann <sven@gimp.org>
* tools/pdbgen/pdb/image.pdb: fixed error and some typos in the
PDB documentation.
* app/pdb/image-cmds.c
* libgimp/gimpimage_pdb.c: regenerated.
2008-09-23 Sven Neumann <sven@gimp.org>
* INSTALL

10
app/pdb/image-cmds.c
View File

@ -2707,7 +2707,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-resize",
"Resize the image to the specified extents.",
"This procedure resizes the image so that it's new width and height are equal to the supplied parameters. Offsets are also provided which describe the position of the previous image's content. No bounds checking is currently provided, so don't supply parameters that are out of bounds. All channels within the image are resized according to the specified parameters; this includes the image selection mask. All layers within the image are repositioned according to the specified offsets.",
"This procedure resizes the image so that it's new width and height are equal to the supplied parameters. Offsets are also provided which describe the position of the previous image's content. All channels within the image are resized according to the specified parameters; this includes the image selection mask. All layers within the image are repositioned according to the specified offsets.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
@ -2777,7 +2777,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-scale",
"Scale the image to the specified extents.",
"This procedure scales the image so that its new width and height are equal to the supplied parameters. Offsets are also provided which describe the position of the previous image's content. No bounds checking is currently provided, so don't supply parameters that are out of bounds. All channels within the image are scaled according to the specified parameters; this includes the image selection mask. All layers within the image are repositioned according to the specified offsets.",
"This procedure scales the image so that its new width and height are equal to the supplied parameters. Offsets are also provided which describe the position of the previous image's content. All channels within the image are scaled according to the specified parameters; this includes the image selection mask. All layers within the image are repositioned according to the specified offsets.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
@ -3304,7 +3304,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-get-layer-position",
"Returns the position of the layer in the layer stack.",
"This procedure determines the positioin of the specified layer in the images layer stack. If the layer doesn't exist in the image, an error is returned.",
"This procedure determines the position of the specified layer in the images layer stack. If the layer doesn't exist in the image, an error is returned.",
"Simon Budig",
"Simon Budig",
"2006",
@ -3519,7 +3519,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-get-channel-position",
"Returns the position of the channel in the channel stack.",
"This procedure determines the positioin of the specified channel in the images channel stack. If the channel doesn't exist in the image, an error is returned.",
"This procedure determines the position of the specified channel in the images channel stack. If the channel doesn't exist in the image, an error is returned.",
"Simon Budig",
"Simon Budig",
"2006",
@ -3676,7 +3676,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-get-vectors-position",
"Returns the position of the vectors object in the vectors objects stack.",
"This procedure determines the positioin of the specified vectors object in the images vectors object stack. If the vectors object doesn't exist in the image, an error is returned.",
"This procedure determines the position of the specified vectors object in the images vectors object stack. If the vectors object doesn't exist in the image, an error is returned.",
"Simon Budig",
"Simon Budig",
"2006",

29
libgimp/gimpimage_pdb.c
View File

@ -339,12 +339,11 @@ gimp_image_free_shadow (gint32 image_ID)
*
* This procedure resizes the image so that it's new width and height
* are equal to the supplied parameters. Offsets are also provided
* which describe the position of the previous image's content. No
* bounds checking is currently provided, so don't supply parameters
* that are out of bounds. All channels within the image are resized
* according to the specified parameters; this includes the image
* selection mask. All layers within the image are repositioned
* according to the specified offsets.
* which describe the position of the previous image's content. All
* channels within the image are resized according to the specified
* parameters; this includes the image selection mask. All layers
* within the image are repositioned according to the specified
* offsets.
*
* Returns: TRUE on success.
*/
@ -419,12 +418,10 @@ gimp_image_resize_to_layers (gint32 image_ID)
*
* This procedure scales the image so that its new width and height are
* equal to the supplied parameters. Offsets are also provided which
* describe the position of the previous image's content. No bounds
* checking is currently provided, so don't supply parameters that are
* out of bounds. All channels within the image are scaled according to
* the specified parameters; this includes the image selection mask.
* All layers within the image are repositioned according to the
* specified offsets.
* describe the position of the previous image's content. All channels
* within the image are scaled according to the specified parameters;
* this includes the image selection mask. All layers within the image
* are repositioned according to the specified offsets.
*
* Returns: TRUE on success.
*/
@ -1000,8 +997,8 @@ gimp_image_remove_layer (gint32 image_ID,
*
* Returns the position of the layer in the layer stack.
*
* This procedure determines the positioin of the specified layer in
* the images layer stack. If the layer doesn't exist in the image, an
* This procedure determines the position of the specified layer in the
* images layer stack. If the layer doesn't exist in the image, an
* error is returned.
*
* Returns: The position of the layer in the layer stack.
@ -1244,7 +1241,7 @@ gimp_image_remove_channel (gint32 image_ID,
*
* Returns the position of the channel in the channel stack.
*
* This procedure determines the positioin of the specified channel in
* This procedure determines the position of the specified channel in
* the images channel stack. If the channel doesn't exist in the image,
* an error is returned.
*
@ -1422,7 +1419,7 @@ gimp_image_remove_vectors (gint32 image_ID,
* Returns the position of the vectors object in the vectors objects
* stack.
*
* This procedure determines the positioin of the specified vectors
* This procedure determines the position of the specified vectors
* object in the images vectors object stack. If the vectors object
* doesn't exist in the image, an error is returned.
*

120
tools/pdbgen/pdb/image.pdb
View File

@ -87,11 +87,12 @@ sub image_new {
$blurb = 'Creates a new image with the specified width, height, and type.';
$help = <<'HELP';
Creates a new image, undisplayed with the specified extents and type. A layer
should be created and added before this image is displayed, or subsequent calls
to gimp_display_new() with this image as an argument will fail. Layers can be
created using the gimp_layer_new() commands. They can be added to an image
using the gimp_image_add_layer() command.
Creates a new image, undisplayed with the specified extents and
type. A layer should be created and added before this image is
displayed, or subsequent calls to gimp_display_new() with this image
as an argument will fail. Layers can be created using the
gimp_layer_new() commands. They can be added to an image using the
gimp_image_add_layer() command.
HELP
&std_pdb_misc;
@ -190,13 +191,12 @@ sub image_resize {
$blurb = 'Resize the image to the specified extents.';
$help = <<'HELP';
This procedure resizes the image so that it's new width and height are equal to
the supplied parameters. Offsets are also provided which describe the position
of the previous image's content. No bounds checking is currently provided, so
don't supply parameters that are out of bounds. All channels within the image
are resized according to the specified parameters; this includes the image
selection mask. All layers within the image are repositioned according to the
specified offsets.
This procedure resizes the image so that it's new width and height are
equal to the supplied parameters. Offsets are also provided which
describe the position of the previous image's content. All channels
within the image are resized according to the specified parameters;
this includes the image selection mask. All layers within the image
are repositioned according to the specified offsets.
HELP
&std_pdb_misc;
@ -231,10 +231,10 @@ sub image_resize_to_layers {
$blurb = 'Resize the image to fit all layers.';
$help = <<'HELP';
This procedure resizes the image to the bounding box of all layers of the
image. All channels within the image are resized to the new size; this includes
the image selection mask. All layers within the image are repositioned to the
new image area.
This procedure resizes the image to the bounding box of all layers of
the image. All channels within the image are resized to the new size;
this includes the image selection mask. All layers within the image
are repositioned to the new image area.
HELP
&simon_pdb_misc('2004', '2.2');
@ -258,13 +258,12 @@ sub image_scale {
$blurb = 'Scale the image to the specified extents.';
$help = <<'HELP';
This procedure scales the image so that its new width and height are equal to
the supplied parameters. Offsets are also provided which describe the position
of the previous image's content. No bounds checking is currently provided, so
don't supply parameters that are out of bounds. All channels within the image
are scaled according to the specified parameters; this includes the image
selection mask. All layers within the image are repositioned according to the
specified offsets.
This procedure scales the image so that its new width and height are
equal to the supplied parameters. Offsets are also provided which
describe the position of the previous image's content. All channels
within the image are scaled according to the specified parameters;
this includes the image selection mask. All layers within the image
are repositioned according to the specified offsets.
HELP
&std_pdb_misc;
@ -294,11 +293,12 @@ sub image_crop {
$blurb = 'Crop the image to the specified extents.';
$help = <<'HELP';
This procedure crops the image so that it's new width and height are equal to
the supplied parameters. Offsets are also provided which describe the position
of the previous image's content. All channels and layers within the image are
cropped to the new image extents; this includes the image selection mask. If
any parameters are out of range, an error is returned.
This procedure crops the image so that it's new width and height are
equal to the supplied parameters. Offsets are also provided which
describe the position of the previous image's content. All channels
and layers within the image are cropped to the new image extents; this
includes the image selection mask. If any parameters are out of range,
an error is returned.
HELP
&std_pdb_misc;
@ -533,9 +533,10 @@ sub image_unset_active_channel {
$blurb = 'Unsets the active channel in the specified image.';
$help = <<'HELP';
If an active channel exists, it is unset. There then exists no active channel,
and if desired, one can be set through a call to 'Set Active Channel'. No error
is returned in the case of no existing active channel.
If an active channel exists, it is unset. There then exists no active
channel, and if desired, one can be set through a call to 'Set Active
Channel'. No error is returned in the case of no existing active
channel.
HELP
&std_pdb_misc;
@ -638,10 +639,11 @@ sub image_pick_correlate_layer {
$blurb = 'Find the layer visible at the specified coordinates.';
$help = <<'HELP';
This procedure finds the layer which is visible at the specified coordinates.
Layers which do not qualify are those whose extents do not pass within the
specified coordinates, or which are transparent at the specified coordinates.
This procedure will return -1 if no layer is found.
This procedure finds the layer which is visible at the specified
coordinates. Layers which do not qualify are those whose extents do
not pass within the specified coordinates, or which are transparent at
the specified coordinates. This procedure will return -1 if no layer
is found.
HELP
&std_pdb_misc;
@ -673,8 +675,9 @@ sub image_get_layer_position {
$blurb = 'Returns the position of the layer in the layer stack.';
$help = <<'HELP';
This procedure determines the positioin of the specified layer in the images
layer stack. If the layer doesn't exist in the image, an error is returned.
This procedure determines the position of the specified layer in the
images layer stack. If the layer doesn't exist in the image, an error
is returned.
HELP
&simon_pdb_misc('2006', '2.4');
@ -818,12 +821,12 @@ sub image_merge_visible_layers {
$blurb = 'Merge the visible image layers into one.';
$help = <<'HELP';
This procedure combines the visible layers into a single layer using the
specified merge type. A merge type of EXPAND_AS_NECESSARY expands the final
layer to encompass the areas of the visible layers. A merge type of
CLIP_TO_IMAGE clips the final layer to the extents of the image. A merge type
of CLIP_TO_BOTTOM_LAYER clips the final layer to the size of the bottommost
layer.
This procedure combines the visible layers into a single layer using
the specified merge type. A merge type of EXPAND_AS_NECESSARY expands
the final layer to encompass the areas of the visible layers. A merge
type of CLIP_TO_IMAGE clips the final layer to the extents of the
image. A merge type of CLIP_TO_BOTTOM_LAYER clips the final layer to
the size of the bottommost layer.
HELP
&std_pdb_misc;
@ -858,12 +861,13 @@ sub image_merge_down {
$blurb = 'Merge the layer passed and the first visible layer below.';
$help = <<'HELP';
This procedure combines the passed layer and the first visible layer below it
using the specified merge type. A merge type of EXPAND_AS_NECESSARY expands the
final layer to encompass the areas of the visible layers. A merge type of
CLIP_TO_IMAGE clips the final layer to the extents of the image. A merge type
of CLIP_TO_BOTTOM_LAYER clips the final layer to the size of the bottommost
layer.
This procedure combines the passed layer and the first visible layer
below it using the specified merge type. A merge type of
EXPAND_AS_NECESSARY expands the final layer to encompass the areas of
the visible layers. A merge type of CLIP_TO_IMAGE clips the final
layer to the extents of the image. A merge type of
CLIP_TO_BOTTOM_LAYER clips the final layer to the size of the
bottommost layer.
HELP
&larry_pdb_misc('1998');
@ -973,10 +977,10 @@ sub image_remove_layer {
$blurb = 'Remove the specified layer from the image.';
$help = <<'HELP';
This procedure removes the specified layer from the image. If the layer doesn't
exist, an error is returned. If there are no layers left in the image, this
call will fail. If this layer is the last layer remaining, the image will
become empty and have no active layer.
This procedure removes the specified layer from the image. If the
layer doesn't exist, an error is returned. If there are no layers left
in the image, this call will fail. If this layer is the last layer
remaining, the image will become empty and have no active layer.
HELP
&std_pdb_misc;
@ -1053,8 +1057,9 @@ sub image_get_channel_position {
$blurb = 'Returns the position of the channel in the channel stack.';
$help = <<'HELP';
This procedure determines the positioin of the specified channel in the images
channel stack. If the channel doesn't exist in the image, an error is returned.
This procedure determines the position of the specified channel in
the images channel stack. If the channel doesn't exist in the image,
an error is returned.
HELP
&simon_pdb_misc('2006', '2.4');
@ -1270,7 +1275,7 @@ sub image_get_vectors_position {
$blurb = 'Returns the position of the vectors object in the vectors objects stack.';
$help = <<'HELP';
This procedure determines the positioin of the specified vectors object in the
This procedure determines the position of the specified vectors object in the
images vectors object stack. If the vectors object doesn't exist in the image,
an error is returned.
HELP
@ -2446,7 +2451,8 @@ sub image_get_vectors_by_tattoo {
$blurb = 'Find a vectors with a given tattoo in an image.';
$help = <<'HELP';
This procedure returns the vectors with the given tattoo in the specified image.
This procedure returns the vectors with the given tattoo in the
specified image.
HELP
&simon_pdb_misc('2005', '2.6');