Documentation arrived.

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

diff --git a/src/rb_evas.c b/src/rb_evas.c
index fb02482920b5b937204ac25f0d771795336f4812..3e333a59dd9c2c1847c29b157380419f8436522f 100644 (file)
--- a/src/rb_evas.c
+++ b/src/rb_evas.c
@@ -1,5 +1,5 @@
 /*
- * $Id: rb_evas.c 49 2004-08-01 10:17:39Z tilman $
+ * $Id: rb_evas.c 58 2004-08-10 14:10:02Z tilman $
  *
  * Copyright (C) 2004 Tilman Sauerbeck (tilman at code-monkey de)
  *
@@ -52,11 +52,18 @@ VALUE TO_EVAS (VALUE parent, Evas *e)
        return self;
 }
 
+/* :nodoc: */
 static VALUE c_inspect (VALUE self)
 {
        INSPECT (self, RbEvas);
 }
 
+/*
+ * call-seq:
+ *  e.render => nil
+ *
+ * Forces a re-render of the Evas.
+ */
 static VALUE c_render (VALUE self)
 {
        GET_OBJ (self, RbEvas, e);
@@ -75,6 +82,12 @@ static VALUE c_font_path_clear (VALUE self)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.font_path_append(path) => nil
+ *
+ * Appends a path to the font path for <i>e</i>.
+ */
 static VALUE c_font_path_append (VALUE self, VALUE path)
 {
        GET_OBJ (self, RbEvas, e);
@@ -86,6 +99,12 @@ static VALUE c_font_path_append (VALUE self, VALUE path)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.font_path_prepend(path) => nil
+ *
+ * Prepends a path to the font path for <i>e</i>.
+ */
 static VALUE c_font_path_prepend (VALUE self, VALUE path)
 {
        GET_OBJ (self, RbEvas, e);
@@ -97,6 +116,12 @@ static VALUE c_font_path_prepend (VALUE self, VALUE path)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.font_path => array
+ *
+ * Returns the font path for <i>e</i>.
+ */
 static VALUE c_font_path_get (VALUE self)
 {
        VALUE ary;
@@ -114,7 +139,12 @@ static VALUE c_font_path_get (VALUE self)
 
        return ary;
 }
-
+/*
+ * call-seq:
+ *  e.font_cache => fixnum
+ *
+ * Returns the size of the font cache for <i>e</i>.
+ */
 static VALUE c_font_cache_get (VALUE self)
  {
        GET_OBJ (self, RbEvas, e);
@@ -122,6 +152,12 @@ static VALUE c_font_cache_get (VALUE self)
        return INT2FIX (evas_font_cache_get (e->real));
 }
 
+/*
+ * call-seq:
+ *  e.font_cache(fixnum)
+ *
+ * Sets the size of the font cache for <i>e</i>.
+ */
 static VALUE c_font_cache_set (VALUE self, VALUE val)
 {
        GET_OBJ (self, RbEvas, e);
@@ -133,6 +169,12 @@ static VALUE c_font_cache_set (VALUE self, VALUE val)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.font_cache_reload => nil
+ *
+ * Flushes the font cache for <i>e</i>.
+ */
 static VALUE c_font_cache_flush (VALUE self)
 {
        GET_OBJ (self, RbEvas, e);
@@ -142,6 +184,12 @@ static VALUE c_font_cache_flush (VALUE self)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.image_cache => fixnum
+ *
+ * Returns the size of the image cache for <i>e</i>.
+ */
 static VALUE c_image_cache_get (VALUE self)
 {
        GET_OBJ (self, RbEvas, e);
@@ -149,6 +197,12 @@ static VALUE c_image_cache_get (VALUE self)
        return INT2FIX (evas_image_cache_get (e->real));
 }
 
+/*
+ * call-seq:
+ *  e.image_cache(fixnum)
+ *
+ * Sets the size of the image cache for <i>e</i>.
+ */
 static VALUE c_image_cache_set (VALUE self, VALUE val)
 {
        GET_OBJ (self, RbEvas, e);
@@ -160,6 +214,12 @@ static VALUE c_image_cache_set (VALUE self, VALUE val)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.image_cache_reload => nil
+ *
+ * Flushes the image cache for <i>e</i>.
+ */
 static VALUE c_image_cache_reload (VALUE self)
 {
        GET_OBJ (self, RbEvas, e);
@@ -169,6 +229,12 @@ static VALUE c_image_cache_reload (VALUE self)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.image_cache_flush => nil
+ *
+ * Flushes the image cache for <i>e</i>.
+ */
 static VALUE c_image_cache_flush (VALUE self)
 {
        GET_OBJ (self, RbEvas, e);
@@ -178,6 +244,12 @@ static VALUE c_image_cache_flush (VALUE self)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.top => evasobject
+ *
+ * Returns the <code>Evas::EvasObject</code> at the top of <i>e</i>.
+ */
 static VALUE c_top_get (VALUE self)
 {
        Evas_Object *o;
@@ -196,6 +268,12 @@ static VALUE c_top_get (VALUE self)
        return (VALUE) obj;
 }
 
+/*
+ * call-seq:
+ *  e.bottom => evasobject
+ *
+ * Returns the <code>Evas::EvasObject</code> at the bottom of <i>e</i>.
+ */
 static VALUE c_bottom_get (VALUE self)
 {
        Evas_Object *o;
@@ -214,6 +292,12 @@ static VALUE c_bottom_get (VALUE self)
        return (VALUE) obj;
 }
 
+/*
+ * call-seq:
+ *  e.find_object(name) => evasobject
+ *
+ * Returns the <code>Evas::EvasObject</code> with the name <i>name</i>.
+ */
 static VALUE c_find_object (VALUE self, VALUE name)
 {
        Evas_Object *o;