Permalink
Browse files

added docs for AbC::UrlFor and AC::UrlFor.

  • Loading branch information...
1 parent a117ac4 commit e3b3f416b57f5642ea25078485f7e9394ad04526 @apotonick apotonick committed May 12, 2011
@@ -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 #_routes methods. Otherwise, an exception
+# will be raised.
+#
+# Note that this module is completely decoupled from HTTP - the only requirement is a valid
+# #_routes implementation.
module AbstractController
module UrlFor
extend ActiveSupport::Concern
@@ -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

0 comments on commit e3b3f41

Please sign in to comment.