git.r.bdr.sh / rbdr / lyricli.rb / blame
| 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 | Class: Lyricli::Sources::Arguments | |
| 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 (A)</a> » | |
| 35 | <span class='title'><span class='object_link'><a href="../../Lyricli.html" title="Lyricli (module)">Lyricli</a></span></span> » <span class='title'><span class='object_link'><a href="../Sources.html" title="Lyricli::Sources (module)">Sources</a></span></span> | |
| 36 | » | |
| 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> | |
| 130 | Returns 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> | |
| 168 | The enable method should run all of the tasks needed to validate the | |
| 169 | source. | |
| 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> | |
| 194 | The 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> | |
| 228 | The current_track method should return the name of the current artist and | |
| 229 | song. | |
| 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> | |
| 256 | Instantiates 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> | |
| 281 | Instantiates 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 | ||
| 296 | 18 | |
| 297 | 19 | |
| 298 | 20</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 | <span id="name-class_method"></span> | |
| 319 | <div class="method_details first"> | |
| 320 | <h3 class="signature first" id="name-class_method"> | |
| 321 | ||
| 322 | + (<tt>Object</tt>) <strong>name</strong> | |
| 323 | ||
| 324 | ||
| 325 | ||
| 326 | ||
| 327 | ||
| 328 | </h3><div class="docstring"> | |
| 329 | <div class="discussion"> | |
| 330 | <p> | |
| 331 | Returns the value of attribute name | |
| 332 | </p> | |
| 333 | ||
| 334 | ||
| 335 | </div> | |
| 336 | </div> | |
| 337 | <div class="tags"> | |
| 338 | ||
| 339 | ||
| 340 | </div><table class="source_code"> | |
| 341 | <tr> | |
| 342 | <td> | |
| 343 | <pre class="lines"> | |
| 344 | ||
| 345 | ||
| 346 | 6 | |
| 347 | 7 | |
| 348 | 8</pre> | |
| 349 | </td> | |
| 350 | <td> | |
| 351 | <pre class="code"><span class="info file"># File 'lib/lyricli/sources/arguments.rb', line 6</span> | |
| 352 | ||
| 353 | <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span> | |
| 354 | <span class='ivar'>@name</span> | |
| 355 | <span class='kw'>end</span></pre> | |
| 356 | </td> | |
| 357 | </tr> | |
| 358 | </table> | |
| 359 | </div> | |
| 360 | ||
| 361 | </div> | |
| 362 | ||
| 363 | ||
| 364 | <div id="class_method_details" class="method_details_list"> | |
| 365 | <h2>Class Method Details</h2> | |
| 366 | ||
| 367 | ||
| 368 | <div class="method_details first"> | |
| 369 | <h3 class="signature first" id="enable-class_method"> | |
| 370 | ||
| 371 | + (<tt>Object</tt>) <strong>enable</strong> | |
| 372 | ||
| 373 | ||
| 374 | ||
| 375 | ||
| 376 | ||
| 377 | </h3><div class="docstring"> | |
| 378 | <div class="discussion"> | |
| 379 | <p> | |
| 380 | The enable method should run all of the tasks needed to validate the | |
| 381 | source. In the case of Rdio it has to authenticate with OAuth. | |
| 382 | </p> | |
| 383 | ||
| 384 | ||
| 385 | </div> | |
| 386 | </div> | |
| 387 | <div class="tags"> | |
| 388 | ||
| 389 | ||
| 390 | </div><table class="source_code"> | |
| 391 | <tr> | |
| 392 | <td> | |
| 393 | <pre class="lines"> | |
| 394 | ||
| 395 | ||
| 396 | 13 | |
| 397 | 14 | |
| 398 | 15</pre> | |
| 399 | </td> | |
| 400 | <td> | |
| 401 | <pre class="code"><span class="info file"># File 'lib/lyricli/sources/arguments.rb', line 13</span> | |
| 402 | ||
| 403 | <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enable'>enable</span> | |
| 404 | <span class='comment'># Nothing to do. | |
| 405 | </span><span class='kw'>end</span></pre> | |
| 406 | </td> | |
| 407 | </tr> | |
| 408 | </table> | |
| 409 | </div> | |
| 410 | ||
| 411 | <div class="method_details "> | |
| 412 | <h3 class="signature " id="reset-class_method"> | |
| 413 | ||
| 414 | + (<tt>Object</tt>) <strong>reset</strong> | |
| 415 | ||
| 416 | ||
| 417 | ||
| 418 | ||
| 419 | ||
| 420 | </h3><div class="docstring"> | |
| 421 | <div class="discussion"> | |
| 422 | <p> | |
| 423 | The reset method resets any configurations it may have | |
| 424 | </p> | |
| 425 | ||
| 426 | ||
| 427 | </div> | |
| 428 | </div> | |
| 429 | <div class="tags"> | |
| 430 | ||
| 431 | ||
| 432 | </div><table class="source_code"> | |
| 433 | <tr> | |
| 434 | <td> | |
| 435 | <pre class="lines"> | |
| 436 | ||
| 437 | ||
| 438 | 32 | |
| 439 | 33 | |
| 440 | 34</pre> | |
| 441 | </td> | |
| 442 | <td> | |
| 443 | <pre class="code"><span class="info file"># File 'lib/lyricli/sources/arguments.rb', line 32</span> | |
| 444 | ||
| 445 | <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_reset'>reset</span> | |
| 446 | <span class='comment'># Reset Code | |
| 447 | </span><span class='kw'>end</span></pre> | |
| 448 | </td> | |
| 449 | </tr> | |
| 450 | </table> | |
| 451 | </div> | |
| 452 | ||
| 453 | </div> | |
| 454 | ||
| 455 | <div id="instance_method_details" class="method_details_list"> | |
| 456 | <h2>Instance Method Details</h2> | |
| 457 | ||
| 458 | ||
| 459 | <div class="method_details first"> | |
| 460 | <h3 class="signature first" id="current_track-instance_method"> | |
| 461 | ||
| 462 | - (<tt>Hash</tt>) <strong>current_track</strong> | |
| 463 | ||
| 464 | ||
| 465 | ||
| 466 | ||
| 467 | ||
| 468 | </h3><div class="docstring"> | |
| 469 | <div class="discussion"> | |
| 470 | <p> | |
| 471 | The current_track method should return the name of the current artist and | |
| 472 | song. | |
| 473 | </p> | |
| 474 | ||
| 475 | ||
| 476 | </div> | |
| 477 | </div> | |
| 478 | <div class="tags"> | |
| 479 | ||
| 480 | <p class="tag_title">Returns:</p> | |
| 481 | <ul class="return"> | |
| 482 | ||
| 483 | <li> | |
| 484 | ||
| 485 | ||
| 486 | <span class='type'>(<tt>Hash</tt>)</span> | |
| 487 | ||
| 488 | ||
| 489 | ||
| 490 | — | |
| 491 | <div class='inline'><p> | |
| 492 | A hash containing the current `:song` and `:artist`. | |
| 493 | </p> | |
| 494 | </div> | |
| 495 | ||
| 496 | </li> | |
| 497 | ||
| 498 | </ul> | |
| 499 | ||
| 500 | </div><table class="source_code"> | |
| 501 | <tr> | |
| 502 | <td> | |
| 503 | <pre class="lines"> | |
| 504 | ||
| 505 | ||
| 506 | 25 | |
| 507 | 26 | |
| 508 | 27 | |
| 509 | 28 | |
| 510 | 29</pre> | |
| 511 | </td> | |
| 512 | <td> | |
| 513 | <pre class="code"><span class="info file"># File 'lib/lyricli/sources/arguments.rb', line 25</span> | |
| 514 | ||
| 515 | <span class='kw'>def</span> <span class='id identifier rubyid_current_track'>current_track</span> | |
| 516 | <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> | |
| 517 | <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> | |
| 518 | <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> | |
| 519 | <span class='kw'>end</span></pre> | |
| 520 | </td> | |
| 521 | </tr> | |
| 522 | </table> | |
| 523 | </div> | |
| 524 | ||
| 525 | </div> | |
| 526 | ||
| 527 | </div> | |
| 528 | ||
| 529 | <div id="footer"> | |
| 530 | Generated on Fri Oct 5 22:31:15 2012 by | |
| 531 | <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> | |
| 532 | 0.8.1 (ruby-1.9.2). | |
| 533 | </div> | |
| 534 | ||
| 535 | </body> | |
| 536 | </html> |