mucgly 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,521 @@
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::Separators
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 (S)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Mucgly.html" title="Mucgly (module)">Mucgly</a></span></span>
36
+ &raquo;
37
+ <span class="title">Separators</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::Separators
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::Separators</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>Separators are collection of special characters used by Mucgly.</p>
106
+
107
+ <p>These are:</p>
108
+ <dl class="rdoc-list"><dt>escape</dt>
109
+ <dd>
110
+ <p>Escape char is used to convert special chars into their literal form or to
111
+ remove the following char. Special characters are: escape char, hookbeg,
112
+ hookend. Escape can remove the following newline, and space in special
113
+ circumtances.</p>
114
+ </dd><dt>hookbeg</dt>
115
+ <dd>
116
+ <p>Hookbeg char (or string) starts macros. If user wants a literal hookbeg,
117
+ then &lt;escape&gt; should be put before it.</p>
118
+ </dd><dt>hookend</dt>
119
+ <dd>
120
+ <p>Hookend char (or string) terminates macros. Hookend can also be escaped. If
121
+ hookend end is same character as escape, then hookend followed by a space
122
+ is considered as hookend.</p>
123
+ </dd></dl>
124
+
125
+
126
+ </div>
127
+ </div>
128
+ <div class="tags">
129
+
130
+
131
+ </div>
132
+
133
+
134
+
135
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
136
+ <ul class="summary">
137
+
138
+ <li class="public ">
139
+ <span class="summary_signature">
140
+
141
+ <a href="#escapeChar-instance_method" title="#escapeChar (instance method)">- (Object) <strong>escapeChar</strong> </a>
142
+
143
+
144
+
145
+ </span>
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'>
159
+ <p>Set of control characters for hook and escape indentification.</p>
160
+ </div></span>
161
+
162
+ </li>
163
+
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#hookBegChars-instance_method" title="#hookBegChars (instance method)">- (Object) <strong>hookBegChars</strong> </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+ <span class="summary_desc"><div class='inline'>
186
+ <p>Returns the value of attribute hookBegChars.</p>
187
+ </div></span>
188
+
189
+ </li>
190
+
191
+
192
+ <li class="public ">
193
+ <span class="summary_signature">
194
+
195
+ <a href="#hookEndChars-instance_method" title="#hookEndChars (instance method)">- (Object) <strong>hookEndChars</strong> </a>
196
+
197
+
198
+
199
+ </span>
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+ <span class="summary_desc"><div class='inline'>
213
+ <p>Returns the value of attribute hookEndChars.</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="#copy-instance_method" title="#copy (instance method)">- (Object) <strong>copy</strong> </a>
236
+
237
+
238
+
239
+ </span>
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+ <span class="summary_desc"><div class='inline'></div></span>
250
+
251
+ </li>
252
+
253
+
254
+ <li class="public ">
255
+ <span class="summary_signature">
256
+
257
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Separators) <strong>initialize</strong> </a>
258
+
259
+
260
+
261
+ </span>
262
+
263
+
264
+ <span class="note title constructor">constructor</span>
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+ <span class="summary_desc"><div class='inline'>
274
+ <p>A new instance of Separators.</p>
275
+ </div></span>
276
+
277
+ </li>
278
+
279
+
280
+ </ul>
281
+
282
+
283
+ <div id="constructor_details" class="method_details_list">
284
+ <h2>Constructor Details</h2>
285
+
286
+ <div class="method_details first">
287
+ <h3 class="signature first" id="initialize-instance_method">
288
+
289
+ - (<tt><span class='object_link'><a href="" title="Mucgly::Separators (class)">Separators</a></span></tt>) <strong>initialize</strong>
290
+
291
+
292
+
293
+
294
+
295
+ </h3><div class="docstring">
296
+ <div class="discussion">
297
+
298
+ <p>A new instance of Separators</p>
299
+
300
+
301
+ </div>
302
+ </div>
303
+ <div class="tags">
304
+
305
+
306
+ </div><table class="source_code">
307
+ <tr>
308
+ <td>
309
+ <pre class="lines">
310
+
311
+
312
+ 605
313
+ 606
314
+ 607
315
+ 608
316
+ 609</pre>
317
+ </td>
318
+ <td>
319
+ <pre class="code"><span class="info file"># File 'lib/mucgly.rb', line 605</span>
320
+
321
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
322
+ <span class='ivar'>@escapeChar</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\</span><span class='tstring_end'>&quot;</span></span>
323
+ <span class='ivar'>@hookBegChars</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-&lt;</span><span class='tstring_end'>&quot;</span></span>
324
+ <span class='ivar'>@hookEndChars</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&gt;-</span><span class='tstring_end'>&quot;</span></span>
325
+ <span class='kw'>end</span></pre>
326
+ </td>
327
+ </tr>
328
+ </table>
329
+ </div>
330
+
331
+ </div>
332
+
333
+ <div id="instance_attr_details" class="attr_details">
334
+ <h2>Instance Attribute Details</h2>
335
+
336
+
337
+ <span id="escapeChar=-instance_method"></span>
338
+ <div class="method_details first">
339
+ <h3 class="signature first" id="escapeChar-instance_method">
340
+
341
+ - (<tt>Object</tt>) <strong>escapeChar</strong>
342
+
343
+
344
+
345
+
346
+
347
+ </h3><div class="docstring">
348
+ <div class="discussion">
349
+
350
+ <p>Set of control characters for hook and escape indentification.</p>
351
+
352
+
353
+ </div>
354
+ </div>
355
+ <div class="tags">
356
+
357
+
358
+ </div><table class="source_code">
359
+ <tr>
360
+ <td>
361
+ <pre class="lines">
362
+
363
+
364
+ 602
365
+ 603
366
+ 604</pre>
367
+ </td>
368
+ <td>
369
+ <pre class="code"><span class="info file"># File 'lib/mucgly.rb', line 602</span>
370
+
371
+ <span class='kw'>def</span> <span class='id identifier rubyid_escapeChar'>escapeChar</span>
372
+ <span class='ivar'>@escapeChar</span>
373
+ <span class='kw'>end</span></pre>
374
+ </td>
375
+ </tr>
376
+ </table>
377
+ </div>
378
+
379
+
380
+ <span id="hookBegChars=-instance_method"></span>
381
+ <div class="method_details ">
382
+ <h3 class="signature " id="hookBegChars-instance_method">
383
+
384
+ - (<tt>Object</tt>) <strong>hookBegChars</strong>
385
+
386
+
387
+
388
+
389
+
390
+ </h3><div class="docstring">
391
+ <div class="discussion">
392
+
393
+ <p>Returns the value of attribute hookBegChars</p>
394
+
395
+
396
+ </div>
397
+ </div>
398
+ <div class="tags">
399
+
400
+
401
+ </div><table class="source_code">
402
+ <tr>
403
+ <td>
404
+ <pre class="lines">
405
+
406
+
407
+ 603
408
+ 604
409
+ 605</pre>
410
+ </td>
411
+ <td>
412
+ <pre class="code"><span class="info file"># File 'lib/mucgly.rb', line 603</span>
413
+
414
+ <span class='kw'>def</span> <span class='id identifier rubyid_hookBegChars'>hookBegChars</span>
415
+ <span class='ivar'>@hookBegChars</span>
416
+ <span class='kw'>end</span></pre>
417
+ </td>
418
+ </tr>
419
+ </table>
420
+ </div>
421
+
422
+
423
+ <span id="hookEndChars=-instance_method"></span>
424
+ <div class="method_details ">
425
+ <h3 class="signature " id="hookEndChars-instance_method">
426
+
427
+ - (<tt>Object</tt>) <strong>hookEndChars</strong>
428
+
429
+
430
+
431
+
432
+
433
+ </h3><div class="docstring">
434
+ <div class="discussion">
435
+
436
+ <p>Returns the value of attribute hookEndChars</p>
437
+
438
+
439
+ </div>
440
+ </div>
441
+ <div class="tags">
442
+
443
+
444
+ </div><table class="source_code">
445
+ <tr>
446
+ <td>
447
+ <pre class="lines">
448
+
449
+
450
+ 603
451
+ 604
452
+ 605</pre>
453
+ </td>
454
+ <td>
455
+ <pre class="code"><span class="info file"># File 'lib/mucgly.rb', line 603</span>
456
+
457
+ <span class='kw'>def</span> <span class='id identifier rubyid_hookEndChars'>hookEndChars</span>
458
+ <span class='ivar'>@hookEndChars</span>
459
+ <span class='kw'>end</span></pre>
460
+ </td>
461
+ </tr>
462
+ </table>
463
+ </div>
464
+
465
+ </div>
466
+
467
+
468
+ <div id="instance_method_details" class="method_details_list">
469
+ <h2>Instance Method Details</h2>
470
+
471
+
472
+ <div class="method_details first">
473
+ <h3 class="signature first" id="copy-instance_method">
474
+
475
+ - (<tt>Object</tt>) <strong>copy</strong>
476
+
477
+
478
+
479
+
480
+
481
+ </h3><table class="source_code">
482
+ <tr>
483
+ <td>
484
+ <pre class="lines">
485
+
486
+
487
+ 618
488
+ 619
489
+ 620
490
+ 621
491
+ 622
492
+ 623
493
+ 624</pre>
494
+ </td>
495
+ <td>
496
+ <pre class="code"><span class="info file"># File 'lib/mucgly.rb', line 618</span>
497
+
498
+ <span class='kw'>def</span> <span class='id identifier rubyid_copy'>copy</span>
499
+ <span class='id identifier rubyid_c'>c</span> <span class='op'>=</span> <span class='const'>Separators</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
500
+ <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_escapeChar'>escapeChar</span> <span class='op'>=</span> <span class='ivar'>@escapeChar</span>
501
+ <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_hookBegChars'>hookBegChars</span> <span class='op'>=</span> <span class='ivar'>@hookBegChars</span>
502
+ <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_hookEndChars'>hookEndChars</span> <span class='op'>=</span> <span class='ivar'>@hookEndChars</span>
503
+ <span class='kw'>return</span> <span class='id identifier rubyid_c'>c</span>
504
+ <span class='kw'>end</span></pre>
505
+ </td>
506
+ </tr>
507
+ </table>
508
+ </div>
509
+
510
+ </div>
511
+
512
+ </div>
513
+
514
+ <div id="footer">
515
+ Generated on Wed Jan 15 19:29:45 2014 by
516
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
517
+ 0.8.6.1 (ruby-1.9.3).
518
+ </div>
519
+
520
+ </body>
521
+ </html>