rdoc 3.9.5 → 3.10.pre.1

data/test/test_rdoc_parser_rd.rb

@@ -0,0 +1,52 @@
+require 'rdoc/test_case'
+
+class TestRDocParserRd < RDoc::TestCase
+
+  def setup
+    super
+
+    @RP = RDoc::Parser
+
+    @tempfile = Tempfile.new self.class.name
+    filename = @tempfile.path
+
+    @top_level = RDoc::TopLevel.new filename
+    @fn = filename
+    @options = RDoc::Options.new
+    @stats = RDoc::Stats.new 0
+  end
+
+  def teardown
+    super
+
+    @tempfile.close
+  end
+
+  def test_file
+    assert_kind_of RDoc::Parser::Text, util_parser('')
+  end
+
+  def test_class_can_parse
+    assert_equal @RP::RD, @RP.can_parse('foo.rd')
+    assert_equal @RP::RD, @RP.can_parse('foo.rd.ja')
+  end
+
+  def test_scan
+    parser = util_parser 'it ((*really*)) works'
+
+    expected =
+      @RM::Document.new(
+        @RM::Paragraph.new('it <em>really</em> works'))
+    expected.file = @top_level
+
+    parser.scan
+
+    assert_equal expected, @top_level.comment.parse
+  end
+
+  def util_parser content
+    RDoc::Parser::RD.new @top_level, @fn, content, @options, @stats
+  end
+
+end
+

data/test/test_rdoc_parser_ruby.rb

@@ -1,17 +1,12 @@
 # coding: utf-8
 
-require 'stringio'
-require 'tempfile'
-require 'rubygems'
-require 'minitest/autorun'
+require 'rdoc/test_case'
 
-require 'rdoc/options'
-require 'rdoc/parser/ruby'
-require 'rdoc/stats'
-
-class TestRDocParserRuby < MiniTest::Unit::TestCase
+class TestRDocParserRuby < RDoc::TestCase
 
   def setup
+    super
+
     @tempfile = Tempfile.new self.class.name
     @filename = @tempfile.path
 
@@ -24,14 +19,25 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     @options.quiet = true
     @options.option_parser = OptionParser.new
 
+    @comment = RDoc::Comment.new '', @top_level
+
     @stats = RDoc::Stats.new 0
   end
 
   def teardown
+    super
+
     @tempfile.close
     @tempfile2.close
   end
 
+  def mu_pp obj
+    s = ''
+    s = PP.pp obj, s
+    s = s.force_encoding(Encoding.default_external) if defined? Encoding
+    s.chomp
+  end
+
   def test_collect_first_comment
     p = util_parser <<-CONTENT
 # first
@@ -42,7 +48,7 @@ class C; end
 
     comment = p.collect_first_comment
 
-    assert_equal "# first\n", comment
+    assert_equal RDoc::Comment.new("# first\n", @top_level), comment
   end
 
   def test_collect_first_comment_encoding
@@ -59,67 +65,7 @@ class C; end
 
     comment = p.collect_first_comment
 
-    assert_equal Encoding::CP852, comment.encoding
-  end
-
-  def test_extract_call_seq
-    m = RDoc::AnyMethod.new nil, 'm'
-    p = util_parser ''
-
-    comment = <<-COMMENT
-  # call-seq:
-  #   bla => true or false
-  #
-  # moar comment
-    COMMENT
-
-    p.extract_call_seq comment, m
-
-    assert_equal "bla => true or false\n", m.call_seq
-  end
-
-  def test_extract_call_seq_blank
-    m = RDoc::AnyMethod.new nil, 'm'
-    p = util_parser ''
-
-    comment = <<-COMMENT
-  # call-seq:
-  #   bla => true or false
-  #
-    COMMENT
-
-    p.extract_call_seq comment, m
-
-    assert_equal "bla => true or false\n", m.call_seq
-  end
-
-  def test_extract_call_seq_no_blank
-    m = RDoc::AnyMethod.new nil, 'm'
-    p = util_parser ''
-
-    comment = <<-COMMENT
-  # call-seq:
-  #   bla => true or false
-    COMMENT
-
-    p.extract_call_seq comment, m
-
-    assert_equal "bla => true or false\n", m.call_seq
-  end
-
-  def test_extract_call_seq_undent
-    m = RDoc::AnyMethod.new nil, 'm'
-    p = util_parser ''
-
-    comment = <<-COMMENT
-  # call-seq:
-  #   bla => true or false
-  # moar comment
-    COMMENT
-
-    p.extract_call_seq comment, m
-
-    assert_equal "bla => true or false\nmoar comment\n", m.call_seq
+    assert_equal Encoding::CP852, comment.text.encoding
   end
 
   def test_get_symbol_or_name
@@ -149,159 +95,32 @@ class C; end
   def test_look_for_directives_in_attr
     util_parser ""
 
