method

parse

Ruby latest stable (v2_5_5) - 0 notes - Class: RDoc::ClassModule

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

parse(comment_location) public

Parses comment_location into an RDoc::Markup::Document composed of multiple RDoc::Markup::Documents with their file set.

Show source

# File lib/rdoc/class_module.rb, line 587
  def parse comment_location
    case comment_location
    when String then
      super
    when Array then
      docs = comment_location.map do |comment, location|
        doc = super comment
        doc.file = location
        doc
      end

      RDoc::Markup::Document.new(*docs)
    when RDoc::Comment then
      doc = super comment_location.text, comment_location.format
      doc.file = comment_location.location
      doc
    when RDoc::Markup::Document then
      return comment_location
    else
      raise ArgumentError, "unknown comment class #{comment_location.class}"
    end
  end

parse

Related methods