In Files

  • rdoc/parser/rd.rb

Parent

Methods

Included Modules

Class/Module Index [+]

Quicksearch

RDoc::Parser::RD

Parse a RD format file. The parsed RDoc::Markup::Document is attached as a file comment.

Public Instance Methods

scan() click to toggle source

Creates an rd-format TopLevel for the given file.

 
               # File rdoc/parser/rd.rb, line 14
def scan
  comment = RDoc::Comment.new @content, @top_level
  comment.format = 'rd'

  @top_level.comment = comment
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus