diff --git a/app/pdb/display-cmds.c b/app/pdb/display-cmds.c index c98954e34e..1308c5d390 100644 --- a/app/pdb/display-cmds.c +++ b/app/pdb/display-cmds.c @@ -246,7 +246,8 @@ register_display_procs (GimpPDB *pdb) gimp_procedure_set_static_help (procedure, "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" - "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); gimp_procedure_set_static_attribution (procedure, "Sven Neumann ", diff --git a/app/pdb/item-cmds.c b/app/pdb/item-cmds.c index 7c3e209fcf..8bd834dbed 100644 --- a/app/pdb/item-cmds.c +++ b/app/pdb/item-cmds.c @@ -1070,7 +1070,8 @@ register_item_procs (GimpPDB *pdb) gimp_procedure_set_static_help (procedure, "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" - "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); gimp_procedure_set_static_attribution (procedure, "Sven Neumann ", @@ -1100,7 +1101,8 @@ register_item_procs (GimpPDB *pdb) gimp_procedure_set_static_help (procedure, "Returns whether the item ID is a drawable.", "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); gimp_procedure_set_static_attribution (procedure, "Spencer Kimball & Peter Mattis", @@ -1130,7 +1132,8 @@ register_item_procs (GimpPDB *pdb) gimp_procedure_set_static_help (procedure, "Returns whether the item ID is a layer.", "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" "```C\n" "if (GIMP_IS_LAYER (item))\n" @@ -1170,7 +1173,8 @@ register_item_procs (GimpPDB *pdb) gimp_procedure_set_static_help (procedure, "Returns whether the item ID is a text layer.", "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); gimp_procedure_set_static_attribution (procedure, "Michael Natterer ", @@ -1200,7 +1204,8 @@ register_item_procs (GimpPDB *pdb) gimp_procedure_set_static_help (procedure, "Returns whether the item ID is a group layer.", "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); gimp_procedure_set_static_attribution (procedure, "Jehan", @@ -1230,7 +1235,8 @@ register_item_procs (GimpPDB *pdb) gimp_procedure_set_static_help (procedure, "Returns whether the item ID is a channel.", "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); gimp_procedure_set_static_attribution (procedure, "Spencer Kimball & Peter Mattis", @@ -1260,7 +1266,8 @@ register_item_procs (GimpPDB *pdb) gimp_procedure_set_static_help (procedure, "Returns whether the item ID is a layer mask.", "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); gimp_procedure_set_static_attribution (procedure, "Spencer Kimball & Peter Mattis", @@ -1290,7 +1297,8 @@ register_item_procs (GimpPDB *pdb) gimp_procedure_set_static_help (procedure, "Returns whether the item ID is a path.", "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); gimp_procedure_set_static_attribution (procedure, "Spencer Kimball & Peter Mattis", @@ -1320,7 +1328,8 @@ register_item_procs (GimpPDB *pdb) gimp_procedure_set_static_help (procedure, "Returns whether the item ID is a selection.", "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); gimp_procedure_set_static_attribution (procedure, "Spencer Kimball & Peter Mattis", diff --git a/app/pdb/resource-cmds.c b/app/pdb/resource-cmds.c index 3e8dff96bf..91ca0ee4f5 100644 --- a/app/pdb/resource-cmds.c +++ b/app/pdb/resource-cmds.c @@ -606,7 +606,8 @@ register_resource_procs (GimpPDB *pdb) gimp_procedure_set_static_help (procedure, "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" - "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); gimp_procedure_set_static_attribution (procedure, "Michael Natterer ", @@ -811,7 +812,8 @@ register_resource_procs (GimpPDB *pdb) gimp_procedure_set_static_help (procedure, "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" - "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); gimp_procedure_set_static_attribution (procedure, "Jehan", diff --git a/libgimp/gimpdisplay_pdb.c b/libgimp/gimpdisplay_pdb.c index 399fc10988..a9dee8831d 100644 --- a/libgimp/gimpdisplay_pdb.c +++ b/libgimp/gimpdisplay_pdb.c @@ -44,7 +44,8 @@ * * This procedure checks if the given display ID is valid and refers to * 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 * valid. This function is mostly for internal usage. * diff --git a/libgimp/gimpitem_pdb.c b/libgimp/gimpitem_pdb.c index baa51337d0..d23dc2c0da 100644 --- a/libgimp/gimpitem_pdb.c +++ b/libgimp/gimpitem_pdb.c @@ -44,7 +44,8 @@ * * This procedure checks if the given item ID is valid and refers to an * 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. * 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. * * 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. * * 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. * * 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 * either use [method.Item.is_layer] or the specific type-checking * 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 * 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. * * 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 * 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. * * 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. * * 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. * * 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 * 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. * * 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. * * 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. * * 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 * 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. * * Returns: TRUE if the item ID is a selection, FALSE otherwise. diff --git a/libgimp/gimpresource_pdb.c b/libgimp/gimpresource_pdb.c index c72690c7c4..6420ab8d03 100644 --- a/libgimp/gimpresource_pdb.c +++ b/libgimp/gimpresource_pdb.c @@ -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 * 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 * 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 * gimp_resource_get_name(). The 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 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(). + * + * *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(). * * Returns: Whether this is the identifier for internal data. * diff --git a/pdb/groups/display.pdb b/pdb/groups/display.pdb index 55e01e0f68..c4f7d6ca5b 100644 --- a/pdb/groups/display.pdb +++ b/pdb/groups/display.pdb @@ -23,7 +23,8 @@ sub display_id_is_valid { This procedure checks if the given display ID is valid and refers to an 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 function is mostly for internal usage. HELP diff --git a/pdb/groups/item.pdb b/pdb/groups/item.pdb index 6bb7f13237..3657f23c98 100644 --- a/pdb/groups/item.pdb +++ b/pdb/groups/item.pdb @@ -23,7 +23,8 @@ sub item_id_is_valid { This procedure checks if the given item ID is valid and refers to an 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 function is mostly for internal usage. HELP @@ -58,7 +59,8 @@ sub item_id_is_drawable { $help = <