-    comment = "# :attr: my_attr\n"
+    comment = RDoc::Comment.new "# :attr: my_attr\n", @top_level
 
     @parser.look_for_directives_in @top_level, comment
 
-    assert_equal "# :attr: my_attr\n", comment
+    assert_equal "# :attr: my_attr\n", comment.text
 
-    comment = "# :attr_reader: my_method\n"
+    comment = RDoc::Comment.new "# :attr_reader: my_method\n", @top_level
 
     @parser.look_for_directives_in @top_level, comment
 
-    assert_equal "# :attr_reader: my_method\n", comment
+    assert_equal "# :attr_reader: my_method\n", comment.text
 
-    comment = "# :attr_writer: my_method\n"
+    comment = RDoc::Comment.new "# :attr_writer: my_method\n", @top_level
 
     @parser.look_for_directives_in @top_level, comment
 
-    assert_equal "# :attr_writer: my_method\n", comment
-  end
-
-  def test_remove_private_comments
-    util_parser ''
-
-    comment = <<-EOS
-# This is text
-#--
-# this is private
-    EOS
-
-    expected = <<-EOS
-# This is text
-    EOS
-
-    @parser.remove_private_comments(comment)
-
-    assert_equal expected, comment
-  end
-
-  def test_remove_private_comments_encoding
-    skip "Encoding not implemented" unless Object.const_defined? :Encoding
-
-    util_parser ''
-
-    comment = <<-EOS
-# This is text
-#--
-# this is private
-    EOS
-    comment.force_encoding Encoding::IBM437
-
-    @parser.remove_private_comments comment
-
-    assert_equal Encoding::IBM437, comment.encoding
-  end
-
-  def test_remove_private_comments_long
-    util_parser ''
-
-    comment = <<-EOS
-#-----
-#++
-# this is text
-#-----
-    EOS
-
-    expected = <<-EOS
-# this is text
-    EOS
-
-    @parser.remove_private_comments(comment)
-
-    assert_equal expected, comment
-  end
-
-  def test_remove_private_comments_rule
-    util_parser ''
-
-    comment = <<-EOS
-# This is text with a rule:
-# ---
-# this is also text
-    EOS
-
-    expected = comment.dup
-
-    @parser.remove_private_comments(comment)
-
-    assert_equal expected, comment
-  end
-
-  def test_remove_private_comments_toggle
-    util_parser ''
-
-    comment = <<-EOS
-# This is text
-#--
-# this is private
-#++
-# This is text again.
-    EOS
-
-    expected = <<-EOS
-# This is text
-# This is text again.
-    EOS
-
-    @parser.remove_private_comments(comment)
-
-    assert_equal expected, comment
-  end
-
-  def test_remove_private_comments_toggle_encoding
-    skip "Encoding not implemented" unless Object.const_defined? :Encoding
-
-    util_parser ''
-
-    comment = <<-EOS
-# This is text
-#--
-# this is private
-#++
-# This is text again.
-    EOS
-
-    comment.force_encoding Encoding::IBM437
-
-    @parser.remove_private_comments comment
-
-    assert_equal Encoding::IBM437, comment.encoding
-  end
-
-  def test_remove_private_comments_toggle_encoding_ruby_bug?
-    skip "Encoding not implemented" unless Object.const_defined? :Encoding
-
-    util_parser ''
-
-    comment = <<-EOS
-#--
-# this is private
-#++
-# This is text again.
-    EOS
-
-    comment.force_encoding Encoding::IBM437
-
-    @parser.remove_private_comments comment
-
-    assert_equal Encoding::IBM437, comment.encoding
+    assert_equal "# :attr_writer: my_method\n", comment.text
   end
 
   def test_look_for_directives_in_commented
     util_parser ""
 
-    comment = "# how to make a section:\n# # :section: new section\n"
+    comment = RDoc::Comment.new <<-COMMENT, @top_level
+# how to make a section:
+# # :section: new section
+    COMMENT
 
     @parser.look_for_directives_in @top_level, comment
 
@@ -310,43 +129,48 @@ class C; end
     assert_equal nil, section.comment
 
     assert_equal "# how to make a section:\n# # :section: new section\n",
-                 comment
+                 comment.text
   end
 
   def test_look_for_directives_in_method
     util_parser ""
 
-    comment = "# :method: my_method\n"
+    comment = RDoc::Comment.new "# :method: my_method\n", @top_level
 
     @parser.look_for_directives_in @top_level, comment
 
-    assert_equal "# :method: my_method\n", comment
+    assert_equal "# :method: my_method\n", comment.text
 
-    comment = "# :singleton-method: my_method\n"
+    comment = RDoc::Comment.new "# :singleton-method: my_method\n", @top_level
 
     @parser.look_for_directives_in @top_level, comment
 
-    assert_equal "# :singleton-method: my_method\n", comment
+    assert_equal "# :singleton-method: my_method\n", comment.text
   end
 
   def test_look_for_directives_in_section
     util_parser ""
 
