aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/abstract_controller/url_for.rb
diff options
context:
space:
mode:
Diffstat (limited to 'actionpack/lib/abstract_controller/url_for.rb')
-rw-r--r--actionpack/lib/abstract_controller/url_for.rb6
1 files changed, 6 insertions, 0 deletions
diff --git a/actionpack/lib/abstract_controller/url_for.rb b/actionpack/lib/abstract_controller/url_for.rb
index e5d5bef6b4..e4261068d8 100644
--- a/actionpack/lib/abstract_controller/url_for.rb
+++ b/actionpack/lib/abstract_controller/url_for.rb
@@ -1,3 +1,9 @@
+# Includes +url_for+ into the host class (e.g. an abstract controller or mailer). The class
+# has to provide a +RouteSet+ by implementing the <tt>_routes</tt> methods. Otherwise, an
+# exception will be raised.
+#
+# Note that this module is completely decoupled from HTTP - the only requirement is a valid
+# <tt>_routes</tt> implementation.
module AbstractController
module UrlFor
extend ActiveSupport::Concern