Add documentation intros for Action Controller and Action Dispatch

In 7c94708d24 the READMEs were included for
the main framework pages of the API documentation, except for Action Pack.
As Action Pack doesn't define any code in the ActionPack namespace, only
it's included modules (Action Dispatch, Action Controller and Abstract
Controller) are documented.

This adds documentation intro's to the main page for Action Controller
and Action Dispatch. The content was copied from the Action Pack README.
As Abstract Controller isn't mentioned there, it is skipped for now.
[ci-skip]
This commit is contained in:
Petrik 2023-04-02 17:33:23 +02:00
parent 6c43ebc220
commit 3376ab5285
3 changed files with 17 additions and 0 deletions

View File

@ -6,6 +6,13 @@ require "action_controller/deprecator"
require "action_controller/metal/strong_parameters" require "action_controller/metal/strong_parameters"
require "action_controller/metal/exceptions" require "action_controller/metal/exceptions"
# = Action Controller
#
# Action Controller is a module of Action Pack.
#
# Action Controller provides a base controller class that can be subclassed to
# implement filters and actions to handle requests. The result of an action is
# typically content generated from views.
module ActionController module ActionController
extend ActiveSupport::Autoload extend ActiveSupport::Autoload

View File

@ -35,6 +35,14 @@ module Rack
autoload :Test, "rack/test" autoload :Test, "rack/test"
end end
# = Action Dispatch
#
# Action Dispatch is a module of Action Pack.
#
# Action Dispatch parses information about the web request, handles
# routing as defined by the user, and does advanced processing related to HTTP
# such as MIME-type negotiation, decoding parameters in POST, PATCH, or PUT
# bodies, handling HTTP caching logic, cookies and sessions.
module ActionDispatch module ActionDispatch
include ActiveSupport::Deprecation::DeprecatedConstantAccessor include ActiveSupport::Deprecation::DeprecatedConstantAccessor
extend ActiveSupport::Autoload extend ActiveSupport::Autoload

View File

@ -36,7 +36,9 @@ module Rails
include: %w( include: %w(
README.rdoc README.rdoc
lib/abstract_controller/**/*.rb lib/abstract_controller/**/*.rb
lib/action_controller.rb
lib/action_controller/**/*.rb lib/action_controller/**/*.rb
lib/action_dispatch.rb
lib/action_dispatch/**/*.rb lib/action_dispatch/**/*.rb
) )
}, },