rdoc 3.5 → 3.5.1

data/History.txt

@@ -1,3 +1,10 @@
+=== 3.5.1
+
+* Bug fixes
+  * Fixed some typos.  Pull request #13 by R.T. Lechow.
+  * Ensure an RDoc::Stats is created in #parse_files.  Fixes documentation for
+    railties which has no files.  Reported by Aaron Patterson
+
 === 3.5 / 2010-01-29
 
 * Minor enhancements

data/Rakefile

@@ -15,8 +15,9 @@ Hoe.spec 'rdoc' do
   developer 'Phil Hagelberg', 'technomancy@gmail.com'
   developer 'Tony Strauss', 'tony.strauss@designingpatterns.com'
 
-  self.remote_rdoc_dir = ''
   self.rsync_args = '-avz'
+  rdoc_locations << 'drbrain@rubyforge.org:/var/www/gforge-projects/rdoc/'
+
   self.testlib = :minitest
   self.isolate_dir = 'tmp/isolate'
 

data/lib/rdoc.rb

@@ -95,7 +95,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '3.5'
+  VERSION = '3.5.1'
 
   ##
   # Method visibilities

data/lib/rdoc/class_module.rb

@@ -151,7 +151,7 @@ class RDoc::ClassModule < RDoc::Context
   end
 
   ##
-  # Finds a class or module with +name+ in this namespace or its descendents
+  # Finds a class or module with +name+ in this namespace or its descendants
 
   def find_class_named name
     return self if full_name == name
@@ -308,7 +308,7 @@ class RDoc::ClassModule < RDoc::Context
   ##
   # Name to use to generate the url:
   # modules and classes that are aliases for another
-  # module or classe return the name of the latter.
+  # module or class return the name of the latter.
 
   def name_for_path
     is_alias_for ? is_alias_for.full_name : full_name

data/lib/rdoc/generator.rb

@@ -22,7 +22,7 @@ require 'rdoc'
 # use RDoc::Options#option_parser to add command-line options to the +rdoc+
 # tool.  See OptionParser for details on how to add options.
 #
-# You can extend the RDoc::Options instance with additional accesors for your
+# You can extend the RDoc::Options instance with additional accessors for your
 # generator.
 #
 # = Generator Instantiation

data/lib/rdoc/markup.rb

@@ -483,7 +483,7 @@ require 'rdoc'
 # [+:include:+ _filename_]
 #   Include the contents of the named file at this point. This directive
 #   must appear alone on one line, possibly preceded by spaces. In this
-#   position, it can be escapd with a \ in front of the first colon.
+#   position, it can be escaped with a \ in front of the first colon.
 #
 #   The file will be searched for in the directories listed by the +--include+
 #   option, or in the current directory by default.  The contents of the file

data/lib/rdoc/markup/heading.rb

@@ -4,7 +4,7 @@
 class RDoc::Markup::Heading < Struct.new :level, :text
 
   ##
-  # Calls #accept_heading on +wisitor+
+  # Calls #accept_heading on +visitor+
 
   def accept visitor
     visitor.accept_heading self

data/lib/rdoc/markup/inline.rb

@@ -29,7 +29,7 @@ class RDoc::Markup
     end
 
     ##
-    # Returns a string reperesentation of +bitmap+
+    # Returns a string representation of +bitmap+
 
     def self.as_string(bitmap)
       return "none" if bitmap.zero?

data/lib/rdoc/markup/parser.rb

@@ -321,7 +321,7 @@ class RDoc::Markup::Parser
         next
       end
 
-      # indentation change: break or verbattim
+      # indentation change: break or verbatim
       if column < indent then
         unget
         break

data/lib/rdoc/markup/to_html.rb

@@ -130,7 +130,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   end
 
   ##
-  # Here's a hypedlink where the label is different to the URL
+  # Here's a hyperlink where the label is different to the URL
   # <label>[url] or {long label}[url]
 
   def handle_special_TIDYLINK(special)

data/lib/rdoc/markup/to_html_crossref.rb

@@ -34,10 +34,10 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
                       # A::B::C.meth
                       #{CLASS_REGEXP_STR}(?:[.#]|::)#{METHOD_REGEXP_STR}
 
