procyberian/gimp
2
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/gimp.git synced 2025-07-04 01:43:24 +00:00
Code Issues 1 Projects 1 Releases Packages Wiki Activity Actions

app, libgimp, pdb: prettify the previous commit.

Browse source 
I double-checked the gi-docgen docs and realized the "Note:" were all on
the same line as previous text. I had forgotten it just removed one
newline. So if I want a new paragraph (double-newline in markdown), I
need 3 newlines in the pdb file.
This commit is contained in:
Jehan 2024-08-26 15:14:48 +02:00
parent 85c48a9a25
commit d1c8e5efb9
9 changed files with 78 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

3
app/pdb/display-cmds.c
View file

@ -246,7 +246,8 @@ register_display_procs (GimpPDB *pdb)
gimp_procedure_set_static_help (procedure, gimp_procedure_set_static_help (procedure,
"Returns TRUE if the display ID is valid.", "Returns TRUE if the display ID is valid.",
"This procedure checks if the given display ID is valid and refers to an existing display.\n" "This procedure checks if the given display ID is valid and refers to an existing display.\n"
"Note: in most use cases, you should not use this function. If you got a [class@Gimp.Display] from the API, you should trust it is valid. This function is mostly for internal usage.", "\n"
"*Note*: in most use cases, you should not use this function. If you got a [class@Gimp.Display] from the API, you should trust it is valid. This function is mostly for internal usage.",
NULL); NULL);
gimp_procedure_set_static_attribution (procedure, gimp_procedure_set_static_attribution (procedure,
"Sven Neumann <sven@gimp.org>", "Sven Neumann <sven@gimp.org>",

27
app/pdb/item-cmds.c
View file

@ -1070,7 +1070,8 @@ register_item_procs (GimpPDB *pdb)
gimp_procedure_set_static_help (procedure, gimp_procedure_set_static_help (procedure,
"Returns %TRUE if the item ID is valid.", "Returns %TRUE if the item ID is valid.",
"This procedure checks if the given item ID is valid and refers to an existing item.\n" "This procedure checks if the given item ID is valid and refers to an existing item.\n"
"Note: in most use cases, you should not use this function. If you got a [class@Gimp.Item] from the API, you should trust it is valid. This function is mostly for internal usage.", "\n"
"*Note*: in most use cases, you should not use this function. If you got a [class@Gimp.Item] from the API, you should trust it is valid. This function is mostly for internal usage.",
NULL); NULL);
gimp_procedure_set_static_attribution (procedure, gimp_procedure_set_static_attribution (procedure,
"Sven Neumann <sven@gimp.org>", "Sven Neumann <sven@gimp.org>",
@ -1100,7 +1101,8 @@ register_item_procs (GimpPDB *pdb)
gimp_procedure_set_static_help (procedure, gimp_procedure_set_static_help (procedure,
"Returns whether the item ID is a drawable.", "Returns whether the item ID is a drawable.",
"This procedure returns %TRUE if the specified item ID is a drawable.\n" "This procedure returns %TRUE if the specified item ID is a drawable.\n"
"Note: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.", "\n"
"*Note*: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.",
NULL); NULL);
gimp_procedure_set_static_attribution (procedure, gimp_procedure_set_static_attribution (procedure,
"Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis",
@ -1130,7 +1132,8 @@ register_item_procs (GimpPDB *pdb)
gimp_procedure_set_static_help (procedure, gimp_procedure_set_static_help (procedure,
"Returns whether the item ID is a layer.", "Returns whether the item ID is a layer.",
"This procedure returns %TRUE if the specified item ID is a layer.\n" "This procedure returns %TRUE if the specified item ID is a layer.\n"
"Note: in most use cases, you should not use this function. If the goal is to verify the accurate type for a [class.Item], you should either use [method.Item.is_layer] or the specific type-checking methods for the used language.\n" "\n"
"*Note*: in most use cases, you should not use this function. If the goal is to verify the accurate type for a [class.Item], you should either use [method.Item.is_layer] or the specific type-checking methods for the used language.\n"
"For instance, in C:\n" "For instance, in C:\n"
"```C\n" "```C\n"
"if (GIMP_IS_LAYER (item))\n" "if (GIMP_IS_LAYER (item))\n"
@ -1170,7 +1173,8 @@ register_item_procs (GimpPDB *pdb)
gimp_procedure_set_static_help (procedure, gimp_procedure_set_static_help (procedure,
"Returns whether the item ID is a text layer.", "Returns whether the item ID is a text layer.",
"This procedure returns %TRUE if the specified item ID is a text layer.\n" "This procedure returns %TRUE if the specified item ID is a text layer.\n"
"Note: in most use cases, you should not use this function. See [func@Gimp.Item.id_is_layer] for a discussion on alternatives.", "\n"
"*Note*: in most use cases, you should not use this function. See [func@Gimp.Item.id_is_layer] for a discussion on alternatives.",
NULL); NULL);
gimp_procedure_set_static_attribution (procedure, gimp_procedure_set_static_attribution (procedure,
"Michael Natterer <mitch@gimp.org>", "Michael Natterer <mitch@gimp.org>",
@ -1200,7 +1204,8 @@ register_item_procs (GimpPDB *pdb)
gimp_procedure_set_static_help (procedure, gimp_procedure_set_static_help (procedure,
"Returns whether the item ID is a group layer.", "Returns whether the item ID is a group layer.",
"This procedure returns %TRUE if the specified item ID is a group layer.\n" "This procedure returns %TRUE if the specified item ID is a group layer.\n"
"Note: in most use cases, you should not use this function. See [func@Gimp.Item.id_is_layer] for a discussion on alternatives.", "\n"
"*Note*: in most use cases, you should not use this function. See [func@Gimp.Item.id_is_layer] for a discussion on alternatives.",
NULL); NULL);
gimp_procedure_set_static_attribution (procedure, gimp_procedure_set_static_attribution (procedure,
"Jehan", "Jehan",
@ -1230,7 +1235,8 @@ register_item_procs (GimpPDB *pdb)
gimp_procedure_set_static_help (procedure, gimp_procedure_set_static_help (procedure,
"Returns whether the item ID is a channel.", "Returns whether the item ID is a channel.",
"This procedure returns %TRUE if the specified item ID is a channel.\n" "This procedure returns %TRUE if the specified item ID is a channel.\n"
"Note: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.", "\n"
"*Note*: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.",
NULL); NULL);
gimp_procedure_set_static_attribution (procedure, gimp_procedure_set_static_attribution (procedure,
"Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis",
@ -1260,7 +1266,8 @@ register_item_procs (GimpPDB *pdb)
gimp_procedure_set_static_help (procedure, gimp_procedure_set_static_help (procedure,
"Returns whether the item ID is a layer mask.", "Returns whether the item ID is a layer mask.",
"This procedure returns %TRUE if the specified item ID is a layer mask.\n" "This procedure returns %TRUE if the specified item ID is a layer mask.\n"
"Note: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.", "\n"
"*Note*: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.",
NULL); NULL);
gimp_procedure_set_static_attribution (procedure, gimp_procedure_set_static_attribution (procedure,
"Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis",
@ -1290,7 +1297,8 @@ register_item_procs (GimpPDB *pdb)
gimp_procedure_set_static_help (procedure, gimp_procedure_set_static_help (procedure,
"Returns whether the item ID is a path.", "Returns whether the item ID is a path.",
"This procedure returns %TRUE if the specified item ID is a path.\n" "This procedure returns %TRUE if the specified item ID is a path.\n"
"Note: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.", "\n"
"*Note*: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.",
NULL); NULL);
gimp_procedure_set_static_attribution (procedure, gimp_procedure_set_static_attribution (procedure,
"Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis",
@ -1320,7 +1328,8 @@ register_item_procs (GimpPDB *pdb)
gimp_procedure_set_static_help (procedure, gimp_procedure_set_static_help (procedure,
"Returns whether the item ID is a selection.", "Returns whether the item ID is a selection.",
"This procedure returns %TRUE if the specified item ID is a selection.\n" "This procedure returns %TRUE if the specified item ID is a selection.\n"
"Note: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.", "\n"
"*Note*: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.",
NULL); NULL);
gimp_procedure_set_static_attribution (procedure, gimp_procedure_set_static_attribution (procedure,
"Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis",

6
app/pdb/resource-cmds.c
View file

@ -606,7 +606,8 @@ register_resource_procs (GimpPDB *pdb)
gimp_procedure_set_static_help (procedure, gimp_procedure_set_static_help (procedure,
"Returns TRUE if the resource ID is valid.", "Returns TRUE if the resource ID is valid.",
"This procedure checks if the given resource ID is valid and refers to an existing resource.\n" "This procedure checks if the given resource ID is valid and refers to an existing resource.\n"
"Note: in most use cases, you should not use this function. If you got a [class@Gimp.Resource] from the API, you should trust it is valid. This function is mostly for internal usage.", "\n"
"*Note*: in most use cases, you should not use this function. If you got a [class@Gimp.Resource] from the API, you should trust it is valid. This function is mostly for internal usage.",
NULL); NULL);
gimp_procedure_set_static_attribution (procedure, gimp_procedure_set_static_attribution (procedure,
"Michael Natterer <mitch@gimp.org>", "Michael Natterer <mitch@gimp.org>",
@ -811,7 +812,8 @@ register_resource_procs (GimpPDB *pdb)
gimp_procedure_set_static_help (procedure, gimp_procedure_set_static_help (procedure,
"Returns a triplet identifying the resource.", "Returns a triplet identifying the resource.",
"This procedure returns 2 strings and a boolean. The first string is the resource name, similar to what you would obtain calling 'gimp-resource-get-name'. The second is an opaque identifier for the collection this resource belongs to.\n" "This procedure returns 2 strings and a boolean. The first string is the resource name, similar to what you would obtain calling 'gimp-resource-get-name'. The second is an opaque identifier for the collection this resource belongs to.\n"
"Note: as far as GIMP is concerned, a collection of resource usually corresponds to a single file on disk (which may or may not contain several resources). Therefore the identifier may be derived from the local file path. Nevertheless you should not use this string as such as this is not guaranteed to be always the case. You should consider it as an opaque identifier only to be used again through _'gimp-resource-get-by-identifier'.", "\n"
"*Note*: as far as GIMP is concerned, a collection of resource usually corresponds to a single file on disk (which may or may not contain several resources). Therefore the identifier may be derived from the local file path. Nevertheless you should not use this string as such as this is not guaranteed to be always the case. You should consider it as an opaque identifier only to be used again through _'gimp-resource-get-by-identifier'.",
NULL); NULL);
gimp_procedure_set_static_attribution (procedure, gimp_procedure_set_static_attribution (procedure,
"Jehan", "Jehan",

3
libgimp/gimpdisplay_pdb.c
View file

@ -44,7 +44,8 @@
* *
* This procedure checks if the given display ID is valid and refers to * This procedure checks if the given display ID is valid and refers to
* an existing display. * an existing display.
* Note: in most use cases, you should not use this function. If you *
* *Note*: in most use cases, you should not use this function. If you
* got a [class@Gimp.Display] from the API, you should trust it is * got a [class@Gimp.Display] from the API, you should trust it is
* valid. This function is mostly for internal usage. * valid. This function is mostly for internal usage.
* *

27
libgimp/gimpitem_pdb.c
View file

@ -44,7 +44,8 @@
* *
* This procedure checks if the given item ID is valid and refers to an * This procedure checks if the given item ID is valid and refers to an
* existing item. * existing item.
* Note: in most use cases, you should not use this function. If you *
* *Note*: in most use cases, you should not use this function. If you
* got a [class@Gimp.Item] from the API, you should trust it is valid. * got a [class@Gimp.Item] from the API, you should trust it is valid.
* This function is mostly for internal usage. * This function is mostly for internal usage.
* *
@ -83,7 +84,8 @@ gimp_item_id_is_valid (gint item_id)
* Returns whether the item ID is a drawable. * Returns whether the item ID is a drawable.
* *
* This procedure returns %TRUE if the specified item ID is a drawable. * This procedure returns %TRUE if the specified item ID is a drawable.
* Note: in most use cases, you should not use this function. See *
* *Note*: in most use cases, you should not use this function. See
* [func.Item.id_is_layer] for a discussion on alternatives. * [func.Item.id_is_layer] for a discussion on alternatives.
* *
* Returns: TRUE if the item ID is a drawable, FALSE otherwise. * Returns: TRUE if the item ID is a drawable, FALSE otherwise.
@ -121,7 +123,8 @@ gimp_item_id_is_drawable (gint item_id)
* Returns whether the item ID is a layer. * Returns whether the item ID is a layer.
* *
* This procedure returns %TRUE if the specified item ID is a layer. * This procedure returns %TRUE if the specified item ID is a layer.
* Note: in most use cases, you should not use this function. If the *
* *Note*: in most use cases, you should not use this function. If the
* goal is to verify the accurate type for a [class.Item], you should * goal is to verify the accurate type for a [class.Item], you should
* either use [method.Item.is_layer] or the specific type-checking * either use [method.Item.is_layer] or the specific type-checking
* methods for the used language. * methods for the used language.
@ -172,7 +175,8 @@ gimp_item_id_is_layer (gint item_id)
* *
* This procedure returns %TRUE if the specified item ID is a text * This procedure returns %TRUE if the specified item ID is a text
* layer. * layer.
* Note: in most use cases, you should not use this function. See *
* *Note*: in most use cases, you should not use this function. See
* [func@Gimp.Item.id_is_layer] for a discussion on alternatives. * [func@Gimp.Item.id_is_layer] for a discussion on alternatives.
* *
* Returns: TRUE if the item is a text layer, FALSE otherwise. * Returns: TRUE if the item is a text layer, FALSE otherwise.
@ -211,7 +215,8 @@ gimp_item_id_is_text_layer (gint item_id)
* *
* This procedure returns %TRUE if the specified item ID is a group * This procedure returns %TRUE if the specified item ID is a group
* layer. * layer.
* Note: in most use cases, you should not use this function. See *
* *Note*: in most use cases, you should not use this function. See
* [func@Gimp.Item.id_is_layer] for a discussion on alternatives. * [func@Gimp.Item.id_is_layer] for a discussion on alternatives.
* *
* Returns: TRUE if the item is a group layer, FALSE otherwise. * Returns: TRUE if the item is a group layer, FALSE otherwise.
@ -249,7 +254,8 @@ gimp_item_id_is_group_layer (gint item_id)
* Returns whether the item ID is a channel. * Returns whether the item ID is a channel.
* *
* This procedure returns %TRUE if the specified item ID is a channel. * This procedure returns %TRUE if the specified item ID is a channel.
* Note: in most use cases, you should not use this function. See *
* *Note*: in most use cases, you should not use this function. See
* [func.Item.id_is_layer] for a discussion on alternatives. * [func.Item.id_is_layer] for a discussion on alternatives.
* *
* Returns: TRUE if the item ID is a channel, FALSE otherwise. * Returns: TRUE if the item ID is a channel, FALSE otherwise.
@ -288,7 +294,8 @@ gimp_item_id_is_channel (gint item_id)
* *
* This procedure returns %TRUE if the specified item ID is a layer * This procedure returns %TRUE if the specified item ID is a layer
* mask. * mask.
* Note: in most use cases, you should not use this function. See *
* *Note*: in most use cases, you should not use this function. See
* [func.Item.id_is_layer] for a discussion on alternatives. * [func.Item.id_is_layer] for a discussion on alternatives.
* *
* Returns: TRUE if the item ID is a layer mask, FALSE otherwise. * Returns: TRUE if the item ID is a layer mask, FALSE otherwise.
@ -326,7 +333,8 @@ gimp_item_id_is_layer_mask (gint item_id)
* Returns whether the item ID is a path. * Returns whether the item ID is a path.
* *
* This procedure returns %TRUE if the specified item ID is a path. * This procedure returns %TRUE if the specified item ID is a path.
* Note: in most use cases, you should not use this function. See *
* *Note*: in most use cases, you should not use this function. See
* [func.Item.id_is_layer] for a discussion on alternatives. * [func.Item.id_is_layer] for a discussion on alternatives.
* *
* Returns: TRUE if the item ID is a path, FALSE otherwise. * Returns: TRUE if the item ID is a path, FALSE otherwise.
@ -365,7 +373,8 @@ gimp_item_id_is_path (gint item_id)
* *
* This procedure returns %TRUE if the specified item ID is a * This procedure returns %TRUE if the specified item ID is a
* selection. * selection.
* Note: in most use cases, you should not use this function. See *
* *Note*: in most use cases, you should not use this function. See
* [func.Item.id_is_layer] for a discussion on alternatives. * [func.Item.id_is_layer] for a discussion on alternatives.
* *
* Returns: TRUE if the item ID is a selection, FALSE otherwise. * Returns: TRUE if the item ID is a selection, FALSE otherwise.

18
libgimp/gimpresource_pdb.c
View file

@ -133,7 +133,8 @@ _gimp_resource_get_by_identifiers (const gchar *type_name,
* *
* This procedure checks if the given resource ID is valid and refers * This procedure checks if the given resource ID is valid and refers
* to an existing resource. * to an existing resource.
* Note: in most use cases, you should not use this function. If you *
* *Note*: in most use cases, you should not use this function. If you
* got a [class@Gimp.Resource] from the API, you should trust it is * got a [class@Gimp.Resource] from the API, you should trust it is
* valid. This function is mostly for internal usage. * valid. This function is mostly for internal usage.
* *
@ -397,13 +398,14 @@ gimp_resource_get_name (GimpResource *resource)
* the resource name, similar to what you would obtain calling * the resource name, similar to what you would obtain calling
* gimp_resource_get_name(). The second is an opaque identifier for the * gimp_resource_get_name(). The second is an opaque identifier for the
* collection this resource belongs to. * collection this resource belongs to.
* Note: as far as GIMP is concerned, a collection of resource usually *
* corresponds to a single file on disk (which may or may not contain * *Note*: as far as GIMP is concerned, a collection of resource
* several resources). Therefore the identifier may be derived from the * usually corresponds to a single file on disk (which may or may not
* local file path. Nevertheless you should not use this string as such * contain several resources). Therefore the identifier may be derived
* as this is not guaranteed to be always the case. You should consider * from the local file path. Nevertheless you should not use this
* it as an opaque identifier only to be used again through * string as such as this is not guaranteed to be always the case. You
* _gimp_resource_get_by_identifier(). * should consider it as an opaque identifier only to be used again
* through _gimp_resource_get_by_identifier().
* *
* Returns: Whether this is the identifier for internal data. * Returns: Whether this is the identifier for internal data.
* *

3
pdb/groups/display.pdb
View file

@ -23,7 +23,8 @@ sub display_id_is_valid {
This procedure checks if the given display ID is valid and refers to an This procedure checks if the given display ID is valid and refers to an
existing display. existing display.
Note: in most use cases, you should not use this function. If you got a
*Note*: in most use cases, you should not use this function. If you got a
[class@Gimp.Display] from the API, you should trust it is valid. This [class@Gimp.Display] from the API, you should trust it is valid. This
function is mostly for internal usage. function is mostly for internal usage.
HELP HELP

27
pdb/groups/item.pdb
View file

@ -23,7 +23,8 @@ sub item_id_is_valid {
This procedure checks if the given item ID is valid and refers to an This procedure checks if the given item ID is valid and refers to an
existing item. existing item.
Note: in most use cases, you should not use this function. If you got a
*Note*: in most use cases, you should not use this function. If you got a
[class@Gimp.Item] from the API, you should trust it is valid. This [class@Gimp.Item] from the API, you should trust it is valid. This
function is mostly for internal usage. function is mostly for internal usage.
HELP HELP
@ -58,7 +59,8 @@ sub item_id_is_drawable {
$help = <<HELP; $help = <<HELP;
This procedure returns %TRUE if the specified item ID is a drawable. This procedure returns %TRUE if the specified item ID is a drawable.
Note: in most use cases, you should not use this function. See
*Note*: in most use cases, you should not use this function. See
[func@Gimp.Item.id_is_layer] for a discussion on alternatives. [func@Gimp.Item.id_is_layer] for a discussion on alternatives.
HELP HELP
@ -93,7 +95,8 @@ sub item_id_is_layer {
$help = <<HELP; $help = <<HELP;
This procedure returns %TRUE if the specified item ID is a layer. This procedure returns %TRUE if the specified item ID is a layer.
Note: in most use cases, you should not use this function. If the goal
*Note*: in most use cases, you should not use this function. If the goal
is to verify the accurate type for a [class@Gimp.Item], you should is to verify the accurate type for a [class@Gimp.Item], you should
either use [method@Gimp.Item.is_layer] or the specific type-checking either use [method@Gimp.Item.is_layer] or the specific type-checking
methods for the used language. methods for the used language.
@ -151,7 +154,8 @@ sub item_id_is_text_layer {
$help = <<'HELP'; $help = <<'HELP';
This procedure returns %TRUE if the specified item ID is a text layer. This procedure returns %TRUE if the specified item ID is a text layer.
Note: in most use cases, you should not use this function. See
*Note*: in most use cases, you should not use this function. See
[func@Gimp.Item.id_is_layer] for a discussion on alternatives. [func@Gimp.Item.id_is_layer] for a discussion on alternatives.
HELP HELP
@ -186,7 +190,8 @@ sub item_id_is_group_layer {
$help = <<'HELP'; $help = <<'HELP';
This procedure returns %TRUE if the specified item ID is a group layer. This procedure returns %TRUE if the specified item ID is a group layer.
Note: in most use cases, you should not use this function. See
*Note*: in most use cases, you should not use this function. See
[func@Gimp.Item.id_is_layer] for a discussion on alternatives. [func@Gimp.Item.id_is_layer] for a discussion on alternatives.
HELP HELP
@ -219,7 +224,8 @@ sub item_id_is_channel {
$help = <<HELP; $help = <<HELP;
This procedure returns %TRUE if the specified item ID is a channel. This procedure returns %TRUE if the specified item ID is a channel.
Note: in most use cases, you should not use this function. See
*Note*: in most use cases, you should not use this function. See
[func@Gimp.Item.id_is_layer] for a discussion on alternatives. [func@Gimp.Item.id_is_layer] for a discussion on alternatives.
HELP HELP
@ -254,7 +260,8 @@ sub item_id_is_layer_mask {
$help = <<HELP; $help = <<HELP;
This procedure returns %TRUE if the specified item ID is a layer mask. This procedure returns %TRUE if the specified item ID is a layer mask.
Note: in most use cases, you should not use this function. See
*Note*: in most use cases, you should not use this function. See
[func@Gimp.Item.id_is_layer] for a discussion on alternatives. [func@Gimp.Item.id_is_layer] for a discussion on alternatives.
HELP HELP
@ -289,7 +296,8 @@ sub item_id_is_selection {
$help = <<HELP; $help = <<HELP;
This procedure returns %TRUE if the specified item ID is a selection. This procedure returns %TRUE if the specified item ID is a selection.
Note: in most use cases, you should not use this function. See
*Note*: in most use cases, you should not use this function. See
[func@Gimp.Item.id_is_layer] for a discussion on alternatives. [func@Gimp.Item.id_is_layer] for a discussion on alternatives.
HELP HELP
@ -324,7 +332,8 @@ sub item_id_is_path {
$help = <<HELP; $help = <<HELP;
This procedure returns %TRUE if the specified item ID is a path. This procedure returns %TRUE if the specified item ID is a path.
Note: in most use cases, you should not use this function. See
*Note*: in most use cases, you should not use this function. See
[func@Gimp.Item.id_is_layer] for a discussion on alternatives. [func@Gimp.Item.id_is_layer] for a discussion on alternatives.
HELP HELP

6
pdb/groups/resource.pdb
View file

@ -108,7 +108,8 @@ sub resource_id_is_valid {
This procedure checks if the given resource ID is valid and refers to an This procedure checks if the given resource ID is valid and refers to an
existing resource. existing resource.
Note: in most use cases, you should not use this function. If you got a
*Note*: in most use cases, you should not use this function. If you got a
[class@Gimp.Resource] from the API, you should trust it is valid. This [class@Gimp.Resource] from the API, you should trust it is valid. This
function is mostly for internal usage. function is mostly for internal usage.
HELP HELP
@ -322,7 +323,8 @@ This procedure returns 2 strings and a boolean. The first string is the resource
name, similar to what you would obtain calling gimp_resource_get_name(). The name, similar to what you would obtain calling gimp_resource_get_name(). The
second is an opaque identifier for the collection this resource belongs to. second is an opaque identifier for the collection this resource belongs to.
Note: as far as GIMP is concerned, a collection of resource usually corresponds
*Note*: as far as GIMP is concerned, a collection of resource usually corresponds
to a single file on disk (which may or may not contain several resources). to a single file on disk (which may or may not contain several resources).
Therefore the identifier may be derived from the local file path. Nevertheless Therefore the identifier may be derived from the local file path. Nevertheless
you should not use this string as such as this is not guaranteed to be always you should not use this string as such as this is not guaranteed to be always