0
@@ -121,7 +121,13 @@
0
   return JS_TRUE;
0
 }
0
 
0
-/* private */ static VALUE /* Context#initialize_native(options={}) */
0
+/*
0
+ * call-seq:
0
+ *   native_initialize(options={})
0
+ *
0
+ * Initializes the native spidermonkey values.
0
+ */
0
+static VALUE
0
 initialize_native(VALUE self, VALUE UNUSED(options))
0
 {
0
   OurContext* context;

0
@@ -4,6 +4,11 @@
0
 
0
 void init_Johnson_Error(VALUE johnson)
0
 {
0
+  /* HACK:  These comments are *only* to make RDoc happy.
0
+  VALUE johnson = rb_define_module("Johnson");
0
+  */
0
+
0
+  /* Johnson::Error class. */
0
   error = rb_define_class_under(johnson, "Error", rb_eStandardError);
0
 }
0
 

0
@@ -27,6 +27,12 @@
0
   return self;
0
 }
0
 
0
+/*
0
+ * call-seq:
0
+ *   parse_io(stream, filename=nil, line_number=0)
0
+ *
0
+ * Parses an IO object, returning a native spidermonkey parse tree.
0
+ */
0
 static VALUE parse_io(int argc, VALUE *argv, VALUE klass) {
0
   VALUE self = allocate(klass);
0
   VALUE stream, filename, linenum;
0
0
0
@@ -81,24 +87,39 @@
0
   return self;
0
 }
0
 
