kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

* lib/rdoc: Import RDoc 3.9.4. Typo and grammar fixes by Luke Gruber.

Browse source 
[Ruby 1.9 - Bug #5203]


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@33088 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
drbrain 2011-08-26 23:45:41 +00:00
parent 164c7dc574
commit 80d6bf2291
4 changed files with 22 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

21
lib/rdoc/parser.rb
View file

@ -4,9 +4,9 @@ require 'rdoc/markup/pre_process'
require 'rdoc/stats'
##
# A parser is simple a class that implements
# A parser is a class that subclasses RDoc::Parser and implements
#
# #initialize(file_name, body, options)
# #initialize top_level, file_name, body, options, stats
#
# and
#
@ -16,17 +16,16 @@ require 'rdoc/stats'
# and an RDoc::Options object. The scan method is then called to return an
# appropriately parsed TopLevel code object.
#
# The ParseFactory is used to redirect to the correct parser given a
# filename extension. This magic works because individual parsers have to
# register themselves with us as they are loaded in. The do this using the
# following incantation
# RDoc::Parser::for is a factory that creates the correct parser for a
# given filename extension. Parsers have to register themselves RDoc::Parser
# using parse_files_matching as when they are loaded:
#
# require "rdoc/parser"
#
# class RDoc::Parser::Xyz < RDoc::Parser
# parse_files_matching /\.xyz$/ # <<<<
#
# def initialize(file_name, body, options)
# def initialize top_level, file_name, body, options, stats
# ...
# end
#
@ -35,8 +34,8 @@ require 'rdoc/stats'
# end
# end
#
# Just to make life interesting, if we suspect a plain text file, we also
# look for a shebang line just in case it's a potential shell script
# If a plain text file is detected, RDoc also looks for a shebang line in case
# the file is a shell script.
class RDoc::Parser
@ -45,8 +44,8 @@ class RDoc::Parser
class << self
##
# A Hash that maps file extensions regular expressions to parsers that
# will consume them.
# An Array of arrays that maps file extension (or name) regular
# expressions to parser classes that will parse matching filenames.
#
# Use parse_files_matching to register a parser's file extensions.