lib/torm.rb in torm-0.0.1 vs lib/torm.rb in torm-0.1.0

@@ -12,18 +12,22 @@
   class << self
     include Tools
 
     attr_accessor :instance, :default_rules_file
 
+    # @return [Torm::RulesEngine] Singleton RulesEngine
     def instance
       @instance ||= RulesEngine.load || RulesEngine.new
     end
 
+    # @return [String] Path where the default rules can be stored
     def default_rules_file
       @default_rules_file ||= File.expand_path('tmp/rules.json')
     end
 
     # Load an engine with the current rules, yield it (to add rules) and then save it if rules were added.
+    #
+    # @yield [Torm::RulesEngine]
     def set_defaults(engine: instance)
       yield engine
       engine.save if engine.dirty?
     end
   end