method

remove_private_comment

Ruby latest stable (v2_5_5) - 0 notes - Class: Simple

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

Method deprecated or moved

This method is deprecated or moved on the latest stable version. The last existing version (v2_2_9) is shown here.

remove_private_comment(comment) public

Removes private comments.

Unlike RDoc::Comment#remove_private this implementation only looks for two dashes at the beginning of the line. Three or more dashes are considered to be a rule and ignored.

Show source

# File lib/rdoc/parser/simple.rb, line 51
  def remove_private_comment comment
    # Workaround for gsub encoding for Ruby 1.9.2 and earlier
    empty = ''
    empty.force_encoding comment.encoding if Object.const_defined? :Encoding

    comment = comment.gsub(%^--\n.*?^\+\+\n?%, empty)
    comment.sub(%^--\n.*%, empty)
  end

remove_private_comment

Related methods

Method deprecated or moved