Adds some documentation

[rbdr/lyricli.rb] / doc / method_list.html

diff --git a/doc/method_list.html b/doc/method_list.html
index 638dd0bc321682613f2ee19169c0d34ec621188a..f731b8e91e08bde4d6ef451eaffddaa1c17fdde2 100644 (file)
--- a/doc/method_list.html
+++ b/doc/method_list.html
@@ -63,6 +63,14 @@
   
 
   <li class="r1 ">
   
 
   <li class="r1 ">

+    <span class='object_link'><a href="Lyricli/SourceManager.html#available_sources-instance_method" title="Lyricli::SourceManager#available_sources (method)">#available_sources</a></span>
+    
+      <small>Lyricli::SourceManager</small>
+    
+  </li>
+  
+
+  <li class="r2 ">

     <span class='object_link'><a href="Lyricli/Util.html#camelize-instance_method" title="Lyricli::Util#camelize (method)">#camelize</a></span>
     
       <small>Lyricli::Util</small>
     <span class='object_link'><a href="Lyricli/Util.html#camelize-instance_method" title="Lyricli::Util#camelize (method)">#camelize</a></span>
     
       <small>Lyricli::Util</small>


@@ -70,7 +78,7 @@
   </li>
   
 
   </li>
   
 

-  <li class="r2 ">
+  <li class="r1 ">

     <span class='object_link'><a href="Lyricli/Lyricli.html#check_params-instance_method" title="Lyricli::Lyricli#check_params (method)">#check_params</a></span>
     
       <small>Lyricli::Lyricli</small>
     <span class='object_link'><a href="Lyricli/Lyricli.html#check_params-instance_method" title="Lyricli::Lyricli#check_params (method)">#check_params</a></span>
     
       <small>Lyricli::Lyricli</small>


@@ -78,7 +86,7 @@
   </li>
   
 
   </li>
   
 

-  <li class="r1 ">
+  <li class="r2 ">

     <span class='object_link'><a href="Lyricli/Sources/Rdio.html#create_auth_token-class_method" title="Lyricli::Sources::Rdio.create_auth_token (method)">create_auth_token</a></span>
     
       <small>Lyricli::Sources::Rdio</small>
     <span class='object_link'><a href="Lyricli/Sources/Rdio.html#create_auth_token-class_method" title="Lyricli::Sources::Rdio.create_auth_token (method)">create_auth_token</a></span>
     
       <small>Lyricli::Sources::Rdio</small>


@@ -86,6 +94,14 @@
   </li>
   
 
   </li>
   
 

+  <li class="r1 ">
+    <span class='object_link'><a href="Lyricli/Sources/Rdio.html#current_track-instance_method" title="Lyricli::Sources::Rdio#current_track (method)">#current_track</a></span>
+    
+      <small>Lyricli::Sources::Rdio</small>
+    
+  </li>
+  
+

   <li class="r2 ">
     <span class='object_link'><a href="Lyricli/Sources/Arguments.html#current_track-instance_method" title="Lyricli::Sources::Arguments#current_track (method)">#current_track</a></span>
     
   <li class="r2 ">
     <span class='object_link'><a href="Lyricli/Sources/Arguments.html#current_track-instance_method" title="Lyricli::Sources::Arguments#current_track (method)">#current_track</a></span>
     


@@ -95,22 +111,30 @@
   
 
   <li class="r1 ">
   
 
   <li class="r1 ">

-    <span class='object_link'><a href="Lyricli/SourceManager.html#current_track-instance_method" title="Lyricli::SourceManager#current_track (method)">#current_track</a></span>
+    <span class='object_link'><a href="Lyricli/Sources/Itunes.html#current_track-instance_method" title="Lyricli::Sources::Itunes#current_track (method)">#current_track</a></span>

     
     

-      <small>Lyricli::SourceManager</small>
+      <small>Lyricli::Sources::Itunes</small>

     
   </li>
   
 
   <li class="r2 ">
     
   </li>
   
 
   <li class="r2 ">

-    <span class='object_link'><a href="Lyricli/Sources/Rdio.html#current_track-instance_method" title="Lyricli::Sources::Rdio#current_track (method)">#current_track</a></span>
+    <span class='object_link'><a href="Lyricli/SourceManager.html#current_track-instance_method" title="Lyricli::SourceManager#current_track (method)">#current_track</a></span>

     
     

-      <small>Lyricli::Sources::Rdio</small>
+      <small>Lyricli::SourceManager</small>

     
   </li>
   
 
   <li class="r1 ">
     
   </li>
   
 
   <li class="r1 ">