-                      # Stand-alone method (preceeded by a #)
+                      # Stand-alone method (preceded by a #)
                       | \\?\##{METHOD_REGEXP_STR}
 
-                      # Stand-alone method (preceeded by ::)
+                      # Stand-alone method (preceded by ::)
                       | ::#{METHOD_REGEXP_STR}
 
                       # A::B::C
@@ -51,7 +51,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
                       # In order that words like "can't" not
                       # be flagged as potential cross-references, only
                       # flag potential class cross-references if the character
-                      # after the cross-referece is a space, sentence
+                      # after the cross-reference is a space, sentence
                       # punctuation, tag start character, or attribute
                       # marker.
                       | #{CLASS_REGEXP_STR}(?=[\s\)\.\?\!\,\;<\000]|\z)

data/lib/rdoc/markup/to_rdoc.rb

@@ -217,7 +217,7 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   end
 
   ##
-  # Removes preceeding \\ from the suppressed crossref +special+
+  # Removes preceding \\ from the suppressed crossref +special+
 
   def handle_special_SUPPRESSED_CROSSREF special
     text = special.text

data/lib/rdoc/parser.rb

@@ -45,7 +45,7 @@ class RDoc::Parser
   class << self
 
     ##
-    # A Hash that maps file exetensions regular expressions to parsers that
+    # A Hash that maps file extensions regular expressions to parsers that
     # will consume them.
     #
     # Use parse_files_matching to register a parser's file extensions.

data/lib/rdoc/parser/c.rb

@@ -71,7 +71,7 @@ require 'rdoc/known_classes'
 #   Documentation for the named attribute.
 #
 # [call-seq:  <i>text up to an empty line</i>]
-#   Because C source doesn't give descripive names to Ruby-level parameters,
+#   Because C source doesn't give descriptive names to Ruby-level parameters,
 #   you need to document the calling sequence explicitly
 #
 # In addition, RDoc assumes by default that the C method implementing a

data/lib/rdoc/rdoc.rb

@@ -354,12 +354,12 @@ The internal error was:
 
   def parse_files files
     file_list = gather_files files
+    @stats = RDoc::Stats.new file_list.size, @options.verbosity
 
     return [] if file_list.empty?
 
     file_info = []
 
-    @stats = RDoc::Stats.new file_list.size, @options.verbosity
     @stats.begin_adding
 
     file_info = file_list.map do |filename|

data/lib/rdoc/stats.rb

@@ -411,7 +411,7 @@ class RDoc::Stats
   end
 
   ##
-  # Determines which parametecs in +method+ were not documented.  Returns a
+  # Determines which parameters in +method+ were not documented.  Returns a
   # total parameter count and an Array of undocumented methods.
 
   def undoc_params method

data/test/test_rdoc_options.rb

@@ -17,7 +17,7 @@ class TestRDocOptions < MiniTest::Unit::TestCase
   end
 
   def test_check_files
-    skip "assumes UNIX permition model" if /mswin|mingw/ =~ RUBY_PLATFORM
+    skip "assumes UNIX permission model" if /mswin|mingw/ =~ RUBY_PLATFORM
     out, err = capture_io do
       Dir.mktmpdir do |dir|
         Dir.chdir dir do

data/test/test_rdoc_parser_ruby.rb

@@ -1144,7 +1144,7 @@ EOF
 
     content = <<-CONTENT
 inline(:my_method) do |*args|
-  "this method is causes z to disapear"
+  "this method causes z to disappear"
 end
     CONTENT
 
@@ -1986,7 +1986,7 @@ class C
   #  my method
 
   inline(:my_method) do |*args|
-    "this method used to cause z to disapear"
+    "this method used to cause z to disappear"
   end
 
   def z

data/test/test_rdoc_rdoc.rb

@@ -47,7 +47,7 @@ class TestRDocRDoc < MiniTest::Unit::TestCase
     assert_empty files
   end
 
-  def test_remove_unparsable
+  def test_remove_unparseable
     file_list = %w[
       blah.class
       blah.eps

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 17
   prerelease: 
   segments: 
   - 3
   - 5
-  version: "3.5"
+  - 1
+  version: 3.5.1
 platform: ruby
 authors: 
 - Eric Hodel
@@ -38,7 +39,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2011-01-29 00:00:00 -08:00
+date: 2011-01-30 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency