git.r.bdr.sh - rbdr/lyricli.rb/blob - doc/Lyricli/Configuration.html

   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::Configuration
   8
   9     &mdash; 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 (C)</a> &raquo;
  35     <span class='title'><span class='object_link'><a href="../Lyricli.html" title="Lyricli (module)">Lyricli</a></span></span>
  36      &raquo;
  37     <span class="title">Configuration</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::Configuration
  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::Configuration</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/configuration.rb</dd>
  98
  99 </dl>
 100 <div class="clear"></div>
 101
 102
 103   <h2>Constant Summary</h2>
 104
 105     <dl class="constants">
 106
 107         <dt id="instance-classvariable" class="">@@instance =
 108
 109         </dt>
 110         <dd><pre class="code"><span class='const'>Configuration</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span></pre></dd>
 111
 112     </dl>
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122     <h2>
 123       Class Method Summary
 124       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
 125     </h2>
 126
 127     <ul class="summary">
 128
 129         <li class="public ">
 130   <span class="summary_signature">
 131
 132       <a href="#instance-class_method" title="instance (class method)">+ (Object) <strong>instance</strong> </a>
 133
 134
 135
 136   </span>
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146     <span class="summary_desc"><div class='inline'></div></span>
 147
 148 </li>
 149
 150
 151     </ul>
 152
 153     <h2>
 154       Instance Method Summary
 155       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
 156     </h2>
 157
 158     <ul class="summary">
 159
 160         <li class="public ">
 161   <span class="summary_signature">
 162
 163       <a href="#%5B%5D-instance_method" title="#[] (instance method)">- (Object) <strong>[]</strong>(key) </a>
 164
 165
 166
 167   </span>
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177     <span class="summary_desc"><div class='inline'></div></span>
 178
 179 </li>
 180
 181
 182         <li class="public ">
 183   <span class="summary_signature">
 184
 185       <a href="#%5B%5D%3D-instance_method" title="#[]= (instance method)">- (Object) <strong>[]=</strong>(key, value) </a>
 186
 187
 188
 189   </span>
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199     <span class="summary_desc"><div class='inline'></div></span>
 200
 201 </li>
 202
 203
 204         <li class="public ">
 205   <span class="summary_signature">
 206
 207       <a href="#initialize-instance_method" title="#initialize (instance method)">- (Configuration) <strong>initialize</strong> </a>
 208
 209
 210
 211   </span>
 212
 213
 214     <span class="note title constructor">constructor</span>
 215
 216
 217
 218
 219
 220
 221
 222
 223     <span class="summary_desc"><div class='inline'><p>
 224 A new instance of Configuration.
 225 </p>
 226 </div></span>
 227
 228 </li>
 229
 230
 231     </ul>
 232
 233
 234 <div id="constructor_details" class="method_details_list">
 235   <h2>Constructor Details</h2>
 236
 237     <div class="method_details first">
 238   <h3 class="signature first" id="initialize-instance_method">
 239
 240     - (<tt><span class='object_link'><a href="" title="Lyricli::Configuration (class)">Configuration</a></span></tt>) <strong>initialize</strong>
 241
 242
 243
 244
 245
 246 </h3><div class="docstring">
 247   <div class="discussion">
 248     <p>
 249 A new instance of Configuration
 250 </p>
 251
 252
 253   </div>
 254 </div>
 255 <div class="tags">
 256
 257
 258 </div><table class="source_code">
 259   <tr>
 260     <td>
 261       <pre class="lines">
 262
 263
 264 4
 265 5
 266 6
 267 7</pre>
 268     </td>
 269     <td>
 270       <pre class="code"><span class="info file"># File 'lib/lyricli/configuration.rb', line 4</span>
 271
 272 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
 273   <span class='ivar'>@config_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>~/.lyricli.conf</span><span class='tstring_end'>&quot;</span></span>
 274   <span class='ivar'>@defaults_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>defaults.json</span><span class='tstring_end'>&quot;</span></span>
 275 <span class='kw'>end</span></pre>
 276     </td>
 277   </tr>
 278 </table>
 279 </div>
 280
 281 </div>
 282
 283
 284   <div id="class_method_details" class="method_details_list">
 285     <h2>Class Method Details</h2>
 286
 287
 288       <div class="method_details first">
 289   <h3 class="signature first" id="instance-class_method">
 290
 291     + (<tt>Object</tt>) <strong>instance</strong>
 292
 293
 294
 295
 296
 297 </h3><table class="source_code">
 298   <tr>
 299     <td>
 300       <pre class="lines">
 301
 302
 303 11
 304 12
 305 13</pre>
 306     </td>
 307     <td>
 308       <pre class="code"><span class="info file"># File 'lib/lyricli/configuration.rb', line 11</span>
 309
 310 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span>
 311   <span class='cvar'>@@instance</span>
 312 <span class='kw'>end</span></pre>
 313     </td>
 314   </tr>
 315 </table>
 316 </div>
 317
 318   </div>
 319
 320   <div id="instance_method_details" class="method_details_list">
 321     <h2>Instance Method Details</h2>
 322
 323
 324       <div class="method_details first">
 325   <h3 class="signature first" id="[]-instance_method">
 326
 327     - (<tt>Object</tt>) <strong>[]</strong>(key)
 328
 329
 330
 331
 332
 333 </h3><table class="source_code">
 334   <tr>
 335     <td>
 336       <pre class="lines">
 337
 338
 339 15
 340 16
 341 17
 342 18</pre>
 343     </td>
 344     <td>
 345       <pre class="code"><span class="info file"># File 'lib/lyricli/configuration.rb', line 15</span>
 346
 347 <span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
 348   <span class='id identifier rubyid_load_config'>load_config</span> <span class='kw'>unless</span> <span class='ivar'>@config</span>
 349   <span class='ivar'>@config</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span>
 350 <span class='kw'>end</span></pre>
 351     </td>
 352   </tr>
 353 </table>
 354 </div>
 355
 356       <div class="method_details ">
 357   <h3 class="signature " id="[]=-instance_method">
 358
 359     - (<tt>Object</tt>) <strong>[]=</strong>(key, value)
 360
 361
 362
 363
 364
 365 </h3><table class="source_code">
 366   <tr>
 367     <td>
 368       <pre class="lines">
 369
 370
 371 20
 372 21
 373 22
 374 23
 375 24</pre>
 376     </td>
 377     <td>
 378       <pre class="code"><span class="info file"># File 'lib/lyricli/configuration.rb', line 20</span>
 379
 380 <span class='kw'>def</span> <span class='op'>[]=</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
 381   <span class='id identifier rubyid_load_config'>load_config</span> <span class='kw'>unless</span> <span class='ivar'>@config</span>
 382   <span class='ivar'>@config</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
 383   <span class='id identifier rubyid_save_config'>save_config</span>
 384 <span class='kw'>end</span></pre>
 385     </td>
 386   </tr>
 387 </table>
 388 </div>
 389
 390   </div>
 391
 392 </div>
 393
 394     <div id="footer">
 395   Generated on Fri Oct  5 22:31:14 2012 by
 396   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
 397   0.8.1 (ruby-1.9.2).
 398 </div>
 399
 400   </body>
 401 </html>