lib/shoppe.rb in shoppe-0.0.16 vs lib/shoppe.rb in shoppe-0.0.17

@@ -12,32 +12,49 @@
 require 'nifty/attachments'
 require 'nifty/dialog'
 
 module Shoppe
   
-  class Error < StandardError; end
+  class Error < StandardError
+    # The Shoppe::Error is the base class for all errors raised by Shoppe.
+  end
   
   class << self
     
+    # The path to the root of the Shoppe applicatinio
+    #
+    # @return [String]
     def root
       File.expand_path('../../', __FILE__)
     end
     
+    # Shoppe settings as configured in the database
+    #
+    # @return [Shoppe::Settings]
     def settings
       Thread.current[:shoppe_settings] ||= Shoppe::Settings.new(Shoppe::Setting.to_hash)
     end
     
+    # Clears the settings from the thread cache so they will be taken
+    # from the database on next access
+    # 
+    # @return [NilClass]
     def reset_settings
       Thread.current[:shoppe_settings] = nil
     end
     
-    def add_setting_group(group, fields = [])
-      setting_groups[group]  ||= []
-      setting_groups[group]    = setting_groups[group] | fields
+    # Defines a new set of settings which should be configrable from the settings page 
+    # in the Shoppe UI.
+    def add_settings_group(group, fields = [])
+      settings_groups[group]  ||= []
+      settings_groups[group]    = settings_groups[group] | fields
     end
     
-    def setting_groups
-      @setting_groups ||= {}
+    # All settings groups which are available for configuration on the settings page.
+    #
+    # @return [Hash]
+    def settings_groups
+      @settings_groups ||= {}
     end
     
   end
   
 end