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

Changeset 4079

Show
Ignore:
Timestamp:
03/28/06 03:19:27 (3 years ago)
Author:
david
Message:

Fixed docs

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

    r4072 r4079  
    682682      end     
    683683 
    684       def render_action(action_name, status = nil, with_layout = true) 
     684      def render_action(action_name, status = nil, with_layout = true) #:nodoc: 
    685685        template = default_template_name(action_name.to_s) 
    686686        if with_layout && !template_exempt_from_layout?(template)  
    …… 
    691691      end 
    692692 
    693       def render_file(template_path, status = nil, use_full_path = false, locals = {}) 
     693      def render_file(template_path, status = nil, use_full_path = false, locals = {}) #:nodoc: 
    694694        add_variables_to_assigns 
    695695        assert_existence_of_template_file(template_path) if use_full_path 
    …… 
    698698      end 
    699699 
    700       def render_template(template, status = nil, type = :rhtml, local_assigns = {}) 
     700      def render_template(template, status = nil, type = :rhtml, local_assigns = {}) #:nodoc: 
    701701        add_variables_to_assigns 
    702702        render_text(@template.render_template(type, template, nil, local_assigns), status) 
    703703      end 
    704704 
    705       def render_text(text = nil, status = nil) 
     705      def render_text(text = nil, status = nil) #:nodoc: 
    706706        @performed_render = true 
    707707        @response.headers['Status'] = (status || DEFAULT_RENDER_STATUS_CODE).to_s 
    …… 
    709709      end 
    710710 
    711       def render_javascript(javascript, status = nil) 
     711      def render_javascript(javascript, status = nil) #:nodoc: 
    712712        @response.headers['Content-Type'] = 'text/javascript; charset=UTF-8' 
    713713        render_text(javascript, status) 
    714714      end 
    715715 
    716       def render_xml(xml, status = nil) 
     716      def render_xml(xml, status = nil) #:nodoc: 
    717717        @response.headers['Content-Type'] = 'application/xml' 
    718718        render_text(xml, status) 
    719719      end 
    720720 
    721       def render_nothing(status = nil) 
     721      def render_nothing(status = nil) #:nodoc: 
    722722        render_text(' ', status) 
    723723      end 
    724724 
    725       def render_partial(partial_path = default_template_name, object = nil, local_assigns = nil, status = nil) 
     725      def render_partial(partial_path = default_template_name, object = nil, local_assigns = nil, status = nil) #:nodoc: 
    726726        add_variables_to_assigns 
    727727        render_text(@template.render_partial(partial_path, object, local_assigns), status) 
    728728      end 
    729729 
    730       def render_partial_collection(partial_name, collection, partial_spacer_template = nil, local_assigns = nil, status = nil) 
     730      def render_partial_collection(partial_name, collection, partial_spacer_template = nil, local_assigns = nil, status = nil) #:nodoc: 
    731731        add_variables_to_assigns 
    732732        render_text(@template.render_partial_collection(partial_name, collection, partial_spacer_template, local_assigns), status) 
    733733      end 
    734734 
    735       def render_with_layout(template_name = default_template_name, status = nil, layout = nil) 
     735      def render_with_layout(template_name = default_template_name, status = nil, layout = nil) #:nodoc: 
    736736        render_with_a_layout(template_name, status, layout) 
    737737      end 
    738738 
    739       def render_without_layout(template_name = default_template_name, status = nil) 
     739      def render_without_layout(template_name = default_template_name, status = nil) #:nodoc: 
    740740        render_with_no_layout(template_name, status) 
    741741      end 
    …… 
    743743 
    744744      # Clears the rendered results, allowing for another render to be performed. 
    745       def erase_render_results 
     745      def erase_render_results #:nodoc: 
    746746        @response.body = nil 
    747747        @performed_render = false 
    748748      end 
    749        
    750749       
    751750      # Clears the redirected results from the headers, resets the status to 200 and returns  
    …… 
    753752      # Note that +redirect_to+ will change the body of the response to indicate a redirection. 
    754753      # The response body is not reset here, see +erase_render_results+ 
    755       def erase_redirect_results 
     754      def erase_redirect_results #:nodoc: 
    756755        @performed_redirect = false 
    757756        response.redirected_to = nil 
    …… 
    762761 
    763762      # Erase both render and redirect results 
    764       def erase_results 
     763      def erase_results #:nodoc: 
    765764        erase_render_results 
    766765        erase_redirect_results 
    767766      end 
    768767 
    769       def rewrite_options(options) 
     768      def rewrite_options(options) #:nodoc: 
    770769        if defaults = default_url_options(options) 
    771770          defaults.merge(options) 

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

    r3989 r4079  
    116116        end 
    117117 
    118         def flash_with_components(refresh = false) 
     118        def flash_with_components(refresh = false) #:nodoc: 
    119119          if @flash.nil? || refresh 
    120120            @flash =  

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

    r2749 r4079  
    2929    # Also note, that if the models follow the pattern of just 1 class per file in the form of MyClass => my_class.rb, then these 
    3030    # classes don't have to be required as Active Support will auto-require them. 
    31     module ClassMethods 
     31    module ClassMethods #:nodoc: 
    3232      # Specifies a variable number of models that this controller depends on. Models are normally Active Record classes or a similar 
    3333      # backend for modelling entity classes. 

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

    r1915 r4079  
    33    protected 
    44      # Deprecated in favor of calling redirect_to directly with the path. 
    5       def redirect_to_path(path) 
     5      def redirect_to_path(path) #:nodoc: 
    66        redirect_to(path) 
    77      end 
    …… 
    1010      # true as the second parameter and the browser will get "301 Moved Permanently" instead of "302 Found". This can also be done through 
    1111      # just setting the headers["Status"] to "301 Moved Permanently" before using the redirect_to. 
    12       def redirect_to_url(url, permanently = false) 
     12      def redirect_to_url(url, permanently = false) #:nodoc: 
    1313        headers["Status"] = "301 Moved Permanently" if permanently 
    1414        redirect_to(url) 

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

    r3834 r4079  
    137137    end 
    138138 
    139     module InstanceMethods 
     139    module InstanceMethods #:nodoc: 
    140140      def assign_shortcuts_with_flash(request, response) #:nodoc: 
    141141        assign_shortcuts_without_flash(request, response) 

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

    r4026 r4079  
    44 
    55module ActionController 
    6   module Integration 
    7  
     6  module Integration #:nodoc: 
    87    # An integration Session instance represents a set of requests and responses 
    98    # performed sequentially by some virtual user. Becase you can instantiate 
    …… 
    170169 
    171170      private 
    172    
     171 
    173172        class MockCGI < CGI #:nodoc: 
    174173          attr_accessor :stdinput, :stdoutput, :env_table 
    …… 
    320319      end 
    321320 
    322       module ClassMethods 
     321      module ClassMethods #:nodoc: 
    323322        mattr_accessor :last_instantiation 
    324323 

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

    r3917 r4079  
    11module Mime 
    2   class Type 
    3  
     2  class Type #:nodoc: 
    43    # A simple helper class used in parsing the accept header 
    54    class AcceptItem #:nodoc: 

  • trunk/actionpack/lib/action_controller/vendor/xml_node.rb

    r3782 r4079  
    22 
    33# SimpleXML like xml parser. Written by leon breet from the ruby on rails Mailing list 
    4 class XmlNode 
     4class XmlNode #:nodoc: 
    55  attr :node 
    66 
    …… 
    8282end 
    8383 
    84 class XmlNodeList < Array 
     84class XmlNodeList < Array #:nodoc: 
    8585  def [](i) 
    8686    i.is_a?(String) ? super(0)[i] : super(i) 

  • trunk/actionpack/lib/action_pack/version.rb

    r3543 r4079  
    1 module ActionPack 
     1module ActionPack #:nodoc: 
    22  module VERSION #:nodoc: 
    33    MAJOR = 1 

  • trunk/actionpack/lib/action_view/base.rb

    r4056 r4079  
    222222    # it's relative to the template_root, otherwise it's absolute. The hash in <tt>local_assigns</tt>  
    223223    # is made available as local variables. 
    224     def render_file(template_path, use_full_path = true, local_assigns = {}) 
     224    def render_file(template_path, use_full_path = true, local_assigns = {}) #:nodoc: 
    225225      @first_render ||= template_path 
    226226 
    …… 
    255255    # Renders the template present at <tt>template_path</tt> (relative to the template_root).  
    256256    # The hash in <tt>local_assigns</tt> is made available as local variables. 
    257     def render(options = {}, old_local_assigns = {}, &block) 
     257    def render(options = {}, old_local_assigns = {}, &block) #:nodoc: 
    258258      if options.is_a?(String) 
    259259        render_file(options, true, old_local_assigns) 
    …… 
    278278    # Renders the +template+ which is given as a string as either rhtml or rxml depending on <tt>template_extension</tt>. 
    279279    # The hash in <tt>local_assigns</tt> is made available as local variables. 
    280     def render_template(template_extension, template, file_path = nil, local_assigns = {}) 
     280    def render_template(template_extension, template, file_path = nil, local_assigns = {}) #:nodoc: 
    281281      if handler = @@template_handlers[template_extension] 
    282282        template ||= read_template_file(file_path, template_extension) # Make sure that a lazyily-read template is loaded. 
    …… 
    294294    # will only be read if it has to be compiled. 
    295295    # 
    296     def compile_and_render_template(extension, template = nil, file_path = nil, local_assigns = {}) 
     296    def compile_and_render_template(extension, template = nil, file_path = nil, local_assigns = {}) #:nodoc: 
    297297      # compile the given template, if necessary 
    298298      if compile_template?(template, file_path, local_assigns) 

  • trunk/actionpack/lib/action_view/compiled_templates.rb

    r2058 r4079  
    1111  # To use a compiled template module, create a new instance and include it into the class 
    1212  # in which you want the template to be rendered. 
    13   class CompiledTemplates < Module 
     13  class CompiledTemplates < Module #:nodoc: 
    1414    attr_reader :method_names 
    1515 

  • trunk/actionpack/Rakefile

    r3801 r4079  
    4545  rdoc.rdoc_dir = 'doc' 
    4646  rdoc.title    = "Action Pack -- On rails from request to response" 
    47   rdoc.options << '--line-numbers' << '--inline-source' << '--main README' 
     47  rdoc.options << '--line-numbers' << '--inline-source' 
    4848  rdoc.template = "#{ENV['template']}.rb" if ENV['template'] 
    4949  rdoc.rdoc_files.include('README', 'RUNNING_UNIT_TESTS', 'CHANGELOG') 
    5050  rdoc.rdoc_files.include('lib/**/*.rb') 
    5151} 
    52  
    5352 
    5453# Create compressed packages