-    comment = "# :section: new section\n# woo stuff\n"
+    comment = RDoc::Comment.new <<-COMMENT, @top_level
+# :section: new section
+# woo stuff
+    COMMENT
 
     @parser.look_for_directives_in @top_level, comment
 
     section = @top_level.current_section
     assert_equal 'new section', section.title
-    assert_equal "# woo stuff\n", section.comment
+    assert_equal "# woo stuff\n", section.comment.text
 
-    assert_equal '', comment
+    assert_empty comment
   end
 
   def test_look_for_directives_in_unhandled
     util_parser ""
 
-    @parser.look_for_directives_in @top_level, "# :unhandled: blah\n"
+    comment = RDoc::Comment.new "# :unhandled: blah\n", @top_level
+
+    @parser.look_for_directives_in @top_level, comment
 
     assert_equal 'blah', @top_level.metadata['unhandled']
   end
@@ -420,7 +244,7 @@ class C; end
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# my attr\n"
+    comment = RDoc::Comment.new "##\n# my attr\n", @top_level
 
     util_parser "attr :foo, :bar"
 
@@ -432,7 +256,7 @@ class C; end
 
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
-    assert_equal 'my attr', foo.comment
+    assert_equal 'my attr', foo.comment.text
     assert_equal @top_level, foo.file
     assert_equal 0, foo.offset
     assert_equal 1, foo.line
@@ -443,7 +267,7 @@ class C; end
     klass.parent = @top_level
     klass.stop_doc
 
-    comment = "##\n# my attr\n"
+    comment = RDoc::Comment.new "##\n# my attr\n", @top_level
 
     util_parser "attr :foo, :bar"
 
@@ -458,7 +282,7 @@ class C; end
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# my attr\n"
+    comment = RDoc::Comment.new "##\n# my attr\n", @top_level
 
     util_parser "attr_accessor :foo, :bar"
 
@@ -471,7 +295,7 @@ class C; end
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
     assert_equal 'RW', foo.rw
-    assert_equal 'my attr', foo.comment
+    assert_equal 'my attr', foo.comment.text
     assert_equal @top_level, foo.file
     assert_equal 0, foo.offset
     assert_equal 1, foo.line
@@ -479,14 +303,14 @@ class C; end
     bar = klass.attributes.last
     assert_equal 'bar', bar.name
     assert_equal 'RW', bar.rw
-    assert_equal 'my attr', bar.comment
+    assert_equal 'my attr', bar.comment.text
   end
 
   def test_parse_attr_accessor_nodoc
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# my attr\n"
+    comment = RDoc::Comment.new "##\n# my attr\n", @top_level
 
     util_parser "attr_accessor :foo, :bar # :nodoc:"
 
@@ -502,7 +326,7 @@ class C; end
     klass.parent = @top_level
     klass.stop_doc
 
-    comment = "##\n# my attr\n"
+    comment = RDoc::Comment.new "##\n# my attr\n", @top_level
 
     util_parser "attr_accessor :foo, :bar"
 
@@ -517,7 +341,7 @@ class C; end
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# my attr\n"
+    comment = RDoc::Comment.new "##\n# my attr\n", @top_level
 
     util_parser "attr_writer :foo, :bar"
 
@@ -530,20 +354,20 @@ class C; end
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
     assert_equal 'W', foo.rw
-    assert_equal "my attr", foo.comment
+    assert_equal "my attr", foo.comment.text
     assert_equal @top_level, foo.file
 
     bar = klass.attributes.last
     assert_equal 'bar', bar.name
     assert_equal 'W', bar.rw
-    assert_equal "my attr", bar.comment
+    assert_equal "my attr", bar.comment.text
   end
 
   def test_parse_meta_attr
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# :attr: \n# my method\n"
+    comment = RDoc::Comment.new "##\n# :attr: \n# my method\n", @top_level
 
     util_parser "add_my_method :foo, :bar"
 
@@ -555,7 +379,7 @@ class C; end
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
     assert_equal 'RW', foo.rw
-    assert_equal "my method", foo.comment
+    assert_equal "my method", foo.comment.text
     assert_equal @top_level, foo.file
   end
 
@@ -563,7 +387,8 @@ class C; end
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# :attr_accessor: \n# my method\n"
+    comment =
+      RDoc::Comment.new "##\n# :attr_accessor: \n# my method\n", @top_level
 
     util_parser "add_my_method :foo, :bar"
 
@@ -575,7 +400,7 @@ class C; end
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
     assert_equal 'RW', foo.rw
-    assert_equal 'my method', foo.comment
+    assert_equal 'my method', foo.comment.text
     assert_equal @top_level, foo.file
   end
 
