Skip to content

Commit fa77687

Browse files
committed
Fix RDOC headings for Action View Helpers [ci-skip]
The Action View Helpers already had RDOC headings but most were on the wrong namespace causing them to not show up in the API docs. This moves them to the correct namespace, adds some missing headers and adds escaping.
1 parent fc5bb56 commit fa77687

23 files changed

+40
-23
lines changed

actionview/lib/action_view/helpers/active_model_helper.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
require "active_support/core_ext/enumerable"
55

66
module ActionView
7-
# = Active Model Helpers
87
module Helpers # :nodoc:
98
module ActiveModelHelper
109
end
1110

11+
# = Active \Model Instance Tag \Helpers
1212
module ActiveModelInstanceTag
1313
def object
1414
@active_model_object ||= begin

actionview/lib/action_view/helpers/asset_tag_helper.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@
77
require "action_view/helpers/tag_helper"
88

99
module ActionView
10-
# = Action View Asset Tag Helpers
1110
module Helpers # :nodoc:
11+
# = Action View Asset Tag \Helpers
12+
#
1213
# This module provides methods for generating HTML that links views to assets such
1314
# as images, JavaScripts, stylesheets, and feeds. These methods do not verify
1415
# the assets exist before linking to them:

actionview/lib/action_view/helpers/asset_url_helper.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
require "zlib"
44

55
module ActionView
6-
# = Action View Asset URL Helpers
76
module Helpers # :nodoc:
7+
# = Action View Asset URL \Helpers
8+
#
89
# This module provides methods for generating asset paths and
910
# URLs.
1011
#

actionview/lib/action_view/helpers/atom_feed_helper.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
require "set"
44

55
module ActionView
6-
# = Action View Atom Feed Helpers
76
module Helpers # :nodoc:
7+
# = Action View Atom Feed \Helpers
88
module AtomFeedHelper
99
# Adds easy defaults to writing Atom feeds with the Builder template engine (this does not work on ERB or any other
1010
# template languages).

actionview/lib/action_view/helpers/cache_helper.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# frozen_string_literal: true
22

33
module ActionView
4-
# = Action View Cache Helper
54
module Helpers # :nodoc:
5+
# = Action View Cache \Helpers
66
module CacheHelper
77
class UncacheableFragmentError < StandardError; end
88

actionview/lib/action_view/helpers/capture_helper.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
require "active_support/core_ext/string/output_safety"
44

55
module ActionView
6-
# = Action View Capture Helper
76
module Helpers # :nodoc:
7+
# = Action View Capture \Helpers
8+
#
89
# \CaptureHelper exposes methods to let you extract generated markup which
910
# can be used in other parts of a template or layout file.
1011
#

actionview/lib/action_view/helpers/controller_helper.rb

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

55
module ActionView
66
module Helpers # :nodoc:
7+
# = Action View Controller \Helpers
8+
#
79
# This module keeps all methods and behavior in ActionView
810
# that simply delegates to the controller.
911
module ControllerHelper # :nodoc:

actionview/lib/action_view/helpers/csp_helper.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# frozen_string_literal: true
22

33
module ActionView
4-
# = Action View CSP Helper
54
module Helpers # :nodoc:
65
module CspHelper
6+
# = Action View CSP \Helpers
7+
#
78
# Returns a meta tag "csp-nonce" with the per-session nonce value
89
# for allowing inline <script> tags.
910
#

actionview/lib/action_view/helpers/csrf_helper.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# frozen_string_literal: true
22

33
module ActionView
4-
# = Action View CSRF Helper
54
module Helpers # :nodoc:
5+
# = Action View CSRF \Helpers
66
module CsrfHelper
77
# Returns meta tags "csrf-param" and "csrf-token" with the name of the cross-site
88
# request forgery protection parameter and token, respectively.

actionview/lib/action_view/helpers/date_helper.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
module ActionView
1212
module Helpers # :nodoc:
13-
# = Action View Date Helpers
13+
# = Action View Date \Helpers
1414
#
1515
# The Date Helper primarily creates select/option tags for different kinds of dates and times or date and time
1616
# elements. All of the select-type methods share a number of common options that are as follows:

0 commit comments

Comments
 (0)