Commit be8215ef authored by Michael Natterer's avatar Michael Natterer 😴 Committed by Michael Natterer

improved documentation of gimp-image-clean-all and gimp-image-is-dirty.

2005-10-29  Michael Natterer  <mitch@gimp.org>

	* tools/pdbgen/pdb/image.pdb: improved documentation of
	gimp-image-clean-all and gimp-image-is-dirty. Fixes bug #318075.

	* app/pdb/image_cmds.c
	* libgimp/gimpimage_pdb.c: regenerated.
parent bc3bd4d6
2005-10-29 Michael Natterer <mitch@gimp.org>
* tools/pdbgen/pdb/image.pdb: improved documentation of
gimp-image-clean-all and gimp-image-is-dirty. Fixes bug #318075.
* app/pdb/image_cmds.c
* libgimp/gimpimage_pdb.c: regenerated.
2005-10-28 Michael Natterer <mitch@gimp.org>
* app/actions/image-actions.c: removed "colors-transform-menu".
......
......@@ -2905,7 +2905,7 @@ static ProcRecord image_clean_all_proc =
"gimp-image-clean-all",
"gimp-image-clean-all",
"Set the image dirty count to 0.",
"This procedure sets the specified image's dirty count to 0, allowing operations to occur without having a 'dirtied' image. This is especially useful for creating and loading images which should not initially be considered dirty, even though layers must be created, filled, and installed in the image.",
"This procedure sets the specified image's dirty count to 0, allowing operations to occur without having a 'dirtied' image. This is especially useful for creating and loading images which should not initially be considered dirty, even though layers must be created, filled, and installed in the image. Note that save plug-ins must NOT call this function themselves after saving the image.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
......@@ -2967,7 +2967,7 @@ static ProcRecord image_is_dirty_proc =
"gimp-image-is-dirty",
"gimp-image-is-dirty",
"Checks if the image has unsaved changes.",
"This procedure checks the specified image's dirty count to see if it needs to be saved.",
"This procedure checks the specified image's dirty count to see if it needs to be saved. Note that saving the image does not automatically set the dirty count to 0, you need to call gimp-image-clean-all after calling a save procedure to make the image clean.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
......
......@@ -1439,7 +1439,8 @@ _gimp_image_set_colormap (gint32 image_ID,
* operations to occur without having a 'dirtied' image. This is
* especially useful for creating and loading images which should not
* initially be considered dirty, even though layers must be created,
* filled, and installed in the image.
* filled, and installed in the image. Note that save plug-ins must NOT
* call this function themselves after saving the image.
*
* Returns: TRUE on success.
*/
......@@ -1469,7 +1470,9 @@ gimp_image_clean_all (gint32 image_ID)
* Checks if the image has unsaved changes.
*
* This procedure checks the specified image's dirty count to see if it
* needs to be saved.
* needs to be saved. Note that saving the image does not automatically
* set the dirty count to 0, you need to call gimp-image-clean-all
* after calling a save procedure to make the image clean.
*
* Returns: True if the image has unsaved changes.
*/
......
......@@ -1017,10 +1017,12 @@ sub image_clean_all {
$blurb = 'Set the image dirty count to 0.';
$help = <<'HELP';
This procedure sets the specified image's dirty count to 0, allowing operations
to occur without having a 'dirtied' image. This is especially useful for
creating and loading images which should not initially be considered dirty, even
though layers must be created, filled, and installed in the image.
This procedure sets the specified image's dirty count to 0, allowing
operations to occur without having a 'dirtied' image. This is
especially useful for creating and loading images which should not
initially be considered dirty, even though layers must be created,
filled, and installed in the image. Note that save plug-ins must NOT
call this function themselves after saving the image.
HELP
&std_pdb_misc;
......@@ -1034,8 +1036,10 @@ sub image_is_dirty {
$blurb = 'Checks if the image has unsaved changes.';
$help = <<'HELP';
This procedure checks the specified image's dirty count to see if it needs
to be saved.
This procedure checks the specified image's dirty count to see if it
needs to be saved. Note that saving the image does not automatically
set the dirty count to 0, you need to call gimp-image-clean-all after
calling a save procedure to make the image clean.
HELP
&std_pdb_misc;
......
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