@@ -583,7 +408,7 @@ class C; end
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# :attr: foo\n# my method\n"
+    comment = RDoc::Comment.new "##\n# :attr: foo\n# my method\n", @top_level
 
     util_parser "add_my_method :foo, :bar"
 
@@ -595,7 +420,7 @@ class C; end
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
     assert_equal 'RW', foo.rw
-    assert_equal 'my method', foo.comment
+    assert_equal 'my method', foo.comment.text
     assert_equal @top_level, foo.file
   end
 
@@ -603,7 +428,8 @@ class C; end
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# :attr_reader: \n# my method\n"
+    comment =
+      RDoc::Comment.new "##\n# :attr_reader: \n# my method\n", @top_level
 
     util_parser "add_my_method :foo, :bar"
 
@@ -614,7 +440,7 @@ class C; end
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
     assert_equal 'R', foo.rw
-    assert_equal 'my method', foo.comment
+    assert_equal 'my method', foo.comment.text
     assert_equal @top_level, foo.file
   end
 
@@ -623,7 +449,7 @@ class C; end
     klass.parent = @top_level
     klass.stop_doc
 
-    comment = "##\n# :attr: \n# my method\n"
+    comment = RDoc::Comment.new "##\n# :attr: \n# my method\n", @top_level
 
     util_parser "add_my_method :foo, :bar"
 
@@ -638,7 +464,8 @@ class C; end
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# :attr_writer: \n# my method\n"
+    comment =
+      RDoc::Comment.new "##\n# :attr_writer: \n# my method\n", @top_level
 
     util_parser "add_my_method :foo, :bar"
 
@@ -649,12 +476,12 @@ class C; end
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
     assert_equal 'W', foo.rw
-    assert_equal "my method", foo.comment
+    assert_equal "my method", foo.comment.text
     assert_equal @top_level, foo.file
   end
 
   def test_parse_class
-    comment = "##\n# my class\n"
+    comment = RDoc::Comment.new "##\n# my class\n", @top_level
 
     util_parser "class Foo\nend"
 
@@ -664,7 +491,7 @@ class C; end
 
     foo = @top_level.classes.first
     assert_equal 'Foo', foo.full_name
-    assert_equal 'my class', foo.comment
+    assert_equal 'my class', foo.comment.text
     assert_equal [@top_level], foo.in_files
     assert_equal 0, foo.offset
     assert_equal 1, foo.line
@@ -681,7 +508,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     foo = @top_level.classes.first
     assert_equal 'Foo', foo.full_name
@@ -712,7 +539,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     foo = @top_level.classes.first
     assert_equal 'Foo', foo.full_name
@@ -721,7 +548,7 @@ end
   end
 
   def test_parse_class_nodoc
-    comment = "##\n# my class\n"
+    comment = RDoc::Comment.new "##\n# my class\n", @top_level
 
     util_parser "class Foo # :nodoc:\nend"
 
@@ -740,7 +567,7 @@ end
   def test_parse_class_stopdoc
     @top_level.stop_doc
 
-    comment = "##\n# my class\n"
+    comment = RDoc::Comment.new "##\n# my class\n", @top_level
 
     util_parser "class Foo\nend"
 
@@ -772,7 +599,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     foo = @top_level.classes.first
     assert_equal 'Foo', foo.full_name
@@ -794,7 +621,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     const_fail_meta = @top_level.classes.first
     assert_equal 'ConstFailMeta', const_fail_meta.full_name
@@ -810,14 +637,14 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_class foo, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_class foo, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     bar = foo.classes.first
     assert_equal 'Super', bar.superclass
   end
 
   def test_parse_module
-    comment = "##\n# my module\n"
+    comment = RDoc::Comment.new "##\n# my module\n", @top_level
 
     util_parser "module Foo\nend"
 
@@ -827,13 +654,13 @@ end
 
     foo = @top_level.modules.first
     assert_equal 'Foo', foo.full_name
-    assert_equal 'my module', foo.comment
+    assert_equal 'my module', foo.comment.text
   end
 
   def test_parse_module_nodoc
     @top_level.stop_doc
 
-    comment = "##\n# my module\n"
+    comment = RDoc::Comment.new "##\n# my module\n", @top_level
 
     util_parser "module Foo # :nodoc:\nend"
 
@@ -849,7 +676,7 @@ end
   def test_parse_module_stopdoc
     @top_level.stop_doc
 
-    comment = "##\n# my module\n"
+    comment = RDoc::Comment.new "##\n# my module\n", @top_level
 
     util_parser "module Foo\nend"
 
@@ -859,7 +686,7 @@ end
 
     foo = @top_level.modules.first
     assert_equal 'Foo', foo.full_name
-    assert_equal 'my module', foo.comment
+    assert_equal 'my module', foo.comment.text
   end
 
   def test_parse_class_colon3
@@ -872,7 +699,7 @@ end
 
     util_parser code
 
