fixed documentation (bug #542972).

2008-07-15  Sven Neumann  <sven@gimp.org>

	* tools/pdbgen/pdb/edit.pdb: fixed documentation (bug #542972).

	* app/pdb/edit-cmds.c
	* libgimp/gimpedit_pdb.c: regenerated.


svn path=/trunk/; revision=26193
This commit is contained in:
Sven Neumann 2008-07-14 22:52:14 +00:00 committed by Sven Neumann
parent f92a070fa8
commit 66b0b1d498
4 changed files with 42 additions and 28 deletions

View File

@ -1,3 +1,10 @@
2008-07-15 Sven Neumann <sven@gimp.org>
* tools/pdbgen/pdb/edit.pdb: fixed documentation (bug #542972).
* app/pdb/edit-cmds.c
* libgimp/gimpedit_pdb.c: regenerated.
2008-07-14 Sven Neumann <sven@gimp.org> 2008-07-14 Sven Neumann <sven@gimp.org>
* tools/pdbgen/pdb/palette.pdb: added new PDB function * tools/pdbgen/pdb/palette.pdb: added new PDB function

View File

@ -799,7 +799,7 @@ register_edit_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure, gimp_procedure_set_static_strings (procedure,
"gimp-edit-cut", "gimp-edit-cut",
"Cut from the specified drawable.", "Cut from the specified drawable.",
"If there is a selection in the image, then the area specified by the selection is cut from the specified drawable and placed in an internal GIMP edit buffer. It can subsequently be retrieved using the 'gimp-edit-paste' command. If there is no selection, then the specified drawable will be removed and its contents stored in the internal GIMP edit buffer.", "If there is a selection in the image, then the area specified by the selection is cut from the specified drawable and placed in an internal GIMP edit buffer. It can subsequently be retrieved using the 'gimp-edit-paste' command. If there is no selection, then the specified drawable will be removed and its contents stored in the internal GIMP edit buffer. This procedure will fail if the selected area lies completely outside the bounds of the current drawable and there is nothing to copy from.",
"Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis",
"1995-1996", "1995-1996",
@ -813,7 +813,7 @@ register_edit_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure, gimp_procedure_add_return_value (procedure,
g_param_spec_boolean ("non-empty", g_param_spec_boolean ("non-empty",
"non empty", "non empty",
"TRUE if the cut was successful, FALSE if the selection contained only transparent pixels", "TRUE if the cut was successful, FALSE if there was nothing to copy from",
FALSE, FALSE,
GIMP_PARAM_READWRITE)); GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure); gimp_pdb_register_procedure (pdb, procedure);
@ -828,7 +828,7 @@ register_edit_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure, gimp_procedure_set_static_strings (procedure,
"gimp-edit-copy", "gimp-edit-copy",
"Copy from the specified drawable.", "Copy from the specified drawable.",
"If there is a selection in the image, then the area specified by the selection is copied from the specified drawable and placed in an internal GIMP edit buffer. It can subsequently be retrieved using the 'gimp-edit-paste' command. If there is no selection, then the specified drawable's contents will be stored in the internal GIMP edit buffer.", "If there is a selection in the image, then the area specified by the selection is copied from the specified drawable and placed in an internal GIMP edit buffer. It can subsequently be retrieved using the 'gimp-edit-paste' command. If there is no selection, then the specified drawable's contents will be stored in the internal GIMP edit buffer. This procedure will fail if the selected area lies completely outside the bounds of the current drawable and there is nothing to copy from.",
"Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis",
"1995-1996", "1995-1996",
@ -842,7 +842,7 @@ register_edit_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure, gimp_procedure_add_return_value (procedure,
g_param_spec_boolean ("non-empty", g_param_spec_boolean ("non-empty",
"non empty", "non empty",
"TRUE if the copy was successful, FALSE if the selection contained only transparent pixels", "TRUE if the cut was successful, FALSE if there was nothing to copy from",
FALSE, FALSE,
GIMP_PARAM_READWRITE)); GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure); gimp_pdb_register_procedure (pdb, procedure);
@ -871,7 +871,7 @@ register_edit_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure, gimp_procedure_add_return_value (procedure,
g_param_spec_boolean ("non-empty", g_param_spec_boolean ("non-empty",
"non empty", "non empty",
"TRUE if the copy was successful, FALSE if the selection contained only transparent pixels", "TRUE if the copy was successful",
FALSE, FALSE,
GIMP_PARAM_READWRITE)); GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure); gimp_pdb_register_procedure (pdb, procedure);
@ -965,7 +965,7 @@ register_edit_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure, gimp_procedure_add_return_value (procedure,
gimp_param_spec_string ("real-name", gimp_param_spec_string ("real-name",
"real name", "real name",
"The real name given to the buffer, or NULL if the selection contained only transparent pixels", "The real name given to the buffer, or NULL if the cut failed",
FALSE, FALSE, FALSE, FALSE, FALSE, FALSE,
NULL, NULL,
GIMP_PARAM_READWRITE)); GIMP_PARAM_READWRITE));
@ -1002,7 +1002,7 @@ register_edit_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure, gimp_procedure_add_return_value (procedure,
gimp_param_spec_string ("real-name", gimp_param_spec_string ("real-name",
"real name", "real name",
"The real name given to the buffer, or NULL if the selection contained only transparent pixels", "The real name given to the buffer, or NULL if the copy failed",
FALSE, FALSE, FALSE, FALSE, FALSE, FALSE,
NULL, NULL,
GIMP_PARAM_READWRITE)); GIMP_PARAM_READWRITE));
@ -1039,7 +1039,7 @@ register_edit_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure, gimp_procedure_add_return_value (procedure,
gimp_param_spec_string ("real-name", gimp_param_spec_string ("real-name",
"real name", "real name",
"The real name given to the buffer, or NULL if the selection contained only transparent pixels", "The real name given to the buffer, or NULL if the copy failed",
FALSE, FALSE, FALSE, FALSE, FALSE, FALSE,
NULL, NULL,
GIMP_PARAM_READWRITE)); GIMP_PARAM_READWRITE));

View File

@ -36,9 +36,11 @@
* internal GIMP edit buffer. It can subsequently be retrieved using * internal GIMP edit buffer. It can subsequently be retrieved using
* the gimp_edit_paste() command. If there is no selection, then the * the gimp_edit_paste() command. If there is no selection, then the
* specified drawable will be removed and its contents stored in the * specified drawable will be removed and its contents stored in the
* internal GIMP edit buffer. * internal GIMP edit buffer. This procedure will fail if the selected
* area lies completely outside the bounds of the current drawable and
* there is nothing to copy from.
* *
* Returns: TRUE if the cut was successful, FALSE if the selection contained only transparent pixels. * Returns: TRUE if the cut was successful, FALSE if there was nothing to copy from.
*/ */
gboolean gboolean
gimp_edit_cut (gint32 drawable_ID) gimp_edit_cut (gint32 drawable_ID)
@ -71,9 +73,11 @@ gimp_edit_cut (gint32 drawable_ID)
* internal GIMP edit buffer. It can subsequently be retrieved using * internal GIMP edit buffer. It can subsequently be retrieved using
* the gimp_edit_paste() command. If there is no selection, then the * the gimp_edit_paste() command. If there is no selection, then the
* specified drawable's contents will be stored in the internal GIMP * specified drawable's contents will be stored in the internal GIMP
* edit buffer. * edit buffer. This procedure will fail if the selected area lies
* completely outside the bounds of the current drawable and there is
* nothing to copy from.
* *
* Returns: TRUE if the copy was successful, FALSE if the selection contained only transparent pixels. * Returns: TRUE if the cut was successful, FALSE if there was nothing to copy from.
*/ */
gboolean gboolean
gimp_edit_copy (gint32 drawable_ID) gimp_edit_copy (gint32 drawable_ID)
@ -108,7 +112,7 @@ gimp_edit_copy (gint32 drawable_ID)
* projection's contents will be stored in the internal GIMP edit * projection's contents will be stored in the internal GIMP edit
* buffer. * buffer.
* *
* Returns: TRUE if the copy was successful, FALSE if the selection contained only transparent pixels. * Returns: TRUE if the copy was successful.
* *
* Since: GIMP 2.2 * Since: GIMP 2.2
*/ */
@ -224,7 +228,7 @@ gimp_edit_paste_as_new (void)
* later pasting, regardless of any intermediate copy or cut * later pasting, regardless of any intermediate copy or cut
* operations. * operations.
* *
* Returns: The real name given to the buffer, or NULL if the selection contained only transparent pixels. * Returns: The real name given to the buffer, or NULL if the cut failed.
* *
* Since: GIMP 2.4 * Since: GIMP 2.4
*/ */
@ -262,7 +266,7 @@ gimp_edit_named_cut (gint32 drawable_ID,
* later pasting, regardless of any intermediate copy or cut * later pasting, regardless of any intermediate copy or cut
* operations. * operations.
* *
* Returns: The real name given to the buffer, or NULL if the selection contained only transparent pixels. * Returns: The real name given to the buffer, or NULL if the copy failed.
* *
* Since: GIMP 2.4 * Since: GIMP 2.4
*/ */
@ -300,7 +304,7 @@ gimp_edit_named_copy (gint32 drawable_ID,
* available for later pasting, regardless of any intermediate copy or * available for later pasting, regardless of any intermediate copy or
* cut operations. * cut operations.
* *
* Returns: The real name given to the buffer, or NULL if the selection contained only transparent pixels. * Returns: The real name given to the buffer, or NULL if the copy failed.
* *
* Since: GIMP 2.4 * Since: GIMP 2.4
*/ */

View File

@ -23,10 +23,12 @@ sub edit_cut {
$help = <<'HELP'; $help = <<'HELP';
If there is a selection in the image, then the area specified by the If there is a selection in the image, then the area specified by the
selection is cut from the specified drawable and placed in an internal selection is cut from the specified drawable and placed in an internal
GIMP edit buffer. It can subsequently be retrieved using the GIMP edit buffer. It can subsequently be retrieved using the
gimp_edit_paste() command. If there is no selection, then the gimp_edit_paste() command. If there is no selection, then the
specified drawable will be removed and its contents stored in the specified drawable will be removed and its contents stored in the
internal GIMP edit buffer. internal GIMP edit buffer. This procedure will fail if the selected area
lies completely outside the bounds of the current drawable and there is
nothing to copy from.
HELP HELP
&std_pdb_misc; &std_pdb_misc;
@ -38,8 +40,8 @@ HELP
@outargs = ( @outargs = (
{ name => 'non_empty', type => 'boolean', { name => 'non_empty', type => 'boolean',
desc => 'TRUE if the cut was successful, FALSE if the desc => 'TRUE if the cut was successful,
selection contained only transparent pixels' } FALSE if there was nothing to copy from' }
); );
%invoke = ( %invoke = (
@ -75,7 +77,9 @@ selection is copied from the specified drawable and placed in an
internal GIMP edit buffer. It can subsequently be retrieved using the internal GIMP edit buffer. It can subsequently be retrieved using the
gimp_edit_paste() command. If there is no selection, then the gimp_edit_paste() command. If there is no selection, then the
specified drawable's contents will be stored in the internal GIMP edit specified drawable's contents will be stored in the internal GIMP edit
buffer. buffer. This procedure will fail if the selected area lies completely
outside the bounds of the current drawable and there is nothing to
copy from.
HELP HELP
&std_pdb_misc; &std_pdb_misc;
@ -87,8 +91,8 @@ HELP
@outargs = ( @outargs = (
{ name => 'non_empty', type => 'boolean', { name => 'non_empty', type => 'boolean',
desc => 'TRUE if the copy was successful, FALSE if the desc => 'TRUE if the cut was successful,
selection contained only transparent pixels' } FALSE if there was nothing to copy from' }
); );
%invoke = ( %invoke = (
@ -135,8 +139,7 @@ HELP
@outargs = ( @outargs = (
{ name => 'non_empty', type => 'boolean', { name => 'non_empty', type => 'boolean',
desc => 'TRUE if the copy was successful, FALSE if the desc => 'TRUE if the copy was successful' }
selection contained only transparent pixels' }
); );
%invoke = ( %invoke = (
@ -266,7 +269,7 @@ HELP
@outargs = ( @outargs = (
{ name => 'real_name', type => 'string', { name => 'real_name', type => 'string',
desc => 'The real name given to the buffer, or NULL if the desc => 'The real name given to the buffer, or NULL if the
selection contained only transparent pixels' } cut failed' }
); );
%invoke = ( %invoke = (
@ -318,7 +321,7 @@ HELP
@outargs = ( @outargs = (
{ name => 'real_name', type => 'string', { name => 'real_name', type => 'string',
desc => 'The real name given to the buffer, or NULL if the desc => 'The real name given to the buffer, or NULL if the
selection contained only transparent pixels' } copy failed' }
); );
%invoke = ( %invoke = (
@ -372,7 +375,7 @@ HELP
@outargs = ( @outargs = (
{ name => 'real_name', type => 'string', { name => 'real_name', type => 'string',
desc => 'The real name given to the buffer, or NULL if the desc => 'The real name given to the buffer, or NULL if the
selection contained only transparent pixels' } copy failed' }
); );
%invoke = ( %invoke = (