lib/rdoc/parser/simple.rb

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