-    @parser.parse_class @top_level, false, @parser.get_tk, ''
+    @parser.parse_class @top_level, false, @parser.get_tk, @comment
 
     assert_equal %w[A B],    RDoc::TopLevel.classes.map { |c| c.full_name }
   end
@@ -891,7 +718,7 @@ end
 
     util_parser code
 
-    @parser.parse_class @top_level, false, @parser.get_tk, ''
+    @parser.parse_class @top_level, false, @parser.get_tk, @comment
 
     assert_equal %w[A],    RDoc::TopLevel.classes.map { |c| c.full_name }
     assert_equal %w[A::B A::d], RDoc::TopLevel.modules.map { |c| c.full_name }
@@ -925,7 +752,7 @@ end
 
     util_parser code
 
-    @parser.parse_module @top_level, false, @parser.get_tk, ''
+    @parser.parse_module @top_level, false, @parser.get_tk, @comment
 
     assert_equal %w[A],    RDoc::TopLevel.modules.map { |c| c.full_name }
     assert_equal %w[A::B A::C A::Object], RDoc::TopLevel.classes.map { |c| c.full_name }.sort
@@ -997,13 +824,14 @@ end
   end
 
   def test_parse_module_relative_to_top_level_namespace
-    comment = <<-EOF
+    comment = RDoc::Comment.new <<-EOF, @top_level
 #
 # Weirdly named module
 #
 EOF
 
-    code = comment + <<-EOF
+    code = <<-EOF
+#{comment.text}
 module ::Foo
   class Helper
   end
@@ -1015,7 +843,7 @@ EOF
 
     foo = @top_level.modules.first
     assert_equal 'Foo', foo.full_name
-    assert_equal 'Weirdly named module', foo.comment
+    assert_equal 'Weirdly named module', foo.comment.text
 
     helper = foo.classes.first
     assert_equal 'Foo::Helper', helper.full_name
@@ -1025,7 +853,7 @@ EOF
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# :attr: foo\n# my attr\n"
+    comment = RDoc::Comment.new "##\n# :attr: foo\n# my attr\n", @top_level
 
     util_parser "\n"
 
@@ -1036,7 +864,7 @@ EOF
     foo = klass.attributes.first
     assert_equal 'foo',      foo.name
     assert_equal 'RW',       foo.rw
-    assert_equal 'my attr',  foo.comment
+    assert_equal 'my attr',  foo.comment.text
     assert_equal @top_level, foo.file
     assert_equal 0,          foo.offset
     assert_equal 1,          foo.line
@@ -1058,7 +886,7 @@ EOF
     klass.parent = @top_level
     klass.stop_doc
 
-    comment = "##\n# :attr: foo\n# my attr\n"
+    comment = RDoc::Comment.new "##\n# :attr: foo\n# my attr\n", @top_level
 
     util_parser "\n"
 
@@ -1073,7 +901,7 @@ EOF
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# :method: foo\n# my method\n"
+    comment = RDoc::Comment.new "##\n# :method: foo\n# my method\n", @top_level
 
     util_parser "\n"
 
@@ -1083,7 +911,7 @@ EOF
 
     foo = klass.method_list.first
     assert_equal 'foo',       foo.name
-    assert_equal 'my method', foo.comment
+    assert_equal 'my method', foo.comment.text
     assert_equal @top_level,  foo.file
     assert_equal 0,           foo.offset
     assert_equal 1,           foo.line
@@ -1119,7 +947,7 @@ EOF
     klass.parent = @top_level
     klass.stop_doc
 
-    comment = "##\n# :method: foo\n# my method\n"
+    comment = RDoc::Comment.new "##\n# :method: foo\n# my method\n", @top_level
 
     util_parser "\n"
 
@@ -1139,7 +967,7 @@ EOF
 
     tk = @parser.get_tk
 
-    @parser.parse_constant klass, tk, ''
+    @parser.parse_constant klass, tk, @comment
 
     foo = klass.constants.first
 
@@ -1158,7 +986,7 @@ EOF
 
     tk = @parser.get_tk
 
-    @parser.parse_constant klass, tk, ''
+    @parser.parse_constant klass, tk, @comment
 
     assert klass.constants.empty?
   end
@@ -1172,7 +1000,7 @@ EOF
 
     tk = @parser.get_tk
 
-    @parser.parse_constant klass, tk, ''
+    @parser.parse_constant klass, tk, @comment
 
     assert_equal cB, klass.find_module_named('A')
   end
@@ -1188,7 +1016,7 @@ EOF
 
     tk = @parser.get_tk
 
-    @parser.parse_constant foo, tk, ''
+    @parser.parse_constant foo, tk, @comment
 
     assert_equal top_bar, bar.find_module_named('A')
   end
@@ -1203,7 +1031,7 @@ EOF
 
     tk = @parser.get_tk
 
-    @parser.parse_constant klass, tk, ''
+    @parser.parse_constant klass, tk, @comment
 
     assert_empty klass.constants
   end
