summaryrefslogtreecommitdiff
path: root/lib/rdoc/parsers/parse_simple.rb
blob: f4b501fe93bed17c02a71abfbd489a15be2b8c04 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
require 'rdoc'
require 'rdoc/code_objects'
require 'rdoc/markup/preprocess'

##
# 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.

class RDoc::SimpleParser

  ##
  # Prepare to parse a plain file

  def initialize(top_level, file_name, body, options, stats)
    preprocess = RDoc::Markup::PreProcess.new(file_name, options.rdoc_include)

    preprocess.handle(body) do |directive, param|
      warn "Unrecognized directive '#{directive}' in #{file_name}"
    end

    @body = body
    @options = options
    @top_level = top_level
  end

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

  def scan
    @top_level.comment = remove_private_comments(@body)
    @top_level
  end

  def remove_private_comments(comment)
    comment.gsub(/^--[^-].*?^\+\+/m, '').sub(/^--.*/m, '')
  end

end