Documentation arrived.

[ruby-ecore.git] / src / ecore / rb_idler.c

diff --git a/src/ecore/rb_idler.c b/src/ecore/rb_idler.c
index b890ef59a49b5726523e610a134c68ee03c33524..05550fd6f9786584271e6be0babbb2edc1392f29 100644 (file)
--- a/src/ecore/rb_idler.c
+++ b/src/ecore/rb_idler.c
@@ -1,5 +1,5 @@
 /*
- * $Id: rb_idler.c 50 2004-08-01 10:18:39Z tilman $
+ * $Id: rb_idler.c 60 2004-08-10 14:12:36Z tilman $
  *
  * Copyright (C) 2004 Tilman Sauerbeck (tilman at code-monkey de)
  *
@@ -62,6 +62,14 @@ static void c_free (RbIdler *idler)
        free (idler);
 }
 
+/*
+ * call-seq:
+ *  Ecore::Idler.new { block } => idler
+ *
+ * Creates an Ecore::Idler object.
+ * When Ecore is idle, the specified block will be called.
+ * If the block returns false, the idler is deleted.
+ */
 static VALUE c_new (VALUE klass)
 {
        VALUE self;
@@ -82,6 +90,12 @@ static VALUE c_new (VALUE klass)
        return self;
 }
 
+/*
+ * call-seq:
+ *  idler.delete => nil
+ *
+ * Deletes <i>idler</i>.
+ */
 static VALUE c_delete (VALUE self)
 {
        GET_OBJ (self, RbIdler, idler);