Nodoc the irrelevant (from 1.2)

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

actionpack/lib/action_controller/assertions/deprecated_assertions.rb

@@ -2,7 +2,7 @@
 
 module ActionController #:nodoc:
   module Assertions #:nodoc:
-    module DeprecatedAssertions
+    module DeprecatedAssertions #:nodoc:
       def assert_success(message=nil) #:nodoc:
         assert_response(:success, message)
       end

actionpack/lib/action_controller/cgi_ext/cgi_methods.rb

@@ -112,7 +112,7 @@ def original_filename
       end
   end
 
-  class FormEncodedPairParser < StringScanner
+  class FormEncodedPairParser < StringScanner #:nodoc:
     attr_reader :top, :parent, :result
 
     def initialize(pairs = [])

actionpack/lib/action_controller/routing.rb

@@ -25,7 +25,7 @@ def to_param
   end
 end
 
-class Regexp
+class Regexp #:nodoc:
   def number_of_captures
     Regexp.new("|#{source}").match('').captures.length
   end
@@ -306,7 +306,7 @@ def controller_relative_to(controller, previous)
       end     
     end
   
-    class Route
+    class Route #:nodoc:
       attr_accessor :segments, :requirements, :conditions
       
       def initialize
@@ -537,7 +537,7 @@ def requirement_for(key)
   
     end
 
-    class Segment
+    class Segment #:nodoc:
       attr_accessor :is_optional
       alias_method :optional?, :is_optional
 
@@ -592,7 +592,7 @@ def optionality_implied?
       end
     end
 
-    class StaticSegment < Segment
+    class StaticSegment < Segment #:nodoc:
       attr_accessor :value, :raw
       alias_method :raw?, :raw
   
@@ -626,7 +626,7 @@ def to_s
       end
     end
 
-    class DividerSegment < StaticSegment
+    class DividerSegment < StaticSegment #:nodoc:
       def initialize(value = nil)
         super(value)
         self.raw = true
@@ -638,7 +638,7 @@ def optionality_implied?
       end
     end
 
-    class DynamicSegment < Segment
+    class DynamicSegment < Segment #:nodoc:
       attr_accessor :key, :default, :regexp
   
       def initialize(key = nil, options = {})
@@ -726,7 +726,7 @@ def optionality_implied?
   
     end
 
-    class ControllerSegment < DynamicSegment
+    class ControllerSegment < DynamicSegment #:nodoc:
       def regexp_chunk
         possible_names = Routing.possible_controllers.collect { |name| Regexp.escape name }
         "(?i-:(#{(regexp || Regexp.union(*possible_names)).source}))"
@@ -753,7 +753,7 @@ def match_extraction(next_capture)
       end
     end
 
-    class PathSegment < DynamicSegment
+    class PathSegment < DynamicSegment #:nodoc:
       EscapedSlash = URI.escape("/")
       def interpolation_chunk
         "\#{URI.escape(#{local_name}.to_s).gsub(#{EscapedSlash.inspect}, '/')}"
@@ -783,7 +783,7 @@ def self.new_escaped(strings)
       end     
     end
 
-    class RouteBuilder
+    class RouteBuilder #:nodoc:
       attr_accessor :separators, :optional_separators
   
       def initialize
@@ -959,13 +959,13 @@ def build(path, options)
       end
     end
 
-    class RouteSet
+    class RouteSet #:nodoc:
       # Mapper instances are used to build routes. The object passed to the draw
       # block in config/routes.rb is a Mapper instance.
       # 
       # Mapper instances have relatively few instance methods, in order to avoid
       # clashes with named routes.
-      class Mapper
+      class Mapper #:nodoc:
         def initialize(set)
           @set = set
         end
@@ -994,7 +994,7 @@ def method_missing(route_name, *args, &proc)
       # A NamedRouteCollection instance is a collection of named routes, and also
       # maintains an anonymous module that can be used to install helpers for the
       # named routes.
-      class NamedRouteCollection
+      class NamedRouteCollection #:nodoc:
         include Enumerable
 
         attr_reader :routes, :helpers

actionpack/lib/action_controller/status_codes.rb

@@ -1,6 +1,5 @@
 module ActionController
-  module StatusCodes
-
+  module StatusCodes #:nodoc:
     # Defines the standard HTTP status codes, by integer, with their
     # corresponding default message texts.
     # Source: http://www.iana.org/assignments/http-status-codes

actionpack/lib/action_controller/vendor/html-scanner/html/selector.rb

@@ -201,7 +201,8 @@ class Selector
 
 
     # An invalid selector.
-    class InvalidSelectorError < StandardError ; end
+    class InvalidSelectorError < StandardError #:nodoc:
+    end
 
 
     class << self

activerecord/lib/active_record/associations.rb

@@ -30,7 +30,7 @@ def initialize(reflection)
     end
   end
 
-  class HasManyThroughSourceAssociationMacroError < ActiveRecordError #:nodoc
+  class HasManyThroughSourceAssociationMacroError < ActiveRecordError #:nodoc:
     def initialize(reflection)
       through_reflection = reflection.through_reflection
       source_reflection  = reflection.source_reflection

