mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
[ruby/rdoc] ClassModule#add_comment should receive RDoc::Comment
https://github.com/ruby/rdoc/commit/3fb03bf399
This commit is contained in:
parent
95aa60f6cd
commit
f7cbbc7074
3 changed files with 18 additions and 10 deletions
|
@ -210,7 +210,7 @@ class RDoc::ClassModule < RDoc::Context
|
|||
normalize_comment comment
|
||||
end
|
||||
|
||||
comment = "#{@comment}\n---\n#{comment}" unless @comment.empty?
|
||||
comment = "#{@comment.to_s}\n---\n#{comment.to_s}" unless @comment.empty?
|
||||
|
||||
super comment
|
||||
end
|
||||
|
|
|
@ -33,6 +33,11 @@ class RDoc::Comment
|
|||
|
||||
attr_reader :text
|
||||
|
||||
##
|
||||
# Alias for text
|
||||
|
||||
alias to_s text
|
||||
|
||||
##
|
||||
# Overrides the content returned by #parse. Use when there is no #text
|
||||
# source for this comment
|
||||
|
|
|
@ -9,21 +9,24 @@ class TestRDocClassModule < XrefTestCase
|
|||
tl3 = @store.add_file 'three.rb'
|
||||
|
||||
cm = RDoc::ClassModule.new 'Klass'
|
||||
cm.add_comment '# comment 1', tl1
|
||||
comment_tl1 = RDoc::Comment.new('# comment 1')
|
||||
cm.add_comment comment_tl1, tl1
|
||||
|
||||
assert_equal [['comment 1', tl1]], cm.comment_location
|
||||
assert_equal 'comment 1', cm.comment
|
||||
assert_equal [[comment_tl1, tl1]], cm.comment_location
|
||||
assert_equal 'comment 1', cm.comment.text
|
||||
|
||||
cm.add_comment '# comment 2', tl2
|
||||
comment_tl2 = RDoc::Comment.new('# comment 2')
|
||||
cm.add_comment comment_tl2, tl2
|
||||
|
||||
assert_equal [['comment 1', tl1], ['comment 2', tl2]], cm.comment_location
|
||||
assert_equal [[comment_tl1, tl1], [comment_tl2, tl2]], cm.comment_location
|
||||
assert_equal "comment 1\n---\ncomment 2", cm.comment
|
||||
|
||||
cm.add_comment "# * comment 3", tl3
|
||||
comment_tl3 = RDoc::Comment.new('# * comment 3')
|
||||
cm.add_comment comment_tl3, tl3
|
||||
|
||||
assert_equal [['comment 1', tl1],
|
||||
['comment 2', tl2],
|
||||
['* comment 3', tl3]], cm.comment_location
|
||||
assert_equal [[comment_tl1, tl1],
|
||||
[comment_tl2, tl2],
|
||||
[comment_tl3, tl3]], cm.comment_location
|
||||
assert_equal "comment 1\n---\ncomment 2\n---\n* comment 3", cm.comment
|
||||
end
|
||||
|
||||
|
|
Loading…
Reference in a new issue