[gimp] app, libgimp, pdb: improve a bit gimp_image_get_parasite_list() docs.
- From: Jehan <jehanp src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gimp] app, libgimp, pdb: improve a bit gimp_image_get_parasite_list() docs.
- Date: Fri, 30 Oct 2020 10:54:27 +0000 (UTC)
commit 1a5eea4f0f7bc0f80d8f481fb6959e01ca8b88b3
Author: Jehan <jehan girinstud io>
Date: Thu Oct 29 12:44:18 2020 +0100
app, libgimp, pdb: improve a bit gimp_image_get_parasite_list() docs.
It is more accurate to say it returns a list of parasite names rather
than a list of parasites (as we could take it as meaning a list of
GimpParasite). Of course, we would soon see the actual element contents
(if not for the introspection metadata (element-type gchar*)), but
better being accurate in textual docs too.
app/pdb/image-cmds.c | 2 +-
libgimp/gimpimage_pdb.c | 4 +++-
pdb/groups/image.pdb | 6 +++++-
3 files changed, 9 insertions(+), 3 deletions(-)
---
diff --git a/app/pdb/image-cmds.c b/app/pdb/image-cmds.c
index 14be5b5be5..58a5ecb4be 100644
--- a/app/pdb/image-cmds.c
+++ b/app/pdb/image-cmds.c
@@ -5558,7 +5558,7 @@ register_image_procs (GimpPDB *pdb)
"gimp-image-get-parasite-list");
gimp_procedure_set_static_help (procedure,
"List all parasites.",
- "Returns a list of all currently attached parasites.",
+ "Returns a list of the names of all currently attached parasites. These
names can later be used to get the actual #GimpParasite with 'gimp-image-get-parasite' when needed.",
NULL);
gimp_procedure_set_static_attribution (procedure,
"Marc Lehmann",
diff --git a/libgimp/gimpimage_pdb.c b/libgimp/gimpimage_pdb.c
index 95f74be1a7..0e57f168e4 100644
--- a/libgimp/gimpimage_pdb.c
+++ b/libgimp/gimpimage_pdb.c
@@ -3385,7 +3385,9 @@ gimp_image_get_parasite (GimpImage *image,
*
* List all parasites.
*
- * Returns a list of all currently attached parasites.
+ * Returns a list of the names of all currently attached parasites.
+ * These names can later be used to get the actual #GimpParasite with
+ * gimp_image_get_parasite() when needed.
*
* Returns: (array length=num_parasites) (element-type gchar*) (transfer full):
* The names of currently attached parasites.
diff --git a/pdb/groups/image.pdb b/pdb/groups/image.pdb
index 9ed9679a58..2e775239d8 100644
--- a/pdb/groups/image.pdb
+++ b/pdb/groups/image.pdb
@@ -2878,7 +2878,11 @@ CODE
sub image_get_parasite_list {
$blurb = 'List all parasites.';
- $help = 'Returns a list of all currently attached parasites.';
+ $help = <<'HELP';
+Returns a list of the names of all currently attached parasites.
+These names can later be used to get the actual #GimpParasite with
+gimp_image_get_parasite() when needed.
+HELP
&marc_pdb_misc('1999', '2.8');
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]