Fix API docs

lib/hanami/action.rb

@@ -83,10 +83,10 @@ def self.gem_loader
     #       config.format :json
     #     end
     #
-    #   @return [Config]
+    # @return [Config]
     #
-    #   @api public
-    #   @since 2.0.0
+    # @since 2.0.0
+    # @api public
 
     # @!scope instance
 
@@ -138,7 +138,7 @@ def self.params(_klass = nil)
             "To use `params`, please add 'hanami/validations' gem to your Gemfile"
     end
 
-    # @overload self.append_before(*callbacks, &block)
+    # @overload append_before(*callbacks, &block)
     #   Define a callback for an Action.
     #   The callback will be executed **before** the action is called, in the
     #   order they are added.
@@ -153,7 +153,7 @@ def self.params(_klass = nil)
     #
     #   @since 0.3.2
     #
-    #   @see Hanami::Action::Callbacks::ClassMethods#append_after
+    #   @see Action#append_after
     #
     #   @example Method names (symbols)
     #     require "hanami/controller"
@@ -206,7 +206,7 @@ class << self
       alias_method :before, :append_before
     end
 
-    # @overload self.append_after(*callbacks, &block)
+    # @overload append_after(*callbacks, &block)
     #   Define a callback for an Action.
     #   The callback will be executed **after** the action is called, in the
     #   order they are added.
@@ -221,7 +221,7 @@ class << self
     #
     #   @since 0.3.2
     #
-    #   @see Hanami::Action::Callbacks::ClassMethods#append_before
+    # @see Action#append_before
     def self.append_after(...)
       config.after_callbacks.append(...)
     end
@@ -231,7 +231,7 @@ class << self
       alias_method :after, :append_after
     end
 
-    # @overload self.prepend_before(*callbacks, &block)
+    # @overload prepend_before(*callbacks, &block)
     #   Define a callback for an Action.
     #   The callback will be executed **before** the action is called.
     #   It will add the callback at the beginning of the callbacks' chain.
@@ -246,12 +246,12 @@ class << self
     #
     #   @since 0.3.2
     #
-    #   @see Hanami::Action::Callbacks::ClassMethods#prepend_after
+    # @see Action#prepend_after
     def self.prepend_before(...)
       config.before_callbacks.prepend(...)
     end
 
-    # @overload self.prepend_after(*callbacks, &block)
+    # @overload prepend_after(*callbacks, &block)
     #   Define a callback for an Action.
     #   The callback will be executed **after** the action is called.
     #   It will add the callback at the beginning of the callbacks' chain.
@@ -266,7 +266,7 @@ def self.prepend_before(...)
     #
     #   @since 0.3.2
     #
-    #   @see Hanami::Action::Callbacks::ClassMethods#prepend_before
+    # @see Action#prepend_before
     def self.prepend_after(...)
       config.after_callbacks.prepend(...)
     end
@@ -334,11 +334,14 @@ def call(env)
 
     protected
 
-    # Hook for subclasses to apply behavior as part of action invocation
+    # Hook for subclasses to apply behavior as part of action invocation.
+    #
+    # This is the method you'll implement in your actions.
     #
     # @param request [Hanami::Action::Request]
     # @param response [Hanami::Action::Response]
     #
+    # @abstract
     # @since 2.0.0
     # @api public
     def handle(request, response)
@@ -361,8 +364,8 @@ def handle(request, response)
     #
     # @since 0.2.0
     #
-    # @see Hanami::Action::Throwable#handle_exception
-    # @see Hanami::Http::Status:ALL
+    # @see Hanami::Action.handle_exception
+    # @see https://rubydoc.info/github/rack/rack/Rack/Utils
     #
     # @example Basic usage
     #   require "hanami/controller"
@@ -525,8 +528,6 @@ def _run_after_callbacks(*args)
     #
     # @since 0.5.0
     #
-    # @see Hanami::Action#_requires_no_body?
-    #
     # @example
     #   require "hanami/controller"
     #

lib/hanami/action/cache.rb

@@ -5,10 +5,11 @@ class Action
     # Cache type API
     #
     # @since 0.3.0
+    # @api private
     #
-    # @see Hanami::Action::Cache::ClassMethods#cache_control
-    # @see Hanami::Action::Cache::ClassMethods#expires
-    # @see Hanami::Action::Cache::ClassMethods#fresh
+    # @see Hanami::Action::Response#cache_control
+    # @see Hanami::Action::Response#expires
+    # @see Hanami::Action::Response#fresh
     module Cache
       # Override Ruby's hook for modules.
       # It includes exposures logic

lib/hanami/action/config.rb

@@ -137,15 +137,13 @@ def format(*formats)
 
       # @!attribute [rw] root_directory
       #
-      #   Sets the the for the public directory, which is used for file downloads.
+      #   Sets the the root directory for the public directory, which is used for file downloads.
       #   This must be an existent directory.
       #
       #   Defaults to the current working directory.
       #
       #   @return [String] the directory path
       #
-      #   @api private
-      #
       #   @since 1.0.0
 
       # @!attribute [rw] public_directory

lib/hanami/action/cookie_jar.rb

@@ -11,7 +11,7 @@ class Action
     #
     # @since 0.1.0
     #
-    # @see Hanami::Action::Cookies#cookies
+    # @see Hanami::Action::Response#cookies
     class CookieJar
       # @since 0.4.5
       # @api private

lib/hanami/action/cookies.rb

@@ -4,11 +4,12 @@ module Hanami
   class Action
     # Cookies API
     #
-    # This module isn't included by default.
+    # If you want cookies in your actions then include this module.
+    # It's not included by default.
     #
     # @since 0.1.0
     #
-    # @see Hanami::Action::Cookies#cookies
+    # @see Hanami::Action::Response#cookies
     module Cookies
       private
 

lib/hanami/action/csrf_protection.rb

@@ -6,7 +6,6 @@
 require_relative "errors"
 
 module Hanami
-  # @api private
   class Action
     # CSRF Protection
     #
@@ -30,8 +29,8 @@ class Action
     #
     # @since 0.4.0
     #
-    # @see https://www.owasp.org/index.php/Cross-Site_Request_Forgery_%28CSRF%29
-    # @see https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)_Prevention_Cheat_Sheet
+    # @see https://owasp.org/www-community/attacks/csrf
+    # @see https://cheatsheetseries.owasp.org/cheatsheets/Cross-Site_Request_Forgery_Prevention_Cheat_Sheet.html
     #
     # @example Custom Handling
     #   module Web::Controllers::Books

lib/hanami/action/response.rb

@@ -14,7 +14,7 @@ class Action
     # @see http://www.rubydoc.info/gems/rack/Rack/Response
     #
     # @since 2.0.0
-    # @api private
+    # @api public
     class Response < ::Rack::Response
       # @since 2.0.0
       # @api private