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,286 @@
|
|
|
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::ValueTag
|
|
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::ValueTag";
|
|
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 (V)</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">ValueTag</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::ValueTag
|
|
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::ValueTag</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/value_tag.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
<p>Embed a Ruby value as a Ruby code block</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 value</span></code></pre>
|
|
116
|
+
|
|
117
|
+
</div>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
</div>
|
|
121
|
+
|
|
122
|
+
<h2>
|
|
123
|
+
Constant Summary
|
|
124
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
125
|
+
</h2>
|
|
126
|
+
|
|
127
|
+
<dl class="constants">
|
|
128
|
+
|
|
129
|
+
<dt id="EXAMPLE-constant" class="">EXAMPLE =
|
|
130
|
+
|
|
131
|
+
</dt>
|
|
132
|
+
<dd><pre class="code"><span class='lbrace'>{</span> <span class='label'>key:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>value</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
|
133
|
+
|
|
134
|
+
</dl>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
<h2>
|
|
145
|
+
Class Method Summary
|
|
146
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
147
|
+
</h2>
|
|
148
|
+
|
|
149
|
+
<ul class="summary">
|
|
150
|
+
|
|
151
|
+
<li class="public ">
|
|
152
|
+
<span class="summary_signature">
|
|
153
|
+
|
|
154
|
+
<a href="#format_tag-class_method" title="format_tag (class method)">.<strong>format_tag</strong>(yard_object, _tag) ⇒ Object </a>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
</span>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
<span class="summary_desc"><div class='inline'>
|
|
169
|
+
</div></span>
|
|
170
|
+
|
|
171
|
+
</li>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<li class="public ">
|
|
175
|
+
<span class="summary_signature">
|
|
176
|
+
|
|
177
|
+
<a href="#format_yard_object-class_method" title="format_yard_object (class method)">.<strong>format_yard_object</strong>(yard_object) ⇒ Object </a>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
</span>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
<span class="summary_desc"><div class='inline'>
|
|
192
|
+
</div></span>
|
|
193
|
+
|
|
194
|
+
</li>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
</ul>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
<div id="class_method_details" class="method_details_list">
|
|
203
|
+
<h2>Class Method Details</h2>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<div class="method_details first">
|
|
207
|
+
<h3 class="signature first" id="format_tag-class_method">
|
|
208
|
+
|
|
209
|
+
.<strong>format_tag</strong>(yard_object, _tag) ⇒ <tt>Object</tt>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
</h3><table class="source_code">
|
|
216
|
+
<tr>
|
|
217
|
+
<td>
|
|
218
|
+
<pre class="lines">
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
18
|
|
222
|
+
19
|
|
223
|
+
20
|
|
224
|
+
21
|
|
225
|
+
22
|
|
226
|
+
23
|
|
227
|
+
24</pre>
|
|
228
|
+
</td>
|
|
229
|
+
<td>
|
|
230
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/value_tag.rb', line 18</span>
|
|
231
|
+
|
|
232
|
+
<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>
|
|
233
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_yard_object'>yard_object</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:value</span><span class='rparen'>)</span>
|
|
234
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>```ruby\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_yard_object'>yard_object</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n```</span><span class='tstring_end'>"</span></span>
|
|
235
|
+
<span class='kw'>else</span>
|
|
236
|
+
<span class='const'><span class='object_link'><a href="Logger.html" title="ReadmeYard::Logger (class)">Logger</a></span></span><span class='period'>.</span><span class='id identifier rubyid_warn'><span class='object_link'><a href="Logger.html#warn-class_method" title="ReadmeYard::Logger.warn (method)">warn</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Cannot parse `@readme value`: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_yard_object'>yard_object</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'> lacks `value` method.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
237
|
+
<span class='kw'>end</span>
|
|
238
|
+
<span class='kw'>end</span></pre>
|
|
239
|
+
</td>
|
|
240
|
+
</tr>
|
|
241
|
+
</table>
|
|
242
|
+
</div>
|
|
243
|
+
|
|
244
|
+
<div class="method_details ">
|
|
245
|
+
<h3 class="signature " id="format_yard_object-class_method">
|
|
246
|
+
|
|
247
|
+
.<strong>format_yard_object</strong>(yard_object) ⇒ <tt>Object</tt>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
</h3><table class="source_code">
|
|
254
|
+
<tr>
|
|
255
|
+
<td>
|
|
256
|
+
<pre class="lines">
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
26
|
|
260
|
+
27
|
|
261
|
+
28</pre>
|
|
262
|
+
</td>
|
|
263
|
+
<td>
|
|
264
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/value_tag.rb', line 26</span>
|
|
265
|
+
|
|
266
|
+
<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>
|
|
267
|
+
<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>
|
|
268
|
+
<span class='kw'>end</span></pre>
|
|
269
|
+
</td>
|
|
270
|
+
</tr>
|
|
271
|
+
</table>
|
|
272
|
+
</div>
|
|
273
|
+
|
|
274
|
+
</div>
|
|
275
|
+
|
|
276
|
+
</div>
|
|
277
|
+
|
|
278
|
+
<div id="footer">
|
|
279
|
+
Generated on Mon May 5 09:48:52 2025 by
|
|
280
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
281
|
+
0.9.37 (ruby-3.4.2).
|
|
282
|
+
</div>
|
|
283
|
+
|
|
284
|
+
</div>
|
|
285
|
+
</body>
|
|
286
|
+
</html>
|