style(yard-junk): fix compaints

marian13 · Oct 9, 2022 · 2f53b03 · 2f53b03
1 parent dcb1746
commit 2f53b03
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 11 deletions.
diff --git a/lib/convenient_service/core/entities/concerns.rb b/lib/convenient_service/core/entities/concerns.rb
@@ -96,7 +96,7 @@ def included?
         end
 
         ##
-        # @param [ConvenientService::Core::Entities::Concerns, Object]
+        # @param other [ConvenientService::Core::Entities::Concerns, Object]
         # @return [Boolean, nil]
         #
         def ==(other)

diff --git a/lib/convenient_service/core/entities/concerns/entities/stack.rb b/lib/convenient_service/core/entities/concerns/entities/stack.rb
@@ -85,7 +85,7 @@ def to_a
             end
 
             ##
-            # @param [ConvenientService::Core::Entities::Concerns::Entities::Stack, Object]
+            # @param other [ConvenientService::Core::Entities::Concerns::Entities::Stack, Object]
             # @return [Boolean, nil]
             #
             def ==(other)

diff --git a/lib/convenient_service/support/middleware/stack_builder.rb b/lib/convenient_service/support/middleware/stack_builder.rb
@@ -4,14 +4,19 @@ module ConvenientService
   module Support
     module Middleware
       ##
-      # TODO: Contribute.
+      # @internal
+      #   TODO: Contribute.
       #
-      # NOTE: Minimal `ibsciss-middleware` version - `0.4.2`.
-      # https://github.com/Ibsciss/ruby-middleware/tree/v0.4.2
+      #   NOTE: Minimal `ibsciss-middleware` version - `0.4.2`.
+      #   https://github.com/Ibsciss/ruby-middleware/tree/v0.4.2
       #
       class StackBuilder < Extractions::RubyMiddleware::Middleware::Builder
         ##
-        # https://github.com/Ibsciss/ruby-middleware/blob/v0.4.2/lib/middleware/builder.rb#L43
+        # @param opts [Hash]
+        # @param block [Proc]
+        # @return [void]
+        #
+        # @see https://github.com/Ibsciss/ruby-middleware/blob/v0.4.2/lib/middleware/builder.rb#L43
         #
         def initialize(opts = {}, &block)
           super
@@ -23,7 +28,7 @@ def initialize(opts = {}, &block)
         end
 
         ##
-        # @param [ConvenientService::Support::Middleware::StackBuilder, Object]
+        # @param other [ConvenientService::Support::Middleware::StackBuilder, Object]
         # @return [Boolean, nil]
         #
         def ==(other)
@@ -35,16 +40,21 @@ def ==(other)
         end
 
         ##
-        # NOTE: `use` can accept additional arguments and block,
-        # that is why `stack` contains tuples like [middleware, args, block].
-        # https://github.com/Ibsciss/ruby-middleware/blob/v0.4.2/lib/middleware/builder.rb#L76
+        # @return [Array]
+        #
+        # @internal
+        #   NOTE: `use` can accept additional arguments and block, that is why `stack` contains tuples like [middleware, args, block].
+        #   https://github.com/Ibsciss/ruby-middleware/blob/v0.4.2/lib/middleware/builder.rb#L76
         #
-        # TODO: better name than just `to_a`.
+        #   TODO: better name than just `to_a`.
         #
         def to_a
           stack
         end
 
+        ##
+        # @return [ConvenientService::Support::Middleware::StackBuilder]
+        #
         def dup
           self.class.new(
             ##