diff options
| author | yuuji.yaginuma <yuuji.yaginuma@gmail.com> | 2017-11-05 21:23:05 +0900 |
|---|---|---|
| committer | yuuji.yaginuma <yuuji.yaginuma@gmail.com> | 2017-11-05 21:23:05 +0900 |
| commit | ab293293c33792621c90c02c5516a99e78460663 (patch) | |
| tree | 7042017de07733adb470eb70add2139a8e3feaad | |
| parent | 9ec67362054e874ed905310a79b670941fa397af (diff) | |
| download | rails-ab293293c33792621c90c02c5516a99e78460663.tar.gz rails-ab293293c33792621c90c02c5516a99e78460663.tar.bz2 rails-ab293293c33792621c90c02c5516a99e78460663.zip | |
Show `RequestForgeryProtection` methods in api doc [ci skip]
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`.
| -rw-r--r-- | actionpack/lib/action_controller/metal/request_forgery_protection.rb | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/actionpack/lib/action_controller/metal/request_forgery_protection.rb b/actionpack/lib/action_controller/metal/request_forgery_protection.rb index d6cd5fd9e0..bd133f24a1 100644 --- a/actionpack/lib/action_controller/metal/request_forgery_protection.rb +++ b/actionpack/lib/action_controller/metal/request_forgery_protection.rb @@ -248,6 +248,7 @@ module ActionController #:nodoc: "If you know what you're doing, go ahead and disable forgery " \ "protection on this action to permit cross-origin JavaScript embedding." private_constant :CROSS_ORIGIN_JAVASCRIPT_WARNING + # :startdoc: # If `verify_authenticity_token` was run (indicating that we have # forgery protection enabled for this request) then also verify that |