GNOME.org
 

[gegl] clean up g-ir-scanner warnings

commit f603efd04bb06033f949fa4d04e325daa87aba95
Author: Øyvind Kolås <pippin gimp org>
Date:   Fri Jul 11 17:26:05 2014 +0200

    clean up g-ir-scanner warnings
    
    Marking some functions that should be skipped, and updating rename-to syntax.

 gegl/buffer/gegl-buffer.h          |   47 ++++++++++++++++++++++++++++++++++-
 gegl/buffer/gegl-sampler-nearest.c |    2 +
 gegl/buffer/gegl-tile-source.h     |    4 +++
 gegl/gegl-introspection-support.h  |   20 ++++-----------
 gegl/gegl-operations-util.h        |    9 +++++++
 5 files changed, 65 insertions(+), 17 deletions(-)
---
diff --git a/gegl/buffer/gegl-buffer.h b/gegl/buffer/gegl-buffer.h
index 838124c..37c9560 100644
--- a/gegl/buffer/gegl-buffer.h
+++ b/gegl/buffer/gegl-buffer.h
@@ -387,7 +387,7 @@ GeglBuffer *    gegl_buffer_dup               (GeglBuffer       *buffer);
 
 
 /**
- * gegl_buffer_sample: (skip)
+ * gegl_buffer_sample_at_level: (skip)
  * @buffer: the GeglBuffer to sample from
  * @x: x coordinate to sample in buffer coordinates
  * @y: y coordinate to sample in buffer coordinates
@@ -395,6 +395,7 @@ GeglBuffer *    gegl_buffer_dup               (GeglBuffer       *buffer);
  * gegl_sampler_compute_scale the same.
  * @dest: buffer capable of storing one pixel in @format.
  * @format: the format to store the sampled color in.
+ * @level: mipmap level to sample from (@x and @y are level 0 coordinates)
  * @sampler_type: the sampler type to use,
  * to be ported from working code. Valid values: GEGL_SAMPLER_NEAREST,
  * GEGL_SAMPLER_LINEAR, GEGL_SAMPLER_CUBIC, GEGL_SAMPLER_NOHALO and
@@ -420,6 +421,29 @@ void              gegl_buffer_sample_at_level (GeglBuffer       *buffer,
                                                GeglSamplerType   sampler_type,
                                                GeglAbyssPolicy   repeat_mode);
 
+/**
+ * gegl_buffer_sample: (skip)
+ * @buffer: the GeglBuffer to sample from
+ * @x: x coordinate to sample in buffer coordinates
+ * @y: y coordinate to sample in buffer coordinates
+ * @scale: a matrix that indicates scaling factors, see
+ * gegl_sampler_compute_scale the same.
+ * @dest: buffer capable of storing one pixel in @format.
+ * @format: the format to store the sampled color in.
+ * @sampler_type: the sampler type to use,
+ * to be ported from working code. Valid values: GEGL_SAMPLER_NEAREST,
+ * GEGL_SAMPLER_LINEAR, GEGL_SAMPLER_CUBIC, GEGL_SAMPLER_NOHALO and
+ * GEGL_SAMPLER_LOHALO
+ * @repeat_mode: how requests outside the buffer extent are handled.
+ * Valid values: GEGL_ABYSS_NONE (abyss pixels are zeroed), GEGL_ABYSS_WHITE
+ * (abyss pixels are white), GEGL_ABYSS_BLACK (abyss pixels are black),
+ * GEGL_ABYSS_CLAMP (coordinates are clamped to the abyss rectangle),
+ * GEGL_ABYSS_LOOP (buffer contents are tiled if outside of the abyss rectangle).
+ *
+ * Query interpolate pixel values at a given coordinate using a specified form
+ * of interpolation. The samplers used cache for a small neighbourhood of the
+ * buffer for more efficient access.
+ */
 void              gegl_buffer_sample          (GeglBuffer       *buffer,
                                                gdouble           x,
                                                gdouble           y,
@@ -449,6 +473,9 @@ typedef void (*GeglSamplerGetFun)  (GeglSampler     *self,
                                     void            *output,
                                     GeglAbyssPolicy  repeat_mode);
 
+/**
+ * gegl_sampler_get_fun: (skip)
+ */
 GeglSamplerGetFun gegl_sampler_get_fun (GeglSampler *sampler);
 
 
@@ -471,6 +498,22 @@ GeglSampler *    gegl_buffer_sampler_new      (GeglBuffer       *buffer,
                                                const Babl       *format,
                                                GeglSamplerType   sampler_type);
 
+/**
+ * gegl_buffer_sampler_new_at_level: (skip)
+ * @buffer: buffer to create a new sampler for
+ * @format: format we want data back in
+ * @sampler_type: the sampler type to use,
+ * @level: the mipmap level to create a sampler for
+ * to be ported from working code. Valid values: GEGL_SAMPLER_NEAREST,
+ * GEGL_SAMPLER_LINEAR, GEGL_SAMPLER_CUBIC, GEGL_SAMPLER_NOHALO and
+ * GEGL_SAMPLER_LOHALO
+ *
+ * Create a new sampler, when you are done with the sampler, g_object_unref
+ * it.
+ *
+ * Samplers only hold weak references to buffers, so if its buffer is freed
+ * the sampler will become invalid.
+ */
 GeglSampler *    gegl_buffer_sampler_new_at_level (GeglBuffer       *buffer,
                                                const Babl       *format,
                                                GeglSamplerType   sampler_type,
@@ -622,7 +665,7 @@ const GeglRectangle * gegl_buffer_get_abyss   (GeglBuffer           *buffer);
  * gegl_buffer_signal_connect:
  * @buffer: a GeglBuffer
  * @detailed_signal: only "changed" expected for now
- * @c_handler: c function callback
+ * @c_handler: (scope async) : c function callback
  * @data: user data:
  *
  * This function should be used instead of g_signal_connect when connecting to
diff --git a/gegl/buffer/gegl-sampler-nearest.c b/gegl/buffer/gegl-sampler-nearest.c
index 2b4c5fc..956d78d 100644
--- a/gegl/buffer/gegl-sampler-nearest.c
+++ b/gegl/buffer/gegl-sampler-nearest.c
@@ -170,6 +170,7 @@ gegl_sampler_get_pixel (GeglSampler    *sampler,
   gegl_buffer_unlock (sampler->buffer);
 }
 
+#if 0
 static void
 gegl_sampler_nearest_get_same_format  (      GeglSampler*    restrict  sampler,
                                        const gdouble                   absolute_x,
@@ -181,6 +182,7 @@ gegl_sampler_nearest_get_same_format  (      GeglSampler*    restrict  sampler,
   GeglRectangle rectangle = {floorf(absolute_x), floorf(absolute_y), 1, 1};
   gegl_buffer_get (sampler->buffer, &rectangle, 1.0, sampler->format, output, GEGL_AUTO_ROWSTRIDE, 
repeat_mode);
 }
+#endif
 
 static void
 gegl_sampler_nearest_get_threaded (      GeglSampler*    restrict  sampler,
diff --git a/gegl/buffer/gegl-tile-source.h b/gegl/buffer/gegl-tile-source.h
index ba63a38..cc78fd6 100644
--- a/gegl/buffer/gegl-tile-source.h
+++ b/gegl/buffer/gegl-tile-source.h
@@ -101,6 +101,10 @@ gegl_tile_source_get_tile (GeglTileSource *source,
 }
 
 
+/**
+ * gegl_buffer_get_tile: (skip)
+ */
+
 GeglTile *
 gegl_buffer_get_tile (GeglBuffer *buffer,
                       gint        x,
diff --git a/gegl/gegl-introspection-support.h b/gegl/gegl-introspection-support.h
index 18a5369..324a288 100644
--- a/gegl/gegl-introspection-support.h
+++ b/gegl/gegl-introspection-support.h
@@ -78,26 +78,22 @@ void
 gegl_color_set_components (GeglColor *color, GValue *format, gdouble *components, gint components_length);
 
  /**
- * gegl_node_introspectable_get_bounding_box:
+ * gegl_node_introspectable_get_bounding_box: (rename-to gegl_node_get_bounding_box)
  * @node: a #GeglNode
  *
  * Returns the position and dimensions of a rectangle spanning the area
  * defined by a node.
  *
- * Rename to: gegl_node_get_bounding_box
- *
  * Return value: (transfer full): pointer a #GeglRectangle
  */
 GeglRectangle *
 gegl_node_introspectable_get_bounding_box (GeglNode *node);
 
 /**
- * gegl_node_introspectable_get_property:
+ * gegl_node_introspectable_get_property: (rename-to gegl_node_get_property)
  * @node: the node to get a property from
  * @property_name: the name of the property to get
  *
- * Rename to: gegl_node_get_property
- *
  * Return value: (transfer full): pointer to a GValue containing the value of the property
  */
 
@@ -105,7 +101,7 @@ GValue * gegl_node_introspectable_get_property (GeglNode    *node,
                                                 const gchar *property_name);
 
 /**
- * gegl_buffer_introspectable_new:
+ * gegl_buffer_introspectable_new: (rename-to gegl_buffer_new)
  * @format_name: The Babl format name for this buffer, e.g. "RGBA float"
  * @x: x origin of the buffer's extent
  * @y: y origin of the buffer's extent
@@ -113,8 +109,6 @@ GValue * gegl_node_introspectable_get_property (GeglNode    *node,
  * @height: height of the buffer's extent
  *
  * Create a new GeglBuffer with the given format and dimensions.
- *
- * Rename to: gegl_buffer_new
  */
 GeglBuffer *    gegl_buffer_introspectable_new (const char *format_name,
                                                 gint        x,
@@ -123,7 +117,7 @@ GeglBuffer *    gegl_buffer_introspectable_new (const char *format_name,
                                                 gint        height);
 
 /**
- * gegl_buffer_introspectable_get:
+ * gegl_buffer_introspectable_get: (rename-to gegl_buffer_get)
  * @buffer: the buffer to retrieve data from.
  * @rect: the coordinates we want to retrieve data from.
  * @scale: sampling scale, 1.0 = pixel for pixel 2.0 = magnify, 0.5 scale down.
@@ -137,8 +131,6 @@ GeglBuffer *    gegl_buffer_introspectable_new (const char *format_name,
  *
  * Fetch a rectangular linear buffer of pixel data from the GeglBuffer.
  *
- * Rename to: gegl_buffer_get
- *
  * Return value: (transfer full) (array length=data_length): A copy of the requested data
  */
 guchar *       gegl_buffer_introspectable_get (GeglBuffer          *buffer,
@@ -150,7 +142,7 @@ guchar *       gegl_buffer_introspectable_get (GeglBuffer          *buffer,
 
 
 /**
- * gegl_buffer_introspectable_set:
+ * gegl_buffer_introspectable_set: (rename-to gegl_buffer_set)
  * @buffer: the buffer to modify.
  * @rect: the rectangle to write.
  * @format_name: the format of the input data.
@@ -158,8 +150,6 @@ guchar *       gegl_buffer_introspectable_get (GeglBuffer          *buffer,
  * @src_length: the lenght of src in bytes
  *
  * Store a linear raster buffer into the GeglBuffer.
- *
- * Rename to: gegl_buffer_set
  */
 void           gegl_buffer_introspectable_set (GeglBuffer          *buffer,
                                                const GeglRectangle *rect,
diff --git a/gegl/gegl-operations-util.h b/gegl/gegl-operations-util.h
index 738b176..2eac131 100644
--- a/gegl/gegl-operations-util.h
+++ b/gegl/gegl-operations-util.h
@@ -125,6 +125,15 @@ gegl_coordinate_pixel_to_relative (gdouble pixel, gdouble pixel_dim)
     return pixel / pixel_dim;
 }
 
+
+/**
+ * gegl_operation_list_keys:
+ * @operation_type: the name of the operation type we want to query to property keys for.
+ * @n_keys: (out caller-allocates): return location for number of property keys.
+ *
+ * Return value: (transfer container) (array length=n_keys): An allocated NULL
+ * terminated array of operation-key names. The list should be freed with g_free after use.
+ */
 gchar      ** gegl_operation_list_keys         (const gchar *operation_type,
                                                 guint       *n_keys);
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]