kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Show RequestForgeryProtection methods in api doc [ci skip]

Browse source 
Several methods of `RequestForgeryProtection` are not showed in the api
doc even though `:doc:` is specified.
(e.g. `form_authenticity_param`)
http://api.rubyonrails.org/classes/ActionController/RequestForgeryProtection.html

These methods are listed in the doc of v4.1.
http://api.rubyonrails.org/v4.1/classes/ActionController/RequestForgeryProtection.html

This is due to the influence of `:nodoc:` added in #18102, methods after
 `CROSS_ORIGIN_JAVASCRIPT_WARNING` not showed from the doc.
Therefore, in order to show the method like originally, added `startdoc`
after `CROSS_ORIGIN_JAVASCRIPT_WARNING`.
This commit is contained in:
yuuji.yaginuma 2017-11-05 21:23:05 +09:00
parent 9ec6736205
commit ab293293c3
1 changed files with 1 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
actionpack/lib/action_controller/metal/request_forgery_protection.rb
View file

@ -248,6 +248,7 @@ module ActionController #:nodoc:
"If you know what you're doing, go ahead and disable forgery " \ "If you know what you're doing, go ahead and disable forgery " \
"protection on this action to permit cross-origin JavaScript embedding." "protection on this action to permit cross-origin JavaScript embedding."
private_constant :CROSS_ORIGIN_JAVASCRIPT_WARNING private_constant :CROSS_ORIGIN_JAVASCRIPT_WARNING
# :startdoc:
# If `verify_authenticity_token` was run (indicating that we have # If `verify_authenticity_token` was run (indicating that we have
# forgery protection enabled for this request) then also verify that # forgery protection enabled for this request) then also verify that