From 5349f231089ddb884c7cb5405e74b7871383d65d Mon Sep 17 00:00:00 2001
From: Ryuta Kamizono <kamipo@gmail.com>
Date: Sat, 30 Sep 2017 18:33:53 +0900
Subject: Remove `:api:` tag that has leaked on the doc directly [ci skip]

Currently `:api:` tag has leaked on the doc directly since RDoc doesn't
support `:api:` tag directive.

http://api.rubyonrails.org/v5.1/classes/AbstractController/Rendering.html

So `:api: private` doesn't work as expected. We are using `:nodoc:` for
the purpose.

Related #13989.
---
 actionpack/lib/abstract_controller/base.rb               |  2 --
 actionpack/lib/abstract_controller/rendering.rb          | 16 +++-------------
 .../lib/action_controller/metal/instrumentation.rb       |  4 ----
 actionpack/test/controller/new_base/base_test.rb         |  3 ---
 4 files changed, 3 insertions(+), 22 deletions(-)

(limited to 'actionpack')

diff --git a/actionpack/lib/abstract_controller/base.rb b/actionpack/lib/abstract_controller/base.rb
index 3761054bb7..14afb355ab 100644
--- a/actionpack/lib/abstract_controller/base.rb
+++ b/actionpack/lib/abstract_controller/base.rb
@@ -180,8 +180,6 @@ module AbstractController
       #
       # ==== Parameters
       # * <tt>name</tt> - The name of an action to be tested
-      #
-      # :api: private
       def action_method?(name)
         self.class.action_methods.include?(name)
       end
diff --git a/actionpack/lib/abstract_controller/rendering.rb b/actionpack/lib/abstract_controller/rendering.rb
index 41898c4c2e..4b4915a85d 100644
--- a/actionpack/lib/abstract_controller/rendering.rb
+++ b/actionpack/lib/abstract_controller/rendering.rb
@@ -20,7 +20,6 @@ module AbstractController
 
     # Normalizes arguments, options and then delegates render_to_body and
     # sticks the result in <tt>self.response_body</tt>.
-    # :api: public
     def render(*args, &block)
       options = _normalize_render(*args, &block)
       rendered_body = render_to_body(options)
@@ -42,19 +41,16 @@ module AbstractController
     # (as ActionController extends it to be anything that
     # responds to the method each), this method needs to be
     # overridden in order to still return a string.
-    # :api: plugin
     def render_to_string(*args, &block)
       options = _normalize_render(*args, &block)
       render_to_body(options)
     end
 
     # Performs the actual template rendering.
-    # :api: public
     def render_to_body(options = {})
     end
 
-    # Returns Content-Type of rendered content
-    # :api: public
+    # Returns Content-Type of rendered content.
     def rendered_format
       Mime[:text]
     end
@@ -65,7 +61,6 @@ module AbstractController
 
     # This method should return a hash with assigns.
     # You can overwrite this configuration per controller.
-    # :api: public
     def view_assigns
       protected_vars = _protected_ivars
       variables      = instance_variables
@@ -79,7 +74,6 @@ module AbstractController
     # Normalize args by converting <tt>render "foo"</tt> to
     # <tt>render :action => "foo"</tt> and <tt>render "foo/bar"</tt> to
     # <tt>render :file => "foo/bar"</tt>.
-    # :api: plugin
     def _normalize_args(action = nil, options = {})
       if action.respond_to?(:permitted?)
         if action.permitted?
@@ -95,20 +89,17 @@ module AbstractController
     end
 
     # Normalize options.
-    # :api: plugin
     def _normalize_options(options)
       options
     end
 
     # Process extra options.
-    # :api: plugin
     def _process_options(options)
       options
     end
 
     # Process the rendered format.
-    # :api: private
-    def _process_format(format)
+    def _process_format(format) # :nodoc:
     end
 
     def _process_variant(options)
@@ -121,8 +112,7 @@ module AbstractController
     end
 
     # Normalize args and options.
-    # :api: private
-    def _normalize_render(*args, &block)
+    def _normalize_render(*args, &block) # :nodoc:
       options = _normalize_args(*args, &block)
       _process_variant(options)
       _normalize_options(options)
diff --git a/actionpack/lib/action_controller/metal/instrumentation.rb b/actionpack/lib/action_controller/metal/instrumentation.rb
index 476f0843b2..5ef83af07a 100644
--- a/actionpack/lib/action_controller/metal/instrumentation.rb
+++ b/actionpack/lib/action_controller/metal/instrumentation.rb
@@ -83,15 +83,12 @@ module ActionController
     #   def cleanup_view_runtime
     #     super - time_taken_in_something_expensive
     #   end
-    #
-    # :api: plugin
     def cleanup_view_runtime
       yield
     end
 
     # Every time after an action is processed, this method is invoked
     # with the payload, so you can add more information.
-    # :api: plugin
     def append_info_to_payload(payload)
       payload[:view_runtime] = view_runtime
     end
@@ -100,7 +97,6 @@ module ActionController
       # A hook which allows other frameworks to log what happened during
       # controller process action. This method should return an array
       # with the messages to be added.
-      # :api: plugin
       def log_process_action(payload) #:nodoc:
         messages, view_runtime = [], payload[:view_runtime]
         messages << ("Views: %.1fms" % view_runtime.to_f) if view_runtime
diff --git a/actionpack/test/controller/new_base/base_test.rb b/actionpack/test/controller/new_base/base_test.rb
index d9f200b2a7..280134f8d2 100644
--- a/actionpack/test/controller/new_base/base_test.rb
+++ b/actionpack/test/controller/new_base/base_test.rb
@@ -47,7 +47,6 @@ module Dispatching
   end
 
   class BaseTest < Rack::TestCase
-    # :api: plugin
     test "simple dispatching" do
       get "/dispatching/simple/index"
 
@@ -56,14 +55,12 @@ module Dispatching
       assert_content_type "text/plain; charset=utf-8"
     end
 
-    # :api: plugin
     test "directly modifying response body" do
       get "/dispatching/simple/modify_response_body"
 
       assert_body "success"
     end
 
-    # :api: plugin
     test "directly modifying response body twice" do
       get "/dispatching/simple/modify_response_body_twice"
 
-- 
cgit v1.2.3