Skip to content

Commit 3376ab5

Browse files
committed
Add documentation intros for Action Controller and Action Dispatch
In 7c94708 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]
1 parent 6c43ebc commit 3376ab5

File tree

3 files changed

+17
-0
lines changed

3 files changed

+17
-0
lines changed

actionpack/lib/action_controller.rb

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@
66
require "action_controller/metal/strong_parameters"
77
require "action_controller/metal/exceptions"
88

9+
# = Action Controller
10+
#
11+
# Action Controller is a module of Action Pack.
12+
#
13+
# Action Controller provides a base controller class that can be subclassed to
14+
# implement filters and actions to handle requests. The result of an action is
15+
# typically content generated from views.
916
module ActionController
1017
extend ActiveSupport::Autoload
1118

actionpack/lib/action_dispatch.rb

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,14 @@ module Rack
3535
autoload :Test, "rack/test"
3636
end
3737

38+
# = Action Dispatch
39+
#
40+
# Action Dispatch is a module of Action Pack.
41+
#
42+
# Action Dispatch parses information about the web request, handles
43+
# routing as defined by the user, and does advanced processing related to HTTP
44+
# such as MIME-type negotiation, decoding parameters in POST, PATCH, or PUT
45+
# bodies, handling HTTP caching logic, cookies and sessions.
3846
module ActionDispatch
3947
include ActiveSupport::Deprecation::DeprecatedConstantAccessor
4048
extend ActiveSupport::Autoload

railties/lib/rails/api/task.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ class Task < RDoc::Task
3636
include: %w(
3737
README.rdoc
3838
lib/abstract_controller/**/*.rb
39+
lib/action_controller.rb
3940
lib/action_controller/**/*.rb
41+
lib/action_dispatch.rb
4042
lib/action_dispatch/**/*.rb
4143
)
4244
},

0 commit comments

Comments
 (0)