In Files

  • rdoc/parser/simple.rb

Files

Class/Module Index [+]

Quicksearch

RDoc::Parser::Simple

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)
  super

  preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include

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

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, '')
end
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)
  @top_level
end