Only grab adjacent comments when looking for class comments

Author: drbrain

History.txt

@@ -27,6 +27,8 @@
   * Fixed relative link generation.
   * Fix crash, RDoc now ignores comments above local variable assignments in
     modules.
+  * RDoc now only accepts adjacent comments for rb_define_module and
+    rb_define_class
 
 === 2.2.1 / 2008-09-24
 This version provides some minor fixes and enhancements to 2.2.0 intended

lib/rdoc/parser/c.rb

@@ -96,8 +96,21 @@ class RDoc::Parser::C < RDoc::Parser
 
   parse_files_matching(/\.(?:([CcHh])\1?|c([+xp])\2|y)\z/)
 
-  @@enclosure_classes = {}
-  @@known_bodies = {}
+  ##
+  # C file the parser is parsing
+
+  attr_accessor :content
+
+  ##
+  # Resets cross-file state.  Call when parsing different projects that need
+  # separate documentation.
+
+  def self.reset
+    @@enclosure_classes = {}
+    @@known_bodies = {}
+  end
+
+  reset
 
   ##
   # Prepare to parse a C file
@@ -365,25 +378,18 @@ def find_class(raw_name, name)
 
   def find_class_comment(class_name, class_meth)
     comment = nil
+
     if @content =~ %r{((?>/\*.*?\*/\s+))
                    (static\s+)?void\s+Init_#{class_name}\s*(?:_\(\s*)?\(\s*(?:void\s*)\)}xmi then
       comment = $1
-    elsif @content =~ %r{Document-(?:class|module):\s#{class_name}\s*?(?:<\s+[:,\w]+)?\n((?>.*?\*/))}m
+    elsif @content =~ %r{Document-(?:class|module):\s+#{class_name}\s*?(?:<\s+[:,\w]+)?\n((?>.*?\*/))}m then
+      comment = $1
+    elsif @content =~ %r{((?>/\*.*?\*/\s+))
+                         ([\w\.\s]+\s* = \s+)?rb_define_(class|module).*?"(#{class_name})"}xm then
       comment = $1
-    else
-      if @content =~ /rb_define_(class|module)/m then
-        class_name = class_name.split("::").last
-        comments = []
-        @content.split(/(\/\*.*?\*\/)\s*?\n/m).each_with_index do |chunk, index|
-          comments[index] = chunk
-          if chunk =~ /rb_define_(class|module).*?"(#{class_name})"/m then
-            comment = comments[index-1]
-            break
-          end
-        end
-      end
     end
-    class_meth.comment = mangle_comment(comment) if comment
+
+    class_meth.comment = mangle_comment comment if comment
   end
 
   ##
@@ -492,9 +498,10 @@ def handle_class_module(var_name, class_mod, class_name, parent, in_module)
       @stats.add_module cm
     end
 
-    cm.record_location(enclosure.toplevel)
+    cm.record_location enclosure.toplevel
+
+    find_class_comment cm.full_name, cm
 
-    find_class_comment(cm.full_name, cm)
     @classes[var_name] = cm
     @@enclosure_classes[var_name] = cm
     @known_classes[var_name] = cm.full_name

test/test_rdoc_parser_c.rb

@@ -21,6 +21,9 @@ def setup
     @fn = filename
     @options = RDoc::Options.new
     @stats = RDoc::Stats.new 0
+
+    RDoc::Parser::C.reset
+    RDoc::TopLevel.reset
   end
 
   def teardown
@@ -137,12 +140,12 @@ def test_do_constants
 }
     EOF
 
-    parser = util_parser content
+    @parser = util_parser content
 
-    parser.do_classes
-    parser.do_constants
+    @parser.do_classes
+    @parser.do_constants
 
-    klass = parser.classes['cFoo']
+    klass = @parser.classes['cFoo']
     assert klass
 
     constants = klass.constants
@@ -223,7 +226,7 @@ def test_find_class_comment_define_class
 
     klass = util_get_class content, 'foo'
 
-    assert_equal "  \n   a comment for class Foo\n   ", klass.comment
+    assert_equal "  \n   a comment for class Foo\n   \n", klass.comment
   end
 
   def test_find_class_comment_define_class_Init_Foo
@@ -245,6 +248,26 @@ def test_find_class_comment_define_class_Init_Foo
     assert_equal "  \n   a comment for class Foo on Init\n   \n", klass.comment
   end
 
+  def test_find_class_comment_define_class_bogus_comment
+    content = <<-EOF
+/*
+ * a comment for other_function
+ */
+void
+other_function() {
+}
+
+void
+Init_Foo(void) {
+    VALUE foo = rb_define_class("Foo", rb_cObject);
+}
+    EOF
+
+    klass = util_get_class content, 'foo'
+
+    assert_equal '', klass.comment
+  end
+
   def test_define_method
     content = <<-EOF
 /*Method Comment! */
@@ -273,9 +296,9 @@ def test_define_method
   end
 
   def util_get_class(content, name)
-    parser = util_parser content
-    parser.scan
-    parser.classes[name]
+    @parser = util_parser content
+    @parser.scan
+    @parser.classes[name]
   end
 
   def util_parser(content)