Merge pull request #702 from aycabta/normalize-comment-should-check-language

Normalization of comment should check language

Author: aycabta

lib/rdoc/comment.rb

@@ -48,9 +48,10 @@ class RDoc::Comment
   # Creates a new comment with +text+ that is found in the RDoc::TopLevel
   # +location+.
 
-  def initialize text = nil, location = nil
+  def initialize text = nil, location = nil, language = nil
     @location = location
     @text     = text.nil? ? nil : text.dup
+    @language = language
 
     @document   = nil
     @format     = 'rdoc'

lib/rdoc/parser/c.rb

@@ -446,7 +446,7 @@ def do_includes
       next unless cls = @classes[c]
       m = @known_classes[m] || m
 
-      comment = RDoc::Comment.new '', @top_level
+      comment = RDoc::Comment.new '', @top_level, :c
       incl = cls.add_include RDoc::Include.new(m, comment)
       incl.record_location @top_level
     end
@@ -564,7 +564,7 @@ def find_alias_comment class_name, new_name, old_name
                                    \s*"#{Regexp.escape new_name}"\s*,
                                    \s*"#{Regexp.escape old_name}"\s*\);%xm
 
-    RDoc::Comment.new($1 || '', @top_level)
+    RDoc::Comment.new($1 || '', @top_level, :c)
   end
 
   ##
@@ -603,7 +603,7 @@ def find_attr_comment var_name, attr_name, read = nil, write = nil
                 ''
               end
 
-    RDoc::Comment.new comment, @top_level
+    RDoc::Comment.new comment, @top_level, :c
   end
 
   ##
@@ -643,7 +643,7 @@ def find_body class_name, meth_name, meth_obj, file_content, quiet = false
 
     case type
     when :func_def
-      comment = RDoc::Comment.new args[0], @top_level
+      comment = RDoc::Comment.new args[0], @top_level, :c
       body = args[1]
       offset, = args[2]
 
@@ -673,7 +673,7 @@ def find_body class_name, meth_name, meth_obj, file_content, quiet = false
 
       body
     when :macro_def
-      comment = RDoc::Comment.new args[0], @top_level
+      comment = RDoc::Comment.new args[0], @top_level, :c
       body = args[1]
       offset, = args[2]
 
@@ -780,7 +780,7 @@ def find_class_comment class_name, class_mod
       comment = ''
     end
 
-    comment = RDoc::Comment.new comment, @top_level
+    comment = RDoc::Comment.new comment, @top_level, :c
     comment.normalize
 
     look_for_directives_in class_mod, comment
@@ -825,7 +825,7 @@ def find_const_comment(type, const_name, class_name = nil)
       table[const_name] ||
       ''
 
-    RDoc::Comment.new comment, @top_level
+    RDoc::Comment.new comment, @top_level, :c
   end
 
   ##
@@ -856,7 +856,7 @@ def find_override_comment class_name, meth_obj
 
     return unless comment
 
-    RDoc::Comment.new comment, @top_level
+    RDoc::Comment.new comment, @top_level, :c
   end
 
   ##
@@ -990,7 +990,7 @@ def handle_constants(type, var_name, const_name, definition)
 
         new_comment = "#{$1}#{new_comment.lstrip}"
 
-        new_comment = RDoc::Comment.new new_comment, @top_level
+        new_comment = RDoc::Comment.new new_comment, @top_level, :c
 
         con = RDoc::Constant.new const_name, new_definition, new_comment
       else

lib/rdoc/parser/ruby.rb

@@ -667,7 +667,7 @@ def make_message message
   # Creates a comment with the correct format
 
   def new_comment comment
-    c = RDoc::Comment.new comment, @top_level
+    c = RDoc::Comment.new comment, @top_level, :ruby
     c.format = @markup
     c
   end

lib/rdoc/text.rb

@@ -10,6 +10,8 @@
 
 module RDoc::Text
 
+  attr_accessor :language
+
   ##
   # Maps markup formats to classes that can parse them.  If the format is
   # unknown, "rdoc" format is used.
@@ -111,8 +113,12 @@ def markup text
   def normalize_comment text
     return text if text.empty?
 
-    text = strip_stars    text
-    text = strip_hashes   text
+    case language
+    when :ruby
+      text = strip_hashes text
+    when :c
+      text = strip_stars text
+    end
     text = expand_tabs    text
     text = flush_left     text
     text = strip_newlines text

test/minitest_helper.rb

