rdoc.rb in erbook-7.1.0

- old
+ new

@@ -1,35 +1,43 @@
 # Workaround for `rdoc --fmt xml` not dumping information about methods.
 #--
-# Copyright 2008 Suraj N. Kurapati
-# See the LICENSE file for details.
+# Copyright protects this work.
+# See LICENSE file for details.
 #++
 
 require 'rubygems'
 gem 'rdoc', '>= 2.4.3', '< 2.5'
 require 'rdoc/rdoc'
 
 module RDoc
   class TopLevel
+    ##
     # Returns an array of all classes recorded thus far.
+    #
     def self.all_classes
       @all_classes.values
     end
 
+    ##
     # Returns an array of all modules recorded thus far.
+    #
     def self.all_modules
       @all_modules.values
     end
 
+    ##
     # Returns an array of RDoc::AnyMethod objects
     # representing all methods recorded thus far.
+    #
     def self.all_methods
       all_classes_and_modules.map {|c| c.method_list }.flatten
     end
 
+    ##
     # Update the return value of the all_classes_and_modules() method
     # to *really* include every class and every module seen thus far.
+    #
     def self.refresh_all_classes_and_modules
       visit = lambda do |node|
         if node.is_a? NormalClass or node.is_a? SingleClass
           @all_classes[node.full_name] = node
 
@@ -41,71 +49,85 @@
       end
 
       all_classes_and_modules.each {|n| visit[n] }
     end
 
+    ##
     # Returns a RDoc::TopLevel object containing information
     # parsed from the given code string.  This information is
     # also added to the global TopLevel class state, so you can
     # access it via the class methods of the TopLevel class.
     #
     # If the file name (which signifies the origin
     # of the given code) is given, it MUST have a
     # ".c" or ".rb" file extension.  Otherwise,
     # RDoc will ignore the given code string!  :-(
     #
-    def self.parse aCodeString, aFileName = __FILE__
-      tl = TopLevel.new(aFileName)
+    def self.parse code_string, file_name = __FILE__
+      tl = TopLevel.new(file_name)
       op = DummyOptions.new
       st = Stats.new(0)
 
-      result = Parser.for(tl, aFileName, aCodeString, op, st).scan
+      result = Parser.for(tl, file_name, code_string, op, st).scan
 
       refresh_all_classes_and_modules
 
       result
     end
 
+    ##
     # Returns a RDoc::TopLevel object containing information
     # parsed from the code in the given file.  This information
     # is also added to the global TopLevel class state, so you
     # can access it via the class methods of the TopLevel class.
     #
     # The given file name MUST have a ".c" or ".rb" file
     # extension.  Otherwise, RDoc will ignore the file!  :-(
     #
-    def self.parse_file aFileName
-      parse File.read(aFileName), aFileName
+    def self.parse_file file_name
+      parse File.read(file_name), file_name
     end
   end
 
   class AnyMethod
+    ##
     # Returns the fully qualified name of this method.
+    #
     def full_name
       [parent.full_name, name].join(singleton ? '::' : '#')
     end
 
+    ##
     # Returns a complete method declaration with block parameters and all.
+    #
     def decl
       a = params.dup
+
       if b = block_params
         a.sub! %r/\s*\#.*(?=.$)/, '' # remove "# :yields: ..." string
         a << " {|#{b}| ... }"
       end
+
       full_name << a
     end
 
+    ##
     # Returns a HTML version of this method's comment.
+    #
     def comment_html
       DummyMarkup.new.markup comment
     end
 
+    ##
     # Returns the RDoc::TopLevel object which contains this method.
+    #
     def top_level
       n = parent
+
       while n && n.parent
         n = n.parent
       end
+
       n
     end
   end
 
   private