activerecord/lib/active_record/connection_adapters/frontbase_adapter.rb

@@ -51,7 +51,7 @@ module ConnectionAdapters
     # Assigns a world-wide unique ID made up of:
     # < Sequence [2], ProcessID [2] , Time [4], IP Addr [4] >
     
-    class TwelveByteKey < String #:nodoc
+    class TwelveByteKey < String #:nodoc:
       @@mutex = Mutex.new
       @@sequence_number = rand(65536)
       @@key_cached_pid_component = nil
@@ -271,7 +271,7 @@ def supports_migrations? #:nodoc:
         true
       end
 
-      def native_database_types #:nodoc
+      def native_database_types #:nodoc:
         {
           :primary_key    => "INTEGER DEFAULT UNIQUE PRIMARY KEY",
           :string         => { :name => "VARCHAR", :limit => 255 },
@@ -566,7 +566,7 @@ def rollback_db_transaction #:nodoc:
         execute "SET COMMIT TRUE"
       end
 
-      def add_limit_offset!(sql, options) #:nodoc
+      def add_limit_offset!(sql, options) #:nodoc:
         if limit = options[:limit]
           offset = options[:offset] || 0
         

activerecord/lib/active_record/connection_adapters/mysql_adapter.rb

@@ -1,7 +1,7 @@
 require 'active_record/connection_adapters/abstract_adapter'
 require 'set'
 
-module MysqlCompat
+module MysqlCompat #:nodoc:
   # add all_hashes method to standard mysql-c bindings or pure ruby version
   def self.define_all_hashes_method!
     raise 'Mysql not loaded' unless defined?(::Mysql)
@@ -160,7 +160,7 @@ def supports_migrations? #:nodoc:
         true
       end
 
-      def native_database_types #:nodoc
+      def native_database_types #:nodoc:
         {
           :primary_key => "int(11) DEFAULT NULL auto_increment PRIMARY KEY",
           :string      => { :name => "varchar", :limit => 255 },
@@ -278,7 +278,7 @@ def rollback_db_transaction #:nodoc:
       end
 
 
-      def add_limit_offset!(sql, options) #:nodoc
+      def add_limit_offset!(sql, options) #:nodoc:
         if limit = options[:limit]
           unless offset = options[:offset]
             sql << " LIMIT #{limit}"

activerecord/lib/active_record/connection_adapters/openbase_adapter.rb

@@ -122,7 +122,7 @@ def quoted_false
 
       # DATABASE STATEMENTS ======================================
 
-      def add_limit_offset!(sql, options) #:nodoc
+      def add_limit_offset!(sql, options) #:nodoc:
         if limit = options[:limit]
           unless offset = options[:offset]
             sql << " RETURN RESULTS #{limit}"

activerecord/lib/active_record/connection_adapters/oracle_adapter.rb

@@ -134,7 +134,7 @@ def supports_migrations? #:nodoc:
           true
         end
 
-        def native_database_types #:nodoc
+        def native_database_types #:nodoc:
           {
             :primary_key => "NUMBER(38) NOT NULL PRIMARY KEY",
             :string      => { :name => "VARCHAR2", :limit => 255 },

activesupport/lib/active_support/core_ext/name_error.rb

@@ -1,7 +1,5 @@
-
 # Add a +missing_name+ method to NameError instances.
-class NameError < StandardError
-  
+class NameError < StandardError #:nodoc:  
   # Add a method to obtain the missing name from a NameError.
   def missing_name
     $1 if /((::)?([A-Z]\w*)(::[A-Z]\w*)*)$/ =~ message
@@ -16,5 +14,4 @@ def missing_name?(name)
       missing_name == name.to_s
     end
   end
-  
 end

activesupport/lib/active_support/dependencies.rb

@@ -382,7 +382,7 @@ def new_constants_in(*descs)
     end
   end
   
-  class LoadingModule
+  class LoadingModule #:nodoc:
     # Old style environment.rb referenced this method directly.  Please note, it doesn't
     # actualy *do* anything any more.
     def self.root(*args)

activesupport/lib/active_support/deprecation.rb

@@ -1,7 +1,7 @@
 require 'yaml'
 
 module ActiveSupport
-  module Deprecation
+  module Deprecation #:nodoc:
     mattr_accessor :debug
     self.debug = false
 
@@ -81,7 +81,7 @@ def extract_callstack(callstack)
     # Warnings are not silenced by default.
     self.silenced = false
 
-    module ClassMethods
+    module ClassMethods #:nodoc:
       # Declare that a method has been deprecated.
       def deprecate(*method_names)
         options = method_names.last.is_a?(Hash) ? method_names.pop : {}
@@ -112,7 +112,7 @@ def deprecation_horizon
       end
     end
 
-    module Assertions
+    module Assertions #:nodoc:
       def assert_deprecated(match = nil, &block)
         result, warnings = collect_deprecations(&block)
         assert !warnings.empty?, "Expected a deprecation warning within the block but received none"
@@ -145,7 +145,7 @@ def collect_deprecations
 
     # Stand-in for @request, @attributes, @params, etc which emits deprecation
     # warnings on any method call (except #inspect).
-    class DeprecatedInstanceVariableProxy
+    class DeprecatedInstanceVariableProxy #:nodoc:
       instance_methods.each { |m| undef_method m unless m =~ /^__/ }
 
       def initialize(instance, method, var = "@#{method}")

activesupport/lib/active_support/multibyte.rb

@@ -1,4 +1,4 @@
-module ActiveSupport::Multibyte
+module ActiveSupport::Multibyte #:nodoc:
   DEFAULT_NORMALIZATION_FORM = :kc
   NORMALIZATIONS_FORMS = [:c, :kc, :d, :kd]
   UNICODE_VERSION = '5.0.0'

activesupport/lib/active_support/multibyte/chars.rb

@@ -2,7 +2,7 @@
 require 'active_support/multibyte/handlers/passthru_handler'
 
 # Encapsulates all the functionality related to the Chars proxy.
-module ActiveSupport::Multibyte
+module ActiveSupport::Multibyte #:nodoc:
   # Chars enables you to work transparently with multibyte encodings in the Ruby String class without having extensive
   # knowledge about the encoding. A Chars object accepts a string upon initialization and proxies String methods in an
   # encoding safe manner. All the normal String methods are also implemented on the proxy.

activesupport/lib/active_support/multibyte/handlers/passthru_handler.rb

@@ -1,6 +1,6 @@
 # Chars uses this handler when $KCODE is not set to 'UTF8'. Because this handler doesn't define any methods all call
 # will be forwarded to String.
-class ActiveSupport::Multibyte::Handlers::PassthruHandler
+class ActiveSupport::Multibyte::Handlers::PassthruHandler #:nodoc:
   
   # Return the original byteoffset
   def self.translate_offset(string, byte_offset) #:nodoc:

activesupport/lib/active_support/multibyte/handlers/utf8_handler.rb

@@ -1,6 +1,7 @@
 # Contains all the handlers and helper classes
-module ActiveSupport::Multibyte::Handlers
-  class EncodingError < ArgumentError; end
+module ActiveSupport::Multibyte::Handlers #:nodoc:
+  class EncodingError < ArgumentError #:nodoc:
+  end
   
   class Codepoint #:nodoc:
     attr_accessor :code, :combining_class, :decomp_type, :decomp_mapping, :uppercase_mapping, :lowercase_mapping

activesupport/lib/active_support/multibyte/handlers/utf8_handler_proc.rb

@@ -1,8 +1,7 @@
 # Methods in this handler call functions in the utf8proc ruby extension. These are significantly faster than the
 # pure ruby versions. Chars automatically uses this handler when it can load the utf8proc extension. For
 # documentation on handler methods see UTF8Handler.
-class ActiveSupport::Multibyte::Handlers::UTF8HandlerProc < ActiveSupport::Multibyte::Handlers::UTF8Handler
-  
+class ActiveSupport::Multibyte::Handlers::UTF8HandlerProc < ActiveSupport::Multibyte::Handlers::UTF8Handler #:nodoc:
   class << self
     def normalize(str, form=ActiveSupport::Multibyte::DEFAULT_NORMALIZATION_FORM) #:nodoc:
       codepoints = str.unpack('U*')

activesupport/lib/active_support/reloadable.rb

@@ -4,9 +4,8 @@
 # 
 # Deprecated as of Rails 1.2.
 # All autoloaded objects are now unloaded.
-module Reloadable
-  class << self
-    
+module Reloadable #:nodoc:
+  class << self    
     def included(base) #nodoc:
       unless base.ancestors.include?(Reloadable::Subclasses) # Avoid double warning
         ActiveSupport::Deprecation.warn "Reloadable has been deprecated and has no effect.", caller
@@ -37,7 +36,7 @@ def reloadable_classes
   # 
   # Deprecated as of Rails 1.2.
   # All autoloaded objects are now unloaded.
-  module Subclasses
+  module Subclasses #:nodoc:
     def self.included(base) #nodoc:
       base.send :include, Reloadable
       ActiveSupport::Deprecation.warn "Reloadable::Subclasses has been deprecated and has no effect.", caller
@@ -48,8 +47,7 @@ def self.included(base) #nodoc:
     end
   end
   
-  module Deprecated
-    
+  module Deprecated #:nodoc:
     def self.included(base)
       class << base
         define_method(:reloadable?) do
@@ -58,7 +56,5 @@ class << base
         end
       end
     end
-    
   end
-  
 end

activesupport/lib/active_support/vendor/xml_simple.rb

@@ -15,7 +15,7 @@ class XmlSimple
 
   # A simple cache for XML documents that were already transformed
   # by xml_in.
-  class Cache
+  class Cache #:nodoc:
     # Creates and initializes a new Cache object.
     def initialize
       @mem_share_cache = {}