Parse a non-source file. We basically take the whole thing as one big comment.
Methods
Included Modules
Class Public methods
new(top_level, file_name, content, options, stats)
Link
Prepare to parse a plain file
Instance Public methods
remove_coding_comment(text)
Link
Removes the encoding magic comment from text
remove_private_comment(comment)
Link
Removes private comments.
Unlike RDoc::Comment#remove_private this implementation only looks for two dashes at the beginning of the line. Three or more dashes are considered to be a rule and ignored.
# File lib/rdoc/parser/simple.rb, line 51 def remove_private_comment comment # Workaround for gsub encoding for Ruby 1.9.2 and earlier empty = '' empty.force_encoding comment.encoding if Object.const_defined? :Encoding comment = comment.gsub(%r^--\n.*?^\+\+\n?%m, empty) comment.sub(%r^--\n.*%m, empty) end
scan()
Link
Extract the file contents and attach them to the TopLevel as a comment