@@ -97,8 +97,9 @@ def block *contents
   # Creates an RDoc::Comment with +text+ which was defined on +top_level+.
   # By default the comment has the 'rdoc' format.
 
-  def comment text, top_level = @top_level
-    RDoc::Comment.new text, top_level
+  def comment text, top_level = @top_level, language = nil
+    comment = RDoc::Comment.new text, top_level, language
+    comment
   end
 
   ##

test/test_rdoc_class_module.rb

@@ -9,19 +9,19 @@ def test_add_comment
     tl3 = @store.add_file 'three.rb'
 
     cm = RDoc::ClassModule.new 'Klass'
-    comment_tl1 = RDoc::Comment.new('# comment 1')
+    comment_tl1 = RDoc::Comment.new('# comment 1', @top_level, :ruby)
     cm.add_comment comment_tl1, tl1
 
     assert_equal [[comment_tl1, tl1]], cm.comment_location
     assert_equal 'comment 1', cm.comment.text
 
-    comment_tl2 = RDoc::Comment.new('# comment 2')
+    comment_tl2 = RDoc::Comment.new('# comment 2', @top_level, :ruby)
     cm.add_comment comment_tl2, tl2
 
     assert_equal [[comment_tl1, tl1], [comment_tl2, tl2]], cm.comment_location
     assert_equal "comment 1\n---\ncomment 2", cm.comment
 
-    comment_tl3 = RDoc::Comment.new('# * comment 3')
+    comment_tl3 = RDoc::Comment.new('# * comment 3', @top_level, :ruby)
     cm.add_comment comment_tl3, tl3
 
     assert_equal [[comment_tl1, tl1],
@@ -42,11 +42,13 @@ def test_add_comment_duplicate
     tl1 = @store.add_file 'one.rb'
 
     cm = RDoc::ClassModule.new 'Klass'
-    cm.add_comment '# comment 1', tl1
-    cm.add_comment '# comment 2', tl1
+    comment1 = RDoc::Comment.new('# comment 1', @top_level, :ruby)
+    comment2 = RDoc::Comment.new('# comment 2', @top_level, :ruby)
+    cm.add_comment comment1, tl1
+    cm.add_comment comment2, tl1
 
-    assert_equal [['comment 1', tl1],
-                  ['comment 2', tl1]], cm.comment_location
+    assert_equal [[comment1, tl1],
+                  [comment2, tl1]], cm.comment_location
   end
 
   def test_add_comment_stopdoc
@@ -66,17 +68,17 @@ def test_ancestors
 
   def test_comment_equals
     cm = RDoc::ClassModule.new 'Klass'
-    cm.comment = '# comment 1'
+    cm.comment = RDoc::Comment.new('# comment 1', @top_level, :ruby)
 
-    assert_equal 'comment 1', cm.comment
+    assert_equal 'comment 1', cm.comment.to_s
 
-    cm.comment = '# comment 2'
+    cm.comment = RDoc::Comment.new('# comment 2', @top_level, :ruby)
 
-    assert_equal "comment 1\n---\ncomment 2", cm.comment
+    assert_equal "comment 1\n---\ncomment 2", cm.comment.to_s
 
-    cm.comment = "# * comment 3"
+    cm.comment = RDoc::Comment.new('# * comment 3', @top_level, :ruby)
 
-    assert_equal "comment 1\n---\ncomment 2\n---\n* comment 3", cm.comment
+    assert_equal "comment 1\n---\ncomment 2\n---\n* comment 3", cm.comment.to_s
   end
 
   def test_comment_equals_comment

test/test_rdoc_comment.rb

@@ -241,6 +241,7 @@ def test_normalize
     @comment.text = <<-TEXT
   # comment
     TEXT
+    @comment.language = :ruby
 
     assert_same @comment, @comment.normalize
 

test/test_rdoc_context_section.rb

@@ -11,7 +11,7 @@ def setup
     @klass = @top_level.add_class RDoc::NormalClass, 'Object'
 
     @S = RDoc::Context::Section
-    @s = @S.new @klass, 'section', comment('# comment', @top_level)
+    @s = @S.new @klass, 'section', comment('# comment', @top_level, :ruby)
   end
 
   def test_add_comment

test/test_rdoc_parser_c.rb

@@ -1381,7 +1381,7 @@ def test_find_modifiers_nodoc
   end
 
   def test_find_modifiers_yields
-    comment = RDoc::Comment.new <<-COMMENT
+    comment = RDoc::Comment.new <<-COMMENT, @top_level, :c
 /* :yields: a, b
  *
  * Blah