Adds some documentation

[rbdr/lyricli.rb] / lib / lyricli.rb

diff --git a/lib/lyricli.rb b/lib/lyricli.rb
index 557fa3bc331dc65806360374bfc2861e3af07f4b..1c908b0f1bce666553e266f3b89e9fa4e404685f 100755 (executable)
--- a/lib/lyricli.rb
+++ b/lib/lyricli.rb
@@ -39,21 +39,26 @@ module Lyricli
   end
 
   # Returns a list of the available sources to enable or disable
+  # @return [String] the list of available sources. Enabled sources have
+  #                   a star appended.
   def self.sources
     source_manager = SourceManager.new
     source_manager.available_sources(true).join(", ")
   end
 
+  # Enables a source via the Source Manager
   def self.enable(source_name)
     source_manager = SourceManager.new
     source_manager.enable(source_name)
   end
 
+  # Disables a source via the Source Manager
   def self.disable(source_name)
     source_manager = SourceManager.new
     source_manager.disable(source_name)
   end
 
+  # Resets all configuration for a source via the Source Manager
   def self.reset(source_name)
     source_manager = SourceManager.new
     source_manager.reset(source_name)