[gegl] Introspection annotations for color, curve, path
- From: Daniel Sabo <daniels src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gegl] Introspection annotations for color, curve, path
- Date: Mon, 3 Jun 2013 04:22:35 +0000 (UTC)
commit 2cbfa8859668dfb46ddd4d99d3c601814db450db
Author: Daniel Sabo <DanielSabo gmail com>
Date: Sun Jun 2 20:08:51 2013 -0700
Introspection annotations for color, curve, path
gegl/property-types/gegl-color.h | 30 +++++++++++++++++++++++++++---
gegl/property-types/gegl-curve.h | 14 +++++++++++++-
gegl/property-types/gegl-path.h | 12 +++++++++++-
3 files changed, 51 insertions(+), 5 deletions(-)
---
diff --git a/gegl/property-types/gegl-color.h b/gegl/property-types/gegl-color.h
index e38127b..ab52d96 100644
--- a/gegl/property-types/gegl-color.h
+++ b/gegl/property-types/gegl-color.h
@@ -71,7 +71,7 @@ GeglColor * gegl_color_new (const gchar *string);
*
* Creates a copy of @color.
*
- * Returns the copied #GeglColor.
+ * Return value: (transfer full): A new copy of @color.
*/
GeglColor * gegl_color_duplicate (GeglColor *color);
@@ -108,7 +108,7 @@ void gegl_color_set_rgba (GeglColor *color,
gdouble blue,
gdouble alpha);
/**
- * gegl_color_set_pixel:
+ * gegl_color_set_pixel: (skip)
* @color: a #GeglColor
* @format: a babl pixel format
* @pixel: pointer to a pixel
@@ -119,7 +119,7 @@ void gegl_color_set_pixel (GeglColor *color,
const Babl *format,
const void *pixel);
/**
- * gegl_color_get_pixel:
+ * gegl_color_get_pixel: (skip)
* @color: a #GeglColor
* @format: a babl pixel format
* @pixel: pointer to a pixel
@@ -138,12 +138,36 @@ void gegl_color_get_pixel (GeglColor *color,
GType gegl_param_color_get_type (void) G_GNUC_CONST;
+/**
+ * gegl_param_spec_color:
+ * @name: canonical name of the property specified
+ * @nick: nick name for the property specified
+ * @blurb: description of the property specified
+ * @default_color: the default value for the property specified
+ * @flags: flags for the property specified
+ *
+ * Creates a new #GParamSpec instance specifying a #GeglColor property.
+ *
+ * Returns: (transfer full): a newly created parameter specification
+ */
GParamSpec * gegl_param_spec_color (const gchar *name,
const gchar *nick,
const gchar *blurb,
GeglColor *default_color,
GParamFlags flags);
+/**
+ * gegl_param_spec_color_from_string:
+ * @name: canonical name of the property specified
+ * @nick: nick name for the property specified
+ * @blurb: description of the property specified
+ * @default_color_string: the default value for the property specified
+ * @flags: flags for the property specified
+ *
+ * Creates a new #GParamSpec instance specifying a #GeglColor property.
+ *
+ * Returns: (transfer full): a newly created parameter specification
+ */
GParamSpec * gegl_param_spec_color_from_string (const gchar *name,
const gchar *nick,
const gchar *blurb,
diff --git a/gegl/property-types/gegl-curve.h b/gegl/property-types/gegl-curve.h
index 8e6f602..3d1e644 100644
--- a/gegl/property-types/gegl-curve.h
+++ b/gegl/property-types/gegl-curve.h
@@ -81,7 +81,7 @@ GeglCurve * gegl_curve_new_default (void);
*
* Create a copy of @curve.
*
- * Returns the copied #GeglCurve.
+ * Return value: (transfer full): A new copy of @curve.
*/
GeglCurve * gegl_curve_duplicate (GeglCurve *curve);
@@ -187,6 +187,18 @@ void gegl_curve_calc_values (GeglCurve *curve,
GType gegl_param_curve_get_type (void) G_GNUC_CONST;
+/**
+ * gegl_param_spec_curve:
+ * @name: canonical name of the property specified
+ * @nick: nick name for the property specified
+ * @blurb: description of the property specified
+ * @default_curve: the default value for the property specified
+ * @flags: flags for the property specified
+ *
+ * Creates a new #GParamSpec instance specifying a #GeglCurve property.
+ *
+ * Returns: (transfer full): a newly created parameter specification
+ */
GParamSpec * gegl_param_spec_curve (const gchar *name,
const gchar *nick,
const gchar *blurb,
diff --git a/gegl/property-types/gegl-path.h b/gegl/property-types/gegl-path.h
index df24ea6..99056ff 100644
--- a/gegl/property-types/gegl-path.h
+++ b/gegl/property-types/gegl-path.h
@@ -378,7 +378,17 @@ void gegl_path_freeze (GeglPath *path);
*/
void gegl_path_thaw (GeglPath *path);
-/***
+/**
+ * gegl_param_spec_path:
+ * @name: canonical name of the property specified
+ * @nick: nick name for the property specified
+ * @blurb: description of the property specified
+ * @default_path: the default value for the property specified
+ * @flags: flags for the property specified
+ *
+ * Creates a new #GParamSpec instance specifying a #GeglPath property.
+ *
+ * Returns: (transfer full): a newly created parameter specification
*/
GParamSpec * gegl_param_spec_path (const gchar *name,
const gchar *nick,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]