+    <span class='object_link'><a href="Lyricli/Configuration.html#delete-instance_method" title="Lyricli::Configuration#delete (method)">#delete</a></span>
+    
+      <small>Lyricli::Configuration</small>
+    
+  </li>
+  
+
+  <li class="r2 ">

     <span class='object_link'><a href="Lyricli/SourceManager.html#disable-instance_method" title="Lyricli::SourceManager#disable (method)">#disable</a></span>
     
       <small>Lyricli::SourceManager</small>
     <span class='object_link'><a href="Lyricli/SourceManager.html#disable-instance_method" title="Lyricli::SourceManager#disable (method)">#disable</a></span>
     
       <small>Lyricli::SourceManager</small>


@@ -118,10 +142,18 @@
   </li>
   
 
   </li>
   
 

+  <li class="r1 ">
+    <span class='object_link'><a href="Lyricli.html#disable-class_method" title="Lyricli.disable (method)">disable</a></span>
+    
+      <small>Lyricli</small>
+    
+  </li>
+  
+

   <li class="r2 ">
   <li class="r2 ">

-    <span class='object_link'><a href="Lyricli/SourceManager.html#enable-instance_method" title="Lyricli::SourceManager#enable (method)">#enable</a></span>
+    <span class='object_link'><a href="Lyricli/Sources/Itunes.html#enable-class_method" title="Lyricli::Sources::Itunes.enable (method)">enable</a></span>

     
     

-      <small>Lyricli::SourceManager</small>
+      <small>Lyricli::Sources::Itunes</small>

     
   </li>
   
     
   </li>
   


@@ -135,22 +167,30 @@
   
 
   <li class="r2 ">
   
 
   <li class="r2 ">

-    <span class='object_link'><a href="Lyricli/Sources/Rdio.html#enable-class_method" title="Lyricli::Sources::Rdio.enable (method)">enable</a></span>
+    <span class='object_link'><a href="Lyricli.html#enable-class_method" title="Lyricli.enable (method)">enable</a></span>

     
     

-      <small>Lyricli::Sources::Rdio</small>
+      <small>Lyricli</small>

     
   </li>
   
 
   <li class="r1 ">
     
   </li>
   
 
   <li class="r1 ">

-    <span class='object_link'><a href="Lyricli.html#execute-class_method" title="Lyricli.execute (method)">execute</a></span>
+    <span class='object_link'><a href="Lyricli/SourceManager.html#enable-instance_method" title="Lyricli::SourceManager#enable (method)">#enable</a></span>

     
     

-      <small>Lyricli</small>
+      <small>Lyricli::SourceManager</small>

     
   </li>
   
 
   <li class="r2 ">
     
   </li>
   
 
   <li class="r2 ">

+    <span class='object_link'><a href="Lyricli/Sources/Rdio.html#enable-class_method" title="Lyricli::Sources::Rdio.enable (method)">enable</a></span>
+    
+      <small>Lyricli::Sources::Rdio</small>
+    
+  </li>
+  
+
+  <li class="r1 ">

     <span class='object_link'><a href="Lyricli/Lyricli.html#exit_with_error-instance_method" title="Lyricli::Lyricli#exit_with_error (method)">#exit_with_error</a></span>
     
       <small>Lyricli::Lyricli</small>
     <span class='object_link'><a href="Lyricli/Lyricli.html#exit_with_error-instance_method" title="Lyricli::Lyricli#exit_with_error (method)">#exit_with_error</a></span>
     
       <small>Lyricli::Lyricli</small>


@@ -158,6 +198,14 @@
   </li>
   
 
   </li>
   
 

+  <li class="r2 ">
+    <span class='object_link'><a href="Lyricli/SourceManager.html#format_sources-instance_method" title="Lyricli::SourceManager#format_sources (method)">#format_sources</a></span>
+    
+      <small>Lyricli::SourceManager</small>
+    
+  </li>
+  
+

   <li class="r1 ">
     <span class='object_link'><a href="Lyricli/Lyricli.html#get_lyrics-instance_method" title="Lyricli::Lyricli#get_lyrics (method)">#get_lyrics</a></span>
     
   <li class="r1 ">
     <span class='object_link'><a href="Lyricli/Lyricli.html#get_lyrics-instance_method" title="Lyricli::Lyricli#get_lyrics (method)">#get_lyrics</a></span>
     


@@ -175,25 +223,25 @@
   
 
   <li class="r1 ">
   
 
   <li class="r1 ">

-    <span class='object_link'><a href="Lyricli/SourceManager.html#initialize-instance_method" title="Lyricli::SourceManager#initialize (method)">#initialize</a></span>
+    <span class='object_link'><a href="Lyricli/Sources/Rdio.html#initialize-instance_method" title="Lyricli::Sources::Rdio#initialize (method)">#initialize</a></span>

     
     

