Documentation arrived.

[ruby-edje.git] / src / rb_edje_main.c

diff --git a/src/rb_edje_main.c b/src/rb_edje_main.c
index 10fc3c7c7a06e56613201890dd3d3e607db8265d..a553b54703202fbb8aff456105bd27cd599bda10 100644 (file)
--- a/src/rb_edje_main.c
+++ b/src/rb_edje_main.c
@@ -1,5 +1,5 @@
 /*
- * $Id: rb_edje_main.c 47 2004-07-26 13:24:50Z tilman $
+ * $Id: rb_edje_main.c 59 2004-08-10 14:10:31Z tilman $
  *
  * Copyright (C) 2004 Tilman Sauerbeck (tilman at code-monkey de)
  *
@@ -26,18 +26,12 @@
 #include "rb_edje.h"
 #include "rb_part.h"
 
-#ifdef DEBUG
-static VALUE m_init (VALUE self)
-{
-       return INT2FIX (edje_init ());
-}
-
-static VALUE m_shutdown (VALUE self)
-{
-       return INT2FIX (edje_shutdown ());
-}
-#endif
-
+/*
+ * call-seq:
+ *    Edje.freeze => nil
+ *
+ * Freezes all <code>Edje::Edje</code> objects.
+ */
 static VALUE m_freeze (VALUE self)
 {
        edje_freeze ();
@@ -45,6 +39,12 @@ static VALUE m_freeze (VALUE self)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *    Edje.thaw => nil
+ *
+ * Thaws all <code>Edje::Edje</code> objects.
+ */
 static VALUE m_thaw (VALUE self)
 {
        edje_thaw ();
@@ -52,11 +52,23 @@ static VALUE m_thaw (VALUE self)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *    Edje.frametime => float
+ *
+ * Returns the frametime (1 / fps) for the Edje library.
+ */
 static VALUE m_frametime_get (VALUE self)
 {
        return rb_float_new (edje_frametime_get ());
 }
 
+/*
+ * call-seq:
+ *    Edje.frametime(float)
+ *
+ * Sets the frametime (1 / fps) for the Edje library.
+ */
 static VALUE m_frametime_set (VALUE self, VALUE val)
 {
        Check_Type (val, T_FLOAT);
@@ -72,11 +84,6 @@ void Init_edje (void)
 
        mEdje = rb_define_module ("Edje");
 
-#ifdef DEBUG
-       rb_define_module_function (mEdje, "init", m_init, 0);
-       rb_define_module_function (mEdje, "shutdown", m_shutdown, 0);
-#endif
-
        rb_define_module_function (mEdje, "freeze", m_freeze, 0);
        rb_define_module_function (mEdje, "thaw", m_thaw, 0);
        rb_define_module_function (mEdje, "frametime", m_frametime_get, 0);