Skip to content

Commit 932d2ae

Browse files
Merge pull request rails#48005 from p8/docs/headers-actionpack
Add missing headers to Action Pack docs [ci-skip]
2 parents 5d159f0 + 168c206 commit 932d2ae

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+92
-0
lines changed

actionpack/lib/abstract_controller/base.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ def corrections # :nodoc:
2626
end
2727
end
2828

29+
# = AbstractController \Base
30+
#
2931
# AbstractController::Base is a low-level API. Nobody should be
3032
# using it directly, and subclasses (like ActionController::Base) are
3133
# expected to provide their own +render+ method, since rendering means

actionpack/lib/abstract_controller/caching/fragments.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
module AbstractController
44
module Caching
5+
# = AbstractController Caching \Fragments
6+
#
57
# Fragment caching is used for caching various blocks within
68
# views without caching the entire action as a whole. This is
79
# useful when certain elements of an action change frequently or

actionpack/lib/action_controller/api.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
require "action_controller/log_subscriber"
66

77
module ActionController
8+
# = Action \Controller \Base
9+
#
810
# API Controller is a lightweight version of ActionController::Base,
911
# created for applications that don't require all functionalities that a complete
1012
# \Rails controller provides, allowing you to create controllers with just the

actionpack/lib/action_controller/base.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
require "action_controller/metal/params_wrapper"
66

77
module ActionController
8+
# = Action Controller \Base
9+
#
810
# Action Controllers are the core of a web request in \Rails. They are made up of one or more actions that are executed
911
# on request and then either it renders a template or redirects to another action. An action is defined as a public method
1012
# on the controller, which will automatically be made accessible to the web-server through \Rails Routes.

actionpack/lib/action_controller/caching.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# frozen_string_literal: true
22

33
module ActionController
4+
# = Action Controller \Caching
5+
#
46
# \Caching is a cheap way of speeding up slow applications by keeping the result of
57
# calculations, renderings, and database calls around for subsequent requests.
68
#

actionpack/lib/action_controller/form_builder.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# frozen_string_literal: true
22

33
module ActionController
4+
# = Action Controller Form Builder
5+
#
46
# Override the default form builder for all views rendered by this
57
# controller and any of its descendants. Accepts a subclass of
68
# ActionView::Helpers::FormBuilder.

actionpack/lib/action_controller/metal.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
require "action_dispatch/middleware/stack"
55

66
module ActionController
7+
# = Action Controller \MiddlewareStack
8+
#
79
# Extend ActionDispatch middleware stack to make it aware of options
810
# allowing the following syntax in controllers:
911
#
@@ -58,6 +60,8 @@ def build_middleware(klass, args, block)
5860
end
5961
end
6062

63+
# = Action Controller \Metal
64+
#
6165
# <tt>ActionController::Metal</tt> is the simplest possible controller, providing a
6266
# valid Rack interface without the additional niceties provided by
6367
# ActionController::Base.

actionpack/lib/action_controller/metal/data_streaming.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
require "action_dispatch/http/content_disposition"
55

66
module ActionController # :nodoc:
7+
# = Action Controller Data Streaming
8+
#
79
# Methods for sending arbitrary data and for streaming files to the browser,
810
# instead of rendering.
911
module DataStreaming

actionpack/lib/action_controller/metal/default_headers.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# frozen_string_literal: true
22

33
module ActionController
4+
# = Action Controller Default Headers
5+
#
46
# Allows configuring default headers that will be automatically merged into
57
# each response.
68
module DefaultHeaders

actionpack/lib/action_controller/metal/etag_with_flash.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# frozen_string_literal: true
22

33
module ActionController
4+
# = Action Controller Etag With Flash
5+
#
46
# When you're using the flash, it's generally used as a conditional on the view.
57
# This means the content of the view depends on the flash. Which in turn means
68
# that the ETag for a response should be computed with the content of the flash

0 commit comments

Comments
 (0)