From a52ff1b0848e8bb2310738ec7b762b82edbbfcb2 Mon Sep 17 00:00:00 2001 From: Ryuta Kamizono Date: Fri, 20 Oct 2017 05:34:47 +0900 Subject: Keep `:api: plugin` methods in the doc [ci skip] `:api:` tag was removed in 5349f231 since RDoc doesn't support `:api:` tag. But those methods are not private API, they are public API for renderers. The renderers should be able to know that they can override this method. --- actionpack/lib/abstract_controller/rendering.rb | 6 +++--- actionpack/lib/action_controller/metal/instrumentation.rb | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) (limited to 'actionpack') diff --git a/actionpack/lib/abstract_controller/rendering.rb b/actionpack/lib/abstract_controller/rendering.rb index 7e156586b9..fe1cd4a5a5 100644 --- a/actionpack/lib/abstract_controller/rendering.rb +++ b/actionpack/lib/abstract_controller/rendering.rb @@ -75,7 +75,7 @@ module AbstractController # Normalize args by converting render "foo" to # render :action => "foo" and render "foo/bar" to # render :file => "foo/bar". - def _normalize_args(action = nil, options = {}) + def _normalize_args(action = nil, options = {}) # :doc: if action.respond_to?(:permitted?) if action.permitted? action @@ -90,12 +90,12 @@ module AbstractController end # Normalize options. - def _normalize_options(options) + def _normalize_options(options) # :doc: options end # Process extra options. - def _process_options(options) + def _process_options(options) # :doc: options end diff --git a/actionpack/lib/action_controller/metal/instrumentation.rb b/actionpack/lib/action_controller/metal/instrumentation.rb index 5ef83af07a..be9449629f 100644 --- a/actionpack/lib/action_controller/metal/instrumentation.rb +++ b/actionpack/lib/action_controller/metal/instrumentation.rb @@ -83,13 +83,13 @@ module ActionController # def cleanup_view_runtime # super - time_taken_in_something_expensive # end - def cleanup_view_runtime + def cleanup_view_runtime # :doc: yield end # Every time after an action is processed, this method is invoked # with the payload, so you can add more information. - def append_info_to_payload(payload) + def append_info_to_payload(payload) # :doc: payload[:view_runtime] = view_runtime end -- cgit v1.2.3