X-Git-Url: https://git.r.bdr.sh/rbdr/lyricli.rb/blobdiff_plain/ad84791b951f4ebdfae9c6bf0a54244a8b5c8f16..34d0bf15a6f4009de376ceed1d7d5cca24a8dfe7:/doc/Lyricli.html diff --git a/doc/Lyricli.html b/doc/Lyricli.html index 8c0685a..8a09e7f 100644 --- a/doc/Lyricli.html +++ b/doc/Lyricli.html @@ -6,7 +6,7 @@ <title> Module: Lyricli - — Documentation by YARD 0.8.1 + — Documentation by YARD 0.8.2.1 </title> @@ -80,13 +80,26 @@ <dt class="r1 last">Defined in:</dt> <dd class="r1 last">lib/lyricli.rb<span class="defines">,<br /> - lib/lyricli/util.rb,<br /> lib/lyricli/sources/rdio.rb,<br /> lib/lyricli/lyrics_engine.rb,<br /> lib/lyricli/configuration.rb,<br /> lib/lyricli/source_manager.rb,<br /> lib/lyricli/sources/arguments.rb</span> + lib/lyricli/util.rb,<br /> lib/lyricli/lyricli.rb,<br /> lib/lyricli/sources/rdio.rb,<br /> lib/lyricli/lyrics_engine.rb,<br /> lib/lyricli/configuration.rb,<br /> lib/lyricli/sources/itunes.rb,<br /> lib/lyricli/source_manager.rb,<br /> lib/lyricli/sources/arguments.rb</span> </dd> </dl> <div class="clear"></div> -<h2>Defined Under Namespace</h2> +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +The Lyricli module allows you to easily search for lyrics by looking for +song and artist data from diverse sources. +</p> + + + </div> +</div> +<div class="tags"> + + +</div><h2>Defined Under Namespace</h2> <p class="children"> @@ -116,7 +129,83 @@ <li class="public "> <span class="summary_signature"> - <a href="#execute-class_method" title="execute (class method)">+ (Object) <strong>execute</strong> </a> + <a href="#disable-class_method" title="disable (class method)">+ (Object) <strong>disable</strong>(source_name) </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Disables a source via the Source Manager. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#enable-class_method" title="enable (class method)">+ (Object) <strong>enable</strong>(source_name) </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Enables a source via the Source Manager. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#lyrics-class_method" title="lyrics (class method)">+ (String) <strong>lyrics</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Lyricli instance and returns lyrics by going through the +sources. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#reset-class_method" title="reset (class method)">+ (Object) <strong>reset</strong>(source_name) </a> @@ -130,7 +219,60 @@ - <span class="summary_desc"><div class='inline'></div></span> + <span class="summary_desc"><div class='inline'><p> +Resets all configuration for a source via the Source Manager. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#sources-class_method" title="sources (class method)">+ (String) <strong>sources</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Returns a list of the available sources to enable or disable. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#version-class_method" title="version (class method)">+ (String) <strong>version</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Returns the version of the library. +</p> +</div></span> </li> @@ -145,35 +287,323 @@ <div class="method_details first"> - <h3 class="signature first" id="execute-class_method"> + <h3 class="signature first" id="disable-class_method"> - + (<tt>Object</tt>) <strong>execute</strong> + + (<tt>Object</tt>) <strong>disable</strong>(source_name) -</h3><table class="source_code"> +</h3><div class="docstring"> + <div class="discussion"> + <p> +Disables a source via the Source Manager +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +56 +57 +58 +59</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/lyricli.rb', line 56</span> + +<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_disable'>disable</span><span class='lparen'>(</span><span class='id identifier rubyid_source_name'>source_name</span><span class='rparen'>)</span> + <span class='id identifier rubyid_source_manager'>source_manager</span> <span class='op'>=</span> <span class='const'>SourceManager</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> + <span class='id identifier rubyid_source_manager'>source_manager</span><span class='period'>.</span><span class='id identifier rubyid_disable'>disable</span><span class='lparen'>(</span><span class='id identifier rubyid_source_name'>source_name</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="enable-class_method"> + + + (<tt>Object</tt>) <strong>enable</strong>(source_name) + + + + + +</h3><div class="docstring"> + <div class="discussion"> + <p> +Enables a source via the Source Manager +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +50 +51 +52 +53</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/lyricli.rb', line 50</span> + +<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enable'>enable</span><span class='lparen'>(</span><span class='id identifier rubyid_source_name'>source_name</span><span class='rparen'>)</span> + <span class='id identifier rubyid_source_manager'>source_manager</span> <span class='op'>=</span> <span class='const'>SourceManager</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> + <span class='id identifier rubyid_source_manager'>source_manager</span><span class='period'>.</span><span class='id identifier rubyid_enable'>enable</span><span class='lparen'>(</span><span class='id identifier rubyid_source_name'>source_name</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="lyrics-class_method"> + + + (<tt>String</tt>) <strong>lyrics</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Lyricli instance and returns lyrics by going through the +sources. +</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +the fetched lyrics +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> <tr> <td> <pre class="lines"> -29 30 31 -32</pre> +32 +33</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/lyricli.rb', line 29</span> + <pre class="code"><span class="info file"># File 'lib/lyricli.rb', line 30</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_execute'>execute</span> +<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_lyrics'>lyrics</span> <span class='ivar'>@lyricli</span> <span class='op'>=</span> <span class='const'>Lyricli</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='ivar'>@lyricli</span><span class='period'>.</span><span class='id identifier rubyid_get_lyrics'>get_lyrics</span> <span class='kw'>end</span></pre> </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="reset-class_method"> + + + (<tt>Object</tt>) <strong>reset</strong>(source_name) + + + + + +</h3><div class="docstring"> + <div class="discussion"> + <p> +Resets all configuration for a source via the Source Manager +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +62 +63 +64 +65</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/lyricli.rb', line 62</span> + +<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_reset'>reset</span><span class='lparen'>(</span><span class='id identifier rubyid_source_name'>source_name</span><span class='rparen'>)</span> + <span class='id identifier rubyid_source_manager'>source_manager</span> <span class='op'>=</span> <span class='const'>SourceManager</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> + <span class='id identifier rubyid_source_manager'>source_manager</span><span class='period'>.</span><span class='id identifier rubyid_reset'>reset</span><span class='lparen'>(</span><span class='id identifier rubyid_source_name'>source_name</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="sources-class_method"> + + + (<tt>String</tt>) <strong>sources</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + <p> +Returns a list of the available sources to enable or disable +</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +the list of available sources. Enabled sources have a star appended. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +44 +45 +46 +47</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/lyricli.rb', line 44</span> + +<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_sources'>sources</span> + <span class='id identifier rubyid_source_manager'>source_manager</span> <span class='op'>=</span> <span class='const'>SourceManager</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> + <span class='id identifier rubyid_source_manager'>source_manager</span><span class='period'>.</span><span class='id identifier rubyid_available_sources'>available_sources</span><span class='lparen'>(</span><span class='kw'>true</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>, </span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="version-class_method"> + + + (<tt>String</tt>) <strong>version</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + <p> +Returns the version of the library +</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +the version +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +37 +38 +39</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/lyricli.rb', line 37</span> + +<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> + <span class='const'>Gem</span><span class='period'>.</span><span class='id identifier rubyid_loaded_specs'>loaded_specs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>lyricli</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> </div> @@ -181,9 +611,9 @@ </div> <div id="footer"> - Generated on Fri Oct 5 22:31:14 2012 by + Generated on Sat Oct 6 02:05:51 2012 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.8.1 (ruby-1.9.2). + 0.8.2.1 (ruby-1.9.2). </div> </body>