@@ -1212,7 +1040,7 @@ EOF
     klass = RDoc::NormalClass.new 'C'
     klass.parent = @top_level
 
-    comment = "# my include\n"
+    comment = RDoc::Comment.new "# my include\n", @top_level
 
     util_parser "include I"
 
@@ -1224,7 +1052,7 @@ EOF
 
     incl = klass.includes.first
     assert_equal 'I', incl.name
-    assert_equal 'my include', incl.comment
+    assert_equal 'my include', incl.comment.text
     assert_equal @top_level, incl.file
   end
 
@@ -1232,7 +1060,7 @@ EOF
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# my method\n"
+    comment = RDoc::Comment.new "##\n# my method\n", @top_level
 
     util_parser "add_my_method :foo, :bar\nadd_my_method :baz"
 
@@ -1242,7 +1070,7 @@ EOF
 
     foo = klass.method_list.first
     assert_equal 'foo',       foo.name
-    assert_equal 'my method', foo.comment
+    assert_equal 'my method', foo.comment.text
     assert_equal @top_level,  foo.file
     assert_equal 0,           foo.offset
     assert_equal 1,           foo.line
@@ -1284,7 +1112,7 @@ EOF
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# my method\n"
+    comment = RDoc::Comment.new "##\n# my method\n", @top_level
 
     content = <<-CONTENT
 inline(:my_method) do |*args|
@@ -1305,7 +1133,8 @@ end
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# :method: woo_hoo!\n# my method\n"
+    comment =
+      RDoc::Comment.new "##\n# :method: woo_hoo!\n# my method\n", @top_level
 
     util_parser "add_my_method :foo, :bar\nadd_my_method :baz"
 
@@ -1315,7 +1144,7 @@ end
 
     foo = klass.method_list.first
     assert_equal 'woo_hoo!',  foo.name
-    assert_equal 'my method', foo.comment
+    assert_equal 'my method', foo.comment.text
     assert_equal @top_level,  foo.file
   end
 
@@ -1323,7 +1152,8 @@ end
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# :singleton-method:\n# my method\n"
+    comment =
+      RDoc::Comment.new "##\n# :singleton-method:\n# my method\n", @top_level
 
     util_parser "add_my_method :foo, :bar\nadd_my_method :baz"
 
@@ -1334,7 +1164,7 @@ end
     foo = klass.method_list.first
     assert_equal 'foo', foo.name
     assert_equal true, foo.singleton, 'singleton method'
-    assert_equal 'my method', foo.comment
+    assert_equal 'my method', foo.comment.text
     assert_equal @top_level,  foo.file
   end
 
@@ -1342,7 +1172,9 @@ end
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# :singleton-method: woo_hoo!\n# my method\n"
+    comment =
+      RDoc::Comment.new "##\n# :singleton-method: woo_hoo!\n# my method\n",
+                        @top_level
 
     util_parser "add_my_method :foo, :bar\nadd_my_method :baz"
 
@@ -1353,13 +1185,13 @@ end
     foo = klass.method_list.first
     assert_equal 'woo_hoo!', foo.name
     assert_equal true, foo.singleton, 'singleton method'
-    assert_equal 'my method', foo.comment
+    assert_equal 'my method', foo.comment.text
     assert_equal @top_level,  foo.file
   end
 
   def test_parse_meta_method_string_name
     klass = RDoc::NormalClass.new 'Foo'
-    comment = "##\n# my method\n"
+    comment = RDoc::Comment.new "##\n# my method\n", @top_level
 
     util_parser "add_my_method 'foo'"
 
@@ -1369,7 +1201,7 @@ end
 
     foo = klass.method_list.first
     assert_equal 'foo', foo.name
-    assert_equal 'my method', foo.comment
+    assert_equal 'my method', foo.comment.text
     assert_equal @top_level,  foo.file
   end
 
@@ -1378,7 +1210,7 @@ end
     klass.parent = @top_level
     klass.stop_doc
 
-    comment = "##\n# my method\n"
+    comment = RDoc::Comment.new "##\n# my method\n", @top_level
 
     util_parser "add_my_method :foo, :bar\nadd_my_method :baz"
 
@@ -1391,7 +1223,7 @@ end
 
   def test_parse_meta_method_unknown
     klass = RDoc::NormalClass.new 'Foo'
-    comment = "##\n# my method\n"
+    comment = RDoc::Comment.new "##\n# my method\n", @top_level
 
     util_parser "add_my_method ('foo')"
 
@@ -1401,7 +1233,7 @@ end
 
     foo = klass.method_list.first
     assert_equal 'unknown', foo.name
-    assert_equal 'my method', foo.comment
+    assert_equal 'my method', foo.comment.text
     assert_equal @top_level,  foo.file
   end
 
