Documentation stuff

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@784 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

activesupport/README

+= Active Support -- Utility classes and standard library extensions from Rails
+
+Active Support is a collection of various utility classes and standard library extensions that were found useful
+for Rails. All these additions have hence been collected in this bundle as way to gather all that sugar that makes
+Ruby sweeter.
+
+
+== Download
+
+The latest version of Active Support can be found at
+
+* http://rubyforge.org/project/showfiles.php?group_id=182
+
+Documentation can be found at 
+
+* http://as.rubyonrails.com
+
+
+== Installation
+
+The prefered method of installing Active Support is through its GEM file. You'll need to have
+RubyGems[http://rubygems.rubyforge.org/wiki/wiki.pl] installed for that, though. If you have,
+then use:
+
+  % [sudo] gem install activesupport-1.0.0.gem
+
+
+== License
+
+Active Support is released under the MIT license.
+
+
+== Support
+
+The Active Support homepage is http://www.rubyonrails.com. You can find the Active Support
+RubyForge page at http://rubyforge.org/projects/activesupport. And as Jim from Rake says:
+
+   Feel free to submit commits or feature requests.  If you send a patch,
+   remember to update the corresponding unit tests.  If fact, I prefer
+   new feature to be submitted in the form of new unit tests.
+
+For other information, feel free to ask on the ruby-talk mailing list
+(which is mirrored to comp.lang.ruby) or contact mailto:david@loudthinking.com.
\ No newline at end of file

activesupport/Rakefile

 require 'rake/testtask'
+require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 
@@ -15,6 +16,18 @@ Rake::TestTask.new { |t|
 # Create compressed packages
 dist_dirs = [ "lib", "test"]
 
+# Genereate the RDoc documentation
+
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "Active Support -- Utility classes and standard library extensions from Rails"
+  rdoc.options << '--line-numbers --inline-source --main README'
+  rdoc.rdoc_files.include('README', 'CHANGELOG')
+  rdoc.rdoc_files.include('lib/active_support.rb')
+  rdoc.rdoc_files.include('lib/active_support/*.rb')
+  rdoc.rdoc_files.include('lib/active_support/**/*.rb')
+}
+
 spec = Gem::Specification.new do |s|
   s.name = PKG_NAME
   s.version = PKG_VERSION

activesupport/lib/active_support/binding_of_caller.rb

 begin
   require 'simplecc'
 rescue LoadError
-  class Continuation; end # :nodoc: # for RDoc
+  class Continuation # :nodoc: # for RDoc
+  end
   def Continuation.create(*args, &block) # :nodoc:
     cc = nil; result = callcc {|c| cc = c; block.call(cc) if block and args.empty?}
     result ||= args

activesupport/lib/active_support/breakpoint.rb

@@ -117,10 +117,10 @@ def breakpoint(id = nil, context = nil, &block)
     end
   end
 
-  module CommandBundle
+  module CommandBundle #:nodoc:
     # Proxy to a Breakpoint client. Lets you directly execute code
     # in the context of the client.
-    class Client
+    class Client #:nodoc:
       def initialize(eval_handler) # :nodoc:
         eval_handler.untaint
         @eval_handler = eval_handler
@@ -218,7 +218,7 @@ def handle_breakpoint(context, message, file = "", line = "", &block) # :nodoc:
   # These exceptions will be raised on failed asserts
   # if Breakpoint.asserts_cause_exceptions is set to
   # true.
-  class FailedAssertError < RuntimeError
+  class FailedAssertError < RuntimeError #:nodoc:
   end
 
   # This asserts that the block evaluates to true.
@@ -409,7 +409,7 @@ def use_drb?
   end
 end
 
-module IRB # :nodoc:
+module IRB #:nodoc:
   class << self; remove_method :start; end
   def self.start(ap_path = nil, main_context = nil, workspace = nil)
     $0 = File::basename(ap_path, ".rb") if ap_path
@@ -462,7 +462,7 @@ def result.last_value; end
   end
   def IRB.parse_opts() end
 
-  class Context
+  class Context #:nodoc:
     alias :old_evaluate :evaluate
     def evaluate(line, line_no)
       if line.chomp == "exit" then
@@ -473,7 +473,7 @@ def evaluate(line, line_no)
     end
   end
 
-  class WorkSpace
+  class WorkSpace #:nodoc:
     alias :old_evaluate :evaluate
 
     def evaluate(*args)
@@ -491,7 +491,7 @@ def evaluate(*args)
     end
   end
 
-  module InputCompletor
+  module InputCompletor #:nodoc:
     def self.eval(code, context, *more)
       # Big hack, this assumes that InputCompletor
       # will only call eval() when it wants code
@@ -502,7 +502,7 @@ def self.eval(code, context, *more)
 end
 
 module DRb # :nodoc:
-  class DRbObject
+  class DRbObject #:nodoc:
     undef :inspect if method_defined?(:inspect)
     undef :clone if method_defined?(:clone)
   end

activesupport/lib/active_support/core_ext/date/conversions.rb

@@ -3,7 +3,7 @@ module CoreExtensions #:nodoc:
     module Date #:nodoc:
       # Getting dates in different convenient string representations and other objects
       module Conversions
-        def self.append_features(klass)
+        def self.append_features(klass) #:nodoc:
           super
           klass.send(:alias_method, :to_default_s, :to_s)
           klass.send(:alias_method, :to_s, :to_formatted_s)