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

libgimp: fix various GIR build warnings breaking HTML reference generation.

Browse source 
- a few inconsistent parameter naming;
- broken links to other symbols.
This commit is contained in:
Jehan 2023-10-02 00:07:46 +02:00
parent 8694f67918
commit 278f78fee6
8 changed files with 48 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
libgimp/gimpbrush.c
View file

@ -88,10 +88,10 @@ gimp_brush_finalize (GObject *object)
* When the brush is parametric or a raster mask, only the mask (as returned by
* [method@Gimp.Brush.get_mask]) will be set. The returned buffer will be NULL.
*
* Make sure you called [func@Gegl.Init] before calling any function using
* Make sure you called [func@Gegl.init] before calling any function using
* `GEGL`.
*
* Returns: (transfer full): a [Gegl@Buffer] of %NULL if the brush is parametric
* Returns: (transfer full): a [class@Gegl.Buffer] of %NULL if the brush is parametric
* or mask only.
*/
GeglBuffer *
@ -128,10 +128,10 @@ gimp_brush_get_buffer (GimpBrush *brush,
* If @max_width or @max_height are %NULL, the buffer is returned in the brush's
* native size.
*
* Make sure you called [func@Gegl.Init] before calling any function using
* Make sure you called [func@Gegl.init] before calling any function using
* `GEGL`.
*
* Returns: (transfer full): a [Gegl@Buffer] representing the @brush mask.
* Returns: (transfer full): a [class@Gegl.Buffer] representing the @brush mask.
*/
GeglBuffer *
gimp_brush_get_mask (GimpBrush *brush,

2
libgimp/gimpbrushchooser.c
View file

@ -43,7 +43,7 @@
* A button which pops up a brush selection dialog.
*
* Note that this widget draws itself using `GEGL` code. You **must** call
* [func@Gegl.Init] first to be able to use this chooser.
* [func@Gegl.init] first to be able to use this chooser.
**/
#define CELL_SIZE 40

2
libgimp/gimpdrawablechooser.c
View file

@ -355,7 +355,7 @@ gimp_drawable_chooser_get_property (GObject *object,
*
* When @drawable is %NULL, initial choice is from context.
*
* Returns: A [class@Gimp.DrawableChooser.
* Returns: A [class@GimpUi.DrawableChooser.
*
* Since: 3.0
*/

4
libgimp/gimppattern.c
View file

@ -81,10 +81,10 @@ gimp_pattern_finalize (GObject *object)
* If @max_width or @max_height are %NULL, the buffer is returned in the pattern's
* native size.
*
* Make sure you called [func@Gegl.Init] before calling any function using
* Make sure you called [func@Gegl.init] before calling any function using
* `GEGL`.
*
* Returns: (transfer full): a [Gegl@Buffer].
* Returns: (transfer full): a [class@Gegl.Buffer].
*/
GeglBuffer *
gimp_pattern_get_buffer (GimpPattern *pattern,

2
libgimp/gimppatternchooser.c
View file

@ -43,7 +43,7 @@
* A button which pops up a pattern selection dialog.
*
* Note that this widget draws itself using `GEGL` code. You **must** call
* [func@Gegl.Init] first to be able to use this chooser.
* [func@Gegl.init] first to be able to use this chooser.
**/
#define CELL_SIZE 40

36
libgimp/gimppropwidgets.c
View file

@ -45,11 +45,11 @@ static gchar * gimp_utils_make_canonical_menu_label (const gchar
* gimp_prop_brush_chooser_new:
* @config: Object to which property is attached.
* @property_name: Name of a [class@Gimp.Brush] property.
* @title: (nullable): title for the poppable dialog.
* @chooser_title: (nullable): title for the poppable dialog.
*
* Creates a [class@Gimp.BrushSelectButton] controlled by the specified property.
* Creates a [class@Gimp.Brush.Chooser] controlled by the specified property.
*
* Returns: (transfer full): A new [class@Gimp.BrushSelectButton].
* Returns: (transfer full): A new [class@GimpUi.BrushChooser].
*
* Since: 3.0
*/
@ -66,11 +66,11 @@ gimp_prop_brush_chooser_new (GObject *config,
* gimp_prop_font_chooser_new:
* @config: Object to which property is attached.
* @property_name: Name of a [class@Gimp.Font] property.
* @title: (nullable): title for the poppable dialog.
* @chooser_title: (nullable): title for the poppable dialog.
*
* Creates a [class@Gimp.FontSelectButton] controlled by the specified property.
* Creates a [class@GimpUi.FontChooser] controlled by the specified property.
*
* Returns: (transfer full): A new [class@Gimp.FontSelectButton].
* Returns: (transfer full): A new [class@GimpUi.FontChooser].
*
* Since: 3.0
*/
@ -87,11 +87,11 @@ gimp_prop_font_chooser_new (GObject *config,
* gimp_prop_gradient_chooser_new:
* @config: Object to which property is attached.
* @property_name: Name of a [class@Gimp.Gradient] property.
* @title: (nullable): title for the poppable dialog.
* @chooser_title: (nullable): title for the poppable dialog.
*
* Creates a [class@Gimp.GradientSelectButton] controlled by the specified property.
* Creates a [class@GimpUi.GradientChooser] controlled by the specified property.
*
* Returns: (transfer full): A new [class@Gimp.GradientSelectButton].
* Returns: (transfer full): A new [class@GimpUi.GradientChooser].
*
* Since: 3.0
*/
@ -108,11 +108,11 @@ gimp_prop_gradient_chooser_new (GObject *config,
* gimp_prop_palette_chooser_new:
* @config: Object to which property is attached.
* @property_name: Name of a [class@Gimp.Palette] property.
* @title: (nullable): title for the poppable dialog.
* @chooser_title: (nullable): title for the poppable dialog.
*
* Creates a [class@Gimp.PaletteSelectButton] controlled by the specified property.
* Creates a [class@GimpUi.PaletteChooser] controlled by the specified property.
*
* Returns: (transfer full): A new [class@Gimp.PaletteSelectButton].
* Returns: (transfer full): A new [class@GimpUi.PaletteChooser].
*
* Since: 3.0
*/
@ -129,11 +129,11 @@ gimp_prop_palette_chooser_new (GObject *config,
* gimp_prop_pattern_chooser_new:
* @config: Object to which property is attached.
* @property_name: Name of a [class@Gimp.Pattern] property.
* @title: (nullable): title for the poppable dialog.
* @chooser_title: (nullable): title for the poppable dialog.
*
* Creates a [class@Gimp.PatternSelectButton] controlled by the specified property.
* Creates a [class@GimpUi.PatternChooser] controlled by the specified property.
*
* Returns: (transfer full): A new [class@Gimp.PatternSelectButton].
* Returns: (transfer full): A new [class@GimpUi.PatternChooser].
*
* Since: 3.0
*/
@ -150,11 +150,11 @@ gimp_prop_pattern_chooser_new (GObject *config,
* gimp_prop_drawable_chooser_new:
* @config: Object to which property is attached.
* @property_name: Name of a [class@Gimp.Drawable] property.
* @title: (nullable): title for the poppable dialog.
* @chooser_title: (nullable): title for the poppable dialog.
*
* Creates a [class@Gimp.DrawableChooser] controlled by the specified property.
* Creates a [class@GimpUi.DrawableChooser] controlled by the specified property.
*
* Returns: (transfer full): A new [class@Gimp.DrawableChooser].
* Returns: (transfer full): A new [class@GimpUi.DrawableChooser].
*
* Since: 3.0
*/

40
libgimp/gimpresourcechooser.c
View file

@ -290,7 +290,7 @@ gimp_resource_chooser_finalize (GObject *object)
/**
* gimp_resource_chooser_set_drag_target:
* @self: A [class@ResourceChooser]
* @chooser: A [class@ResourceChooser]
* @drag_region_widget: An interior widget to be a droppable region
* and emit "drag-data-received" signal
* @drag_target: The drag target to accept
@ -304,11 +304,11 @@ gimp_resource_chooser_finalize (GObject *object)
* Since: 3.0
**/
void
gimp_resource_chooser_set_drag_target (GimpResourceChooser *self,
gimp_resource_chooser_set_drag_target (GimpResourceChooser *chooser,
GtkWidget *drag_region_widget,
const GtkTargetEntry *drag_target)
{
g_return_if_fail (GIMP_IS_RESOURCE_CHOOSER (self));
g_return_if_fail (GIMP_IS_RESOURCE_CHOOSER (chooser));
g_return_if_fail (drag_target != NULL);
g_return_if_fail (drag_region_widget != NULL);
@ -319,16 +319,16 @@ gimp_resource_chooser_set_drag_target (GimpResourceChooser *self,
drag_target, 1, /* Pass array of size 1 */
GDK_ACTION_COPY);
/* connect drag_region_widget's drag_received signal to self's callback. */
/* connect drag_region_widget's drag_received signal to chooser's callback. */
g_signal_connect_swapped (drag_region_widget, "drag-data-received",
G_CALLBACK (gimp_resource_select_drag_data_received),
self);
chooser);
}
/**
* gimp_resource_chooser_set_clickable:
* @self: A [class@ResourceChooser]
* @widget: An interior widget that emits "clicked" signal
* @chooser: A [class@ResourceChooser]
* @widget: An interior widget that emits "clicked" signal
*
* Called by a subclass init to specialize the instance.
*
@ -339,22 +339,22 @@ gimp_resource_chooser_set_drag_target (GimpResourceChooser *self,
* Since: 3.0
**/
void
gimp_resource_chooser_set_clickable (GimpResourceChooser *self,
gimp_resource_chooser_set_clickable (GimpResourceChooser *chooser,
GtkWidget *widget)
{
g_return_if_fail (GIMP_IS_RESOURCE_CHOOSER (self));
g_return_if_fail (GIMP_IS_RESOURCE_CHOOSER (chooser));
g_return_if_fail (widget != NULL);
g_return_if_fail (GTK_IS_WIDGET (widget));
/* Require the widget have a signal "clicked", usually a button. */
g_signal_connect_swapped (widget, "clicked",
G_CALLBACK (gimp_resource_chooser_clicked),
self);
chooser);
}
/**
* gimp_resource_chooser_get_resource:
* @self: A #GimpResourceChooser
* @chooser: A #GimpResourceChooser
*
* Gets the currently selected resource.
*
@ -363,20 +363,20 @@ gimp_resource_chooser_set_clickable (GimpResourceChooser *self,
* Since: 3.0
*/
GimpResource *
gimp_resource_chooser_get_resource (GimpResourceChooser *self)
gimp_resource_chooser_get_resource (GimpResourceChooser *chooser)
{
GimpResourceChooserPrivate *priv;
g_return_val_if_fail (GIMP_IS_RESOURCE_CHOOSER (self), NULL);
g_return_val_if_fail (GIMP_IS_RESOURCE_CHOOSER (chooser), NULL);
priv = gimp_resource_chooser_get_instance_private (self);
priv = gimp_resource_chooser_get_instance_private (chooser);
return priv->resource;
}
/**
* gimp_resource_chooser_set_resource:
* @self: A #GimpResourceChooser
* @chooser: A #GimpResourceChooser
* @resource: Resource to set.
*
* Sets the currently selected resource.
@ -385,15 +385,15 @@ gimp_resource_chooser_get_resource (GimpResourceChooser *self)
* Since: 3.0
*/
void
gimp_resource_chooser_set_resource (GimpResourceChooser *self,
gimp_resource_chooser_set_resource (GimpResourceChooser *chooser,
GimpResource *resource)
{
GimpResourceChooserPrivate *priv;
g_return_if_fail (GIMP_IS_RESOURCE_CHOOSER (self));
g_return_if_fail (GIMP_IS_RESOURCE_CHOOSER (chooser));
g_return_if_fail (resource != NULL);
priv = gimp_resource_chooser_get_instance_private (self);
priv = gimp_resource_chooser_get_instance_private (chooser);
if (priv->callback)
{
@ -402,12 +402,12 @@ gimp_resource_chooser_set_resource (GimpResourceChooser *self,
* (since all views of the resource must be consistent.)
* That will call back, which will change our own view of the resource.
*/
gimp_resource_chooser_set_remote_dialog (self, resource);
gimp_resource_chooser_set_remote_dialog (chooser, resource);
}
else
{
/* Call our own setter. */
gimp_resource_chooser_callback (resource, FALSE, self);
gimp_resource_chooser_callback (resource, FALSE, chooser);
}
}

2
libgimpwidgets/gimppreviewarea.c
View file

@ -1879,7 +1879,7 @@ gimp_preview_area_fill (GimpPreviewArea *area,
* gimp_preview_area_reset:
* @area: a #GimpPreviewArea widget.
*
* Reset any previous drawing done through [class@Gimp.PreviewArea] functions.
* Reset any previous drawing done through [class@GimpUi.PreviewArea] functions.
*
* Since: 3.0
**/