lib/yao/config.rb in yao-0.13.4 vs lib/yao/config.rb in yao-0.14.0

@@ -1,24 +1,32 @@
 module Yao
   class Config
+
+    # @return [Hash]
     def _configuration_defaults
       @_configuration_defaults ||= {}
     end
 
+    # @return [Hash]
     def _configuration_hooks
       @_configuration_hooks ||= {}
     end
 
+    # @return [Array]
     def _configuration_hooks_queue
       @_configuration_hooks_queue ||= []
     end
 
+    # @return [Hash]
     def configuration
       @configuration ||= {}
     end
 
     HOOK_RENEW_CLIENT_KEYS = %i(tenant_name username password auth_url debug debug_record_response)
+
+    # @param v [Boolean]
+    # @return [Array]
     def delay_hook=(v)
       @delay_hook = v
       if !v and !_configuration_hooks_queue.empty?
         _configuration_hooks_queue.each do |n, val|
           _configuration_hooks[n].call(val) if _configuration_hooks[n]
@@ -31,14 +39,18 @@
 
         _configuration_hooks_queue.clear
       end
     end
 
+    # @return [Boolean]
     def delay_hook?
       @delay_hook
     end
 
+    # @param name [String]
+    # @param default [String]
+    # @param hook [Proc]
     def param(name, default, &hook)
       raise("Duplicate definition of #{name}") if self.respond_to?(name)
 
       name = name.to_sym
       _configuration_defaults[name] = default
@@ -53,10 +65,13 @@
           raise ArgumentError, "wrong number of arguments (#{a.size} for 0, 1)"
         end
       end
     end
 
+    # @param name [String]
+    # @param value [String]
+    # @return [String]
     def set(name, value)
       raise("Undefined config key #{name}") unless self.respond_to?(name)
       configuration[name.to_sym] = value
       if delay_hook?
         _configuration_hooks_queue.push([name, value])
@@ -65,19 +80,23 @@
       end
       value
     end
   end
 
+  # @param blk [Proc]
+  # @return [Yao::Config]
   def self.config(&blk)
     @__config ||= Config.new
     if blk
       @__config.delay_hook = true
       @__config.instance_eval(&blk)
       @__config.delay_hook = false
     end
     @__config
   end
 
+  # @param blk [Proc]
+  # @return [Yao::Config]
   def self.configure(&blk)
     config(&blk)
   end
 end