dnrops
/
gimp
mirror of https://github.com/GNOME/gimp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

app, libgimp, pdb: fixing broken GIR links. 

The 'help' field needs to be single-quoted so that @-values do not look
like perl variables, hence breaking GIR annotations.

Fixing:

> Possible unintended interpolation of @Gimp in string at /home/jehan/dev/src/gimp/pdb/groups/item.pdb line 64.
This commit is contained in:
Jehan 2024-08-27 00:24:26 +02:00
parent d1c8e5efb9
commit 0fe66771da
3 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
app/pdb/item-cmds.c
View File

@ -1102,7 +1102,7 @@ register_item_procs (GimpPDB *pdb)
"Returns whether the item ID is a drawable.",
"This procedure returns %TRUE if the specified item ID is a drawable.\n"
"\n"
"*Note*: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.",
"*Note*: in most use cases, you should not use this function. See [func@Gimp.Item.id_is_layer] for a discussion on alternatives.",
NULL);
gimp_procedure_set_static_attribution (procedure,
"Spencer Kimball & Peter Mattis",
@ -1133,7 +1133,7 @@ register_item_procs (GimpPDB *pdb)
"Returns whether the item ID is a layer.",
"This procedure returns %TRUE if the specified item ID is a layer.\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"
"*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 either use [method@Gimp.Item.is_layer] or the specific type-checking methods for the used language.\n"
"For instance, in C:\n"
"```C\n"
"if (GIMP_IS_LAYER (item))\n"
@ -1236,7 +1236,7 @@ register_item_procs (GimpPDB *pdb)
"Returns whether the item ID is a channel.",
"This procedure returns %TRUE if the specified item ID is a channel.\n"
"\n"
"*Note*: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.",
"*Note*: in most use cases, you should not use this function. See [func@Gimp.Item.id_is_layer] for a discussion on alternatives.",
NULL);
gimp_procedure_set_static_attribution (procedure,
"Spencer Kimball & Peter Mattis",
@ -1267,7 +1267,7 @@ register_item_procs (GimpPDB *pdb)
"Returns whether the item ID is a layer mask.",
"This procedure returns %TRUE if the specified item ID is a layer mask.\n"
"\n"
"*Note*: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.",
"*Note*: in most use cases, you should not use this function. See [func@Gimp.Item.id_is_layer] for a discussion on alternatives.",
NULL);
gimp_procedure_set_static_attribution (procedure,
"Spencer Kimball & Peter Mattis",
@ -1298,7 +1298,7 @@ register_item_procs (GimpPDB *pdb)
"Returns whether the item ID is a path.",
"This procedure returns %TRUE if the specified item ID is a path.\n"
"\n"
"*Note*: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.",
"*Note*: in most use cases, you should not use this function. See [func@Gimp.Item.id_is_layer] for a discussion on alternatives.",
NULL);
gimp_procedure_set_static_attribution (procedure,
"Spencer Kimball & Peter Mattis",
@ -1329,7 +1329,7 @@ register_item_procs (GimpPDB *pdb)
"Returns whether the item ID is a selection.",
"This procedure returns %TRUE if the specified item ID is a selection.\n"
"\n"
"*Note*: in most use cases, you should not use this function. See [func.Item.id_is_layer] for a discussion on alternatives.",
"*Note*: in most use cases, you should not use this function. See [func@Gimp.Item.id_is_layer] for a discussion on alternatives.",
NULL);
gimp_procedure_set_static_attribution (procedure,
"Spencer Kimball & Peter Mattis",

16
libgimp/gimpitem_pdb.c
View File

@ -86,7 +86,7 @@ gimp_item_id_is_valid (gint item_id)
* This procedure returns %TRUE if the specified item ID is a drawable.
*
* *Note*: in most use cases, you should not use this function. See
* [func.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 ID is a drawable, FALSE otherwise.
*
@ -125,9 +125,9 @@ gimp_item_id_is_drawable (gint item_id)
* 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 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.
* goal 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 methods for the used language.
* For instance, in C:
* ```C
* if (GIMP_IS_LAYER (item))
@ -256,7 +256,7 @@ gimp_item_id_is_group_layer (gint item_id)
* This procedure returns %TRUE if the specified item ID is a channel.
*
* *Note*: in most use cases, you should not use this function. See
* [func.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 ID is a channel, FALSE otherwise.
*
@ -296,7 +296,7 @@ gimp_item_id_is_channel (gint item_id)
* mask.
*
* *Note*: in most use cases, you should not use this function. See
* [func.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 ID is a layer mask, FALSE otherwise.
*
@ -335,7 +335,7 @@ gimp_item_id_is_layer_mask (gint item_id)
* This procedure returns %TRUE if the specified item ID is a path.
*
* *Note*: in most use cases, you should not use this function. See
* [func.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 ID is a path, FALSE otherwise.
*
@ -375,7 +375,7 @@ gimp_item_id_is_path (gint item_id)
* selection.
*
* *Note*: in most use cases, you should not use this function. See
* [func.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 ID is a selection, FALSE otherwise.
*

22
pdb/groups/item.pdb
View File

@ -56,7 +56,7 @@ CODE
sub item_id_is_drawable {
$blurb = 'Returns whether the item ID is a drawable.';
$help = <<HELP;
$help = <<'HELP';
This procedure returns %TRUE if the specified item ID is a drawable.
@ -92,7 +92,7 @@ CODE
sub item_id_is_layer {
$blurb = 'Returns whether the item ID is a layer.';
$help = <<HELP;
$help = <<'HELP';
This procedure returns %TRUE if the specified item ID is a layer.
@ -221,7 +221,7 @@ CODE
sub item_id_is_channel {
$blurb = 'Returns whether the item ID is a channel.';
$help = <<HELP;
$help = <<'HELP';
This procedure returns %TRUE if the specified item ID is a channel.
@ -257,7 +257,7 @@ CODE
sub item_id_is_layer_mask {
$blurb = 'Returns whether the item ID is a layer mask.';
$help = <<HELP;
$help = <<'HELP';
This procedure returns %TRUE if the specified item ID is a layer mask.
@ -293,7 +293,7 @@ CODE
sub item_id_is_selection {
$blurb = 'Returns whether the item ID is a selection.';
$help = <<HELP;
$help = <<'HELP';
This procedure returns %TRUE if the specified item ID is a selection.
@ -329,7 +329,7 @@ CODE
sub item_id_is_path {
$blurb = 'Returns whether the item ID is a path.';
$help = <<HELP;
$help = <<'HELP';
This procedure returns %TRUE if the specified item ID is a path.
@ -426,7 +426,7 @@ CODE
sub item_is_group {
$blurb = 'Returns whether the item is a group item.';
$help = <<HELP;
$help = <<'HELP';
This procedure returns %TRUE if the specified item is a group item which
can have children.
HELP
@ -455,7 +455,7 @@ CODE
sub item_get_parent {
$blurb = "Returns the item's parent item.";
$help = <<HELP;
$help = <<'HELP';
This procedure returns the item's parent item, if any.
HELP
@ -483,7 +483,7 @@ CODE
sub item_get_children {
$blurb = "Returns the item's list of children.";
$help = <<HELP;
$help = <<'HELP';
This procedure returns the list of items which are children of the specified
item. The order is topmost to bottommost.
HELP
@ -537,7 +537,7 @@ CODE
sub item_get_expanded {
$blurb = 'Returns whether the item is expanded.';
$help = <<HELP;
$help = <<'HELP';
This procedure returns %TRUE if the specified item is expanded.
HELP
@ -565,7 +565,7 @@ CODE
sub item_set_expanded {
$blurb = 'Sets the expanded state of the item.';
$help = <<HELP;
$help = <<'HELP';
This procedure expands or collapses the item.
HELP