0
-static VALUE /* line */
0
-line(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   line
0
+ *
0
+ * Returns the line number of the node.
0
+ */
0
+static VALUE line(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
 
0
   Data_Get_Struct(self, ImmutableNodeContext, ctx);
0
   return INT2NUM(ctx->node->pn_pos.begin.lineno);
0
 }
0
 
0
-static VALUE /* index */
0
-begin_index(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   index
0
+ *
0
+ * Returns the column number of the node.
0
+ */
0
+static VALUE begin_index(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
 
0
   Data_Get_Struct(self, ImmutableNodeContext, ctx);
0
   return INT2NUM(ctx->node->pn_pos.begin.index);
0
 }
0
 
0
-static VALUE /* pn_arity */
0
-pn_arity(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   pn_arity
0
+ *
0
+ * Returns the arity of the node as a symbol.
0
+ */
0
+static VALUE pn_arity(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
 
0
   Data_Get_Struct(self, ImmutableNodeContext, ctx);
0
@@ -121,8 +142,13 @@
0
   return Qnil;
0
 }
0
 
0
-static VALUE /* pn_type */
0
-pn_type(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   pn_type
0
+ *
0
+ * Returns the type of the node as a symbol.
0
+ */
0
+static VALUE pn_type(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
 
0
   Data_Get_Struct(self, ImmutableNodeContext, ctx);
0
@@ -134,8 +160,13 @@
0
   return INT2NUM(ctx->node->pn_type);
0
 }
0
 
0
-static VALUE /* pn_expr */
0
-data_pn_expr(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   pn_expr
0
+ *
0
+ * Returns the parse node expression as an ImmutableNode.
0
+ */
0
+static VALUE data_pn_expr(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
 
0
   Data_Get_Struct(self, ImmutableNodeContext, ctx);
0
@@ -149,8 +180,13 @@
0
   return Qnil;
0
 }
0
 
0
-static VALUE /* pn_kid */
0
-data_pn_kid(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   pn_kid
0
+ *
0
+ * Returns the child ImmutableNode.
0
+ */
0
+static VALUE data_pn_kid(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
 
0
   Data_Get_Struct(self, ImmutableNodeContext, ctx);
0
@@ -164,8 +200,13 @@
0
   return Qnil;
0
 }
0
 
0
-static VALUE /* pn_kid1 */
0
-data_pn_kid1(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   pn_kid1
0
+ *
0
+ * Returns the first child ImmutableNode.
0
+ */
0
+static VALUE data_pn_kid1(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
 
0
   Data_Get_Struct(self, ImmutableNodeContext, ctx);
0
@@ -179,8 +220,13 @@
0
   return Qnil;
0
 }
0
 
0
-static VALUE /* pn_kid2 */
0
-data_pn_kid2(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   pn_kid2
0
+ *
0
+ * Returns the second child ImmutableNode.
0
+ */
0
+static VALUE data_pn_kid2(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
 
0
   Data_Get_Struct(self, ImmutableNodeContext, ctx);
0
@@ -194,8 +240,13 @@
0
   return Qnil;
0
 }
0
 
0
-static VALUE /* pn_kid3 */
0
-data_pn_kid3(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   pn_kid3
0
+ *
0
+ * Returns the third child ImmutableNode.
0
+ */
0
+static VALUE data_pn_kid3(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
 
0
   Data_Get_Struct(self, ImmutableNodeContext, ctx);
0
@@ -209,8 +260,13 @@
0
   return Qnil;
0
 }
0
 
0
-static VALUE /* pn_dval */
0
-data_pn_dval(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   pn_dval
0
+ *
0
+ * Returns the numeric value of the node.
0
+ */
0
+static VALUE data_pn_dval(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
 
0
   Data_Get_Struct(self, ImmutableNodeContext, ctx);
0
@@ -221,8 +277,13 @@
0
   }
0
 }
0
 
0
-static VALUE /* pn_op */
0
-data_pn_op(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   pn_op
0
+ *
0
+ * Returns the op code for the node as a symbol.
0
+ */
0
+static VALUE data_pn_op(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
 
0
   Data_Get_Struct(self, ImmutableNodeContext, ctx);
0
@@ -234,8 +295,13 @@
0
   return INT2NUM(ctx->node->pn_op);
0
 }
0
 
0
-static VALUE /* pn_left */
0
-data_pn_left(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   pn_left
0
+ *
0
+ * Returns the left side ImmutableNode.
0
+ */
0
+static VALUE data_pn_left(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
 
0
   Data_Get_Struct(self, ImmutableNodeContext, ctx);
0
@@ -250,8 +316,13 @@
0
   return Qnil;
0
 }
0
 
0
-static VALUE /* pn_extra */
0
-data_pn_extra(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   pn_extra
0
+ *
0
+ * Returns extra informaton about the node as an Integer.
0
+ */
0
+static VALUE data_pn_extra(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
 
0
   Data_Get_Struct(self, ImmutableNodeContext, ctx);
0
0
@@ -259,16 +330,26 @@
0
   return INT2NUM(ctx->node->pn_extra);
0
 }
0
 
0
-static VALUE /* name */
0
-name(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   name
0
+ *
0
+ * Returns the name of the node.
0
+ */
0
+static VALUE name(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
 
0
   Data_Get_Struct(self, ImmutableNodeContext, ctx);
0
   return rb_str_new2(JS_GetStringBytes(ATOM_TO_STRING(ctx->node->pn_atom)));
0
 }
0
 
0
-static VALUE /* regexp */
0
-regexp(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   regexp
0
+ *
0
+ * Returns the regexp value as a String.
0
+ */
0
+static VALUE regexp(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
   jsval result;
0
 
0
@@ -277,8 +358,13 @@
0
   return rb_str_new2(JS_GetStringBytes(JSVAL_TO_STRING(result)));
0
 }
0
 
0
-static VALUE /* function_name */
0
-function_name(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   function_name
0
+ *
0
+ * Returns the function name as a String.
0
+ */
0
+static VALUE function_name(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
   JSFunction * f;
0
   JSObject * object;
0
@@ -294,8 +380,13 @@
0
   }
0
 }
0
 
0
-static VALUE /* function_args */
0
-function_args(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   function_args
0
+ *
0
+ * Returns the function argument names as an Array of String.
0
+ */
0
+static VALUE function_args(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
   JSFunction * f;
0
   JSObject * object;
0
@@ -319,8 +410,13 @@
0
   return func_args;
0
 }
0
 
0
-static VALUE /* function_body */
0
-function_body(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   function_body
0
+ *
0
+ * Returns the function body as an ImmutableNode.
0
+ */
0
+static VALUE function_body(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
   JSFunction * f;
0
   JSObject * object;
0
@@ -339,8 +435,13 @@
0
   return Qnil;
0
 }
0
 
0
-static VALUE /* pn_right */
0
-data_pn_right(VALUE self)
0
+/*
0
+ * call-seq:
0
+ *   pn_right
0
+ *
0
+ * Returns right side as an ImmutableNode.
0
+ */
0
+static VALUE data_pn_right(VALUE self)
0
 {
0
   ImmutableNodeContext * ctx;
0
 
0
@@ -356,8 +457,13 @@
0
   return Qnil;
0
 }
0
 
0
-static VALUE /* children */
0
-children(VALUE self) {
0
+/*
0
+ * call-seq:
0
+ *   children
0
+ *
0
+ * Returns children as an Array of ImmutableNode.
0
+ */
0
+static VALUE children(VALUE self) {
0
   ImmutableNodeContext * ctx;
0
   JSParseNode * p;
0
   VALUE children;
0
@@ -378,6 +484,12 @@
0
 
0
 void init_Johnson_SpiderMonkey_Immutable_Node(VALUE spidermonkey)
0
 {
0
+  /* HACK:  These comments are *only* to make RDoc happy.
0
+  VALUE johnson = rb_define_module("Johnson");
0
+  VALUE spidermonkey = rb_define_module_under(johnson, "SpiderMonkey");
0
+  */
0
+
0
+  /* ImmutableNode class. */
0
   cNode = rb_define_class_under(spidermonkey, "ImmutableNode", rb_cObject);
0
 
0
   rb_define_alloc_func(cNode, allocate);

0
@@ -35,7 +35,13 @@
0
   JRETURN_RUBY(CONVERT_TO_RUBY(context, result));
0
 }
0
 
0
-static VALUE /* [] */
0
+/*
0
+ * call-seq:
0
+ *   [](name)
0
+ *
0
+ * Returns the property with +name+.
0
+ */
0
+static VALUE
0
 get(VALUE self, VALUE name)
0
 {
0
   RubyLandProxy* proxy;
0
@@ -62,7 +68,13 @@
0
   JRETURN_RUBY(CONVERT_TO_RUBY(proxy->context, js_value));
0
 }
0
 
0
-static VALUE /* []= */
0
+/*
0
+ * call-seq:
0
+ *   []=(name,value)
0
+ *
0
+ * Sets the property with +name+ to +value+.
0
+ */
0
+static VALUE
0
 set(VALUE self, VALUE name, VALUE value)
0
 {
0
   RubyLandProxy* proxy;
0
@@ -91,7 +103,13 @@
0
   JRETURN_RUBY(value);
0
 }
0
 
0
-static VALUE /* function? */
0
+/*
0
+ * call-seq:
0
+ *   function?
0
+ *
0
+ * Returns <code>true</code> if this is a function.
0
+ */
0
+static VALUE
0
 function_p(VALUE self)
0
 {
0
   RubyLandProxy* proxy;
0
@@ -99,7 +117,13 @@
0
   return JS_TypeOfValue(proxy->context->js, proxy->value) == JSTYPE_FUNCTION;
0
 }
0
 
0
-static VALUE /* respond_to?(sym) */
0
+/*
0
+ * call-seq:
0
+ *   respond_to?(symbol)
0
+ *
0
+ * Returns <code>true</code> if _obj_ responds to given method.
0
+ */
0
+static VALUE
0
 respond_to_p(VALUE self, VALUE sym)
0
 {
0
   RubyLandProxy* proxy;
0
@@ -126,7 +150,13 @@
0
   JRETURN_RUBY(found ? Qtrue : CALL_RUBY_WRAPPER(rb_call_super, 1, &sym));
0
 }
0
 
0
-/* private */ static VALUE /* native_call(global, *args) */
0
+/*
0
+ * call-seq:
0
+ *   native_call(global, *args)
0
+ *
0
+ * Call as a function with given +global+ using *args.
0
+ */
0
+static VALUE
0
 native_call(int argc, VALUE* argv, VALUE self)
0
 {
0
   if (!function_p(self))
0
@@ -153,7 +183,13 @@
0
   JS_DestroyIdArray(context->js, (JSIdArray*)data);
0
 }
0
 
0
-static VALUE /* each(&block) */ 
0
+/*
0
+ * call-seq:
0
+ *   each { |obj| block }
0
+ *
0
+ * Calls <em>block</em> with each item in the collection.
0
+ */
0
+static VALUE
0
 each(VALUE self)
0
 {
0
   RubyLandProxy* proxy;
0
@@ -222,6 +258,12 @@
0
   JRETURN_RUBY(self);
0
 }
0
 
0
+/*
0
+ * call-seq:
0
+ *   length
0
+ *
0
+ * Returns the length of the collection.
0
+ */
0
 static VALUE
0
 length(VALUE self)
0
 {
0
@@ -254,7 +296,13 @@
0
   }
0
 }
0
 
0
-/* private */ static VALUE /* context */
0
+/*
0
+ * call-seq:
0
+ *   context
0
+ *
0
+ * Returns context.
0
+ */
0
+static VALUE
0
 context(VALUE self)
0
 {
0
   RubyLandProxy* proxy;
0
@@ -262,7 +310,13 @@
0
   return (VALUE)JS_GetContextPrivate(proxy->context->js);
0
 }
0
 
0
-/* private */ static VALUE /* function_property?(name) */
0
+/*
0
+ * call-seq:
0
+ *   function_property?(name)
0
+ *
0
+ * Returns <code>true</code> if +name+ is a function property.
0
+ */
0
+static VALUE
0
 function_property_p(VALUE self, VALUE name)
0
 {
0
   Check_Type(name, T_STRING);
0
@@ -286,7 +340,13 @@
0
   JRETURN_RUBY(type == JSTYPE_FUNCTION ? Qtrue : Qfalse);
0
 }
0
 
0
-/* private */ static VALUE
0
+/*
0
+ * call-seq:
0
+ *   call_function_property(name, arguments)
0
+ *
0
+ * Calls function +name+ with +arguments+.
0
+ */
0
+static VALUE
0
 call_function_property(int argc, VALUE* argv, VALUE self)
0
 {
0
   RubyLandProxy* proxy;
0
@@ -314,6 +374,24 @@
0
   JRETURN_RUBY(call_js_function_value(proxy->context, proxy->value, function, argc - 1, &(argv[1])));
0
 }
0
 
0
+/*
0
+ * call-seq:
0
+ *   to_s
0
+ *
0
+ * Converts object to a string.
0
+ */
0
+static VALUE to_s(VALUE self)
0
+{
0
+  RubyLandProxy* proxy;
0
+  Data_Get_Struct(self, RubyLandProxy, proxy);
0
+
0
+  PREPARE_RUBY_JROOTS(proxy->context, 1);
0
+  JROOT(proxy->value);
0
+  JSString* str = JS_ValueToString(proxy->context->js, proxy->value);
0
+
0
+  JRETURN_RUBY(convert_jsstring_to_ruby(proxy->context, str));
0
+}
0
+
0
 ///////////////////////////////////////////////////////////////////////////
0
 //// INFRASTRUCTURE BELOW HERE ////////////////////////////////////////////
0
 ///////////////////////////////////////////////////////////////////////////
0
0
@@ -388,20 +466,14 @@
0
   }
0
 }
0
 
0
-static VALUE to_s(VALUE self)
0
-{
0
-  RubyLandProxy* proxy;
0
-  Data_Get_Struct(self, RubyLandProxy, proxy);
0
-
0
-  PREPARE_RUBY_JROOTS(proxy->context, 1);
0
-  JROOT(proxy->value);
0
-  JSString* str = JS_ValueToString(proxy->context->js, proxy->value);
0
-
0
-  JRETURN_RUBY(convert_jsstring_to_ruby(proxy->context, str));
0
-}
0
-
0
 void init_Johnson_SpiderMonkey_Proxy(VALUE spidermonkey)
0
 {
0
+  /* HACK:  These comments are *only* to make RDoc happy.
0
+  VALUE johnson = rb_define_module("Johnson");
0
+  VALUE spidermonkey = rb_define_module_under(johnson, "SpiderMonkey");
0
+  */
0
+
0
+  /* RubyLandProxy class. */
0
   proxy_class = rb_define_class_under(spidermonkey, "RubyLandProxy", rb_cObject);
0
 
0
   rb_define_method(proxy_class, "[]", get, 1);