mucgly 0.0.1

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,529 @@
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: Mucgly::MucglyFile::Token
8
+
9
+ &mdash; Documentation by YARD 0.8.6.1
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" 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 (T)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../Mucgly.html" title="Mucgly (module)">Mucgly</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../MucglyFile.html" title="Mucgly::MucglyFile (class)">MucglyFile</a></span></span>
36
+ &raquo;
37
+ <span class="title">Token</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: Mucgly::MucglyFile::Token
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">Mucgly::MucglyFile::Token</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/mucgly.rb</dd>
98
+
99
+ </dl>
100
+ <div class="clear"></div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Input is a stream of characters or control values.</p>
106
+
107
+ <p>Supported types: char, hookEnd, hookBeg, escape, eof, and empty</p>
108
+
109
+
110
+ </div>
111
+ </div>
112
+ <div class="tags">
113
+
114
+
115
+ </div>
116
+
117
+
118
+
119
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
120
+ <ul class="summary">
121
+
122
+ <li class="public ">
123
+ <span class="summary_signature">
124
+
125
+ <a href="#type-instance_method" title="#type (instance method)">- (Object) <strong>type</strong> </a>
126
+
127
+
128
+
129
+ </span>
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+ <span class="summary_desc"><div class='inline'>
143
+ <p>Returns the value of attribute type.</p>
144
+ </div></span>
145
+
146
+ </li>
147
+
148
+
149
+ <li class="public ">
150
+ <span class="summary_signature">
151
+
152
+ <a href="#value-instance_method" title="#value (instance method)">- (Object) <strong>value</strong> </a>
153
+
154
+
155
+
156
+ </span>
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+ <span class="summary_desc"><div class='inline'>
170
+ <p>Returns the value of attribute value.</p>
171
+ </div></span>
172
+
173
+ </li>
174
+
175
+
176
+ </ul>
177
+
178
+
179
+
180
+
181
+
182
+ <h2>
183
+ Instance Method Summary
184
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
185
+ </h2>
186
+
187
+ <ul class="summary">
188
+
189
+ <li class="public ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Token) <strong>initialize</strong>(type, value = nil) </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+ <span class="note title constructor">constructor</span>
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+ <span class="summary_desc"><div class='inline'>
209
+ <p>A new instance of Token.</p>
210
+ </div></span>
211
+
212
+ </li>
213
+
214
+
215
+ <li class="public ">
216
+ <span class="summary_signature">
217
+
218
+ <a href="#isChar-instance_method" title="#isChar (instance method)">- (Object) <strong>isChar</strong> </a>
219
+
220
+
221
+
222
+ </span>
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+ <span class="summary_desc"><div class='inline'></div></span>
233
+
234
+ </li>
235
+
236
+
237
+ <li class="public ">
238
+ <span class="summary_signature">
239
+
240
+ <a href="#isPunct-instance_method" title="#isPunct (instance method)">- (Object) <strong>isPunct</strong> </a>
241
+
242
+
243
+
244
+ </span>
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+ <span class="summary_desc"><div class='inline'></div></span>
255
+
256
+ </li>
257
+
258
+
259
+ <li class="public ">
260
+ <span class="summary_signature">
261
+
262
+ <a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>
263
+
264
+
265
+
266
+ </span>
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+ <span class="summary_desc"><div class='inline'></div></span>
277
+
278
+ </li>
279
+
280
+
281
+ </ul>
282
+
283
+
284
+ <div id="constructor_details" class="method_details_list">
285
+ <h2>Constructor Details</h2>
286
+
287
+ <div class="method_details first">
288
+ <h3 class="signature first" id="initialize-instance_method">
289
+
290
+ - (<tt><span class='object_link'><a href="" title="Mucgly::MucglyFile::Token (class)">Token</a></span></tt>) <strong>initialize</strong>(type, value = nil)
291
+
292
+
293
+
294
+
295
+
296
+ </h3><div class="docstring">
297
+ <div class="discussion">
298
+
299
+ <p>A new instance of Token</p>
300
+
301
+
302
+ </div>
303
+ </div>
304
+ <div class="tags">
305
+
306
+
307
+ </div><table class="source_code">
308
+ <tr>
309
+ <td>
310
+ <pre class="lines">
311
+
312
+
313
+ 166
314
+ 167
315
+ 168
316
+ 169</pre>
317
+ </td>
318
+ <td>
319
+ <pre class="code"><span class="info file"># File 'lib/mucgly.rb', line 166</span>
320
+
321
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
322
+ <span class='ivar'>@type</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span>
323
+ <span class='ivar'>@value</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
324
+ <span class='kw'>end</span></pre>
325
+ </td>
326
+ </tr>
327
+ </table>
328
+ </div>
329
+
330
+ </div>
331
+
332
+ <div id="instance_attr_details" class="attr_details">
333
+ <h2>Instance Attribute Details</h2>
334
+
335
+
336
+ <span id="type=-instance_method"></span>
337
+ <div class="method_details first">
338
+ <h3 class="signature first" id="type-instance_method">
339
+
340
+ - (<tt>Object</tt>) <strong>type</strong>
341
+
342
+
343
+
344
+
345
+
346
+ </h3><div class="docstring">
347
+ <div class="discussion">
348
+
349
+ <p>Returns the value of attribute type</p>
350
+
351
+
352
+ </div>
353
+ </div>
354
+ <div class="tags">
355
+
356
+
357
+ </div><table class="source_code">
358
+ <tr>
359
+ <td>
360
+ <pre class="lines">
361
+
362
+
363
+ 164
364
+ 165
365
+ 166</pre>
366
+ </td>
367
+ <td>
368
+ <pre class="code"><span class="info file"># File 'lib/mucgly.rb', line 164</span>
369
+
370
+ <span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
371
+ <span class='ivar'>@type</span>
372
+ <span class='kw'>end</span></pre>
373
+ </td>
374
+ </tr>
375
+ </table>
376
+ </div>
377
+
378
+
379
+ <span id="value=-instance_method"></span>
380
+ <div class="method_details ">
381
+ <h3 class="signature " id="value-instance_method">
382
+
383
+ - (<tt>Object</tt>) <strong>value</strong>
384
+
385
+
386
+
387
+
388
+
389
+ </h3><div class="docstring">
390
+ <div class="discussion">
391
+
392
+ <p>Returns the value of attribute value</p>
393
+
394
+
395
+ </div>
396
+ </div>
397
+ <div class="tags">
398
+
399
+
400
+ </div><table class="source_code">
401
+ <tr>
402
+ <td>
403
+ <pre class="lines">
404
+
405
+
406
+ 164
407
+ 165
408
+ 166</pre>
409
+ </td>
410
+ <td>
411
+ <pre class="code"><span class="info file"># File 'lib/mucgly.rb', line 164</span>
412
+
413
+ <span class='kw'>def</span> <span class='id identifier rubyid_value'>value</span>
414
+ <span class='ivar'>@value</span>
415
+ <span class='kw'>end</span></pre>
416
+ </td>
417
+ </tr>
418
+ </table>
419
+ </div>
420
+
421
+ </div>
422
+
423
+
424
+ <div id="instance_method_details" class="method_details_list">
425
+ <h2>Instance Method Details</h2>
426
+
427
+
428
+ <div class="method_details first">
429
+ <h3 class="signature first" id="isChar-instance_method">
430
+
431
+ - (<tt>Object</tt>) <strong>isChar</strong>
432
+
433
+
434
+
435
+
436
+
437
+ </h3><table class="source_code">
438
+ <tr>
439
+ <td>
440
+ <pre class="lines">
441
+
442
+
443
+ 175
444
+ 176
445
+ 177</pre>
446
+ </td>
447
+ <td>
448
+ <pre class="code"><span class="info file"># File 'lib/mucgly.rb', line 175</span>
449
+
450
+ <span class='kw'>def</span> <span class='id identifier rubyid_isChar'>isChar</span>
451
+ <span class='ivar'>@type</span> <span class='op'>==</span> <span class='symbol'>:char</span>
452
+ <span class='kw'>end</span></pre>
453
+ </td>
454
+ </tr>
455
+ </table>
456
+ </div>
457
+
458
+ <div class="method_details ">
459
+ <h3 class="signature " id="isPunct-instance_method">
460
+
461
+ - (<tt>Object</tt>) <strong>isPunct</strong>
462
+
463
+
464
+
465
+
466
+
467
+ </h3><table class="source_code">
468
+ <tr>
469
+ <td>
470
+ <pre class="lines">
471
+
472
+
473
+ 171
474
+ 172
475
+ 173</pre>
476
+ </td>
477
+ <td>
478
+ <pre class="code"><span class="info file"># File 'lib/mucgly.rb', line 171</span>
479
+
480
+ <span class='kw'>def</span> <span class='id identifier rubyid_isPunct'>isPunct</span>
481
+ <span class='op'>!</span><span class='id identifier rubyid_isChar'>isChar</span>
482
+ <span class='kw'>end</span></pre>
483
+ </td>
484
+ </tr>
485
+ </table>
486
+ </div>
487
+
488
+ <div class="method_details ">
489
+ <h3 class="signature " id="to_s-instance_method">
490
+
491
+ - (<tt>Object</tt>) <strong>to_s</strong>
492
+
493
+
494
+
495
+
496
+
497
+ </h3><table class="source_code">
498
+ <tr>
499
+ <td>
500
+ <pre class="lines">
501
+
502
+
503
+ 179
504
+ 180
505
+ 181</pre>
506
+ </td>
507
+ <td>
508
+ <pre class="code"><span class="info file"># File 'lib/mucgly.rb', line 179</span>
509
+
510
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
511
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@type</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbrace'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
512
+ <span class='kw'>end</span></pre>
513
+ </td>
514
+ </tr>
515
+ </table>
516
+ </div>
517
+
518
+ </div>
519
+
520
+ </div>
521
+
522
+ <div id="footer">
523
+ Generated on Wed Jan 15 19:29:45 2014 by
524
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
525
+ 0.8.6.1 (ruby-1.9.3).
526
+ </div>
527
+
528
+ </body>
529
+ </html>