@@ -1409,7 +1241,7 @@ end
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 
-    comment = "##\n# my method\n"
+    comment = RDoc::Comment.new "##\n# my method\n", @top_level
 
     util_parser "def foo() :bar end"
 
@@ -1419,7 +1251,7 @@ end
 
     foo = klass.method_list.first
     assert_equal 'foo',       foo.name
-    assert_equal 'my method', foo.comment
+    assert_equal 'my method', foo.comment.text
     assert_equal @top_level,  foo.file
     assert_equal 0,           foo.offset
     assert_equal 1,           foo.line
@@ -1468,7 +1300,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     assert klass.aliases.empty?
   end
@@ -1478,7 +1310,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method @top_level, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     klass = RDoc::TopLevel.find_class_named 'FalseClass'
 
@@ -1494,7 +1326,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     assert klass.method_list.empty?
   end
@@ -1504,7 +1336,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method @top_level, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     assert @top_level.method_list.empty?
   end
@@ -1517,7 +1349,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     assert_equal 1, klass.method_list.length
   end
@@ -1530,7 +1362,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     assert_equal 1, klass.method_list.length
   end
@@ -1543,7 +1375,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     assert_equal 1, klass.method_list.length
   end
@@ -1553,7 +1385,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method @top_level, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     klass = RDoc::TopLevel.find_class_named 'NilClass'
 
@@ -1569,7 +1401,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     foo = klass.method_list.first
     assert_equal '(arg1, arg2 = {})', foo.params
@@ -1584,7 +1416,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     foo = klass.method_list.first
     assert_equal '(arg1, arg2)', foo.params
@@ -1598,7 +1430,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     foo = klass.method_list.first
     assert_equal '(arg1, arg2, arg3)', foo.params
@@ -1609,7 +1441,7 @@ end
     klass.parent = @top_level
     klass.stop_doc
 
-    comment = "##\n# my method\n"
+    comment = RDoc::Comment.new "##\n# my method\n", @top_level
 
     util_parser "def foo() :bar end"
 
@@ -1627,7 +1459,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     object = RDoc::TopLevel.find_class_named 'Object'
 
@@ -1643,7 +1475,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     object = RDoc::TopLevel.find_class_named 'Object'
 
@@ -1656,7 +1488,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method @top_level, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method @top_level, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     klass = RDoc::TopLevel.find_class_named 'TrueClass'
 
@@ -1677,7 +1509,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     omega = klass.method_list.first
     assert_equal "def \317\211", omega.text
@@ -1695,7 +1527,7 @@ module Foo
 end
     CODE
 
-    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil
 
     foo = @top_level.modules.first
     assert_equal 'Foo', foo.full_name, 'module Foo'
@@ -1706,18 +1538,46 @@ end
   end
 
   def test_parse_statements_class_nested
-    comment = "##\n# my method\n"
+    comment = RDoc::Comment.new "##\n# my method\n", @top_level
 
-    util_parser "module Foo\n#{comment}class Bar\nend\nend"
+    util_parser "module Foo\n#{comment.text}class Bar\nend\nend"
 
-    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL
 
     foo = @top_level.modules.first
     assert_equal 'Foo', foo.full_name, 'module Foo'
 
     bar = foo.classes.first
     assert_equal 'Foo::Bar', bar.full_name, 'class Foo::Bar'
-    assert_equal 'my method', bar.comment
+    assert_equal 'my method', bar.comment.text
+  end
+
+  def test_parse_statements_def_percent_string_pound
+    util_parser "class C\ndef a\n%r{#}\nend\ndef b() end\nend"
+
+    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL
+
+    x = @top_level.classes.first
+
+    assert_equal 2, x.method_list.length
+    a = x.method_list.first
+
+    rt = RDoc::RubyToken
+
+    expected = [
+      rt::TkCOMMENT   .new( 0, 2, 1, "# File #{@filename}, line 2"),
+      rt::TkNL        .new( 0, 0, 0, "\n"),
+      rt::TkSPACE     .new( 0, 1, 1, ""),
+      rt::TkDEF       .new( 8, 2, 0, "def"),
+      rt::TkSPACE     .new(11, 2, 3, " "),
+      rt::TkIDENTIFIER.new(12, 2, 4, "a"),
+      rt::TkNL        .new(13, 2, 5, "\n"),
+      rt::TkDREGEXP   .new(14, 3, 0, "%r{#}"),
+      rt::TkNL        .new(19, 3, 5, "\n"),
+      rt::TkEND       .new(20, 4, 0, "end"),
+    ]
+
+    assert_equal expected, a.token_stream
   end
 
   def test_parse_statements_encoding
@@ -1738,8 +1598,8 @@ end
 
     foo = @top_level.classes.first.method_list.first
     assert_equal 'foo', foo.name
-    assert_equal 'this is my method', foo.comment
-    assert_equal Encoding::CP852, foo.comment.encoding
+    assert_equal 'this is my method', foo.comment.text
+    assert_equal Encoding::CP852, foo.comment.text.encoding
   end
 
   def test_parse_statements_identifier_meta_method
