Ruby on Rails | Screencasts | Download | Documentation | Weblog | Community | Source

Changeset 6044

Show
Ignore:
Timestamp:
01/26/07 21:37:38 (2 years ago)
Author:
david
Message:

Nodoc the irrelevant (from 1.2)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/actionpack/lib/action_controller/assertions/deprecated_assertions.rb

    r5358 r6044  
    33module ActionController #:nodoc: 
    44  module Assertions #:nodoc: 
    5     module DeprecatedAssertions 
     5    module DeprecatedAssertions #:nodoc: 
    66      def assert_success(message=nil) #:nodoc: 
    77        assert_response(:success, message) 

  • trunk/actionpack/lib/action_controller/cgi_ext/cgi_methods.rb

    r5904 r6044  
    113113  end 
    114114 
    115   class FormEncodedPairParser < StringScanner 
     115  class FormEncodedPairParser < StringScanner #:nodoc: 
    116116    attr_reader :top, :parent, :result 
    117117 

  • trunk/actionpack/lib/action_controller/routing.rb

    r5803 r6044  
    2626end 
    2727 
    28 class Regexp 
     28class Regexp #:nodoc: 
    2929  def number_of_captures 
    3030    Regexp.new("|#{source}").match('').captures.length 
    …… 
    307307    end 
    308308   
    309     class Route 
     309    class Route #:nodoc: 
    310310      attr_accessor :segments, :requirements, :conditions 
    311311       
    …… 
    538538    end 
    539539 
    540     class Segment 
     540    class Segment #:nodoc: 
    541541      attr_accessor :is_optional 
    542542      alias_method :optional?, :is_optional 
    …… 
    593593    end 
    594594 
    595     class StaticSegment < Segment 
     595    class StaticSegment < Segment #:nodoc: 
    596596      attr_accessor :value, :raw 
    597597      alias_method :raw?, :raw 
    …… 
    627627    end 
    628628 
    629     class DividerSegment < StaticSegment 
     629    class DividerSegment < StaticSegment #:nodoc: 
    630630      def initialize(value = nil) 
    631631        super(value) 
    …… 
    639639    end 
    640640 
    641     class DynamicSegment < Segment 
     641    class DynamicSegment < Segment #:nodoc: 
    642642      attr_accessor :key, :default, :regexp 
    643643   
    …… 
    727727    end 
    728728 
    729     class ControllerSegment < DynamicSegment 
     729    class ControllerSegment < DynamicSegment #:nodoc: 
    730730      def regexp_chunk 
    731731        possible_names = Routing.possible_controllers.collect { |name| Regexp.escape name } 
    …… 
    754754    end 
    755755 
    756     class PathSegment < DynamicSegment 
     756    class PathSegment < DynamicSegment #:nodoc: 
    757757      EscapedSlash = URI.escape("/") 
    758758      def interpolation_chunk 
    …… 
    784784    end 
    785785 
    786     class RouteBuilder 
     786    class RouteBuilder #:nodoc: 
    787787      attr_accessor :separators, :optional_separators 
    788788   
    …… 
    960960    end 
    961961 
    962     class RouteSet 
     962    class RouteSet #:nodoc: 
    963963      # Mapper instances are used to build routes. The object passed to the draw 
    964964      # block in config/routes.rb is a Mapper instance. 
    …… 
    966966      # Mapper instances have relatively few instance methods, in order to avoid 
    967967      # clashes with named routes. 
    968       class Mapper 
     968      class Mapper #:nodoc: 
    969969        def initialize(set) 
    970970          @set = set 
    …… 
    995995      # maintains an anonymous module that can be used to install helpers for the 
    996996      # named routes. 
    997       class NamedRouteCollection 
     997      class NamedRouteCollection #:nodoc: 
    998998        include Enumerable 
    999999 

  • trunk/actionpack/lib/action_controller/status_codes.rb

    r5482 r6044  
    11module ActionController 
    2   module StatusCodes 
    3  
     2  module StatusCodes #:nodoc: 
    43    # Defines the standard HTTP status codes, by integer, with their 
    54    # corresponding default message texts. 

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

    r4929 r6044  
    202202 
    203203    # An invalid selector. 
    204     class InvalidSelectorError < StandardError ; end 
     204    class InvalidSelectorError < StandardError #:nodoc: 
     205    end 
    205206 
    206207 

  • trunk/activerecord/lib/active_record/associations.rb

    r6018 r6044  
    3131  end 
    3232 
    33   class HasManyThroughSourceAssociationMacroError < ActiveRecordError #:nodoc 
     33  class HasManyThroughSourceAssociationMacroError < ActiveRecordError #:nodoc: 
    3434    def initialize(reflection) 
    3535      through_reflection = reflection.through_reflection 

  • trunk/activerecord/lib/active_record/connection_adapters/frontbase_adapter.rb

    r5953 r6044  
    5252    # < Sequence [2], ProcessID [2] , Time [4], IP Addr [4] > 
    5353     
    54     class TwelveByteKey < String #:nodoc 
     54    class TwelveByteKey < String #:nodoc: 
    5555      @@mutex = Mutex.new 
    5656      @@sequence_number = rand(65536) 
    …… 
    272272      end 
    273273 
    274       def native_database_types #:nodoc 
     274      def native_database_types #:nodoc: 
    275275        { 
    276276          :primary_key    => "INTEGER DEFAULT UNIQUE PRIMARY KEY", 
    …… 
    567567      end 
    568568 
    569       def add_limit_offset!(sql, options) #:nodoc 
     569      def add_limit_offset!(sql, options) #:nodoc: 
    570570        if limit = options[:limit] 
    571571          offset = options[:offset] || 0 

  • trunk/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb

    r5937 r6044  
    22require 'set' 
    33 
    4 module MysqlCompat 
     4module MysqlCompat #:nodoc: 
    55  # add all_hashes method to standard mysql-c bindings or pure ruby version 
    66  def self.define_all_hashes_method! 
    …… 
    161161      end 
    162162 
    163       def native_database_types #:nodoc 
     163      def native_database_types #:nodoc: 
    164164        { 
    165165          :primary_key => "int(11) DEFAULT NULL auto_increment PRIMARY KEY", 
    …… 
    279279 
    280280 
    281       def add_limit_offset!(sql, options) #:nodoc 
     281      def add_limit_offset!(sql, options) #:nodoc: 
    282282        if limit = options[:limit] 
    283283          unless offset = options[:offset] 

  • trunk/activerecord/lib/active_record/connection_adapters/openbase_adapter.rb

    r4596 r6044  
    123123      # DATABASE STATEMENTS ====================================== 
    124124 
    125       def add_limit_offset!(sql, options) #:nodoc 
     125      def add_limit_offset!(sql, options) #:nodoc: 
    126126        if limit = options[:limit] 
    127127          unless offset = options[:offset] 

  • trunk/activerecord/lib/active_record/connection_adapters/oracle_adapter.rb

    r5958 r6044  
    135135        end 
    136136 
    137         def native_database_types #:nodoc 
     137        def native_database_types #:nodoc: 
    138138          { 
    139139            :primary_key => "NUMBER(38) NOT NULL PRIMARY KEY", 

  • trunk/activesupport/lib/active_support/core_ext/name_error.rb

    r4681 r6044  
    1  
    21# Add a +missing_name+ method to NameError instances. 
    3 class NameError < StandardError 
    4    
     2class NameError < StandardError #:nodoc:   
    53  # Add a method to obtain the missing name from a NameError. 
    64  def missing_name 
    …… 
    1715    end 
    1816  end 
    19    
    2017end 

  • trunk/activesupport/lib/active_support/dependencies.rb

    r5814 r6044  
    383383  end 
    384384   
    385   class LoadingModule 
     385  class LoadingModule #:nodoc: 
    386386    # Old style environment.rb referenced this method directly.  Please note, it doesn't 
    387387    # actualy *do* anything any more. 

  • trunk/activesupport/lib/active_support/deprecation.rb

    r5763 r6044  
    22 
    33module ActiveSupport 
    4   module Deprecation 
     4  module Deprecation #:nodoc: 
    55    mattr_accessor :debug 
    66    self.debug = false 
    …… 
    8282    self.silenced = false 
    8383 
    84     module ClassMethods 
     84    module ClassMethods #:nodoc: 
    8585      # Declare that a method has been deprecated. 
    8686      def deprecate(*method_names) 
    …… 
    113113    end 
    114114 
    115     module Assertions 
     115    module Assertions #:nodoc: 
    116116      def assert_deprecated(match = nil, &block) 
    117117        result, warnings = collect_deprecations(&block) 
    …… 
    146146    # Stand-in for @request, @attributes, @params, etc which emits deprecation 
    147147    # warnings on any method call (except #inspect). 
    148     class DeprecatedInstanceVariableProxy 
     148    class DeprecatedInstanceVariableProxy #:nodoc: 
    149149      instance_methods.each { |m| undef_method m unless m =~ /^__/ } 
    150150 

  • trunk/activesupport/lib/active_support/multibyte.rb

    r5223 r6044  
    1 module ActiveSupport::Multibyte 
     1module ActiveSupport::Multibyte #:nodoc: 
    22  DEFAULT_NORMALIZATION_FORM = :kc 
    33  NORMALIZATIONS_FORMS = [:c, :kc, :d, :kd] 

  • trunk/activesupport/lib/active_support/multibyte/chars.rb

    r5223 r6044  
    33 
    44# Encapsulates all the functionality related to the Chars proxy. 
    5 module ActiveSupport::Multibyte 
     5module ActiveSupport::Multibyte #:nodoc: 
    66  # Chars enables you to work transparently with multibyte encodings in the Ruby String class without having extensive 
    77  # knowledge about the encoding. A Chars object accepts a string upon initialization and proxies String methods in an 

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

    r5223 r6044  
    11# Chars uses this handler when $KCODE is not set to 'UTF8'. Because this handler doesn't define any methods all call 
    22# will be forwarded to String. 
    3 class ActiveSupport::Multibyte::Handlers::PassthruHandler 
     3class ActiveSupport::Multibyte::Handlers::PassthruHandler #:nodoc: 
    44   
    55  # Return the original byteoffset 

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

    r5223 r6044  
    22# pure ruby versions. Chars automatically uses this handler when it can load the utf8proc extension. For 
    33# documentation on handler methods see UTF8Handler. 
    4 class ActiveSupport::Multibyte::Handlers::UTF8HandlerProc < ActiveSupport::Multibyte::Handlers::UTF8Handler 
    5    
     4class ActiveSupport::Multibyte::Handlers::UTF8HandlerProc < ActiveSupport::Multibyte::Handlers::UTF8Handler #:nodoc: 
    65  class << self 
    76    def normalize(str, form=ActiveSupport::Multibyte::DEFAULT_NORMALIZATION_FORM) #:nodoc: 

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

    r6021 r6044  
    11# Contains all the handlers and helper classes 
    2 module ActiveSupport::Multibyte::Handlers 
    3   class EncodingError < ArgumentError; end 
     2module ActiveSupport::Multibyte::Handlers #:nodoc: 
     3  class EncodingError < ArgumentError #:nodoc: 
     4  end 
    45   
    56  class Codepoint #:nodoc: 

  • trunk/activesupport/lib/active_support/reloadable.rb

    r4760 r6044  
    55# Deprecated as of Rails 1.2. 
    66# All autoloaded objects are now unloaded. 
    7 module Reloadable 
    8   class << self 
    9      
     7module Reloadable #:nodoc: 
     8  class << self     
    109    def included(base) #nodoc: 
    1110      unless base.ancestors.include?(Reloadable::Subclasses) # Avoid double warning 
    …… 
    3837  # Deprecated as of Rails 1.2. 
    3938  # All autoloaded objects are now unloaded. 
    40   module Subclasses 
     39  module Subclasses #:nodoc: 
    4140    def self.included(base) #nodoc: 
    4241      base.send :include, Reloadable 
    …… 
    4948  end 
    5049   
    51   module Deprecated 
    52      
     50  module Deprecated #:nodoc: 
    5351    def self.included(base) 
    5452      class << base 
    …… 
    5957      end 
    6058    end 
    61      
    6259  end 
    63    
    6460end 

  • trunk/activesupport/lib/active_support/vendor/xml_simple.rb

    r5414 r6044  
    1616  # A simple cache for XML documents that were already transformed 
    1717  # by xml_in. 
    18   class Cache 
     18  class Cache #:nodoc: 
    1919    # Creates and initializes a new Cache object. 
    2020    def initialize