lib/rdoc/parsers/parse_simple.rb

   1 require 'rdoc'
   2 require 'rdoc/code_objects'
   3 require 'rdoc/markup/preprocess'
   4
   5 ##
   6 # Parse a non-source file. We basically take the whole thing as one big
   7 # comment. If the first character in the file is '#', we strip leading pound
   8 # signs.
   9
  10 class RDoc::SimpleParser
  11
  12   ##
  13   # Prepare to parse a plain file
  14
  15   def initialize(top_level, file_name, body, options, stats)
  16     preprocess = RDoc::Markup::PreProcess.new(file_name, options.rdoc_include)
  17
  18     preprocess.handle(body) do |directive, param|
  19       warn "Unrecognized directive '#{directive}' in #{file_name}"
  20     end
  21
  22     @body = body
  23     @options = options
  24     @top_level = top_level
  25   end
  26
  27   ##
  28   # Extract the file contents and attach them to the toplevel as a comment
  29
  30   def scan
  31     @top_level.comment = remove_private_comments(@body)
  32     @top_level
  33   end
  34
  35   def remove_private_comments(comment)
  36     comment.gsub(/^--[^-].*?^\+\+/m, '').sub(/^--.*/m, '')
  37   end
  38
  39 end
  40