@@ -2220,7 +2080,7 @@ end
 
     tk = @parser.get_tk
 
-    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, @comment
 
     foo = klass.method_list.first
     assert_equal 'nth(i)', foo.block_params
@@ -2255,7 +2115,7 @@ end
   def test_sanity_interpolation_curly
     util_parser '%{ #{} }'
 
-    assert_equal '%{ #{} }', @parser.get_tk.text
+    assert_equal '%Q{ #{} }', @parser.get_tk.text
     assert_equal RDoc::RubyToken::TkNL, @parser.get_tk.class
   end
 
@@ -2312,11 +2172,11 @@ end
 
     foo = @top_level.classes.first
 
-    assert_equal 'Foo comment', foo.comment
+    assert_equal 'Foo comment', foo.comment.text
 
     m = foo.method_list.first
 
-    assert_equal 'm comment', m.comment
+    assert_equal 'm comment', m.comment.text
   end
 
   def test_scan_block_comment_nested # Issue #41
@@ -2338,12 +2198,12 @@ end
     foo = @top_level.modules.first
 
     assert_equal 'Foo', foo.full_name
-    assert_equal 'findmeindoc', foo.comment
+    assert_equal 'findmeindoc', foo.comment.text
 
     bar = foo.classes.first
 
     assert_equal 'Foo::Bar', bar.full_name
-    assert_equal '', bar.comment
+    assert_equal '', bar.comment.text
   end
 
   def test_scan_block_comment_notflush
@@ -2386,11 +2246,11 @@ end
     foo = @top_level.classes.first
 
     assert_equal "= DESCRIPTION\n\nThis is a simple test class\n\n= RUMPUS\n\nIs a silly word",
-      foo.comment
+      foo.comment.text
 
     m = foo.method_list.first
 
-    assert_equal 'A nice girl', m.comment
+    assert_equal 'A nice girl', m.comment.text
   end
 
   def test_scan_meta_method_block
@@ -2415,6 +2275,87 @@ class C
     assert_equal 2, @top_level.classes.first.method_list.length
   end
 
+  def test_scan_markup_override
+    content = <<-CONTENT
+# *awesome*
+class C
+  # :markup: rd
+  # ((*radical*))
+  def m
+  end
+end
+    CONTENT
+
+    util_parser content
+
+    @parser.scan
+
+    c = @top_level.classes.first
+
+    assert_equal 'rdoc', c.comment.format
+
+    assert_equal 'rd', c.method_list.first.comment.format
+  end
+
+  def test_scan_markup_first_comment
+    content = <<-CONTENT
+# :markup: rd
+
+# ((*awesome*))
+class C
+  # ((*radical*))
+  def m
+  end
+end
+    CONTENT
+
+    util_parser content
+
+    @parser.scan
+
+    c = @top_level.classes.first
+
+    assert_equal 'rd', c.comment.format
+
+    assert_equal 'rd', c.method_list.first.comment.format
+  end
+
+  def test_scan_tomdoc_meta
+    util_parser <<-RUBY
+# :markup: tomdoc
+
+class C
+
+  # Signature
+  #
+  #   find_by_<field>[_and_<field>...](args)
+  #
+  # field - A field name.
+
+end
+
+    RUBY
+
+    @parser.scan
+
+    c = @top_level.classes.first
+
+    m = c.method_list.first
+
+    assert_equal "find_by_<field>[_and_<field>...]", m.name
+    assert_equal "find_by_<field>[_and_<field>...](args)\n", m.call_seq
+
+    expected =
+      @RM::Document.new(
+        @RM::Heading.new(3, 'Signature'),
+        @RM::List.new(:NOTE,
+          @RM::ListItem.new('field',
+            @RM::Paragraph.new('A field name.'))))
+    expected.file = @top_level
+
+    assert_equal expected, m.comment.parse
+  end
+
   def test_stopdoc_after_comment
     util_parser <<-EOS
       module Bar
@@ -2433,11 +2374,11 @@ class C
 
     foo = @top_level.modules.first.modules.first
     assert_equal 'Foo', foo.name
-    assert_equal 'hello', foo.comment
+    assert_equal 'hello', foo.comment.text
 
     baz = @top_level.modules.first.classes.first
     assert_equal 'Baz', baz.name
-    assert_equal 'there', baz.comment
+    assert_equal 'there', baz.comment.text
   end
 
   def tk(klass, line, char, name, text)
@@ -2445,9 +2386,9 @@ class C
 
     token = if klass.instance_method(:initialize).arity == 3 then
               raise ArgumentError, "name not used for #{klass}" unless name.nil?
-              klass.new nil, line, char
+              klass.new 0, line, char
             else
-              klass.new nil, line, char, name
+              klass.new 0, line, char, name
             end
 
     token.set_text text