lib/magicka/aggregator/method_builder.rb in magicka-0.5.6 vs lib/magicka/aggregator/method_builder.rb in magicka-0.6.0

@@ -4,18 +4,28 @@
   class Aggregator
     # @api private
     #
     # Class responsible for building an {Aggregator} method
     class MethodBuilder < Sinclair
+      # @param klass [Class.new<Aggregator>]
+      #   Aggragator class to receive the method
+      # @param element_class [Class<Magicka::ELement>]
+      #   Class of the element to be rendered
+      # @param method_name [String,Symbol]
+      #   Name of the method that will render the element
+      # @param template [String] custom template file to be used
       def initialize(klass, element_class, method_name = nil, template: nil)
         super(klass)
 
         @element_class = element_class
         @method_name = method_name
         @template = template
       end
 
+      # Prepare methods to be built
+      #
+      # @return [Aggregator::MethodBuilder] return self
       def prepare
         element_klass = element_class
         template_file = template
 
         add_method(method_name) do |field, model: self.model, **args|
@@ -30,10 +40,31 @@
       end
 
       private
 
       attr_reader :element_class, :template
+      # @method element_class
+      # @api private
+      # @private
+      #
+      # Class of the element to be rendered by the method
+      #
+      # @return [Class<Magicka::Element>]
 
+      # @method template
+      # @api private
+      # @private
+      #
+      # template file
+      #
+      # @return [String]
+
+      # name of the method to be generated
+      #
+      # When the method name was not supplied in the constructor,
+      # it is infered from {#element_class}
+      #
+      # @return [String,Symbol]
       def method_name
         @method_name ||= element_class
                          .name
                          .underscore
                          .gsub(%r{.*/}, '')