method

remove_private_comment

ruby latest stable - Class: RDoc::Parser::Simple

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.

# 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

Method deprecated or moved

Related methods