Extended maintenance of Ruby 1.9.3 ended on February 23, 2015. Read more
Parse a non-source file. We basically take the whole thing as one big comment.
Prepare to parse a plain file
# File rdoc/parser/simple.rb, line 14 def initialize(top_level, file_name, content, options, stats) super preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include preprocess.handle @content, @top_level end
Removes the encoding magic comment from text
# File rdoc/parser/simple.rb, line 44 def remove_coding_comment text text.sub(/\A# .*coding[=:].*$/, '') end
Removes comments wrapped in --/++
# File rdoc/parser/simple.rb, line 37 def remove_private_comments text text.gsub(/^--\n.*?^\+\+/m, '').sub(/^--\n.*/m, '') end
Extract the file contents and attach them to the TopLevel as a comment
# File rdoc/parser/simple.rb, line 25 def scan comment = remove_coding_comment @content comment = remove_private_comments comment @top_level.comment = comment @top_level.parser = self.class @top_level 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.