Documentation arrived.
[ruby-ecore.git] / src / ecore / rb_timer.c
index fa9ab155cb960d0a10482272215e00b945a1fad2..55b4a393bb74a86b3ef1954f4a22c6d5de5fedc2 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * $Id: rb_timer.c 50 2004-08-01 10:18:39Z tilman $
+ * $Id: rb_timer.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 (RbTimer *timer)
        free (timer);
 }
 
+/*
+ * call-seq:
+ *  Ecore::Timer.new(interval) { block } => timer
+ *
+ * Creates an Ecore::Timer object with the specified interval.
+ * When the timeout is hit, the block is called.
+ * If the block returns false, the timer is deleted.
+ */
 static VALUE c_new (VALUE klass, VALUE interval)
 {
        VALUE self;
@@ -83,6 +91,12 @@ static VALUE c_new (VALUE klass, VALUE interval)
        return self;
 }
 
+/*
+ * call-seq:
+ *  timer.delete => nil
+ *
+ * Deletes <i>timer</i>.
+ */
 static VALUE c_delete (VALUE self)
 {
        GET_OBJ (self, RbTimer, timer);