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,281 @@
|
|
|
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::ReadmeTag
|
|
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::ReadmeTag";
|
|
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
|
+
<span class='title'><span class='object_link'><a href="../ReadmeYard.html" title="ReadmeYard (class)">ReadmeYard</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">ReadmeTag</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::ReadmeTag
|
|
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::ReadmeTag</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/readme_tag.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
<p>By default, only the text nested under a @readme tag
|
|
105
|
+
will be embedded in the final output. The default
|
|
106
|
+
embed behavior can be changed through the use of tag names.</p>
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
</div>
|
|
110
|
+
</div>
|
|
111
|
+
<div class="tags">
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<p class="tag_title">See Also:</p>
|
|
115
|
+
<ul class="see">
|
|
116
|
+
|
|
117
|
+
<li><span class='object_link'><a href="CommentTag.html" title="ReadmeYard::CommentTag (class)">CommentTag</a></span></li>
|
|
118
|
+
|
|
119
|
+
<li><span class='object_link'><a href="CodeTag.html" title="ReadmeYard::CodeTag (class)">CodeTag</a></span></li>
|
|
120
|
+
|
|
121
|
+
<li><span class='object_link'><a href="SourceTag.html" title="ReadmeYard::SourceTag (class)">SourceTag</a></span></li>
|
|
122
|
+
|
|
123
|
+
<li><span class='object_link'><a href="ValueTag.html" title="ReadmeYard::ValueTag (class)">ValueTag</a></span></li>
|
|
124
|
+
|
|
125
|
+
<li><span class='object_link'><a href="StringTag.html" title="ReadmeYard::StringTag (class)">StringTag</a></span></li>
|
|
126
|
+
|
|
127
|
+
</ul>
|
|
128
|
+
|
|
129
|
+
</div>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
<h2>
|
|
138
|
+
Class Method Summary
|
|
139
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
140
|
+
</h2>
|
|
141
|
+
|
|
142
|
+
<ul class="summary">
|
|
143
|
+
|
|
144
|
+
<li class="public ">
|
|
145
|
+
<span class="summary_signature">
|
|
146
|
+
|
|
147
|
+
<a href="#format_tag-class_method" title="format_tag (class method)">.<strong>format_tag</strong>(_yard_object, tag) ⇒ Object </a>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
</span>
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<span class="summary_desc"><div class='inline'>
|
|
162
|
+
</div></span>
|
|
163
|
+
|
|
164
|
+
</li>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<li class="public ">
|
|
168
|
+
<span class="summary_signature">
|
|
169
|
+
|
|
170
|
+
<a href="#format_tags-class_method" title="format_tags (class method)">.<strong>format_tags</strong>(yard_object, yard_tags) ⇒ Object </a>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
</span>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
<span class="summary_desc"><div class='inline'>
|
|
185
|
+
</div></span>
|
|
186
|
+
|
|
187
|
+
</li>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
</ul>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
<div id="class_method_details" class="method_details_list">
|
|
196
|
+
<h2>Class Method Details</h2>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
<div class="method_details first">
|
|
200
|
+
<h3 class="signature first" id="format_tag-class_method">
|
|
201
|
+
|
|
202
|
+
.<strong>format_tag</strong>(_yard_object, tag) ⇒ <tt>Object</tt>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
</h3><table class="source_code">
|
|
209
|
+
<tr>
|
|
210
|
+
<td>
|
|
211
|
+
<pre class="lines">
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
27
|
|
215
|
+
28
|
|
216
|
+
29</pre>
|
|
217
|
+
</td>
|
|
218
|
+
<td>
|
|
219
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/readme_tag.rb', line 27</span>
|
|
220
|
+
|
|
221
|
+
<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>
|
|
222
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_tag'>tag</span><span class='period'>.</span><span class='id identifier rubyid_text'>text</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span>
|
|
223
|
+
<span class='kw'>end</span></pre>
|
|
224
|
+
</td>
|
|
225
|
+
</tr>
|
|
226
|
+
</table>
|
|
227
|
+
</div>
|
|
228
|
+
|
|
229
|
+
<div class="method_details ">
|
|
230
|
+
<h3 class="signature " id="format_tags-class_method">
|
|
231
|
+
|
|
232
|
+
.<strong>format_tags</strong>(yard_object, yard_tags) ⇒ <tt>Object</tt>
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</h3><table class="source_code">
|
|
239
|
+
<tr>
|
|
240
|
+
<td>
|
|
241
|
+
<pre class="lines">
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
18
|
|
245
|
+
19
|
|
246
|
+
20
|
|
247
|
+
21
|
|
248
|
+
22
|
|
249
|
+
23
|
|
250
|
+
24
|
|
251
|
+
25</pre>
|
|
252
|
+
</td>
|
|
253
|
+
<td>
|
|
254
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/readme_tag.rb', line 18</span>
|
|
255
|
+
|
|
256
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_format_tags'>format_tags</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>
|
|
257
|
+
<span class='id identifier rubyid_md'>md</span> <span class='op'>=</span> <span class='op'>+</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
258
|
+
<span class='id identifier rubyid_yard_tags'>yard_tags</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_tag'>tag</span><span class='op'>|</span>
|
|
259
|
+
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='id identifier rubyid_format_yard_tag'>format_yard_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>
|
|
260
|
+
<span class='id identifier rubyid_md'>md</span> <span class='op'><<</span> <span class='id identifier rubyid_res'>res</span> <span class='kw'>if</span> <span class='id identifier rubyid_res'>res</span>
|
|
261
|
+
<span class='kw'>end</span>
|
|
262
|
+
<span class='id identifier rubyid_md'>md</span>
|
|
263
|
+
<span class='kw'>end</span></pre>
|
|
264
|
+
</td>
|
|
265
|
+
</tr>
|
|
266
|
+
</table>
|
|
267
|
+
</div>
|
|
268
|
+
|
|
269
|
+
</div>
|
|
270
|
+
|
|
271
|
+
</div>
|
|
272
|
+
|
|
273
|
+
<div id="footer">
|
|
274
|
+
Generated on Mon May 5 09:48:52 2025 by
|
|
275
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
276
|
+
0.9.37 (ruby-3.4.2).
|
|
277
|
+
</div>
|
|
278
|
+
|
|
279
|
+
</div>
|
|
280
|
+
</body>
|
|
281
|
+
</html>
|
|
@@ -0,0 +1,277 @@
|
|
|
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::SourceTag
|
|
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::SourceTag";
|
|
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 (S)</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">SourceTag</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::SourceTag
|
|
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::SourceTag</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/source_tag.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
<p>Embed Ruby comments and 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 source</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 comment and code for ReadmeYard::SourceTag#format_tag is in the README because <code>@readme source</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 comment and code for ReadmeYard::SourceTag#format_tag
|
|
202
|
+
is in the README because <code>@readme source</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
|
|
219
|
+
22
|
|
220
|
+
23</pre>
|
|
221
|
+
</td>
|
|
222
|
+
<td>
|
|
223
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/source_tag.rb', line 19</span>
|
|
224
|
+
|
|
225
|
+
<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>
|
|
226
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="CommentTag.html" title="ReadmeYard::CommentTag (class)">CommentTag</a></span></span><span class='period'>.</span><span class='id identifier rubyid_format_docstring_as_comment'><span class='object_link'><a href="CommentTag.html#format_docstring_as_comment-class_method" title="ReadmeYard::CommentTag.format_docstring_as_comment (method)">format_docstring_as_comment</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_yard_object'>yard_object</span><span class='rparen'>)</span>
|
|
227
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\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_source'>source</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
228
|
+
<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_text'>text</span><span class='rparen'>)</span>
|
|
229
|
+
<span class='kw'>end</span></pre>
|
|
230
|
+
</td>
|
|
231
|
+
</tr>
|
|
232
|
+
</table>
|
|
233
|
+
</div>
|
|
234
|
+
|
|
235
|
+
<div class="method_details ">
|
|
236
|
+
<h3 class="signature " id="format_yard_object-class_method">
|
|
237
|
+
|
|
238
|
+
.<strong>format_yard_object</strong>(yard_object) ⇒ <tt>Object</tt>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
</h3><table class="source_code">
|
|
245
|
+
<tr>
|
|
246
|
+
<td>
|
|
247
|
+
<pre class="lines">
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
25
|
|
251
|
+
26
|
|
252
|
+
27</pre>
|
|
253
|
+
</td>
|
|
254
|
+
<td>
|
|
255
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/source_tag.rb', line 25</span>
|
|
256
|
+
|
|
257
|
+
<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>
|
|
258
|
+
<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>
|
|
259
|
+
<span class='kw'>end</span></pre>
|
|
260
|
+
</td>
|
|
261
|
+
</tr>
|
|
262
|
+
</table>
|
|
263
|
+
</div>
|
|
264
|
+
|
|
265
|
+
</div>
|
|
266
|
+
|
|
267
|
+
</div>
|
|
268
|
+
|
|
269
|
+
<div id="footer">
|
|
270
|
+
Generated on Mon May 5 09:48:52 2025 by
|
|
271
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
272
|
+
0.9.37 (ruby-3.4.2).
|
|
273
|
+
</div>
|
|
274
|
+
|
|
275
|
+
</div>
|
|
276
|
+
</body>
|
|
277
|
+
</html>
|