aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_controller
diff options
context:
space:
mode:
authorNick Sutterer <apotonick@gmail.com>2011-05-12 09:31:36 +0200
committerNick Sutterer <apotonick@gmail.com>2011-05-12 09:31:36 +0200
commite3b3f416b57f5642ea25078485f7e9394ad04526 (patch)
tree494662d709d2e08e98bbba1209f7060dfaec6fe3 /actionpack/lib/action_controller
parenta117ac431ad3624d047f84f0860c301a844f55c9 (diff)
downloadrails-e3b3f416b57f5642ea25078485f7e9394ad04526.tar.gz
rails-e3b3f416b57f5642ea25078485f7e9394ad04526.tar.bz2
rails-e3b3f416b57f5642ea25078485f7e9394ad04526.zip
added docs for AbC::UrlFor and AC::UrlFor.
Diffstat (limited to 'actionpack/lib/action_controller')
-rw-r--r--actionpack/lib/action_controller/metal/url_for.rb6
1 files changed, 6 insertions, 0 deletions
diff --git a/actionpack/lib/action_controller/metal/url_for.rb b/actionpack/lib/action_controller/metal/url_for.rb
index 6fc0cf1fb8..9a03033f48 100644
--- a/actionpack/lib/action_controller/metal/url_for.rb
+++ b/actionpack/lib/action_controller/metal/url_for.rb
@@ -1,3 +1,9 @@
+# Includes #url_for into the host class. The class has to provide a RouteSet by implementing
+# the #_routes methods. Otherwise, an exception will be raised.
+#
+# In addition to AbstractController::UrlFor, 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, which needs to be a Rack-compatible environment hash.
module ActionController
module UrlFor
extend ActiveSupport::Concern