method

set_comment

v1_9_1_378 - Show latest stable - 0 notes - Class: RDoc::Context::Section

1_8_6_287 (0)
1_8_7_72 (0)
1_8_7_330 (0)
1_9_1_378 (38)
1_9_2_180 (-3)
1_9_3_125
1_9_3_392
2_1_10
2_2_9
2_4_6
2_5_5
2_6_3
What's this?

set_comment(comment) public

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
# ---------------------

Show source

# File lib/rdoc/code_objects.rb, line 171
      def set_comment(comment)
        return unless comment

        if comment =~ /^#[ \t]*:section:.*\n/
          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

set_comment

Related methods

Flowdock - Team Inbox With Chat for Software Developers