ruby_rhymes 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,632 @@
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: Phrase::Pronunciation
8
+
9
+ &mdash; Documentation by YARD 0.7.2
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
+ relpath = '..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../_index.html">Index (P)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Phrase.html" title="Phrase (class)">Phrase</a></span></span>
38
+ &raquo;
39
+ <span class="title">Pronunciation</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Class: Phrase::Pronunciation
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+ <dt class="r1">Inherits:</dt>
68
+ <dd class="r1">
69
+ <span class="inheritName">Object</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">Phrase::Pronunciation</li>
75
+
76
+ </ul>
77
+ <a href="#" class="inheritanceTree">show all</a>
78
+
79
+ </dd>
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+ <dt class="r2 last">Defined in:</dt>
90
+ <dd class="r2 last">lib/ruby_rhymes.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+ <h2>Overview</h2><div class="docstring">
96
+ <div class="discussion">
97
+ <p>
98
+ a container of word, pronunciation_id, num_syllables, and rhyme_key
99
+ </p>
100
+
101
+
102
+ </div>
103
+ </div>
104
+ <div class="tags">
105
+
106
+ </div>
107
+
108
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
109
+ <ul class="summary">
110
+
111
+ <li class="public ">
112
+ <span class="summary_signature">
113
+
114
+ <a href="#num_syllables-instance_method" title="#num_syllables (instance method)">- (Object) <strong>num_syllables</strong> </a>
115
+
116
+
117
+
118
+ </span>
119
+
120
+
121
+ <span class="note title readonly">readonly</span>
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+ <span class="summary_desc"><div class='inline'><p>
131
+ Returns the value of attribute num_syllables.
132
+ </p>
133
+ </div></span>
134
+
135
+ </li>
136
+
137
+
138
+ <li class="public ">
139
+ <span class="summary_signature">
140
+
141
+ <a href="#pronunciation_id-instance_method" title="#pronunciation_id (instance method)">- (Object) <strong>pronunciation_id</strong> </a>
142
+
143
+
144
+
145
+ </span>
146
+
147
+
148
+ <span class="note title readonly">readonly</span>
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+ <span class="summary_desc"><div class='inline'><p>
158
+ Returns the value of attribute pronunciation_id.
159
+ </p>
160
+ </div></span>
161
+
162
+ </li>
163
+
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#rhyme_key-instance_method" title="#rhyme_key (instance method)">- (Object) <strong>rhyme_key</strong> </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+ <span class="note title readonly">readonly</span>
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+ <span class="summary_desc"><div class='inline'><p>
185
+ Returns the value of attribute rhyme_key.
186
+ </p>
187
+ </div></span>
188
+
189
+ </li>
190
+
191
+
192
+ <li class="public ">
193
+ <span class="summary_signature">
194
+
195
+ <a href="#word-instance_method" title="#word (instance method)">- (Object) <strong>word</strong> </a>
196
+
197
+
198
+
199
+ </span>
200
+
201
+
202
+ <span class="note title readonly">readonly</span>
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+ <span class="summary_desc"><div class='inline'><p>
212
+ Returns the value of attribute word.
213
+ </p>
214
+ </div></span>
215
+
216
+ </li>
217
+
218
+
219
+ </ul>
220
+
221
+
222
+
223
+
224
+
225
+ <h2>
226
+ Instance Method Summary
227
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
228
+ </h2>
229
+
230
+ <ul class="summary">
231
+
232
+ <li class="public ">
233
+ <span class="summary_signature">
234
+
235
+ <a href="#dict%3F-instance_method" title="#dict? (instance method)">- (Boolean) <strong>dict?</strong> </a>
236
+
237
+
238
+
239
+ </span>
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+ <span class="summary_desc"><div class='inline'><p>
249
+ dictionary word?.
250
+ </p>
251
+ </div></span>
252
+
253
+ </li>
254
+
255
+
256
+ <li class="public ">
257
+ <span class="summary_signature">
258
+
259
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Pronunciation) <strong>initialize</strong>(word, pronunciation_id, num_syllables, rhyme_key) </a>
260
+
261
+
262
+
263
+ </span>
264
+
265
+ <span class="note title constructor">constructor</span>
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+ <span class="summary_desc"><div class='inline'><p>
275
+ A new instance of Pronunciation.
276
+ </p>
277
+ </div></span>
278
+
279
+ </li>
280
+
281
+
282
+ <li class="public ">
283
+ <span class="summary_signature">
284
+
285
+ <a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>
286
+
287
+
288
+
289
+ </span>
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+ <span class="summary_desc"><div class='inline'></div></span>
299
+
300
+ </li>
301
+
302
+
303
+ </ul>
304
+
305
+
306
+ <div id="constructor_details" class="method_details_list">
307
+ <h2>Constructor Details</h2>
308
+
309
+ <div class="method_details first">
310
+ <p class="signature first" id="initialize-instance_method">
311
+
312
+ - (<tt><span class='object_link'><a href="" title="Phrase::Pronunciation (class)">Pronunciation</a></span></tt>) <strong>initialize</strong>(word, pronunciation_id, num_syllables, rhyme_key)
313
+
314
+
315
+
316
+ </p><div class="docstring">
317
+ <div class="discussion">
318
+ <p>
319
+ A new instance of Pronunciation
320
+ </p>
321
+
322
+
323
+ </div>
324
+ </div>
325
+ <div class="tags">
326
+
327
+ </div><table class="source_code">
328
+ <tr>
329
+ <td>
330
+ <pre class="lines">
331
+
332
+
333
+ 184
334
+ 185
335
+ 186
336
+ 187
337
+ 188
338
+ 189</pre>
339
+ </td>
340
+ <td>
341
+ <pre class="code"><span class="info file"># File 'lib/ruby_rhymes.rb', line 184</span>
342
+
343
+ <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='word identifier id'>word</span><span class='comma token'>,</span> <span class='pronunciation_id identifier id'>pronunciation_id</span><span class='comma token'>,</span> <span class='num_syllables identifier id'>num_syllables</span><span class='comma token'>,</span> <span class='rhyme_key identifier id'>rhyme_key</span><span class='rparen token'>)</span>
344
+ <span class='@word ivar id'>@word</span> <span class='assign token'>=</span> <span class='word identifier id'>word</span>
345
+ <span class='@pronunciation_id ivar id'>@pronunciation_id</span> <span class='assign token'>=</span> <span class='pronunciation_id identifier id'>pronunciation_id</span>
346
+ <span class='@num_syllables ivar id'>@num_syllables</span> <span class='assign token'>=</span> <span class='num_syllables identifier id'>num_syllables</span>
347
+ <span class='@rhyme_key ivar id'>@rhyme_key</span> <span class='assign token'>=</span> <span class='rhyme_key identifier id'>rhyme_key</span>
348
+ <span class='end end kw'>end</span>
349
+ </pre>
350
+ </td>
351
+ </tr>
352
+ </table>
353
+ </div>
354
+
355
+ </div>
356
+
357
+ <div id="instance_attr_details" class="attr_details">
358
+ <h2>Instance Attribute Details</h2>
359
+
360
+
361
+ <span id=""></span>
362
+ <span id="num_syllables-instance_method"></span>
363
+ <div class="method_details first">
364
+ <p class="signature first" id="num_syllables-instance_method">
365
+
366
+ - (<tt>Object</tt>) <strong>num_syllables</strong> <span class="extras">(readonly)</span>
367
+
368
+
369
+
370
+ </p><div class="docstring">
371
+ <div class="discussion">
372
+ <p>
373
+ Returns the value of attribute num_syllables
374
+ </p>
375
+
376
+
377
+ </div>
378
+ </div>
379
+ <div class="tags">
380
+
381
+ </div><table class="source_code">
382
+ <tr>
383
+ <td>
384
+ <pre class="lines">
385
+
386
+
387
+ 182
388
+ 183
389
+ 184</pre>
390
+ </td>
391
+ <td>
392
+ <pre class="code"><span class="info file"># File 'lib/ruby_rhymes.rb', line 182</span>
393
+
394
+ <span class='def def kw'>def</span> <span class='num_syllables identifier id'>num_syllables</span>
395
+ <span class='@num_syllables ivar id'>@num_syllables</span>
396
+ <span class='end end kw'>end</span>
397
+ </pre>
398
+ </td>
399
+ </tr>
400
+ </table>
401
+ </div>
402
+
403
+
404
+ <span id=""></span>
405
+ <span id="pronunciation_id-instance_method"></span>
406
+ <div class="method_details ">
407
+ <p class="signature " id="pronunciation_id-instance_method">
408
+
409
+ - (<tt>Object</tt>) <strong>pronunciation_id</strong> <span class="extras">(readonly)</span>
410
+
411
+
412
+
413
+ </p><div class="docstring">
414
+ <div class="discussion">
415
+ <p>
416
+ Returns the value of attribute pronunciation_id
417
+ </p>
418
+
419
+
420
+ </div>
421
+ </div>
422
+ <div class="tags">
423
+
424
+ </div><table class="source_code">
425
+ <tr>
426
+ <td>
427
+ <pre class="lines">
428
+
429
+
430
+ 182
431
+ 183
432
+ 184</pre>
433
+ </td>
434
+ <td>
435
+ <pre class="code"><span class="info file"># File 'lib/ruby_rhymes.rb', line 182</span>
436
+
437
+ <span class='def def kw'>def</span> <span class='pronunciation_id identifier id'>pronunciation_id</span>
438
+ <span class='@pronunciation_id ivar id'>@pronunciation_id</span>
439
+ <span class='end end kw'>end</span>
440
+ </pre>
441
+ </td>
442
+ </tr>
443
+ </table>
444
+ </div>
445
+
446
+
447
+ <span id=""></span>
448
+ <span id="rhyme_key-instance_method"></span>
449
+ <div class="method_details ">
450
+ <p class="signature " id="rhyme_key-instance_method">
451
+
452
+ - (<tt>Object</tt>) <strong>rhyme_key</strong> <span class="extras">(readonly)</span>
453
+
454
+
455
+
456
+ </p><div class="docstring">
457
+ <div class="discussion">
458
+ <p>
459
+ Returns the value of attribute rhyme_key
460
+ </p>
461
+
462
+
463
+ </div>
464
+ </div>
465
+ <div class="tags">
466
+
467
+ </div><table class="source_code">
468
+ <tr>
469
+ <td>
470
+ <pre class="lines">
471
+
472
+
473
+ 182
474
+ 183
475
+ 184</pre>
476
+ </td>
477
+ <td>
478
+ <pre class="code"><span class="info file"># File 'lib/ruby_rhymes.rb', line 182</span>
479
+
480
+ <span class='def def kw'>def</span> <span class='rhyme_key identifier id'>rhyme_key</span>
481
+ <span class='@rhyme_key ivar id'>@rhyme_key</span>
482
+ <span class='end end kw'>end</span>
483
+ </pre>
484
+ </td>
485
+ </tr>
486
+ </table>
487
+ </div>
488
+
489
+
490
+ <span id=""></span>
491
+ <span id="word-instance_method"></span>
492
+ <div class="method_details ">
493
+ <p class="signature " id="word-instance_method">
494
+
495
+ - (<tt>Object</tt>) <strong>word</strong> <span class="extras">(readonly)</span>
496
+
497
+
498
+
499
+ </p><div class="docstring">
500
+ <div class="discussion">
501
+ <p>
502
+ Returns the value of attribute word
503
+ </p>
504
+
505
+
506
+ </div>
507
+ </div>
508
+ <div class="tags">
509
+
510
+ </div><table class="source_code">
511
+ <tr>
512
+ <td>
513
+ <pre class="lines">
514
+
515
+
516
+ 182
517
+ 183
518
+ 184</pre>
519
+ </td>
520
+ <td>
521
+ <pre class="code"><span class="info file"># File 'lib/ruby_rhymes.rb', line 182</span>
522
+
523
+ <span class='def def kw'>def</span> <span class='word identifier id'>word</span>
524
+ <span class='@word ivar id'>@word</span>
525
+ <span class='end end kw'>end</span>
526
+ </pre>
527
+ </td>
528
+ </tr>
529
+ </table>
530
+ </div>
531
+
532
+ </div>
533
+
534
+
535
+ <div id="instance_method_details" class="method_details_list">
536
+ <h2>Instance Method Details</h2>
537
+
538
+
539
+ <div class="method_details first">
540
+ <p class="signature first" id="dict?-instance_method">
541
+
542
+ - (<tt>Boolean</tt>) <strong>dict?</strong>
543
+
544
+
545
+
546
+ </p><div class="docstring">
547
+ <div class="discussion">
548
+ <p>
549
+ dictionary word?
550
+ </p>
551
+
552
+
553
+ </div>
554
+ </div>
555
+ <div class="tags">
556
+ <h3>Returns:</h3>
557
+ <ul class="return">
558
+
559
+ <li>
560
+
561
+
562
+ <span class='type'>(<tt>Boolean</tt>)</span>
563
+
564
+
565
+
566
+ </li>
567
+
568
+ </ul>
569
+
570
+ </div><table class="source_code">
571
+ <tr>
572
+ <td>
573
+ <pre class="lines">
574
+
575
+
576
+ 192
577
+ 193
578
+ 194</pre>
579
+ </td>
580
+ <td>
581
+ <pre class="code"><span class="info file"># File 'lib/ruby_rhymes.rb', line 192</span>
582
+
583
+ <span class='def def kw'>def</span> <span class='dict? fid id'>dict?</span>
584
+ <span class='notop op'>!</span><span class='notop op'>!</span><span class='@pronunciation_id ivar id'>@pronunciation_id</span>
585
+ <span class='end end kw'>end</span>
586
+ </pre>
587
+ </td>
588
+ </tr>
589
+ </table>
590
+ </div>
591
+
592
+ <div class="method_details ">
593
+ <p class="signature " id="to_s-instance_method">
594
+
595
+ - (<tt>Object</tt>) <strong>to_s</strong>
596
+
597
+
598
+
599
+ </p><table class="source_code">
600
+ <tr>
601
+ <td>
602
+ <pre class="lines">
603
+
604
+
605
+ 196
606
+ 197
607
+ 198</pre>
608
+ </td>
609
+ <td>
610
+ <pre class="code"><span class="info file"># File 'lib/ruby_rhymes.rb', line 196</span>
611
+
612
+ <span class='def def kw'>def</span> <span class='to_s identifier id'>to_s</span>
613
+ <span class='word identifier id'>word</span>
614
+ <span class='end end kw'>end</span>
615
+ </pre>
616
+ </td>
617
+ </tr>
618
+ </table>
619
+ </div>
620
+
621
+ </div>
622
+
623
+ </div>
624
+
625
+ <div id="footer">
626
+ Generated on Tue Oct 11 20:47:07 2011 by
627
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
628
+ 0.7.2 (ruby-1.8.7).
629
+ </div>
630
+
631
+ </body>
632
+ </html>