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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: '0368a7e25427d9424b42730fcafc891842b799a7dbf5bace1045b5e5be5d5249'
|
|
4
|
+
data.tar.gz: 666018d5b0fa0922c60b39a6146de0becfa7ba786fe58d9806eb9afcbacb8a01
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bfdf64d212db54ad7eff6af8c862915e05aacdf66117dff16378bdaae989685dbe9342f8f9d9b5ee26b67fed6e198e34a8618548d3dbc9b175cbc5732c5b9e4e
|
|
7
|
+
data.tar.gz: 4f25eac729b4a0b843fef0902c4f13a8116e9116ba77642c99f6b7025f87e4e965fe4b40d5fc6f1e8d8ea58cd93c0e80294f8fd616bf93be1570e9c36d671bcf
|
data/CHANGELOG.md
CHANGED
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -19,14 +19,12 @@ If you're reading the README, that means this text is here
|
|
|
19
19
|
because the custom `{@readme ReadmeYard}` markdown tag is in
|
|
20
20
|
README_YARD.md and `readme build` was run at the command line.
|
|
21
21
|
|
|
22
|
-
Here's the [full documentation](https://rubydoc.info/github/mattruzicka/readme_yard).
|
|
23
|
-
|
|
24
22
|
|
|
25
23
|
---
|
|
26
24
|
|
|
27
25
|
⚠️ **Generated file warning** – Edit README_YARD.md, not README.md. Changes to README.md will be lost when running `readme build`.
|
|
28
26
|
|
|
29
|
-
|
|
27
|
+
**Future Work**
|
|
30
28
|
- Implement safeguards to prevent accidental edits to README.md
|
|
31
29
|
- Support bidirectional editing through git integration
|
|
32
30
|
|
|
@@ -43,6 +41,7 @@ Here's the [full documentation](https://rubydoc.info/github/mattruzicka/readme_y
|
|
|
43
41
|
- [Standalone Tag Usage](#standalone-tag-usage)
|
|
44
42
|
- [Example Tag](#example-tag)
|
|
45
43
|
- [Contributing](#contributing)
|
|
44
|
+
- [Documentation](https://mattruzicka.github.io/readme_yard/)
|
|
46
45
|
|
|
47
46
|
---
|
|
48
47
|
|
|
@@ -293,6 +292,6 @@ ReadmeYard::ExampleTag.hello_world #=> "Hello 🌎 🌍 🌏"
|
|
|
293
292
|
|
|
294
293
|
## Contributing
|
|
295
294
|
|
|
296
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/mattruzicka/
|
|
295
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/mattruzicka/readme_yard.
|
|
297
296
|
|
|
298
297
|
Thanks for reading me, the README that documents how to document the README with code that documents itself 🤯
|
data/README_YARD.md
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
|
|
10
10
|
⚠️ **Generated file warning** – Edit README_YARD.md, not README.md. Changes to README.md will be lost when running `readme build`.
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
**Future Work**
|
|
13
13
|
- Implement safeguards to prevent accidental edits to README.md
|
|
14
14
|
- Support bidirectional editing through git integration
|
|
15
15
|
|
|
@@ -26,6 +26,7 @@
|
|
|
26
26
|
- [Standalone Tag Usage](#standalone-tag-usage)
|
|
27
27
|
- [Example Tag](#example-tag)
|
|
28
28
|
- [Contributing](#contributing)
|
|
29
|
+
- [Documentation]({@string ReadmeYard::DOCS_URL})
|
|
29
30
|
|
|
30
31
|
---
|
|
31
32
|
|
|
@@ -189,6 +190,6 @@ The below example code is generated from `{@example ReadmeYard::ExampleTag.hello
|
|
|
189
190
|
|
|
190
191
|
## Contributing
|
|
191
192
|
|
|
192
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/mattruzicka/
|
|
193
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/mattruzicka/readme_yard.
|
|
193
194
|
|
|
194
195
|
Thanks for reading me, the README that documents how to document the README with code that documents itself 🤯
|
|
@@ -0,0 +1,273 @@
|
|
|
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::CodeTag
|
|
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::CodeTag";
|
|
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">CodeTag</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::CodeTag
|
|
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::CodeTag</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/code_tag.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
<p>Embed Ruby code</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 code</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_tag-class_method" title="format_tag (class method)">.<strong>format_tag</strong>(yard_object, _tag) ⇒ Object </a>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
</span>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
<span class="summary_desc"><div class='inline'><p>The code for this method is in the README because <code>@readme code</code> is below (in the source code).</p>
|
|
153
|
+
</div></span>
|
|
154
|
+
|
|
155
|
+
</li>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<li class="public ">
|
|
159
|
+
<span class="summary_signature">
|
|
160
|
+
|
|
161
|
+
<a href="#format_yard_object-class_method" title="format_yard_object (class method)">.<strong>format_yard_object</strong>(yard_object) ⇒ Object </a>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
</span>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<span class="summary_desc"><div class='inline'>
|
|
176
|
+
</div></span>
|
|
177
|
+
|
|
178
|
+
</li>
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
</ul>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<div id="class_method_details" class="method_details_list">
|
|
187
|
+
<h2>Class Method Details</h2>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<div class="method_details first">
|
|
191
|
+
<h3 class="signature first" id="format_tag-class_method">
|
|
192
|
+
|
|
193
|
+
.<strong>format_tag</strong>(yard_object, _tag) ⇒ <tt>Object</tt>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
</h3><div class="docstring">
|
|
200
|
+
<div class="discussion">
|
|
201
|
+
<p>The code for this method is in the README because
|
|
202
|
+
<code>@readme code</code> is below (in the source code).</p>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
</div>
|
|
206
|
+
</div>
|
|
207
|
+
<div class="tags">
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
</div><table class="source_code">
|
|
211
|
+
<tr>
|
|
212
|
+
<td>
|
|
213
|
+
<pre class="lines">
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
19
|
|
217
|
+
20
|
|
218
|
+
21</pre>
|
|
219
|
+
</td>
|
|
220
|
+
<td>
|
|
221
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/code_tag.rb', line 19</span>
|
|
222
|
+
|
|
223
|
+
<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>
|
|
224
|
+
<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_yard_object'>yard_object</span><span class='period'>.</span><span class='id identifier rubyid_source'>source</span><span class='rparen'>)</span>
|
|
225
|
+
<span class='kw'>end</span></pre>
|
|
226
|
+
</td>
|
|
227
|
+
</tr>
|
|
228
|
+
</table>
|
|
229
|
+
</div>
|
|
230
|
+
|
|
231
|
+
<div class="method_details ">
|
|
232
|
+
<h3 class="signature " id="format_yard_object-class_method">
|
|
233
|
+
|
|
234
|
+
.<strong>format_yard_object</strong>(yard_object) ⇒ <tt>Object</tt>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
</h3><table class="source_code">
|
|
241
|
+
<tr>
|
|
242
|
+
<td>
|
|
243
|
+
<pre class="lines">
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
23
|
|
247
|
+
24
|
|
248
|
+
25</pre>
|
|
249
|
+
</td>
|
|
250
|
+
<td>
|
|
251
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/code_tag.rb', line 23</span>
|
|
252
|
+
|
|
253
|
+
<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>
|
|
254
|
+
<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>
|
|
255
|
+
<span class='kw'>end</span></pre>
|
|
256
|
+
</td>
|
|
257
|
+
</tr>
|
|
258
|
+
</table>
|
|
259
|
+
</div>
|
|
260
|
+
|
|
261
|
+
</div>
|
|
262
|
+
|
|
263
|
+
</div>
|
|
264
|
+
|
|
265
|
+
<div id="footer">
|
|
266
|
+
Generated on Mon May 5 09:48:52 2025 by
|
|
267
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
268
|
+
0.9.37 (ruby-3.4.2).
|
|
269
|
+
</div>
|
|
270
|
+
|
|
271
|
+
</div>
|
|
272
|
+
</body>
|
|
273
|
+
</html>
|