Permalink
Browse files

* backport r33087 from trunk

* lib/rdoc:  Import RDoc 3.9.4.  Typo and grammar fixes by Luke Gruber.
  [Ruby 1.9 - Bug #5203]


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_9_3@33091 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
  • Loading branch information...
1 parent 8b2a8e2 commit 33839f671119bb5e2e7d6e09d5cec838d3404df9 @drbrain drbrain committed Aug 26, 2011
Showing with 25 additions and 19 deletions.
  1. +7 −0 ChangeLog
  2. +1 −1 NEWS
  3. +1 −1 lib/rdoc.rb
  4. +6 −6 lib/rdoc/markup.rb
  5. +10 −11 lib/rdoc/parser.rb
View
@@ -1,3 +1,10 @@
+Sat Aug 27 08:44:58 2011 Eric Hodel <drbrain@segment7.net>
+
+ * backport r33087 from trunk
+
+ * lib/rdoc: Import RDoc 3.9.4. Typo and grammar fixes by Luke Gruber.
+ [Ruby 1.9 - Bug #5203]
+
Sat Aug 27 07:53:34 2011 Eric Hodel <drbrain@segment7.net>
* backport r33087 from trunk.
View
2 NEWS
@@ -258,7 +258,7 @@ with all sufficient information, see the ChangeLog file.
https://github.com/jimweirich/rake/blob/master/CHANGES
* RDoc
- * RDoc has been upgraded to version 3.9.2. For full release notes see
+ * RDoc has been upgraded to version 3.9.4. For full release notes see
http://docs.seattlerb.org/rdoc/History_txt.html
* rexml
View
@@ -104,7 +104,7 @@ def self.const_missing const_name # :nodoc:
##
# RDoc version you are using
- VERSION = '3.9.3'
+ VERSION = '3.9.4'
##
# Method visibilities
View
@@ -36,7 +36,7 @@
# sequences, and to add special processing for text that matches a
# regular expression. Here we make WikiWords significant to the parser,
# and also make the sequences {word} and \<no>text...</no> signify
-# strike-through text. When then subclass the HTML output class to deal
+# strike-through text. We then subclass the HTML output class to deal
# with these:
#
# require 'rdoc/markup'
@@ -61,7 +61,7 @@
#
# == Encoding
#
-# Where Encoding support is available RDoc will automatically convert all
+# Where Encoding support is available, RDoc will automatically convert all
# documents to the same output encoding. The output encoding can be set via
# RDoc::Options#encoding and defaults to Encoding.default_external.
#
@@ -127,7 +127,7 @@
# === Simple Lists
#
# If a paragraph starts with a "*", "-", "<digit>." or "<letter>.",
-# then it is taken to be the start of a list. The margin in increased to be
+# then it is taken to be the start of a list. The margin is increased to be
# the first non-space following the list start flag. Subsequent lines
# should be indented to this new margin until the list ends. For example:
#
@@ -444,10 +444,10 @@
#
# [+:nodoc:+ / <tt>:nodoc: all</tt>]
# This directive prevents documentation for the element from
-# being generated. For classes and modules, the methods, aliases,
+# being generated. For classes and modules, methods, aliases,
# constants, and attributes directly within the affected class or
# module also will be omitted. By default, though, modules and
-# classes within that class of module _will_ be documented. This is
+# classes within that class or module _will_ be documented. This is
# turned off by adding the +all+ modifier.
#
# module MyModule # :nodoc:
@@ -591,7 +591,7 @@ class RDoc::Markup
attr_reader :attribute_manager
##
- # Take a block of text and use various heuristics to determine it's
+ # Take a block of text and use various heuristics to determine its
# structure (paragraphs, lists, and so on). Invoke an event handler as we
# identify significant chunks.
View
@@ -4,9 +4,9 @@
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 @@
# 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 @@
# 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.

0 comments on commit 33839f6

Please sign in to comment.