diff options
author | Vijay Dev <vijaydev.cse@gmail.com> | 2012-03-07 01:04:14 +0530 |
---|---|---|
committer | Vijay Dev <vijaydev.cse@gmail.com> | 2012-03-07 01:04:14 +0530 |
commit | 7c90d91c3c43bdbba25d38589aed0e2940af3bc8 (patch) | |
tree | 5fd756835ebd41371c678e8804675ed287a9d3ae /actionpack/lib/action_controller/metal | |
parent | f3a3203b00438c7c2782ad6a914a73f96dec95f7 (diff) | |
download | rails-7c90d91c3c43bdbba25d38589aed0e2940af3bc8.tar.gz rails-7c90d91c3c43bdbba25d38589aed0e2940af3bc8.tar.bz2 rails-7c90d91c3c43bdbba25d38589aed0e2940af3bc8.zip |
Clean up module docs [ci skip]
Removed some useless docstrings and no-doc'ed some.
Diffstat (limited to 'actionpack/lib/action_controller/metal')
-rw-r--r-- | actionpack/lib/action_controller/metal/url_for.rb | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/actionpack/lib/action_controller/metal/url_for.rb b/actionpack/lib/action_controller/metal/url_for.rb index 1177a703b3..8e7b56dbcc 100644 --- a/actionpack/lib/action_controller/metal/url_for.rb +++ b/actionpack/lib/action_controller/metal/url_for.rb @@ -1,25 +1,25 @@ -# Includes +url_for+ into the host class. The class has to provide a +RouteSet+ by implementing -# the <tt>_routes</tt> method. Otherwise, an exception will be raised. -# -# In addition to <tt>AbstractController::UrlFor</tt>, this module accesses the HTTP layer to define -# url options like the +host+. In order to do so, this module requires the host class -# to implement +env+ and +request+, which need to be a Rack-compatible. -# -# Example: -# -# class RootUrl -# include ActionController::UrlFor -# include Rails.application.routes.url_helpers -# -# delegate :env, :request, :to => :controller -# -# def initialize(controller) -# @controller = controller -# @url = root_path # named route from the application. -# end -# end -# module ActionController + # Includes +url_for+ into the host class. The class has to provide a +RouteSet+ by implementing + # the <tt>_routes</tt> method. Otherwise, an exception will be raised. + # + # In addition to <tt>AbstractController::UrlFor</tt>, this module accesses the HTTP layer to define + # url options like the +host+. In order to do so, this module requires the host class + # to implement +env+ and +request+, which need to be a Rack-compatible. + # + # Example: + # + # class RootUrl + # include ActionController::UrlFor + # include Rails.application.routes.url_helpers + # + # delegate :env, :request, :to => :controller + # + # def initialize(controller) + # @controller = controller + # @url = root_path # named route from the application. + # end + # end + # module UrlFor extend ActiveSupport::Concern |