-      <small>Lyricli::SourceManager</small>
+      <small>Lyricli::Sources::Rdio</small>

     
   </li>
   
 
   <li class="r2 ">
     
   </li>
   
 
   <li class="r2 ">

-    <span class='object_link'><a href="Lyricli/Configuration.html#initialize-instance_method" title="Lyricli::Configuration#initialize (method)">#initialize</a></span>
+    <span class='object_link'><a href="Lyricli/SourceManager.html#initialize-instance_method" title="Lyricli::SourceManager#initialize (method)">#initialize</a></span>

     
     

-      <small>Lyricli::Configuration</small>
+      <small>Lyricli::SourceManager</small>

     
   </li>
   
 
   <li class="r1 ">
     
   </li>
   
 
   <li class="r1 ">

-    <span class='object_link'><a href="Lyricli/Sources/Arguments.html#initialize-instance_method" title="Lyricli::Sources::Arguments#initialize (method)">#initialize</a></span>
+    <span class='object_link'><a href="Lyricli/Configuration.html#initialize-instance_method" title="Lyricli::Configuration#initialize (method)">#initialize</a></span>

     
     

-      <small>Lyricli::Sources::Arguments</small>
+      <small>Lyricli::Configuration</small>

     
   </li>
   
     
   </li>
   


@@ -207,22 +255,30 @@
   
 
   <li class="r1 ">
   
 
   <li class="r1 ">

-    <span class='object_link'><a href="Lyricli/Sources/Rdio.html#initialize-instance_method" title="Lyricli::Sources::Rdio#initialize (method)">#initialize</a></span>
+    <span class='object_link'><a href="Lyricli/LyricsEngine.html#initialize-instance_method" title="Lyricli::LyricsEngine#initialize (method)">#initialize</a></span>

     
     

-      <small>Lyricli::Sources::Rdio</small>
+      <small>Lyricli::LyricsEngine</small>

     
   </li>
   
 
   <li class="r2 ">
     
   </li>
   
 
   <li class="r2 ">

-    <span class='object_link'><a href="Lyricli/LyricsEngine.html#initialize-instance_method" title="Lyricli::LyricsEngine#initialize (method)">#initialize</a></span>
+    <span class='object_link'><a href="Lyricli/Sources/Itunes.html#initialize-instance_method" title="Lyricli::Sources::Itunes#initialize (method)">#initialize</a></span>

     
     

-      <small>Lyricli::LyricsEngine</small>
+      <small>Lyricli::Sources::Itunes</small>

     
   </li>
   
 
   <li class="r1 ">
     
   </li>
   
 
   <li class="r1 ">

+    <span class='object_link'><a href="Lyricli/Sources/Arguments.html#initialize-instance_method" title="Lyricli::Sources::Arguments#initialize (method)">#initialize</a></span>
+    
+      <small>Lyricli::Sources::Arguments</small>
+    
+  </li>
+  
+
+  <li class="r2 ">

     <span class='object_link'><a href="Lyricli/Configuration.html#instance-class_method" title="Lyricli::Configuration.instance (method)">instance</a></span>
     
       <small>Lyricli::Configuration</small>
     <span class='object_link'><a href="Lyricli/Configuration.html#instance-class_method" title="Lyricli::Configuration.instance (method)">instance</a></span>
     
       <small>Lyricli::Configuration</small>


@@ -230,7 +286,23 @@
   </li>
   
 
   </li>
   
 

+  <li class="r1 ">
+    <span class='object_link'><a href="Lyricli/Configuration.html#load_config-instance_method" title="Lyricli::Configuration#load_config (method)">#load_config</a></span>
+    
+      <small>Lyricli::Configuration</small>
+    
+  </li>
+  
+

   <li class="r2 ">
   <li class="r2 ">

+    <span class='object_link'><a href="Lyricli.html#lyrics-class_method" title="Lyricli.lyrics (method)">lyrics</a></span>
+    
+      <small>Lyricli</small>
+    
+  </li>
+  
+
+  <li class="r1 ">

     <span class='object_link'><a href="Lyricli/Sources/Rdio.html#name-class_method" title="Lyricli::Sources::Rdio.name (method)">name</a></span>
     
       <small>Lyricli::Sources::Rdio</small>
     <span class='object_link'><a href="Lyricli/Sources/Rdio.html#name-class_method" title="Lyricli::Sources::Rdio.name (method)">name</a></span>
     
       <small>Lyricli::Sources::Rdio</small>


@@ -238,7 +310,7 @@
   </li>
   
 
   </li>
   
 

-  <li class="r1 ">
+  <li class="r2 ">

     <span class='object_link'><a href="Lyricli/Sources/Arguments.html#name-class_method" title="Lyricli::Sources::Arguments.name (method)">name</a></span>
     
       <small>Lyricli::Sources::Arguments</small>
     <span class='object_link'><a href="Lyricli/Sources/Arguments.html#name-class_method" title="Lyricli::Sources::Arguments.name (method)">name</a></span>
     
       <small>Lyricli::Sources::Arguments</small>


