dallasgroot/Gimp
dallasgroot/Gimp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

pdb, libgimp, app: update API docs for is_dirty and file_load

Browse source 
Closes #14463
This commit is contained in:
Jacob Boerema 2025-09-15 15:07:14 -04:00 committed by Jehan
parent a9dce982a6
commit 2d850fe2de
6 changed files with 13 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
app/pdb/file-cmds.c
View file

@ -419,7 +419,7 @@ register_file_procs (GimpPDB *pdb)
"gimp-file-load");
gimp_procedure_set_static_help (procedure,
"Loads an image file by invoking the right load handler.",
"This procedure invokes the correct file load handler using magic if possible, and falling back on the file's extension and/or prefix if not.",
"This procedure invokes the correct file load handler using magic if possible, and falling back on the file's extension and/or prefix if not. Note that the loaded image will be marked as dirty, which can be changed by calling [method@Gimp.Image.clean_all].",
NULL);
gimp_procedure_set_static_attribution (procedure,
"Josh MacDonald",

2
app/pdb/image-cmds.c
View file

@ -4658,7 +4658,7 @@ register_image_procs (GimpPDB *pdb)
"gimp-image-is-dirty");
gimp_procedure_set_static_help (procedure,
"Checks if the image has unsaved changes.",
"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.",
"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 [method@Gimp.Image.clean_all] after calling a save procedure to make the image clean. When loading an image using e.g. [func@Gimp.file_load] the image will be marked as dirty too.",
NULL);
gimp_procedure_set_static_attribution (procedure,
"Spencer Kimball & Peter Mattis",

3
libgimp/gimpfile_pdb.c
View file

@ -45,7 +45,8 @@
*
* This procedure invokes the correct file load handler using magic if
* possible, and falling back on the file's extension and/or prefix if
* not.
* not. Note that the loaded image will be marked as dirty, which can
* be changed by calling [method@Gimp.Image.clean_all].
*
* Returns: (transfer none): The output image.
**/

6
libgimp/gimpimage_pdb.c
View file

@ -2075,8 +2075,10 @@ gimp_image_clean_all (GimpImage *image)
*
* 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.
* set the dirty count to 0, you need to call
* [method@Gimp.Image.clean_all] after calling a save procedure to make
* the image clean. When loading an image using e.g.
* [func@Gimp.file_load] the image will be marked as dirty too.
*
* Returns: TRUE if the image has unsaved changes.
**/

3
pdb/groups/file.pdb
View file

@ -23,7 +23,8 @@ sub file_load {
$help = <<'HELP';
This procedure invokes the correct file load handler using magic if
possible, and falling back on the file's extension and/or prefix if
not.
not. Note that the loaded image will be marked as dirty, which can be
changed by calling [method@Gimp.Image.clean_all].
HELP
&josh_pdb_misc('1997');

5
pdb/groups/image.pdb
View file

@ -1795,8 +1795,9 @@ sub image_is_dirty {
$help = <<'HELP';
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.
set the dirty count to 0, you need to call [method@Gimp.Image.clean_all] after
calling a save procedure to make the image clean. When loading an image using
e.g. [func@Gimp.file_load] the image will be marked as dirty too.
HELP
&std_pdb_misc;