* eval.c: Add doxygen comments.

* ruby.c: ditto.

* thread_pthread.c: ditto

* version.c: ditto.

* vm_core.h: ditto.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@36078 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 12 insertions, 0 deletions

diff --git a/ruby.c b/ruby.c
index 7db0736f72..beaf198612 100644
--- a/ruby.c
+++ b/ruby.c
@@ -1706,6 +1706,11 @@ set_arg0(VALUE val, ID id)
     rb_progname = rb_obj_freeze(rb_external_str_new(s, i));
 }
 
+/*! Sets the current script name to this value.
+ *
+ * This is similiar to <code>$0 = name</code> in Ruby level but also affects
+ * <code>Method#location</code> and others.
+ */
 void
 ruby_script(const char *name)
 {
@@ -1765,6 +1770,7 @@ opt_W_getter(ID id, void *data)
     }
 }
 
+/*! Defines built-in variables */
 void
 ruby_prog_init(void)
 {
@@ -1860,6 +1866,12 @@ fill_standard_fds(void)
     }
 }
 
+/*! Initializes the process for ruby(1).
+ *
+ * This function assumes this process is ruby(1) and it has just started.
+ * Usually programs that embeds CRuby interpreter should not call this function,
+ * and should do their own initialization.
+ */
 void
 ruby_sysinit(int *argc, char ***argv)
 {