Permalink
Browse files

documents the request and response methods in AC::Base

  • Loading branch information...
1 parent 18dbad8 commit 2919f0df9a483e8834d645b3ec02efd72494edad @fxn fxn committed Sep 17, 2012
Showing with 21 additions and 3 deletions.
  1. +21 −3 actionpack/lib/action_controller/base.rb
@@ -162,16 +162,34 @@ module ActionController
class Base < Metal
abstract!
- # Shortcut helper that returns all the ActionController::Base modules except the ones passed in the argument:
+ # We document the request and response methods here because albeit they are
+ # implemented in ActionController::Metal, the type of the returned objects
+ # is unknown at that level.
+
+ ##
+ # :method: request
+ #
+ # Returns an ActionDispatch::Request instance that represents the
+ # current request.
+
+ ##
+ # :method: response
+ #
+ # Returns an ActionDispatch::Response that represents the current
+ # response.
+
+ # Shortcut helper that returns all the <tt>ActionController::Base</tt>
+ # modules except the ones passed in the argument:
#
# class MetalController
# ActionController::Base.without_modules(:ParamsWrapper, :Streaming).each do |left|
# include left
# end
# end
#
- # This gives better control over what you want to exclude and makes it easier
- # to create a bare controller class, instead of listing the modules required manually.
+ # This gives better control over what you want to exclude and makes it
+ # easier to create a bare controller class, instead of listing the modules
+ # required manually.
def self.without_modules(*modules)
modules = modules.map do |m|
m.is_a?(Symbol) ? ActionController.const_get(m) : m

0 comments on commit 2919f0d

Please sign in to comment.