readme_yard 0.4.0 → 0.5.0
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/Gemfile.lock +1 -1
- data/README.md +3 -4
- data/README_YARD.md +3 -2
- data/docs/ReadmeYard/CodeTag.html +273 -0
- data/docs/ReadmeYard/CommentTag.html +418 -0
- data/docs/ReadmeYard/Error.html +217 -0
- data/docs/ReadmeYard/ExampleTag.html +382 -0
- data/docs/ReadmeYard/Logger.html +299 -0
- data/docs/ReadmeYard/ReadmeTag.html +281 -0
- data/docs/ReadmeYard/SourceTag.html +277 -0
- data/docs/ReadmeYard/StringTag.html +402 -0
- data/docs/ReadmeYard/TagRegistry.html +266 -0
- data/docs/ReadmeYard/ValueTag.html +286 -0
- data/docs/ReadmeYard/YardOptsManager.html +504 -0
- data/docs/ReadmeYard.html +746 -0
- data/docs/_index.html +243 -0
- data/docs/class_list.html +54 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +503 -0
- data/docs/file.README.html +405 -0
- data/docs/file_list.html +59 -0
- data/docs/frames.html +22 -0
- data/docs/index.html +405 -0
- data/docs/js/app.js +344 -0
- data/docs/js/full_list.js +242 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +358 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/readme_yard/string_tag.rb +7 -2
- data/lib/readme_yard/version.rb +2 -1
- data/lib/readme_yard.rb +0 -2
- data/readme_yard.gemspec +2 -1
- metadata +29 -2
|
@@ -0,0 +1,746 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: ReadmeYard
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.37
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "ReadmeYard";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index (R)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">ReadmeYard</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: ReadmeYard
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">ReadmeYard</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/readme_yard.rb<span class="defines">,<br />
|
|
98
|
+
lib/readme_yard/error.rb,<br /> lib/readme_yard/logger.rb,<br /> lib/readme_yard/version.rb,<br /> lib/readme_yard/code_tag.rb,<br /> lib/readme_yard/value_tag.rb,<br /> lib/readme_yard/readme_tag.rb,<br /> lib/readme_yard/source_tag.rb,<br /> lib/readme_yard/string_tag.rb,<br /> lib/readme_yard/comment_tag.rb,<br /> lib/readme_yard/example_tag.rb,<br /> lib/readme_yard/tag_registry.rb,<br /> lib/readme_yard/yard_opts_manager.rb</span>
|
|
99
|
+
</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
<p>Build a better README with <a href="https://yardoc.org">YARD</a>
|
|
107
|
+
by generating it straight from the source.</p>
|
|
108
|
+
|
|
109
|
+
<p>This gem aims to minimize the effort needed to keep your
|
|
110
|
+
README, documentation, and source code synced, useful,
|
|
111
|
+
and correct. Among its features, it introduces the @readme tag
|
|
112
|
+
that enables you to embed code comments directly into README sections,
|
|
113
|
+
eliminating redundancy and keeping documentation consistent
|
|
114
|
+
across your codebase and project README.</p>
|
|
115
|
+
|
|
116
|
+
<p>Look at the <a href="https://github.com/mattruzicka/readme_yard/blob/main/README_YARD.md">README_YARD.md</a>
|
|
117
|
+
template for this project to see how it works.
|
|
118
|
+
If you’re reading the README, that means this text is here
|
|
119
|
+
because the custom <code>{@readme ReadmeYard}</code> markdown tag is in
|
|
120
|
+
README_YARD.md and <code>readme build</code> was run at the command line.</p>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
</div>
|
|
124
|
+
</div>
|
|
125
|
+
<div class="tags">
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
</div><h2>Defined Under Namespace</h2>
|
|
129
|
+
<p class="children">
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="ReadmeYard/CodeTag.html" title="ReadmeYard::CodeTag (class)">CodeTag</a></span>, <span class='object_link'><a href="ReadmeYard/CommentTag.html" title="ReadmeYard::CommentTag (class)">CommentTag</a></span>, <span class='object_link'><a href="ReadmeYard/Error.html" title="ReadmeYard::Error (class)">Error</a></span>, <span class='object_link'><a href="ReadmeYard/ExampleTag.html" title="ReadmeYard::ExampleTag (class)">ExampleTag</a></span>, <span class='object_link'><a href="ReadmeYard/Logger.html" title="ReadmeYard::Logger (class)">Logger</a></span>, <span class='object_link'><a href="ReadmeYard/ReadmeTag.html" title="ReadmeYard::ReadmeTag (class)">ReadmeTag</a></span>, <span class='object_link'><a href="ReadmeYard/SourceTag.html" title="ReadmeYard::SourceTag (class)">SourceTag</a></span>, <span class='object_link'><a href="ReadmeYard/StringTag.html" title="ReadmeYard::StringTag (class)">StringTag</a></span>, <span class='object_link'><a href="ReadmeYard/TagRegistry.html" title="ReadmeYard::TagRegistry (class)">TagRegistry</a></span>, <span class='object_link'><a href="ReadmeYard/ValueTag.html" title="ReadmeYard::ValueTag (class)">ValueTag</a></span>, <span class='object_link'><a href="ReadmeYard/YardOptsManager.html" title="ReadmeYard::YardOptsManager (class)">YardOptsManager</a></span>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
</p>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
<h2>
|
|
141
|
+
Constant Summary
|
|
142
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
143
|
+
</h2>
|
|
144
|
+
|
|
145
|
+
<dl class="constants">
|
|
146
|
+
|
|
147
|
+
<dt id="VERSION-constant" class="">VERSION =
|
|
148
|
+
|
|
149
|
+
</dt>
|
|
150
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.4.0</span><span class='tstring_end'>"</span></span></pre></dd>
|
|
151
|
+
|
|
152
|
+
<dt id="DOCS_URL-constant" class="">DOCS_URL =
|
|
153
|
+
|
|
154
|
+
</dt>
|
|
155
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>https://mattruzicka.github.io/readme_yard/</span><span class='tstring_end'>"</span></span></pre></dd>
|
|
156
|
+
|
|
157
|
+
</dl>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
164
|
+
<ul class="summary">
|
|
165
|
+
|
|
166
|
+
<li class="public ">
|
|
167
|
+
<span class="summary_signature">
|
|
168
|
+
|
|
169
|
+
<a href="#readme_path-instance_method" title="#readme_path (instance method)">#<strong>readme_path</strong> ⇒ Object </a>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
</span>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute readme_path.</p>
|
|
187
|
+
</div></span>
|
|
188
|
+
|
|
189
|
+
</li>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<li class="public ">
|
|
193
|
+
<span class="summary_signature">
|
|
194
|
+
|
|
195
|
+
<a href="#readme_yard_path-instance_method" title="#readme_yard_path (instance method)">#<strong>readme_yard_path</strong> ⇒ Object </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'><p>Returns the value of attribute readme_yard_path.</p>
|
|
213
|
+
</div></span>
|
|
214
|
+
|
|
215
|
+
</li>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
</ul>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<h2>
|
|
225
|
+
Class Method Summary
|
|
226
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
227
|
+
</h2>
|
|
228
|
+
|
|
229
|
+
<ul class="summary">
|
|
230
|
+
|
|
231
|
+
<li class="public ">
|
|
232
|
+
<span class="summary_signature">
|
|
233
|
+
|
|
234
|
+
<a href="#call-class_method" title="call (class method)">.<strong>call</strong>(arg, options) ⇒ Object </a>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<span class="summary_desc"><div class='inline'>
|
|
249
|
+
</div></span>
|
|
250
|
+
|
|
251
|
+
</li>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
</ul>
|
|
255
|
+
|
|
256
|
+
<h2>
|
|
257
|
+
Instance Method Summary
|
|
258
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
259
|
+
</h2>
|
|
260
|
+
|
|
261
|
+
<ul class="summary">
|
|
262
|
+
|
|
263
|
+
<li class="public ">
|
|
264
|
+
<span class="summary_signature">
|
|
265
|
+
|
|
266
|
+
<a href="#build-instance_method" title="#build (instance method)">#<strong>build</strong>(options: "-nq") ⇒ Object </a>
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
</span>
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<span class="summary_desc"><div class='inline'><p>Reads from README_YARD.md and writes to README.md.</p>
|
|
281
|
+
</div></span>
|
|
282
|
+
|
|
283
|
+
</li>
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
<li class="public ">
|
|
287
|
+
<span class="summary_signature">
|
|
288
|
+
|
|
289
|
+
<a href="#command_line_usage-instance_method" title="#command_line_usage (instance method)">#<strong>command_line_usage</strong> ⇒ Object </a>
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
</span>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<span class="summary_desc"><div class='inline'><p>This unnecessarily meta method returns the <code>@readme</code> text you see below (if you’re reading this in the source code).</p>
|
|
304
|
+
</div></span>
|
|
305
|
+
|
|
306
|
+
</li>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
<li class="public ">
|
|
310
|
+
<span class="summary_signature">
|
|
311
|
+
|
|
312
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ ReadmeYard </a>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
</span>
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
<span class="note title constructor">constructor</span>
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
<span class="summary_desc"><div class='inline'><p>A new instance of ReadmeYard.</p>
|
|
329
|
+
</div></span>
|
|
330
|
+
|
|
331
|
+
</li>
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
<li class="public ">
|
|
335
|
+
<span class="summary_signature">
|
|
336
|
+
|
|
337
|
+
<a href="#yard-instance_method" title="#yard (instance method)">#<strong>yard</strong>(options: "") ⇒ Object </a>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
</span>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<span class="summary_desc"><div class='inline'><p>Same as “build” + generates yard `docs.</p>
|
|
352
|
+
</div></span>
|
|
353
|
+
|
|
354
|
+
</li>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
</ul>
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
<div id="constructor_details" class="method_details_list">
|
|
361
|
+
<h2>Constructor Details</h2>
|
|
362
|
+
|
|
363
|
+
<div class="method_details first">
|
|
364
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
365
|
+
|
|
366
|
+
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="ReadmeYard (class)">ReadmeYard</a></span></tt>
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
</h3><div class="docstring">
|
|
373
|
+
<div class="discussion">
|
|
374
|
+
<p>Returns a new instance of ReadmeYard.</p>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
</div>
|
|
378
|
+
</div>
|
|
379
|
+
<div class="tags">
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</div><table class="source_code">
|
|
383
|
+
<tr>
|
|
384
|
+
<td>
|
|
385
|
+
<pre class="lines">
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
61
|
|
389
|
+
62
|
|
390
|
+
63
|
|
391
|
+
64</pre>
|
|
392
|
+
</td>
|
|
393
|
+
<td>
|
|
394
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard.rb', line 61</span>
|
|
395
|
+
|
|
396
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
|
|
397
|
+
<span class='ivar'>@readme_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>./README.md</span><span class='tstring_end'>"</span></span>
|
|
398
|
+
<span class='ivar'>@readme_yard_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>./README_YARD.md</span><span class='tstring_end'>"</span></span>
|
|
399
|
+
<span class='kw'>end</span></pre>
|
|
400
|
+
</td>
|
|
401
|
+
</tr>
|
|
402
|
+
</table>
|
|
403
|
+
</div>
|
|
404
|
+
|
|
405
|
+
</div>
|
|
406
|
+
|
|
407
|
+
<div id="instance_attr_details" class="attr_details">
|
|
408
|
+
<h2>Instance Attribute Details</h2>
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
<span id="readme_path=-instance_method"></span>
|
|
412
|
+
<div class="method_details first">
|
|
413
|
+
<h3 class="signature first" id="readme_path-instance_method">
|
|
414
|
+
|
|
415
|
+
#<strong>readme_path</strong> ⇒ <tt>Object</tt>
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
</h3><div class="docstring">
|
|
422
|
+
<div class="discussion">
|
|
423
|
+
<p>Returns the value of attribute readme_path.</p>
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
</div>
|
|
427
|
+
</div>
|
|
428
|
+
<div class="tags">
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
</div><table class="source_code">
|
|
432
|
+
<tr>
|
|
433
|
+
<td>
|
|
434
|
+
<pre class="lines">
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
66
|
|
438
|
+
67
|
|
439
|
+
68</pre>
|
|
440
|
+
</td>
|
|
441
|
+
<td>
|
|
442
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard.rb', line 66</span>
|
|
443
|
+
|
|
444
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_readme_path'>readme_path</span>
|
|
445
|
+
<span class='ivar'>@readme_path</span>
|
|
446
|
+
<span class='kw'>end</span></pre>
|
|
447
|
+
</td>
|
|
448
|
+
</tr>
|
|
449
|
+
</table>
|
|
450
|
+
</div>
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
<span id="readme_yard_path=-instance_method"></span>
|
|
454
|
+
<div class="method_details ">
|
|
455
|
+
<h3 class="signature " id="readme_yard_path-instance_method">
|
|
456
|
+
|
|
457
|
+
#<strong>readme_yard_path</strong> ⇒ <tt>Object</tt>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
</h3><div class="docstring">
|
|
464
|
+
<div class="discussion">
|
|
465
|
+
<p>Returns the value of attribute readme_yard_path.</p>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
</div>
|
|
469
|
+
</div>
|
|
470
|
+
<div class="tags">
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
</div><table class="source_code">
|
|
474
|
+
<tr>
|
|
475
|
+
<td>
|
|
476
|
+
<pre class="lines">
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
66
|
|
480
|
+
67
|
|
481
|
+
68</pre>
|
|
482
|
+
</td>
|
|
483
|
+
<td>
|
|
484
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard.rb', line 66</span>
|
|
485
|
+
|
|
486
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_readme_yard_path'>readme_yard_path</span>
|
|
487
|
+
<span class='ivar'>@readme_yard_path</span>
|
|
488
|
+
<span class='kw'>end</span></pre>
|
|
489
|
+
</td>
|
|
490
|
+
</tr>
|
|
491
|
+
</table>
|
|
492
|
+
</div>
|
|
493
|
+
|
|
494
|
+
</div>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
<div id="class_method_details" class="method_details_list">
|
|
498
|
+
<h2>Class Method Details</h2>
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
<div class="method_details first">
|
|
502
|
+
<h3 class="signature first" id="call-class_method">
|
|
503
|
+
|
|
504
|
+
.<strong>call</strong>(arg, options) ⇒ <tt>Object</tt>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
</h3><div class="docstring">
|
|
511
|
+
<div class="discussion">
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
</div>
|
|
516
|
+
</div>
|
|
517
|
+
<div class="tags">
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
<p class="tag_title">See Also:</p>
|
|
521
|
+
<ul class="see">
|
|
522
|
+
|
|
523
|
+
<li><span class='object_link'><a href="#command_line_usage-instance_method" title="ReadmeYard#command_line_usage (method)">#command_line_usage</a></span></li>
|
|
524
|
+
|
|
525
|
+
</ul>
|
|
526
|
+
|
|
527
|
+
</div><table class="source_code">
|
|
528
|
+
<tr>
|
|
529
|
+
<td>
|
|
530
|
+
<pre class="lines">
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
44
|
|
534
|
+
45
|
|
535
|
+
46
|
|
536
|
+
47
|
|
537
|
+
48
|
|
538
|
+
49
|
|
539
|
+
50
|
|
540
|
+
51
|
|
541
|
+
52
|
|
542
|
+
53
|
|
543
|
+
54
|
|
544
|
+
55
|
|
545
|
+
56
|
|
546
|
+
57
|
|
547
|
+
58
|
|
548
|
+
59</pre>
|
|
549
|
+
</td>
|
|
550
|
+
<td>
|
|
551
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard.rb', line 44</span>
|
|
552
|
+
|
|
553
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
554
|
+
<span class='id identifier rubyid_readme_yard'>readme_yard</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="ReadmeYard (class)">ReadmeYard</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="ReadmeYard#initialize (method)">new</a></span></span>
|
|
555
|
+
|
|
556
|
+
<span class='kw'>case</span> <span class='id identifier rubyid_arg'>arg</span>
|
|
557
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>build</span><span class='tstring_end'>"</span></span>
|
|
558
|
+
<span class='id identifier rubyid_readme_yard'>readme_yard</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='label'>options:</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
559
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>yard</span><span class='tstring_end'>"</span></span>
|
|
560
|
+
<span class='id identifier rubyid_readme_yard'>readme_yard</span><span class='period'>.</span><span class='id identifier rubyid_yard'>yard</span><span class='lparen'>(</span><span class='label'>options:</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
561
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>version</span><span class='tstring_end'>"</span></span>
|
|
562
|
+
<span class='const'><span class='object_link'><a href="ReadmeYard/Logger.html" title="ReadmeYard::Logger (class)">Logger</a></span></span><span class='period'>.</span><span class='id identifier rubyid_puts_md'><span class='object_link'><a href="ReadmeYard/Logger.html#puts_md-class_method" title="ReadmeYard::Logger.puts_md (method)">puts_md</a></span></span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#VERSION-constant" title="ReadmeYard::VERSION (constant)">VERSION</a></span></span><span class='rparen'>)</span>
|
|
563
|
+
<span class='kw'>else</span>
|
|
564
|
+
<span class='const'><span class='object_link'><a href="ReadmeYard/Logger.html" title="ReadmeYard::Logger (class)">Logger</a></span></span><span class='period'>.</span><span class='id identifier rubyid_puts_md'><span class='object_link'><a href="ReadmeYard/Logger.html#puts_md-class_method" title="ReadmeYard::Logger.puts_md (method)">puts_md</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_readme_yard'>readme_yard</span><span class='period'>.</span><span class='id identifier rubyid_command_line_usage'>command_line_usage</span><span class='rparen'>)</span>
|
|
565
|
+
<span class='kw'>end</span>
|
|
566
|
+
<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="ReadmeYard/Error.html" title="ReadmeYard::Error (class)">Error</a></span></span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
|
|
567
|
+
<span class='const'><span class='object_link'><a href="ReadmeYard/Logger.html" title="ReadmeYard::Logger (class)">Logger</a></span></span><span class='period'>.</span><span class='id identifier rubyid_puts_md'><span class='object_link'><a href="ReadmeYard/Logger.html#puts_md-class_method" title="ReadmeYard::Logger.puts_md (method)">puts_md</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
|
568
|
+
<span class='kw'>end</span></pre>
|
|
569
|
+
</td>
|
|
570
|
+
</tr>
|
|
571
|
+
</table>
|
|
572
|
+
</div>
|
|
573
|
+
|
|
574
|
+
</div>
|
|
575
|
+
|
|
576
|
+
<div id="instance_method_details" class="method_details_list">
|
|
577
|
+
<h2>Instance Method Details</h2>
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
<div class="method_details first">
|
|
581
|
+
<h3 class="signature first" id="build-instance_method">
|
|
582
|
+
|
|
583
|
+
#<strong>build</strong>(options: "-nq") ⇒ <tt>Object</tt>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
</h3><div class="docstring">
|
|
590
|
+
<div class="discussion">
|
|
591
|
+
<p>Reads from README_YARD.md and writes to README.md</p>
|
|
592
|
+
|
|
593
|
+
<p>Forwards options to yardoc</p>
|
|
594
|
+
|
|
595
|
+
<p><code>-n</code> only generate .yardoc database, no documentation.</p>
|
|
596
|
+
|
|
597
|
+
<p><code>-q</code> silence yardoc output statements</p>
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
</div>
|
|
601
|
+
</div>
|
|
602
|
+
<div class="tags">
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
</div><table class="source_code">
|
|
606
|
+
<tr>
|
|
607
|
+
<td>
|
|
608
|
+
<pre class="lines">
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
101
|
|
612
|
+
102
|
|
613
|
+
103
|
|
614
|
+
104
|
|
615
|
+
105
|
|
616
|
+
106
|
|
617
|
+
107</pre>
|
|
618
|
+
</td>
|
|
619
|
+
<td>
|
|
620
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard.rb', line 101</span>
|
|
621
|
+
|
|
622
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='label'>options:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>-nq</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
623
|
+
<span class='const'>YARD</span><span class='op'>::</span><span class='const'>CLI</span><span class='op'>::</span><span class='const'>Yardoc</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>-nq</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
624
|
+
<span class='id identifier rubyid_old_readme'>old_readme</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span><span class='lparen'>(</span><span class='id identifier rubyid_readme_path'>readme_path</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_readme_path'>readme_path</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
625
|
+
<span class='id identifier rubyid_new_readme'>new_readme</span> <span class='op'>=</span> <span class='id identifier rubyid_gsub_tags!'>gsub_tags!</span><span class='lparen'>(</span><span class='id identifier rubyid_readme_yard_md'>readme_yard_md</span><span class='rparen'>)</span>
|
|
626
|
+
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_readme_path'>readme_path</span><span class='comma'>,</span> <span class='id identifier rubyid_new_readme'>new_readme</span><span class='rparen'>)</span>
|
|
627
|
+
<span class='id identifier rubyid_show_readme_diff'>show_readme_diff</span><span class='lparen'>(</span><span class='id identifier rubyid_old_readme'>old_readme</span><span class='comma'>,</span> <span class='id identifier rubyid_new_readme'>new_readme</span><span class='rparen'>)</span>
|
|
628
|
+
<span class='kw'>end</span></pre>
|
|
629
|
+
</td>
|
|
630
|
+
</tr>
|
|
631
|
+
</table>
|
|
632
|
+
</div>
|
|
633
|
+
|
|
634
|
+
<div class="method_details ">
|
|
635
|
+
<h3 class="signature " id="command_line_usage-instance_method">
|
|
636
|
+
|
|
637
|
+
#<strong>command_line_usage</strong> ⇒ <tt>Object</tt>
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
</h3><div class="docstring">
|
|
644
|
+
<div class="discussion">
|
|
645
|
+
<p>This unnecessarily meta method returns the <code>@readme</code> text you see
|
|
646
|
+
below (if you’re reading this in the source code). It was implemented
|
|
647
|
+
just for fun as a demonstration of @readme tags.</p>
|
|
648
|
+
|
|
649
|
+
<h2 id="command-line-usage">Command Line Usage</h2>
|
|
650
|
+
|
|
651
|
+
<p><code>readme</code> - Prints command line usage.</p>
|
|
652
|
+
|
|
653
|
+
<p><code>readme build</code> - Reads from README_YARD.md and writes to README.md.</p>
|
|
654
|
+
|
|
655
|
+
<p><code>readme yard</code> - Same as <code>readme build</code> + generates yard docs.</p>
|
|
656
|
+
|
|
657
|
+
<p><code>readme version</code> - Prints the current version of ReadmeYard.</p>
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
</div>
|
|
661
|
+
</div>
|
|
662
|
+
<div class="tags">
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
</div><table class="source_code">
|
|
666
|
+
<tr>
|
|
667
|
+
<td>
|
|
668
|
+
<pre class="lines">
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
84
|
|
672
|
+
85
|
|
673
|
+
86
|
|
674
|
+
87
|
|
675
|
+
88
|
|
676
|
+
89</pre>
|
|
677
|
+
</td>
|
|
678
|
+
<td>
|
|
679
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard.rb', line 84</span>
|
|
680
|
+
|
|
681
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_command_line_usage'>command_line_usage</span>
|
|
682
|
+
<span class='id identifier rubyid_yard_parse_this_file'>yard_parse_this_file</span>
|
|
683
|
+
<span class='id identifier rubyid_yard_object'>yard_object</span> <span class='op'>=</span> <span class='const'>YARD</span><span class='op'>::</span><span class='const'>Registry</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>#</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid___method__'>__method__</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
684
|
+
<span class='id identifier rubyid_yard_tags'>yard_tags</span> <span class='op'>=</span> <span class='id identifier rubyid_yard_object'>yard_object</span><span class='period'>.</span><span class='id identifier rubyid_tags'>tags</span><span class='lparen'>(</span><span class='symbol'>:readme</span><span class='rparen'>)</span>
|
|
685
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="ReadmeYard/ReadmeTag.html" title="ReadmeYard::ReadmeTag (class)">ReadmeTag</a></span></span><span class='period'>.</span><span class='id identifier rubyid_format_tags'><span class='object_link'><a href="ReadmeYard/ReadmeTag.html#format_tags-class_method" title="ReadmeYard::ReadmeTag.format_tags (method)">format_tags</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_yard_object'>yard_object</span><span class='comma'>,</span> <span class='id identifier rubyid_yard_tags'>yard_tags</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n\n</span><span class='tstring_end'>"</span></span>
|
|
686
|
+
<span class='kw'>end</span></pre>
|
|
687
|
+
</td>
|
|
688
|
+
</tr>
|
|
689
|
+
</table>
|
|
690
|
+
</div>
|
|
691
|
+
|
|
692
|
+
<div class="method_details ">
|
|
693
|
+
<h3 class="signature " id="yard-instance_method">
|
|
694
|
+
|
|
695
|
+
#<strong>yard</strong>(options: "") ⇒ <tt>Object</tt>
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
</h3><div class="docstring">
|
|
702
|
+
<div class="discussion">
|
|
703
|
+
<p>Same as “build” + generates yard `docs.</p>
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
</div>
|
|
707
|
+
</div>
|
|
708
|
+
<div class="tags">
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
</div><table class="source_code">
|
|
712
|
+
<tr>
|
|
713
|
+
<td>
|
|
714
|
+
<pre class="lines">
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
112
|
|
718
|
+
113
|
|
719
|
+
114
|
|
720
|
+
115</pre>
|
|
721
|
+
</td>
|
|
722
|
+
<td>
|
|
723
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard.rb', line 112</span>
|
|
724
|
+
|
|
725
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_yard'>yard</span><span class='lparen'>(</span><span class='label'>options:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
726
|
+
<span class='const'><span class='object_link'><a href="ReadmeYard/YardOptsManager.html" title="ReadmeYard::YardOptsManager (class)">YardOptsManager</a></span></span><span class='period'>.</span><span class='id identifier rubyid_upsert_yardopts'><span class='object_link'><a href="ReadmeYard/YardOptsManager.html#upsert_yardopts-class_method" title="ReadmeYard::YardOptsManager.upsert_yardopts (method)">upsert_yardopts</a></span></span>
|
|
727
|
+
<span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='label'>options:</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
728
|
+
<span class='kw'>end</span></pre>
|
|
729
|
+
</td>
|
|
730
|
+
</tr>
|
|
731
|
+
</table>
|
|
732
|
+
</div>
|
|
733
|
+
|
|
734
|
+
</div>
|
|
735
|
+
|
|
736
|
+
</div>
|
|
737
|
+
|
|
738
|
+
<div id="footer">
|
|
739
|
+
Generated on Mon May 5 09:48:52 2025 by
|
|
740
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
741
|
+
0.9.37 (ruby-3.4.2).
|
|
742
|
+
</div>
|
|
743
|
+
|
|
744
|
+
</div>
|
|
745
|
+
</body>
|
|
746
|
+
</html>
|