@@ -246,6 +318,14 @@
   </li>
   
 
   </li>
   
 

+  <li class="r1 ">
+    <span class='object_link'><a href="Lyricli/Sources/Itunes.html#name-class_method" title="Lyricli::Sources::Itunes.name (method)">name</a></span>
+    
+      <small>Lyricli::Sources::Itunes</small>
+    
+  </li>
+  
+

   <li class="r2 ">
     <span class='object_link'><a href="Lyricli/Util.html#parse_class-instance_method" title="Lyricli::Util#parse_class (method)">#parse_class</a></span>
     
   <li class="r2 ">
     <span class='object_link'><a href="Lyricli/Util.html#parse_class-instance_method" title="Lyricli::Util#parse_class (method)">#parse_class</a></span>
     


@@ -255,6 +335,14 @@
   
 
   <li class="r1 ">
   
 
   <li class="r1 ">

+    <span class='object_link'><a href="Lyricli/Sources/Rdio.html#reset-class_method" title="Lyricli::Sources::Rdio.reset (method)">reset</a></span>
+    
+      <small>Lyricli::Sources::Rdio</small>
+    
+  </li>
+  
+
+  <li class="r2 ">

     <span class='object_link'><a href="Lyricli/SourceManager.html#reset-instance_method" title="Lyricli::SourceManager#reset (method)">#reset</a></span>
     
       <small>Lyricli::SourceManager</small>
     <span class='object_link'><a href="Lyricli/SourceManager.html#reset-instance_method" title="Lyricli::SourceManager#reset (method)">#reset</a></span>
     
       <small>Lyricli::SourceManager</small>


@@ -262,18 +350,26 @@
   </li>
   
 
   </li>
   
 

+  <li class="r1 ">
+    <span class='object_link'><a href="Lyricli.html#reset-class_method" title="Lyricli.reset (method)">reset</a></span>
+    
+      <small>Lyricli</small>
+    
+  </li>
+  
+

   <li class="r2 ">
   <li class="r2 ">

-    <span class='object_link'><a href="Lyricli/Sources/Arguments.html#reset-class_method" title="Lyricli::Sources::Arguments.reset (method)">reset</a></span>
+    <span class='object_link'><a href="Lyricli/Sources/Itunes.html#reset-class_method" title="Lyricli::Sources::Itunes.reset (method)">reset</a></span>

     
     

-      <small>Lyricli::Sources::Arguments</small>
+      <small>Lyricli::Sources::Itunes</small>

     
   </li>
   
 
   <li class="r1 ">
     
   </li>
   
 
   <li class="r1 ">

-    <span class='object_link'><a href="Lyricli/Sources/Rdio.html#reset-class_method" title="Lyricli::Sources::Rdio.reset (method)">reset</a></span>
+    <span class='object_link'><a href="Lyricli/Sources/Arguments.html#reset-class_method" title="Lyricli::Sources::Arguments.reset (method)">reset</a></span>

     
     

-      <small>Lyricli::Sources::Rdio</small>
+      <small>Lyricli::Sources::Arguments</small>

     
   </li>
   
     
   </li>
   


@@ -287,6 +383,14 @@
   
 
   <li class="r1 ">
   
 
   <li class="r1 ">

+    <span class='object_link'><a href="Lyricli/Configuration.html#save_config-instance_method" title="Lyricli::Configuration#save_config (method)">#save_config</a></span>
+    
+      <small>Lyricli::Configuration</small>
+    
+  </li>
+  
+
+  <li class="r2 ">

     <span class='object_link'><a href="Lyricli/Lyricli.html#set_current_track-instance_method" title="Lyricli::Lyricli#set_current_track (method)">#set_current_track</a></span>
     
       <small>Lyricli::Lyricli</small>
     <span class='object_link'><a href="Lyricli/Lyricli.html#set_current_track-instance_method" title="Lyricli::Lyricli#set_current_track (method)">#set_current_track</a></span>
     
       <small>Lyricli::Lyricli</small>


@@ -294,6 +398,22 @@
   </li>
   
 
   </li>
   
 

+  <li class="r1 ">
+    <span class='object_link'><a href="Lyricli.html#sources-class_method" title="Lyricli.sources (method)">sources</a></span>
+    
+      <small>Lyricli</small>
+    
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="Lyricli.html#version-class_method" title="Lyricli.version (method)">version</a></span>
+    
+      <small>Lyricli</small>
+    
+  </li>
+  
+

       </ul>
     </div>
   </body>
       </ul>
     </div>
   </body>