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,418 @@
|
|
|
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::CommentTag
|
|
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::CommentTag";
|
|
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 (C)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../ReadmeYard.html" title="ReadmeYard (class)">ReadmeYard</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">CommentTag</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::CommentTag
|
|
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::CommentTag</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/comment_tag.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
<p>Embed comments</p>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
</div>
|
|
109
|
+
<div class="tags">
|
|
110
|
+
|
|
111
|
+
<div class="examples">
|
|
112
|
+
<h4 class="tag_title">Examples:</h4>
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
<pre class="example code"><code><span class='comment'># @readme comment</span></code></pre>
|
|
116
|
+
|
|
117
|
+
</div>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
</div>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
<h2>
|
|
129
|
+
Class Method Summary
|
|
130
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
131
|
+
</h2>
|
|
132
|
+
|
|
133
|
+
<ul class="summary">
|
|
134
|
+
|
|
135
|
+
<li class="public ">
|
|
136
|
+
<span class="summary_signature">
|
|
137
|
+
|
|
138
|
+
<a href="#format_docstring_as_comment-class_method" title="format_docstring_as_comment (class method)">.<strong>format_docstring_as_comment</strong>(yard_object) ⇒ Object </a>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
</span>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
<span class="summary_desc"><div class='inline'>
|
|
153
|
+
</div></span>
|
|
154
|
+
|
|
155
|
+
</li>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<li class="public ">
|
|
159
|
+
<span class="summary_signature">
|
|
160
|
+
|
|
161
|
+
<a href="#format_tag-class_method" title="format_tag (class method)">.<strong>format_tag</strong>(yard_object, _tag) ⇒ Object </a>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
</span>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<span class="summary_desc"><div class='inline'><p>This comment is in the README because <code>@readme comment</code> is below (in the source code).</p>
|
|
176
|
+
</div></span>
|
|
177
|
+
|
|
178
|
+
</li>
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
<li class="public ">
|
|
182
|
+
<span class="summary_signature">
|
|
183
|
+
|
|
184
|
+
<a href="#format_yard_object-class_method" title="format_yard_object (class method)">.<strong>format_yard_object</strong>(yard_object) ⇒ Object </a>
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
</span>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<span class="summary_desc"><div class='inline'>
|
|
199
|
+
</div></span>
|
|
200
|
+
|
|
201
|
+
</li>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
<li class="public ">
|
|
205
|
+
<span class="summary_signature">
|
|
206
|
+
|
|
207
|
+
<a href="#named_readme_tag_regex-class_method" title="named_readme_tag_regex (class method)">.<strong>named_readme_tag_regex</strong> ⇒ Object </a>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
</span>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
<span class="summary_desc"><div class='inline'>
|
|
222
|
+
</div></span>
|
|
223
|
+
|
|
224
|
+
</li>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
</ul>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
<div id="class_method_details" class="method_details_list">
|
|
233
|
+
<h2>Class Method Details</h2>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
<div class="method_details first">
|
|
237
|
+
<h3 class="signature first" id="format_docstring_as_comment-class_method">
|
|
238
|
+
|
|
239
|
+
.<strong>format_docstring_as_comment</strong>(yard_object) ⇒ <tt>Object</tt>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
</h3><div class="docstring">
|
|
246
|
+
<div class="discussion">
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
</div>
|
|
251
|
+
</div>
|
|
252
|
+
<div class="tags">
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<p class="tag_title">See Also:</p>
|
|
256
|
+
<ul class="see">
|
|
257
|
+
|
|
258
|
+
<li><a href="https://rubydoc.info/gems/yard/YARD%2FDocstring:to_raw" target="_parent" title="https://rubydoc.info/gems/yard/YARD%2FDocstring:to_raw">https://rubydoc.info/gems/yard/YARD%2FDocstring:to_raw</a></li>
|
|
259
|
+
|
|
260
|
+
</ul>
|
|
261
|
+
|
|
262
|
+
</div><table class="source_code">
|
|
263
|
+
<tr>
|
|
264
|
+
<td>
|
|
265
|
+
<pre class="lines">
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
31
|
|
269
|
+
32
|
|
270
|
+
33
|
|
271
|
+
34
|
|
272
|
+
35
|
|
273
|
+
36
|
|
274
|
+
37
|
|
275
|
+
38
|
|
276
|
+
39
|
|
277
|
+
40
|
|
278
|
+
41
|
|
279
|
+
42
|
|
280
|
+
43</pre>
|
|
281
|
+
</td>
|
|
282
|
+
<td>
|
|
283
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/comment_tag.rb', line 31</span>
|
|
284
|
+
|
|
285
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_format_docstring_as_comment'>format_docstring_as_comment</span><span class='lparen'>(</span><span class='id identifier rubyid_yard_object'>yard_object</span><span class='rparen'>)</span>
|
|
286
|
+
<span class='id identifier rubyid_comment'>comment</span> <span class='op'>=</span> <span class='op'>+</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
287
|
+
<span class='id identifier rubyid_docstring'>docstring</span> <span class='op'>=</span> <span class='id identifier rubyid_yard_object'>yard_object</span><span class='period'>.</span><span class='id identifier rubyid_docstring'>docstring</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
|
|
288
|
+
<span class='id identifier rubyid_docstring'>docstring</span><span class='period'>.</span><span class='id identifier rubyid_gsub!'>gsub!</span><span class='lparen'>(</span><span class='id identifier rubyid_named_readme_tag_regex'>named_readme_tag_regex</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
289
|
+
<span class='id identifier rubyid_docstring'>docstring</span><span class='period'>.</span><span class='id identifier rubyid_lines'>lines</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_line'>line</span><span class='op'>|</span>
|
|
290
|
+
<span class='id identifier rubyid_comment'>comment</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#</span><span class='tstring_end'>"</span></span>
|
|
291
|
+
<span class='id identifier rubyid_comment'>comment</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_line'>line</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span>
|
|
292
|
+
<span class='id identifier rubyid_comment'>comment</span> <span class='op'><<</span> <span class='id identifier rubyid_line'>line</span>
|
|
293
|
+
<span class='kw'>end</span>
|
|
294
|
+
<span class='id identifier rubyid_last_line'>last_line</span> <span class='op'>=</span> <span class='id identifier rubyid_yard_object'>yard_object</span><span class='period'>.</span><span class='id identifier rubyid_docstring'>docstring</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span><span class='period'>.</span><span class='id identifier rubyid_lines'>lines</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span>
|
|
295
|
+
<span class='id identifier rubyid_comment'>comment</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_last_line'>last_line</span><span class='op'>&.</span><span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\n$</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
|
|
296
|
+
<span class='id identifier rubyid_comment'>comment</span>
|
|
297
|
+
<span class='kw'>end</span></pre>
|
|
298
|
+
</td>
|
|
299
|
+
</tr>
|
|
300
|
+
</table>
|
|
301
|
+
</div>
|
|
302
|
+
|
|
303
|
+
<div class="method_details ">
|
|
304
|
+
<h3 class="signature " id="format_tag-class_method">
|
|
305
|
+
|
|
306
|
+
.<strong>format_tag</strong>(yard_object, _tag) ⇒ <tt>Object</tt>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
</h3><div class="docstring">
|
|
313
|
+
<div class="discussion">
|
|
314
|
+
<p>This comment is in the README because <code>@readme comment</code>
|
|
315
|
+
is below (in the source code).</p>
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
</div>
|
|
319
|
+
</div>
|
|
320
|
+
<div class="tags">
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
</div><table class="source_code">
|
|
324
|
+
<tr>
|
|
325
|
+
<td>
|
|
326
|
+
<pre class="lines">
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
19
|
|
330
|
+
20
|
|
331
|
+
21
|
|
332
|
+
22</pre>
|
|
333
|
+
</td>
|
|
334
|
+
<td>
|
|
335
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/comment_tag.rb', line 19</span>
|
|
336
|
+
|
|
337
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_format_tag'>format_tag</span><span class='lparen'>(</span><span class='id identifier rubyid_yard_object'>yard_object</span><span class='comma'>,</span> <span class='id identifier rubyid__tag'>_tag</span><span class='rparen'>)</span>
|
|
338
|
+
<span class='id identifier rubyid_comment'>comment</span> <span class='op'>=</span> <span class='id identifier rubyid_format_docstring_as_comment'>format_docstring_as_comment</span><span class='lparen'>(</span><span class='id identifier rubyid_yard_object'>yard_object</span><span class='rparen'>)</span>
|
|
339
|
+
<span class='const'><span class='object_link'><a href="ExampleTag.html" title="ReadmeYard::ExampleTag (class)">ExampleTag</a></span></span><span class='period'>.</span><span class='id identifier rubyid_format_ruby'><span class='object_link'><a href="ExampleTag.html#format_ruby-class_method" title="ReadmeYard::ExampleTag.format_ruby (method)">format_ruby</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_comment'>comment</span><span class='rparen'>)</span>
|
|
340
|
+
<span class='kw'>end</span></pre>
|
|
341
|
+
</td>
|
|
342
|
+
</tr>
|
|
343
|
+
</table>
|
|
344
|
+
</div>
|
|
345
|
+
|
|
346
|
+
<div class="method_details ">
|
|
347
|
+
<h3 class="signature " id="format_yard_object-class_method">
|
|
348
|
+
|
|
349
|
+
.<strong>format_yard_object</strong>(yard_object) ⇒ <tt>Object</tt>
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
</h3><table class="source_code">
|
|
356
|
+
<tr>
|
|
357
|
+
<td>
|
|
358
|
+
<pre class="lines">
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
24
|
|
362
|
+
25
|
|
363
|
+
26</pre>
|
|
364
|
+
</td>
|
|
365
|
+
<td>
|
|
366
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/comment_tag.rb', line 24</span>
|
|
367
|
+
|
|
368
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_format_yard_object'>format_yard_object</span><span class='lparen'>(</span><span class='id identifier rubyid_yard_object'>yard_object</span><span class='rparen'>)</span>
|
|
369
|
+
<span class='id identifier rubyid_format_tag'>format_tag</span><span class='lparen'>(</span><span class='id identifier rubyid_yard_object'>yard_object</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
370
|
+
<span class='kw'>end</span></pre>
|
|
371
|
+
</td>
|
|
372
|
+
</tr>
|
|
373
|
+
</table>
|
|
374
|
+
</div>
|
|
375
|
+
|
|
376
|
+
<div class="method_details ">
|
|
377
|
+
<h3 class="signature " id="named_readme_tag_regex-class_method">
|
|
378
|
+
|
|
379
|
+
.<strong>named_readme_tag_regex</strong> ⇒ <tt>Object</tt>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
</h3><table class="source_code">
|
|
386
|
+
<tr>
|
|
387
|
+
<td>
|
|
388
|
+
<pre class="lines">
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
45
|
|
392
|
+
46
|
|
393
|
+
47</pre>
|
|
394
|
+
</td>
|
|
395
|
+
<td>
|
|
396
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/comment_tag.rb', line 45</span>
|
|
397
|
+
|
|
398
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_named_readme_tag_regex'>named_readme_tag_regex</span>
|
|
399
|
+
<span class='ivar'>@named_readme_tag_regex</span> <span class='op'>||=</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(\n|^)@readme\s(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../ReadmeYard.html" title="ReadmeYard (class)">ReadmeYard</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="TagRegistry.html" title="ReadmeYard::TagRegistry (class)">TagRegistry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tag_names'><span class='object_link'><a href="TagRegistry.html#tag_names-class_method" title="ReadmeYard::TagRegistry.tag_names (method)">tag_names</a></span></span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>|</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>)\n</span><span class='regexp_end'>/</span></span>
|
|
400
|
+
<span class='kw'>end</span></pre>
|
|
401
|
+
</td>
|
|
402
|
+
</tr>
|
|
403
|
+
</table>
|
|
404
|
+
</div>
|
|
405
|
+
|
|
406
|
+
</div>
|
|
407
|
+
|
|
408
|
+
</div>
|
|
409
|
+
|
|
410
|
+
<div id="footer">
|
|
411
|
+
Generated on Mon May 5 09:48:52 2025 by
|
|
412
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
413
|
+
0.9.37 (ruby-3.4.2).
|
|
414
|
+
</div>
|
|
415
|
+
|
|
416
|
+
</div>
|
|
417
|
+
</body>
|
|
418
|
+
</html>
|
|
@@ -0,0 +1,217 @@
|
|
|
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
|
+
Exception: ReadmeYard::Error
|
|
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::Error";
|
|
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 (E)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../ReadmeYard.html" title="ReadmeYard (class)">ReadmeYard</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Error</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>Exception: ReadmeYard::Error
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">StandardError</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">StandardError</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">ReadmeYard::Error</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/readme_yard/error.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
<h2>
|
|
113
|
+
Class Method Summary
|
|
114
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
115
|
+
</h2>
|
|
116
|
+
|
|
117
|
+
<ul class="summary">
|
|
118
|
+
|
|
119
|
+
<li class="public ">
|
|
120
|
+
<span class="summary_signature">
|
|
121
|
+
|
|
122
|
+
<a href="#object_not_found-class_method" title="object_not_found (class method)">.<strong>object_not_found</strong>(object_path, tag_name) ⇒ Object </a>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
</span>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<span class="summary_desc"><div class='inline'>
|
|
137
|
+
</div></span>
|
|
138
|
+
|
|
139
|
+
</li>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
</ul>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
<div id="class_method_details" class="method_details_list">
|
|
149
|
+
<h2>Class Method Details</h2>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
<div class="method_details first">
|
|
153
|
+
<h3 class="signature first" id="object_not_found-class_method">
|
|
154
|
+
|
|
155
|
+
.<strong>object_not_found</strong>(object_path, tag_name) ⇒ <tt>Object</tt>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
</h3><div class="docstring">
|
|
162
|
+
<div class="discussion">
|
|
163
|
+
|
|
164
|
+
<div class="note todo">
|
|
165
|
+
<strong>TODO:</strong>
|
|
166
|
+
<div class='inline'><p>Look for instance method with same name if
|
|
167
|
+
class method and vise versa to give a more helpful error.
|
|
168
|
+
Look for the object path in other scopes.</p>
|
|
169
|
+
</div>
|
|
170
|
+
</div>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
</div>
|
|
176
|
+
</div>
|
|
177
|
+
<div class="tags">
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</div><table class="source_code">
|
|
181
|
+
<tr>
|
|
182
|
+
<td>
|
|
183
|
+
<pre class="lines">
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
12
|
|
187
|
+
13
|
|
188
|
+
14
|
|
189
|
+
15
|
|
190
|
+
16</pre>
|
|
191
|
+
</td>
|
|
192
|
+
<td>
|
|
193
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/error.rb', line 12</span>
|
|
194
|
+
|
|
195
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_object_not_found'>object_not_found</span><span class='lparen'>(</span><span class='id identifier rubyid_object_path'>object_path</span><span class='comma'>,</span> <span class='id identifier rubyid_tag_name'>tag_name</span><span class='rparen'>)</span>
|
|
196
|
+
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>*Readme Yard* could not find `</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_object_path'>object_path</span><span class='embexpr_end'>}</span><span class='tstring_content'>`. Perhaps</span><span class='tstring_end'>"</span></span> \
|
|
197
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> the `@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_tag_name'>tag_name</span><span class='embexpr_end'>}</span><span class='tstring_content'>` tag was moved, mispelled,</span><span class='tstring_end'>"</span></span> \
|
|
198
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> or the `.yardopts` YARD file is missing the file path.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
199
|
+
<span class='kw'>end</span></pre>
|
|
200
|
+
</td>
|
|
201
|
+
</tr>
|
|
202
|
+
</table>
|
|
203
|
+
</div>
|
|
204
|
+
|
|
205
|
+
</div>
|
|
206
|
+
|
|
207
|
+
</div>
|
|
208
|
+
|
|
209
|
+
<div id="footer">
|
|
210
|
+
Generated on Mon May 5 09:48:52 2025 by
|
|
211
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
212
|
+
0.9.37 (ruby-3.4.2).
|
|
213
|
+
</div>
|
|
214
|
+
|
|
215
|
+
</div>
|
|
216
|
+
</body>
|
|
217
|
+
</html>
|