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,504 @@
|
|
|
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::YardOptsManager
|
|
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::YardOptsManager";
|
|
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 (Y)</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">YardOptsManager</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::YardOptsManager
|
|
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::YardOptsManager</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/yard_opts_manager.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
<h2>
|
|
105
|
+
Constant Summary
|
|
106
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
107
|
+
</h2>
|
|
108
|
+
|
|
109
|
+
<dl class="constants">
|
|
110
|
+
|
|
111
|
+
<dt id="YARDOPTS_FILE-constant" class="">YARDOPTS_FILE =
|
|
112
|
+
|
|
113
|
+
</dt>
|
|
114
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>.yardopts</span><span class='tstring_end'>"</span></span></pre></dd>
|
|
115
|
+
|
|
116
|
+
</dl>
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
<h2>
|
|
127
|
+
Class Method Summary
|
|
128
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
129
|
+
</h2>
|
|
130
|
+
|
|
131
|
+
<ul class="summary">
|
|
132
|
+
|
|
133
|
+
<li class="public ">
|
|
134
|
+
<span class="summary_signature">
|
|
135
|
+
|
|
136
|
+
<a href="#build_yardopts_text_addition-class_method" title="build_yardopts_text_addition (class method)">.<strong>build_yardopts_text_addition</strong>(yardopts_text) ⇒ Object </a>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
</span>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
<span class="summary_desc"><div class='inline'>
|
|
151
|
+
</div></span>
|
|
152
|
+
|
|
153
|
+
</li>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<li class="public ">
|
|
157
|
+
<span class="summary_signature">
|
|
158
|
+
|
|
159
|
+
<a href="#create_yardopts_file-class_method" title="create_yardopts_file (class method)">.<strong>create_yardopts_file</strong> ⇒ Object </a>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
</span>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<span class="summary_desc"><div class='inline'>
|
|
174
|
+
</div></span>
|
|
175
|
+
|
|
176
|
+
</li>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
<li class="public ">
|
|
180
|
+
<span class="summary_signature">
|
|
181
|
+
|
|
182
|
+
<a href="#default_readme_plugin_opts-class_method" title="default_readme_plugin_opts (class method)">.<strong>default_readme_plugin_opts</strong>(yardopts_text) ⇒ Object </a>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
</span>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
<span class="summary_desc"><div class='inline'>
|
|
197
|
+
</div></span>
|
|
198
|
+
|
|
199
|
+
</li>
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
<li class="public ">
|
|
203
|
+
<span class="summary_signature">
|
|
204
|
+
|
|
205
|
+
<a href="#update_yardopts_file-class_method" title="update_yardopts_file (class method)">.<strong>update_yardopts_file</strong> ⇒ Object </a>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
</span>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
<span class="summary_desc"><div class='inline'>
|
|
220
|
+
</div></span>
|
|
221
|
+
|
|
222
|
+
</li>
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<li class="public ">
|
|
226
|
+
<span class="summary_signature">
|
|
227
|
+
|
|
228
|
+
<a href="#upsert_yardopts-class_method" title="upsert_yardopts (class method)">.<strong>upsert_yardopts</strong> ⇒ Object </a>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
</span>
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
<span class="summary_desc"><div class='inline'>
|
|
243
|
+
</div></span>
|
|
244
|
+
|
|
245
|
+
</li>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<li class="public ">
|
|
249
|
+
<span class="summary_signature">
|
|
250
|
+
|
|
251
|
+
<a href="#warn_about_supported_markdown-class_method" title="warn_about_supported_markdown (class method)">.<strong>warn_about_supported_markdown</strong> ⇒ Object </a>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
</span>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<span class="summary_desc"><div class='inline'>
|
|
266
|
+
</div></span>
|
|
267
|
+
|
|
268
|
+
</li>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
</ul>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
<div id="class_method_details" class="method_details_list">
|
|
277
|
+
<h2>Class Method Details</h2>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<div class="method_details first">
|
|
281
|
+
<h3 class="signature first" id="build_yardopts_text_addition-class_method">
|
|
282
|
+
|
|
283
|
+
.<strong>build_yardopts_text_addition</strong>(yardopts_text) ⇒ <tt>Object</tt>
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
</h3><table class="source_code">
|
|
290
|
+
<tr>
|
|
291
|
+
<td>
|
|
292
|
+
<pre class="lines">
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
18
|
|
296
|
+
19
|
|
297
|
+
20
|
|
298
|
+
21
|
|
299
|
+
22
|
|
300
|
+
23
|
|
301
|
+
24
|
|
302
|
+
25
|
|
303
|
+
26
|
|
304
|
+
27
|
|
305
|
+
28
|
|
306
|
+
29
|
|
307
|
+
30
|
|
308
|
+
31</pre>
|
|
309
|
+
</td>
|
|
310
|
+
<td>
|
|
311
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/yard_opts_manager.rb', line 18</span>
|
|
312
|
+
|
|
313
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_build_yardopts_text_addition'>build_yardopts_text_addition</span><span class='lparen'>(</span><span class='id identifier rubyid_yardopts_text'>yardopts_text</span><span class='rparen'>)</span>
|
|
314
|
+
<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_yardopts_text'>yardopts_text</span><span class='period'>.</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'>\s*--plugin\s+readme\W</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
|
|
315
|
+
|
|
316
|
+
<span class='id identifier rubyid_readme_plugin_opts'>readme_plugin_opts</span> <span class='op'>=</span> <span class='id identifier rubyid_default_readme_plugin_opts'>default_readme_plugin_opts</span><span class='lparen'>(</span><span class='id identifier rubyid_yardopts_text'>yardopts_text</span><span class='rparen'>)</span>
|
|
317
|
+
<span class='kw'>case</span> <span class='id identifier rubyid_yardopts_text'>yardopts_text</span>
|
|
318
|
+
<span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\s*--markup\s+markdown</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\s*-m\s+markdown</span><span class='regexp_end'>/</span></span>
|
|
319
|
+
<span class='id identifier rubyid_readme_plugin_opts'>readme_plugin_opts</span>
|
|
320
|
+
<span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\s*--markup\s</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\s*-m\s</span><span class='regexp_end'>/</span></span>
|
|
321
|
+
<span class='id identifier rubyid_warn_about_supported_markdown'>warn_about_supported_markdown</span>
|
|
322
|
+
<span class='id identifier rubyid_readme_plugin_opts'>readme_plugin_opts</span>
|
|
323
|
+
<span class='kw'>else</span>
|
|
324
|
+
<span class='id identifier rubyid_readme_plugin_opts'>readme_plugin_opts</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>--markup markdown\n</span><span class='tstring_end'>"</span></span>
|
|
325
|
+
<span class='kw'>end</span>
|
|
326
|
+
<span class='kw'>end</span></pre>
|
|
327
|
+
</td>
|
|
328
|
+
</tr>
|
|
329
|
+
</table>
|
|
330
|
+
</div>
|
|
331
|
+
|
|
332
|
+
<div class="method_details ">
|
|
333
|
+
<h3 class="signature " id="create_yardopts_file-class_method">
|
|
334
|
+
|
|
335
|
+
.<strong>create_yardopts_file</strong> ⇒ <tt>Object</tt>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
</h3><table class="source_code">
|
|
342
|
+
<tr>
|
|
343
|
+
<td>
|
|
344
|
+
<pre class="lines">
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
39
|
|
348
|
+
40
|
|
349
|
+
41</pre>
|
|
350
|
+
</td>
|
|
351
|
+
<td>
|
|
352
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/yard_opts_manager.rb', line 39</span>
|
|
353
|
+
|
|
354
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_yardopts_file'>create_yardopts_file</span>
|
|
355
|
+
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#YARDOPTS_FILE-constant" title="ReadmeYard::YardOptsManager::YARDOPTS_FILE (constant)">YARDOPTS_FILE</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>--plugin readme\n--markup markdown\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
356
|
+
<span class='kw'>end</span></pre>
|
|
357
|
+
</td>
|
|
358
|
+
</tr>
|
|
359
|
+
</table>
|
|
360
|
+
</div>
|
|
361
|
+
|
|
362
|
+
<div class="method_details ">
|
|
363
|
+
<h3 class="signature " id="default_readme_plugin_opts-class_method">
|
|
364
|
+
|
|
365
|
+
.<strong>default_readme_plugin_opts</strong>(yardopts_text) ⇒ <tt>Object</tt>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
</h3><table class="source_code">
|
|
372
|
+
<tr>
|
|
373
|
+
<td>
|
|
374
|
+
<pre class="lines">
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
33
|
|
378
|
+
34
|
|
379
|
+
35
|
|
380
|
+
36
|
|
381
|
+
37</pre>
|
|
382
|
+
</td>
|
|
383
|
+
<td>
|
|
384
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/yard_opts_manager.rb', line 33</span>
|
|
385
|
+
|
|
386
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_default_readme_plugin_opts'>default_readme_plugin_opts</span><span class='lparen'>(</span><span class='id identifier rubyid_yardopts_text'>yardopts_text</span><span class='rparen'>)</span>
|
|
387
|
+
<span class='id identifier rubyid_readme_opts'>readme_opts</span> <span class='op'>=</span> <span class='op'>+</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
388
|
+
<span class='id identifier rubyid_readme_opts'>readme_opts</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> <span class='kw'>unless</span> <span class='id identifier rubyid_yardopts_text'>yardopts_text</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><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
389
|
+
<span class='id identifier rubyid_readme_opts'>readme_opts</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>--plugin readme\n</span><span class='tstring_end'>"</span></span>
|
|
390
|
+
<span class='kw'>end</span></pre>
|
|
391
|
+
</td>
|
|
392
|
+
</tr>
|
|
393
|
+
</table>
|
|
394
|
+
</div>
|
|
395
|
+
|
|
396
|
+
<div class="method_details ">
|
|
397
|
+
<h3 class="signature " id="update_yardopts_file-class_method">
|
|
398
|
+
|
|
399
|
+
.<strong>update_yardopts_file</strong> ⇒ <tt>Object</tt>
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
</h3><table class="source_code">
|
|
406
|
+
<tr>
|
|
407
|
+
<td>
|
|
408
|
+
<pre class="lines">
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
12
|
|
412
|
+
13
|
|
413
|
+
14
|
|
414
|
+
15
|
|
415
|
+
16</pre>
|
|
416
|
+
</td>
|
|
417
|
+
<td>
|
|
418
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/yard_opts_manager.rb', line 12</span>
|
|
419
|
+
|
|
420
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_yardopts_file'>update_yardopts_file</span>
|
|
421
|
+
<span class='id identifier rubyid_text'>text</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='const'><span class='object_link'><a href="#YARDOPTS_FILE-constant" title="ReadmeYard::YardOptsManager::YARDOPTS_FILE (constant)">YARDOPTS_FILE</a></span></span><span class='rparen'>)</span>
|
|
422
|
+
<span class='id identifier rubyid_text_addition'>text_addition</span> <span class='op'>=</span> <span class='id identifier rubyid_build_yardopts_text_addition'>build_yardopts_text_addition</span><span class='lparen'>(</span><span class='id identifier rubyid_text'>text</span><span class='rparen'>)</span>
|
|
423
|
+
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#YARDOPTS_FILE-constant" title="ReadmeYard::YardOptsManager::YARDOPTS_FILE (constant)">YARDOPTS_FILE</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>a</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span> <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_text_addition'>text_addition</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='kw'>if</span> <span class='id identifier rubyid_text_addition'>text_addition</span>
|
|
424
|
+
<span class='kw'>end</span></pre>
|
|
425
|
+
</td>
|
|
426
|
+
</tr>
|
|
427
|
+
</table>
|
|
428
|
+
</div>
|
|
429
|
+
|
|
430
|
+
<div class="method_details ">
|
|
431
|
+
<h3 class="signature " id="upsert_yardopts-class_method">
|
|
432
|
+
|
|
433
|
+
.<strong>upsert_yardopts</strong> ⇒ <tt>Object</tt>
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
</h3><table class="source_code">
|
|
440
|
+
<tr>
|
|
441
|
+
<td>
|
|
442
|
+
<pre class="lines">
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
8
|
|
446
|
+
9
|
|
447
|
+
10</pre>
|
|
448
|
+
</td>
|
|
449
|
+
<td>
|
|
450
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/yard_opts_manager.rb', line 8</span>
|
|
451
|
+
|
|
452
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_upsert_yardopts'>upsert_yardopts</span>
|
|
453
|
+
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#YARDOPTS_FILE-constant" title="ReadmeYard::YardOptsManager::YARDOPTS_FILE (constant)">YARDOPTS_FILE</a></span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_update_yardopts_file'>update_yardopts_file</span> <span class='op'>:</span> <span class='id identifier rubyid_create_yardopts_file'>create_yardopts_file</span>
|
|
454
|
+
<span class='kw'>end</span></pre>
|
|
455
|
+
</td>
|
|
456
|
+
</tr>
|
|
457
|
+
</table>
|
|
458
|
+
</div>
|
|
459
|
+
|
|
460
|
+
<div class="method_details ">
|
|
461
|
+
<h3 class="signature " id="warn_about_supported_markdown-class_method">
|
|
462
|
+
|
|
463
|
+
.<strong>warn_about_supported_markdown</strong> ⇒ <tt>Object</tt>
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
</h3><table class="source_code">
|
|
470
|
+
<tr>
|
|
471
|
+
<td>
|
|
472
|
+
<pre class="lines">
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
43
|
|
476
|
+
44
|
|
477
|
+
45
|
|
478
|
+
46</pre>
|
|
479
|
+
</td>
|
|
480
|
+
<td>
|
|
481
|
+
<pre class="code"><span class="info file"># File 'lib/readme_yard/yard_opts_manager.rb', line 43</span>
|
|
482
|
+
|
|
483
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_warn_about_supported_markdown'>warn_about_supported_markdown</span>
|
|
484
|
+
<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='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>*Readme Yard* works best with markdown. </span><span class='tstring_end'>"</span></span> \
|
|
485
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Consider adding `--markup markdown` to your `.yardopts` file.</span><span class='tstring_end'>"</span></span>
|
|
486
|
+
<span class='kw'>end</span></pre>
|
|
487
|
+
</td>
|
|
488
|
+
</tr>
|
|
489
|
+
</table>
|
|
490
|
+
</div>
|
|
491
|
+
|
|
492
|
+
</div>
|
|
493
|
+
|
|
494
|
+
</div>
|
|
495
|
+
|
|
496
|
+
<div id="footer">
|
|
497
|
+
Generated on Mon May 5 09:48:52 2025 by
|
|
498
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
499
|
+
0.9.37 (ruby-3.4.2).
|
|
500
|
+
</div>
|
|
501
|
+
|
|
502
|
+
</div>
|
|
503
|
+
</body>
|
|
504
|
+
</html>
|