]> git.r.bdr.sh - rbdr/lyricli.rb/blame_incremental - doc/Lyricli/Sources/Arguments.html
git.r.bdr.sh / rbdr / lyricli.rb / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Adds some documentation
[rbdr/lyricli.rb] / doc / Lyricli / Sources / Arguments.html
... / ...
CommitLineData
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 Class: Lyricli::Sources::Arguments
8
9 &mdash; Documentation by YARD 0.8.2.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 (A)</a> &raquo;
35 <span class='title'><span class='object_link'><a href="../../Lyricli.html" title="Lyricli (module)">Lyricli</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sources.html" title="Lyricli::Sources (module)">Sources</a></span></span>
36 &raquo;
37 <span class="title">Arguments</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>Class: Lyricli::Sources::Arguments
67
68
69
70</h1>
71
72<dl class="box">
73
74 <dt class="r1">Inherits:</dt>
75 <dd class="r1">
76 <span class="inheritName">Object</span>
77
78 <ul class="fullTree">
79 <li>Object</li>
80
81 <li class="next">Lyricli::Sources::Arguments</li>
82
83 </ul>
84 <a href="#" class="inheritanceTree">show all</a>
85
86 </dd>
87
88
89
90
91
92
93
94
95
96 <dt class="r2 last">Defined in:</dt>
97 <dd class="r2 last">lib/lyricli/sources/arguments.rb</dd>
98
99</dl>
100<div class="clear"></div>
101
102
103
104
105
106 <h2>Class Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
107 <ul class="summary">
108
109 <li class="public ">
110 <span class="summary_signature">
111
112 <a href="#name-class_method" title="name (class method)">+ (Object) <strong>name</strong> </a>
113
114
115
116 </span>
117
118
119
120
121
122
123
124
125
126
127
128
129 <span class="summary_desc"><div class='inline'><p>
130Returns the value of attribute name.
131</p>
132</div></span>
133
134</li>
135
136
137 </ul>
138
139
140
141
142
143 <h2>
144 Class Method Summary
145 <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
146 </h2>
147
148 <ul class="summary">
149
150 <li class="public ">
151 <span class="summary_signature">
152
153 <a href="#enable-class_method" title="enable (class method)">+ (Object) <strong>enable</strong> </a>
154
155
156
157 </span>
158
159
160
161
162
163
164
165
166
167 <span class="summary_desc"><div class='inline'><p>
168The enable method should run all of the tasks needed to validate the
169source.
170</p>
171</div></span>
172
173</li>
174
175
176 <li class="public ">
177 <span class="summary_signature">
178
179 <a href="#reset-class_method" title="reset (class method)">+ (Object) <strong>reset</strong> </a>
180
181
182
183 </span>
184
185
186
187
188
189
190
191
192
193 <span class="summary_desc"><div class='inline'><p>
194The reset method resets any configurations it may have.
195</p>
196</div></span>
197
198</li>
199
200
201 </ul>
202
203 <h2>
204 Instance Method Summary
205 <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
206 </h2>
207
208 <ul class="summary">
209
210 <li class="public ">
211 <span class="summary_signature">
212
213 <a href="#current_track-instance_method" title="#current_track (instance method)">- (Hash) <strong>current_track</strong> </a>
214
215
216
217 </span>
218
219
220
221
222
223
224
225
226
227 <span class="summary_desc"><div class='inline'><p>
228The current_track method should return the name of the current artist and
229song.
230</p>
231</div></span>
232
233</li>
234
235
236 <li class="public ">
237 <span class="summary_signature">
238
239 <a href="#initialize-instance_method" title="#initialize (instance method)">- (Arguments) <strong>initialize</strong> </a>
240
241
242
243 </span>
244
245
246 <span class="note title constructor">constructor</span>
247
248
249
250
251
252
253
254
255 <span class="summary_desc"><div class='inline'><p>
256Instantiates everything it needs to run.
257</p>
258</div></span>
259
260</li>
261
262
263 </ul>
264
265
266<div id="constructor_details" class="method_details_list">
267 <h2>Constructor Details</h2>
268
269 <div class="method_details first">
270 <h3 class="signature first" id="initialize-instance_method">
271
272 - (<tt><span class='object_link'><a href="" title="Lyricli::Sources::Arguments (class)">Arguments</a></span></tt>) <strong>initialize</strong>
273
274
275
276
277
278</h3><div class="docstring">
279 <div class="discussion">
280 <p>
281Instantiates everything it needs to run.
282</p>
283
284
285 </div>
286</div>
287<div class="tags">
288
289
290</div><table class="source_code">
291 <tr>
292 <td>
293 <pre class="lines">
294
295
29618
29719
29820</pre>
299 </td>
300 <td>
301 <pre class="code"><span class="info file"># File 'lib/lyricli/sources/arguments.rb', line 18</span>
302
303<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
304 <span class='comment'># Nothing to do.
305</span><span class='kw'>end</span></pre>
306 </td>
307 </tr>
308</table>
309</div>
310
311</div>
312
313 <div id="class_attr_details" class="attr_details">
314 <h2>Class Attribute Details</h2>
315
316
317 <span id="name=-class_method"></span>
318 <div class="method_details first">
319 <h3 class="signature first" id="name-class_method">
320
321 + (<tt>Object</tt>) <strong>name</strong>
322
323
324
325
326
327</h3><div class="docstring">
328 <div class="discussion">
329 <p>
330Returns the value of attribute name
331</p>
332
333
334 </div>
335</div>
336<div class="tags">
337
338
339</div><table class="source_code">
340 <tr>
341 <td>
342 <pre class="lines">
343
344
3456
3467
3478</pre>
348 </td>
349 <td>
350 <pre class="code"><span class="info file"># File 'lib/lyricli/sources/arguments.rb', line 6</span>
351
352<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
353 <span class='ivar'>@name</span>
354<span class='kw'>end</span></pre>
355 </td>
356 </tr>
357</table>
358</div>
359
360 </div>
361
362
363 <div id="class_method_details" class="method_details_list">
364 <h2>Class Method Details</h2>
365
366
367 <div class="method_details first">
368 <h3 class="signature first" id="enable-class_method">
369
370 + (<tt>Object</tt>) <strong>enable</strong>
371
372
373
374
375
376</h3><div class="docstring">
377 <div class="discussion">
378 <p>
379The enable method should run all of the tasks needed to validate the
380source. In the case of Rdio it has to authenticate with OAuth.
381</p>
382
383
384 </div>
385</div>
386<div class="tags">
387
388
389</div><table class="source_code">
390 <tr>
391 <td>
392 <pre class="lines">
393
394
39513
39614
39715</pre>
398 </td>
399 <td>
400 <pre class="code"><span class="info file"># File 'lib/lyricli/sources/arguments.rb', line 13</span>
401
402<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enable'>enable</span>
403 <span class='comment'># Nothing to do.
404</span><span class='kw'>end</span></pre>
405 </td>
406 </tr>
407</table>
408</div>
409
410 <div class="method_details ">
411 <h3 class="signature " id="reset-class_method">
412
413 + (<tt>Object</tt>) <strong>reset</strong>
414
415
416
417
418
419</h3><div class="docstring">
420 <div class="discussion">
421 <p>
422The reset method resets any configurations it may have
423</p>
424
425
426 </div>
427</div>
428<div class="tags">
429
430
431</div><table class="source_code">
432 <tr>
433 <td>
434 <pre class="lines">
435
436
43732
43833
43934</pre>
440 </td>
441 <td>
442 <pre class="code"><span class="info file"># File 'lib/lyricli/sources/arguments.rb', line 32</span>
443
444<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_reset'>reset</span>
445 <span class='comment'># Reset Code
446</span><span class='kw'>end</span></pre>
447 </td>
448 </tr>
449</table>
450</div>
451
452 </div>
453
454 <div id="instance_method_details" class="method_details_list">
455 <h2>Instance Method Details</h2>
456
457
458 <div class="method_details first">
459 <h3 class="signature first" id="current_track-instance_method">
460
461 - (<tt>Hash</tt>) <strong>current_track</strong>
462
463
464
465
466
467</h3><div class="docstring">
468 <div class="discussion">
469 <p>
470The current_track method should return the name of the current artist and
471song.
472</p>
473
474
475 </div>
476</div>
477<div class="tags">
478
479<p class="tag_title">Returns:</p>
480<ul class="return">
481
482 <li>
483
484
485 <span class='type'>(<tt>Hash</tt>)</span>
486
487
488
489 &mdash;
490 <div class='inline'><p>
491A hash containing the current `:song` and `:artist`.
492</p>
493</div>
494
495 </li>
496
497</ul>
498
499</div><table class="source_code">
500 <tr>
501 <td>
502 <pre class="lines">
503
504
50525
50626
50727
50828
50929</pre>
510 </td>
511 <td>
512 <pre class="code"><span class="info file"># File 'lib/lyricli/sources/arguments.rb', line 25</span>
513
514<span class='kw'>def</span> <span class='id identifier rubyid_current_track'>current_track</span>
515 <span class='id identifier rubyid_artist'>artist</span> <span class='op'>=</span> <span class='const'>ARGV</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
516 <span class='id identifier rubyid_song'>song</span> <span class='op'>=</span> <span class='const'>ARGV</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
517 <span class='lbrace'>{</span><span class='label'>artist:</span> <span class='id identifier rubyid_artist'>artist</span><span class='comma'>,</span> <span class='label'>song:</span> <span class='id identifier rubyid_song'>song</span><span class='rbrace'>}</span>
518<span class='kw'>end</span></pre>
519 </td>
520 </tr>
521</table>
522</div>
523
524 </div>
525
526</div>
527
528 <div id="footer">
529 Generated on Sat Oct 6 02:05:51 2012 by
530 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
531 0.8.2.1 (ruby-1.9.2).
532</div>
533
534 </body>
535</html>
Original ruby version of lyricli #cli