Import changes from Ruby trunk

Author: drbrain

lib/rdoc/generator.rb

@@ -7,12 +7,12 @@
 module RDoc::Generator
 
   ##
-  # Name of sub-direcory that holds file descriptions
+  # Name of sub-directory that holds file descriptions
 
   FILE_DIR  = "files"
 
   ##
-  # Name of sub-direcory that holds class descriptions
+  # Name of sub-directory that holds class descriptions
 
   CLASS_DIR = "classes"
 

lib/rdoc/generator/ri.rb

@@ -45,7 +45,7 @@ def generate(toplevels)
   def process_class(from_class)
     generate_class_info(from_class)
 
-    # now recure into this classes constituent classess
+    # now recurse into this class' constituent classes
     from_class.each_classmodule do |mod|
       process_class(mod)
     end

lib/rdoc/known_classes.rb

@@ -23,13 +23,13 @@ module RDoc
     "rb_cProc"             => "Proc",
     "rb_cRange"            => "Range",
     "rb_cRegexp"           => "Regexp",
+    "rb_cRubyVM"           => "RubyVM",
     "rb_cString"           => "String",
     "rb_cStruct"           => "Struct",
     "rb_cSymbol"           => "Symbol",
     "rb_cThread"           => "Thread",
     "rb_cTime"             => "Time",
     "rb_cTrueClass"        => "TrueClass",
-    "rb_cVM"               => "VM",
 
     "rb_eArgError"         => "ArgError",
     "rb_eEOFError"         => "EOFError",

lib/rdoc/markup/fragments.rb

@@ -11,7 +11,7 @@ class Fragment
     attr_reader   :level, :param, :txt
     attr_accessor :type
 
-    ######
+    ##
     # This is a simple factory system that lets us associate fragement
     # types (a string) with a subclass of fragment
 

lib/rdoc/parser/c.rb

@@ -46,10 +46,10 @@
 # method in the HTML output. This method must be in the same source file
 # as the rb_define_method.
 #
-# C classes can be diagramed (see /tc/dl/ruby/ruby/error.c), and RDoc
+# C classes can be diagrammed (see /tc/dl/ruby/ruby/error.c), and RDoc
 # integrates C and Ruby source into one tree
 #
-# The comment blocks may include special direcives:
+# The comment blocks may include special directives:
 #
 # [Document-class: <i>name</i>]
 #   This comment block is documentation for the given class. Use this
@@ -63,7 +63,7 @@
 #   Because C source doesn't give descripive names to Ruby-level parameters,
 #   you need to document the calling sequence explicitly
 #
-# In additon, RDoc assumes by default that the C method implementing a
+# In addition, RDoc assumes by default that the C method implementing a
 # Ruby function is in the same source file as the rb_define_method call.
 # If this isn't the case, add the comment:
 #

lib/rdoc/parser/f95.rb

@@ -196,7 +196,7 @@ def set_text(text)
   EXTERNAL_ALIAS_MES = "The entity is"
 
   ##
-  # devine code constructs
+  # Define code constructs
 
   def scan
     # remove private comment
@@ -1062,7 +1062,7 @@ def collect_first_comment(body)
   # If "all" argument is true, information of all arguments are returned.
   #
   # If "modified_params" is true, list of arguments are decorated, for
-  # exameple, optional arguments are parenthetic as "[arg]".
+  # example, optional arguments are parenthetic as "[arg]".
 
   def find_arguments(args, text, all=nil, indent=nil, modified_params=nil)
     return unless args || all
@@ -1140,7 +1140,7 @@ def find_namelists(text, before_contains=nil)
   end
 
   ##
-  # Comments just after module or subprogram, or arguments are returnd. If
+  # Comments just after module or subprogram, or arguments are returned. If
   # "COMMENTS_ARE_UPPER" is true, comments just before modules or subprograms
   # are returnd
 

lib/rdoc/parser/ruby.rb

@@ -2,7 +2,7 @@
 # This file contains stuff stolen outright from:
 #
 #   rtags.rb -
-#   ruby-lex.rb - ruby lexcal analizer
+#   ruby-lex.rb - ruby lexcal analyzer
 #   ruby-token.rb - ruby tokens
 #       by Keiju ISHITSUKA (Nippon Rational Inc.)
 #
@@ -1491,20 +1491,27 @@ def collect_first_comment
     tk = get_tk
 
     while TkCOMMENT === tk
-      if first_line && tk.text[0,2] == "#!"
+      if first_line and tk.text =~ /\A#!/ then
+        skip_tkspace
+        tk = get_tk
+      elsif first_line and tk.text =~ /\A#\s*-\*-/ =~ tk.text then
+        first_line = false
         skip_tkspace
         tk = get_tk
       else
+        first_line = false
         res << tk.text << "\n"
         tk = get_tk
+
         if TkNL === tk then
-          skip_tkspace(false)
+          skip_tkspace false
           tk = get_tk
         end
       end
-      first_line = false
     end
-    unget_tk(tk)
+
+    unget_tk tk
+
     res
   end
 

test/test_rdoc_parser_c.rb

@@ -25,7 +25,7 @@ def setup
   end
 
   def teardown
-    @tempfile.unlink
+    @tempfile.close
   end
 
   def test_do_classes_boot_class