lib/basquiat.rb in basquiat-1.2.0 vs lib/basquiat.rb in basquiat-1.3.0.pre.1

@@ -6,24 +6,29 @@
 require 'basquiat/errors'
 require 'basquiat/adapters'
 require 'basquiat/version'
 require 'basquiat/interfaces/base'
 
-# Overall namespace And config class
+# Overall namespace config class
 module Basquiat
   class << self
+    # resets the gems configuration. Useful for testing and not much else
     def reset
       @configuration = Configuration.new
     end
 
+    # @return [Configuration] returns or initializes the Configuration object
     def configuration
       @configuration ||= Configuration.new
     end
 
+    # used to configure the gem using a block
+    # @yieldparam [Configuration] configuration the current {Configuration} instance
     def configure
       yield configuration
     end
 
+    # @return [Logger] shorthand for configuration.logger
     def logger
       configuration.logger
     end
   end
 end