Documentation arrived.

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

diff --git a/src/rb_text.c b/src/rb_text.c
index 7788465613d31a6d1356da461e74d80dfa93fa7d..076fd9ea727b21f01a55f4d39dbed45b77878af0 100644 (file)
--- a/src/rb_text.c
+++ b/src/rb_text.c
@@ -1,5 +1,5 @@
 /*
- * $Id: rb_text.c 49 2004-08-01 10:17:39Z tilman $
+ * $Id: rb_text.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::Text.new(evas) => text
+ *
+ * Creates an Evas::Text object.
+ */
 static VALUE c_new (VALUE klass, VALUE evas)
 {
        VALUE self, argv[1];
@@ -49,6 +55,12 @@ static VALUE c_new (VALUE klass, VALUE evas)
        return self;
 }
 
+/*
+ * call-seq:
+ *  text.font_source => string or nil
+ *
+ * Returns the font source of <i>text</i>.
+ */
 static VALUE c_font_source_get (VALUE self)
 {
        const char *tmp;
@@ -61,6 +73,12 @@ static VALUE c_font_source_get (VALUE self)
                return rb_str_new2 (tmp);
 }
 
+/*
+ * call-seq:
+ *  text.font_source(source)
+ *
+ * Sets the font source of <i>text</i>.
+ */
 static VALUE c_font_source_set (VALUE self, VALUE val)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -72,6 +90,15 @@ static VALUE c_font_source_set (VALUE self, VALUE val)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  text.get_font => array
+ *
+ * Returns the font name and font size of <i>text</i>.
+ *
+ *  text.set_font("vera", 10) #=> nil
+ *  text_get_font             #=> ["vera", 10]
+ */
 static VALUE c_get_font (VALUE self)
 {
        char *font = NULL;
@@ -85,6 +112,14 @@ static VALUE c_get_font (VALUE self)
                            INT2FIX (size));
 }
 
+/*
+ * call-seq:
+ *  text.set_font(font, size) => nil
+ *
+ * Sets the font name and font size of <i>text</i>.
+ *
+ *  text.set_font("vera", 10) #=> nil
+ */
 static VALUE c_set_font (VALUE self, VALUE font, VALUE size)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -98,6 +133,12 @@ static VALUE c_set_font (VALUE self, VALUE font, VALUE size)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  text.text => string
+ *
+ * Returns the text of <i>text</i>.
+ */
 static VALUE c_text_get (VALUE self)
 {
        const char *tmp;
@@ -110,6 +151,12 @@ static VALUE c_text_get (VALUE self)
                return rb_str_new2 (tmp);
 }
 
+/*
+ * call-seq:
+ *  text.text(string)
+ *
+ * Sets the text of <i>text</i>.
+ */
 static VALUE c_text_set (VALUE self, VALUE val)
 {
        GET_OBJ (self, RbEvasObject, e);