Don't include C comment in token stream

Author: drbrain

History.txt

@@ -17,18 +17,19 @@
   * Converted to minitest.
 
 * Z Bug Fixes
-  * Fix missing superclass in ri output.
-  * Fix an RDoc crash when told to parse an empty file.
-  * Ignore nonexistent files instead of crashing.
+  * Fix missing superclass in ri output
+  * Fix an RDoc crash when told to parse an empty file
+  * Ignore nonexistent files instead of crashing
   * .txt and .rdoc files are always considered text.  Patch #22897 by Aaron
     Patterson.
-  * When merging ri data with a nonexistant directory, RDoc no longer crashes.
+  * When merging ri data with a nonexistant directory, RDoc no longer crashes
   * Fix visibility of methods in XML output.  Issue by Yehuda Katz.
-  * Fixed relative link generation.
+  * Fixed relative link generation
   * Fix crash, RDoc now ignores comments above local variable assignments in
-    modules.
+    modules
   * RDoc now only accepts adjacent comments for rb_define_module and
     rb_define_class
+  * C file RDoc is no longer included in token stream
 
 === 2.2.1 / 2008-09-24
 This version provides some minor fixes and enhancements to 2.2.0 intended

lib/rdoc/code_objects.rb

@@ -830,9 +830,7 @@ def superclass
     def superclass=(superclass)
       raise NoMethodError, "#{full_name} is a module" if module?
 
-      if @superclass.nil? or @superclass == 'Object' then
-        @superclass = superclass 
-      end
+      @superclass = superclass if @superclass.nil? or @superclass == 'Object'
     end
 
     def to_s

lib/rdoc/generator.rb

@@ -913,15 +913,16 @@ def initialize(context, html_class, options)
 
       context.viewer = self
 
-      if (ts = @context.token_stream)
-        @source_code = markup_code(ts)
-        unless @options.inline_source
-          @src_url = create_source_code_file(@source_code)
+      if ts = @context.token_stream then
+        @source_code = markup_code ts
+
+        unless @options.inline_source then
+          @src_url = create_source_code_file @source_code
           @img_url = RDoc::Markup::ToHtml.gen_relative_url path, 'source.png'
         end
       end
 
-      AllReferences.add(name, self)
+      AllReferences.add name, self
     end
 
     ##

lib/rdoc/parser/c.rb

@@ -283,12 +283,13 @@ def find_attr_comment(attr_name)
 
   def find_body(class_name, meth_name, meth_obj, body, quiet = false)
     case body
-    when %r"((?>/\*.*?\*/\s*))(?:(?:static|SWIGINTERN)\s+)?(?:intern\s+)?VALUE\s+#{meth_name}
-            \s*(\([^)]*\))([^;]|$)"xm
-      comment, params = $1, $2
-      body_text = $&
+    when %r"((?>/\*.*?\*/\s*))((?:(?:static|SWIGINTERN)\s+)?(?:intern\s+)?VALUE\s+#{meth_name}
+            \s*(\([^)]*\))([^;]|$))"xm
+      comment = $1
+      body_text = $2
+      params = $3
 
-      remove_private_comments(comment) if comment
+      remove_private_comments comment if comment
 
       # see if we can find the whole body
 
@@ -301,15 +302,15 @@ def find_body(class_name, meth_name, meth_obj, body, quiet = false)
       # distinct (for example Kernel.hash and Kernel.object_id share the same
       # implementation
 
-      override_comment = find_override_comment(class_name, meth_obj.name)
+      override_comment = find_override_comment class_name, meth_obj.name
       comment = override_comment if override_comment
 
-      find_modifiers(comment, meth_obj) if comment
+      find_modifiers comment, meth_obj if comment
 
 #        meth_obj.params = params
       meth_obj.start_collecting_tokens
-      meth_obj.add_token(RDoc::RubyToken::Token.new(1,1).set_text(body_text))
-      meth_obj.comment = mangle_comment(comment)
+      meth_obj.add_token RDoc::RubyToken::Token.new(1,1).set_text(body_text)
+      meth_obj.comment = mangle_comment comment
     when %r{((?>/\*.*?\*/\s*))^\s*\#\s*define\s+#{meth_name}\s+(\w+)}m
       comment = $1
       find_body(class_name, $2, meth_obj, body, true)

test/test_rdoc_parser_c.rb

@@ -268,6 +268,36 @@ def test_find_class_comment_define_class_bogus_comment
     assert_equal '', klass.comment
   end
 
+  def test_find_body
+    content = <<-EOF
+/*
+ * a comment for other_function
+ */
+VALUE
+other_function() {
+}
+
+void
+Init_Foo(void) {
+    VALUE foo = rb_define_class("Foo", rb_cObject);
+
+    rb_define_method(foo, "my_method", other_function, 0);
+}
+    EOF
+
+    klass = util_get_class content, 'foo'
+    other_function = klass.method_list.first
+
+    assert_equal 'my_method', other_function.name
+    assert_equal "  \n   a comment for other_function\n   \n",
+                 other_function.comment
+    assert_equal '()', other_function.params
+
+    code = other_function.token_stream.first.text
+
+    assert_equal "VALUE\nother_function() ", code
+  end
+
   def test_define_method
     content = <<-EOF
 /*Method Comment! */