Class: RDoc::Parser::Simple

Inherits:
RDoc::Parser show all
Defined in:
lib/rdoc/parser/simple.rb

Overview

Parse a non-source file. We basically take the whole thing as one big comment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RDoc::Parser

alias_extension, binary?, can_parse, for, parse_files_matching, process_directive, zip?

Constructor Details

#initialize(top_level, file_name, content, options, stats) ⇒ Simple

Prepare to parse a plain file



14
15
16
17
18
19
20
 
# File 'lib/rdoc/parser/simple.rb', line 14

def initialize(top_level, file_name, content, options, stats)
  super

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

  preprocess.handle @content, @top_level
end

Instance Attribute Details

#content ⇒ Object (readonly)

:nodoc:



9
10
11
 
# File 'lib/rdoc/parser/simple.rb', line 9

def content
  @content
end

Instance Method Details

#remove_coding_comment(text) ⇒ Object

Removes the encoding magic comment from text



44
45
46
 
# File 'lib/rdoc/parser/simple.rb', line 44

def remove_coding_comment text
  text.sub(/\A# .*coding[=:].*$/, '')
end

#remove_private_comments(text) ⇒ Object

Removes comments wrapped in --/++



37
38
39
 
# File 'lib/rdoc/parser/simple.rb', line 37

def remove_private_comments text
  text.gsub(/^--\n.*?^\+\+/m, '').sub(/^--\n.*/m, '')
end

#scan ⇒ Object

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



25
26
27
28
29
30
31
32
 
# File 'lib/rdoc/parser/simple.rb', line 25

def scan
  comment = remove_coding_comment @content
  comment = remove_private_comments comment

  @top_level.comment = comment
  @top_level.parser = self.class
  @top_level
end