In Files

  • rdoc/parser/simple.rb


Class/Module Index [+]



Parse a non-source file. We basically take the whole thing as one big comment. If the first character in the file is ‘#’, we strip leading pound signs.

Public Class Methods

new(top_level, file_name, content, options, stats) click to toggle source

Prepare to parse a plain file

               # File rdoc/parser/simple.rb, line 15
def initialize(top_level, file_name, content, options, stats)

  preprocess = @file_name, @options.rdoc_include

  preprocess.handle @content do |directive, param|
    warn "Unrecognized directive '#{directive}' in #{@file_name}"

Public Instance Methods

remove_private_comments(comment) click to toggle source
               # File rdoc/parser/simple.rb, line 33
def remove_private_comments(comment)
  comment.gsub(/^--\n.*?^\+\+/m, '').sub(/^--\n.*/m, '')
scan() click to toggle source

Extract the file contents and attach them to the toplevel as a comment

               # File rdoc/parser/simple.rb, line 28
def scan
  @top_level.comment = remove_private_comments(@content)

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