Documentation arrived.

[ruby-evas.git] / src / rb_gradient.c

diff --git a/src/rb_gradient.c b/src/rb_gradient.c
index e597685475aaee79671bbac0fdcd5a362acdc156..2129e01235b8b96f7aa223042ebed2c9cde77983 100644 (file)
--- a/src/rb_gradient.c
+++ b/src/rb_gradient.c
@@ -1,5 +1,5 @@
 /*
- * $Id: rb_gradient.c 49 2004-08-01 10:17:39Z tilman $
+ * $Id: rb_gradient.c 58 2004-08-10 14:10:02Z tilman $
  *
  * Copyright (C) 2004 Tilman Sauerbeck (tilman at code-monkey de)
  *
@@ -31,6 +31,12 @@ static void c_free (RbEvasObject *e)
        c_evas_object_free (e, true);
 }
 
+/*
+ * call-seq:
+ *  Evas::Gradient.new(evas) => gradient
+ *
+ * Creates an Evas::Gradient object.
+ */
 static VALUE c_new (VALUE klass, VALUE evas)
 {
        VALUE self, argv[1];
@@ -49,7 +55,13 @@ static VALUE c_new (VALUE klass, VALUE evas)
        return self;
 }
 
-static VALUE c_color_add (VALUE self, VALUE r, VALUE g, VALUE b,
+/*
+ * call-seq:
+ *  gradient.add_color(r, g, b, a, distance) => nil
+ *
+ * Adds a color to <i>gradient</i>.
+ */
+static VALUE c_add_color (VALUE self, VALUE r, VALUE g, VALUE b,
                           VALUE a, VALUE distance)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -67,7 +79,13 @@ static VALUE c_color_add (VALUE self, VALUE r, VALUE g, VALUE b,
        return Qnil;
 }
 
-static VALUE c_colors_clear (VALUE self)
+/*
+ * call-seq:
+ *  gradient.clear_colors => nil
+ *
+ * Clears the colors of <i>gradient</i>.
+ */
+static VALUE c_clear_colors (VALUE self)
 {
        GET_OBJ (self, RbEvasObject, e);
 
@@ -76,6 +94,12 @@ static VALUE c_colors_clear (VALUE self)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  gradient.angle => fixnum
+ *
+ * Returns the angle of <i>gradient</i>.
+ */
 static VALUE c_angle_get (VALUE self)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -83,6 +107,12 @@ static VALUE c_angle_get (VALUE self)
        return INT2FIX (evas_object_gradient_angle_get (e->real));
 }
 
+/*
+ * call-seq:
+ *  gradient.angle(fixnum)
+ *
+ * Sets the angle of <i>gradient</i>.
+ */
 static VALUE c_angle_set (VALUE self, VALUE val)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -99,8 +129,8 @@ void Init_Gradient (void)
        VALUE c = rb_define_class_under (mEvas, "Gradient", cEvasObject);
 
        rb_define_singleton_method (c, "new", c_new, 1);
-       rb_define_method (c, "color_add", c_color_add, 5);
-       rb_define_method (c, "colors_clear", c_colors_clear, 0);
+       rb_define_method (c, "add_color", c_add_color, 5);
+       rb_define_method (c, "clear_colors", c_clear_colors, 0);
        rb_define_method (c, "angle", c_angle_get, 0);
        rb_define_method (c, "angle=", c_angle_set, 1);
 }