From 1c279a7d2753949c725754e1302f791b76358114 Mon Sep 17 00:00:00 2001
From: drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Tue, 27 Nov 2012 04:28:14 +0000
Subject: * lib/rdoc*:  Updated to RDoc 4.0 (pre-release) * bin/rdoc:  ditto *
 test/rdoc:  ditto * NEWS:  Updated with RDoc 4.0 information

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@37889 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 lib/rdoc/generator.rb | 32 +++++++++++++++++++++-----------
 1 file changed, 21 insertions(+), 11 deletions(-)

(limited to 'lib/rdoc/generator.rb')

diff --git a/lib/rdoc/generator.rb b/lib/rdoc/generator.rb
index 2fa891f533..9051f8a658 100644
--- a/lib/rdoc/generator.rb
+++ b/lib/rdoc/generator.rb
@@ -1,12 +1,10 @@
-require 'rdoc'
-
 ##
 # RDoc uses generators to turn parsed source code in the form of an
 # RDoc::CodeObject tree into some form of output.  RDoc comes with the HTML
 # generator RDoc::Generator::Darkfish and an ri data generator
 # RDoc::Generator::RI.
 #
-# = Registering a Generator
+# == Registering a Generator
 #
 # Generators are registered by calling RDoc::RDoc.add_generator with the class
 # of the generator:
@@ -15,26 +13,38 @@ require 'rdoc'
 #     RDoc::RDoc.add_generator self
 #   end
 #
-# = Adding Options to +rdoc+
+# == Adding Options to +rdoc+
 #
 # Before option processing in +rdoc+, RDoc::Options will call ::setup_options
 # on the generator class with an RDoc::Options instance.  The generator can
 # use RDoc::Options#option_parser to add command-line options to the +rdoc+
-# tool.  See OptionParser for details on how to add options.
+# tool.  See RDoc::Options@Custom+Options for an example and see OptionParser
+# for details on how to add options.
 #
 # You can extend the RDoc::Options instance with additional accessors for your
 # generator.
 #
-# = Generator Instantiation
+# == Generator Instantiation
 #
 # After parsing, RDoc::RDoc will instantiate a generator by calling
-# #initialize with an RDoc::Options instance.
+# #initialize with an RDoc::Store instance and an RDoc::Options instance.
+#
+# The RDoc::Store instance holds documentation for parsed source code.  In
+# RDoc 3 and earlier the RDoc::TopLevel class held this data.  When upgrading
+# a generator from RDoc 3 and earlier you should only need to replace
+# RDoc::TopLevel with the store instance.
 #
-# RDoc will then call #generate on the generator instance and pass in an Array
-# of RDoc::TopLevel instances, each representing a parsed file.  You can use
-# the various class methods on RDoc::TopLevel and in the RDoc::CodeObject tree
-# to create your desired output format.
+# RDoc will then call #generate on the generator instance.  You can use the
+# various methods on RDoc::Store and in the RDoc::CodeObject tree to create
+# your desired output format.
 
 module RDoc::Generator
+
+  autoload :Markup,   'rdoc/generator/markup'
+
+  autoload :Darkfish,  'rdoc/generator/darkfish'
+  autoload :JsonIndex, 'rdoc/generator/json_index'
+  autoload :RI,        'rdoc/generator/ri'
+
 end
 
-- 
cgit v1.2.3