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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
  Module: Lyricli
  
    &mdash; Documentation by YARD 0.8.1
  
</title>

  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />

  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  hasFrames = window.top.frames.main ? true : false;
  relpath = '';
  framesUrl = "frames.html#!" + escape(window.location.href);
</script>


  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>


  </head>
  <body>
    <div id="header">
      <div id="menu">
  
    <a href="_index.html">Index (L)</a> &raquo;
    
    
    <span class="title">Lyricli</span>
  

  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="class_list.html">
      Class List
    </a>
  
    <a class="full_list_link" id="method_list_link"
        href="method_list.html">
      Method List
    </a>
  
    <a class="full_list_link" id="file_list_link"
        href="file_list.html">
      File List
    </a>
  
</div>
      <div class="clear"></div>
    </div>

    <iframe id="search_frame"></iframe>

    <div id="content"><h1>Module: Lyricli
  
  
</h1>

<dl class="box">
  
  
    <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>
</dd>
  
</dl>
<div class="clear"></div>

<h2>Defined Under Namespace</h2>
<p class="children">
  
    
      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Lyricli/Sources.html" title="Lyricli::Sources (module)">Sources</a></span>, <span class='object_link'><a href="Lyricli/Util.html" title="Lyricli::Util (module)">Util</a></span>
    
  
      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Lyricli/Configuration.html" title="Lyricli::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="Lyricli/Lyricli.html" title="Lyricli::Lyricli (class)">Lyricli</a></span>, <span class='object_link'><a href="Lyricli/LyricsEngine.html" title="Lyricli::LyricsEngine (class)">LyricsEngine</a></span>, <span class='object_link'><a href="Lyricli/SourceManager.html" title="Lyricli::SourceManager (class)">SourceManager</a></span>
    
  
</p>


    <h2>
      Class Method Summary
      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
    </h2>

    <ul class="summary">
      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#execute-class_method" title="execute (class method)">+ (Object) <strong>execute</strong> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
    </ul>
  

  <div id="class_method_details" class="method_details_list">
    <h2>Class Method Details</h2>

    
      <div class="method_details first">
  <h3 class="signature first" id="execute-class_method">
  
    + (<tt>Object</tt>) <strong>execute</strong> 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


29
30
31
32</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/lyricli.rb', line 29</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='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>

</div>

    <div id="footer">
  Generated on Fri Oct  5 22:31:14 2012 by
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.8.1 (ruby-1.9.2).
</div>

  </body>
</html>
Commit	Line	Data
823e558b BB	1	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
	2	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	4	<head>
	5	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	6	<title>
	7	Module: Lyricli
	8
	9	— Documentation by YARD 0.8.1
	10
	11	</title>
	12
	13	<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
	14
	15	<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
	16
	17	<script type="text/javascript" charset="utf-8">
	18	hasFrames = window.top.frames.main ? true : false;
	19	relpath = '';
	20	framesUrl = "frames.html#!" + escape(window.location.href);
	21	</script>
	22
	23
	24	<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
	25
	26	<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
	27
	28
	29	</head>
	30	<body>
	31	<div id="header">
	32	<div id="menu">
	33
	34	<a href="_index.html">Index (L)</a> »
	35
	36
	37	<span class="title">Lyricli</span>
	38
	39
	40	<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
	41	</div>
	42
	43	<div id="search">
	44
	45	<a class="full_list_link" id="class_list_link"
	46	href="class_list.html">
	47	Class List
	48	</a>
	49
	50	<a class="full_list_link" id="method_list_link"
	51	href="method_list.html">
	52	Method List
	53	</a>
	54
	55	<a class="full_list_link" id="file_list_link"
	56	href="file_list.html">
	57	File List
	58	</a>
	59
	60	</div>
	61	<div class="clear"></div>
	62	</div>
	63
	64	<iframe id="search_frame"></iframe>
65
66	<div id="content"><h1>Module: Lyricli
67
68
69
70	</h1>
71
72	<dl class="box">
73
74
75
76
77
78
79
80
81	<dt class="r1 last">Defined in:</dt>
82	<dd class="r1 last">lib/lyricli.rb<span class="defines">,<br />
83	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>
84	</dd>
85
86	</dl>
87	<div class="clear"></div>
88
89	<h2>Defined Under Namespace</h2>
90	<p class="children">
91
92
93	<strong class="modules">Modules:</strong> <span class='object_link'><a href="Lyricli/Sources.html" title="Lyricli::Sources (module)">Sources</a></span>, <span class='object_link'><a href="Lyricli/Util.html" title="Lyricli::Util (module)">Util</a></span>
94
95
96
97	<strong class="classes">Classes:</strong> <span class='object_link'><a href="Lyricli/Configuration.html" title="Lyricli::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="Lyricli/Lyricli.html" title="Lyricli::Lyricli (class)">Lyricli</a></span>, <span class='object_link'><a href="Lyricli/LyricsEngine.html" title="Lyricli::LyricsEngine (class)">LyricsEngine</a></span>, <span class='object_link'><a href="Lyricli/SourceManager.html" title="Lyricli::SourceManager (class)">SourceManager</a></span>
98
99
100	</p>
101
102
103
104
105
106
107
108
109	<h2>
110	Class Method Summary
111	<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
112	</h2>
113
114	<ul class="summary">
115
116	<li class="public ">
117	<span class="summary_signature">
118
119	<a href="#execute-class_method" title="execute (class method)">+ (Object) <strong>execute</strong> </a>
120
121
122
123	</span>
124
125
126
127
128
129
130
131
132
133	<span class="summary_desc"><div class='inline'></div></span>
134
135	</li>
136
137
138	</ul>
139
140
141
142
143	<div id="class_method_details" class="method_details_list">
144	<h2>Class Method Details</h2>
145
146
147	<div class="method_details first">
148	<h3 class="signature first" id="execute-class_method">
149
150	+ (<tt>Object</tt>) <strong>execute</strong>
151
152
153
154
155
156	</h3><table class="source_code">
157	<tr>
158	<td>
159	<pre class="lines">
160
161
162	29
163	30
164	31
165	32</pre>
166	</td>
167	<td>
168	<pre class="code"><span class="info file"># File 'lib/lyricli.rb', line 29</span>
169
170	<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_execute'>execute</span>
171	<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>
172	<span class='ivar'>@lyricli</span><span class='period'>.</span><span class='id identifier rubyid_get_lyrics'>get_lyrics</span>
173	<span class='kw'>end</span></pre>
174	</td>
175	</tr>
176	</table>
177	</div>
178
179	</div>
180
181	</div>
182
183	<div id="footer">
184	Generated on Fri Oct 5 22:31:14 2012 by
185	<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
186	0.8.1 (ruby-1.9.2).
187	</div>
188
189	</body>
190	</html>