diff options
author | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-12-04 05:38:17 +0000 |
---|---|---|
committer | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-12-04 05:38:17 +0000 |
commit | 5d8d9754340ae05e596310a951ec3f6f74bb4a07 (patch) | |
tree | 90c49a7df5a3563647243421a3528b50c5eaa02d /lib/rdoc/code_objects.rb | |
parent | 405a50a5948fecb6ba44efb250a86052f4a406c8 (diff) |
Ignore leading and trailing lines in :section: blocks
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@7455 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rdoc/code_objects.rb')
-rw-r--r-- | lib/rdoc/code_objects.rb | 32 |
1 files changed, 29 insertions, 3 deletions
diff --git a/lib/rdoc/code_objects.rb b/lib/rdoc/code_objects.rb index 134ac398e9..d6c4f1bdb9 100644 --- a/lib/rdoc/code_objects.rb +++ b/lib/rdoc/code_objects.rb @@ -126,10 +126,36 @@ module RDoc @title = title @@sequence.succ! @sequence = @@sequence.dup - if comment - @comment = comment.sub(/.*$/, '') - @comment = nil if @comment.empty? + set_comment(comment) + end + + private + + # Set the comment for this section from the original comment block + # If the first line contains :section:, strip it and use the rest. Otherwise + # remove lines up to the line containing :section:, and look for + # those lines again at the end and remove them. This lets us write + # + # # --------------------- + # # :SECTION: The title + # # The body + # # --------------------- + + def set_comment(comment) + return unless comment + + if comment =~ /^.*?:section:.*$/ + start = $` + rest = $' + if start.empty? + @comment = rest + else + @comment = rest.sub(/#{start.chomp}\Z/, '') + end + else + @comment = comment end + @comment = nil if @comment.empty? end end |