hookapp 2.1.1 → 2.1.2
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/bin/hook +1 -1
- data/hookapp.gemspec +1 -1
- data/html/App.html +36 -24
- data/html/GLI/Commands/Doc.html +55 -19
- data/html/GLI/Commands/MarkdownDocumentListener.html +309 -151
- data/html/GLI/Commands.html +49 -19
- data/html/GLI.html +33 -19
- data/html/Hook/Prompt.html +50 -20
- data/html/Hook/PromptFZF.html +129 -69
- data/html/Hook/PromptSTD.html +104 -52
- data/html/Hook.html +34 -19
- data/html/HookApp.html +487 -265
- data/html/Hooker.html +60 -42
- data/html/Object.html +36 -23
- data/html/README_rdoc.html +180 -75
- data/html/String.html +185 -103
- data/html/created.rid +10 -10
- data/html/css/rdoc.css +402 -358
- data/html/fonts/SourceCodePro-Bold.ttf +0 -0
- data/html/fonts/SourceCodePro-Regular.ttf +0 -0
- data/html/index.html +193 -45
- data/html/js/darkfish.js +38 -2
- data/html/js/navigation.js +8 -8
- data/html/js/navigation.js.gz +0 -0
- data/html/js/search.js +4 -4
- data/html/js/search_index.js +1 -1
- data/html/js/search_index.js.gz +0 -0
- data/html/js/searcher.js.gz +0 -0
- data/html/table_of_contents.html +52 -8
- data/lib/hook/hookapp.rb +8 -4
- data/lib/hook/version.rb +1 -1
- metadata +3 -3
|
@@ -1,11 +1,17 @@
|
|
|
1
1
|
<!DOCTYPE html>
|
|
2
2
|
|
|
3
|
-
<html>
|
|
3
|
+
<html lang="en">
|
|
4
4
|
<head>
|
|
5
5
|
<meta charset="UTF-8">
|
|
6
|
+
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
6
7
|
|
|
7
8
|
<title>class GLI::Commands::MarkdownDocumentListener - hookapp</title>
|
|
8
9
|
|
|
10
|
+
<meta name="keywords" content="ruby,class,GLI::Commands::MarkdownDocumentListener">
|
|
11
|
+
|
|
12
|
+
<meta name="description" content="class GLI::Commands::MarkdownDocumentListener: DocumentListener class for GLI documentation generator">
|
|
13
|
+
|
|
14
|
+
|
|
9
15
|
<script type="text/javascript">
|
|
10
16
|
var rdoc_rel_prefix = "../../";
|
|
11
17
|
var index_rel_prefix = "../../";
|
|
@@ -22,7 +28,12 @@
|
|
|
22
28
|
|
|
23
29
|
|
|
24
30
|
<body id="top" role="document" class="class">
|
|
25
|
-
<
|
|
31
|
+
<div id="navigation-toggle" role="button" tabindex="0" aria-label="Toggle sidebar" aria-expanded="true" aria-controls="navigation">
|
|
32
|
+
<span aria-hidden="true">☰</span>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
<nav id="navigation" role="navigation">
|
|
26
37
|
<div id="project-navigation">
|
|
27
38
|
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
28
39
|
<h2>
|
|
@@ -41,7 +52,7 @@
|
|
|
41
52
|
<div id="search-field-wrapper">
|
|
42
53
|
<input id="search-field" role="combobox" aria-label="Search"
|
|
43
54
|
aria-autocomplete="list" aria-controls="search-results"
|
|
44
|
-
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
55
|
+
type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
|
|
45
56
|
title="Type to search, Up and Down to navigate, Enter to load">
|
|
46
57
|
</div>
|
|
47
58
|
|
|
@@ -54,47 +65,81 @@
|
|
|
54
65
|
</div>
|
|
55
66
|
|
|
56
67
|
|
|
68
|
+
|
|
69
|
+
<div id="parent-class-section" class="nav-section">
|
|
70
|
+
<h3>Ancestors</h3>
|
|
71
|
+
<ul><li><a href="../../Object.html">Object</a><ul><li>BasicObject</li></ul></li></ul>
|
|
72
|
+
</div>
|
|
57
73
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
<div
|
|
62
|
-
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
<div class="nav-section">
|
|
78
|
+
<h3>Class Methods</h3>
|
|
79
|
+
<ul class="link-list" role="directory">
|
|
80
|
+
<li ><a href="#method-c-new">new</a></li>
|
|
81
|
+
</ul>
|
|
82
|
+
</div>
|
|
63
83
|
|
|
64
|
-
<p class="link"><a href="../../Object.html">Object</a>
|
|
65
|
-
</div>
|
|
66
84
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
<!-- Method Quickref -->
|
|
71
|
-
<div id="method-list-section" class="nav-section">
|
|
72
|
-
<h3>Methods</h3>
|
|
73
|
-
|
|
74
|
-
<ul class="link-list" role="directory">
|
|
75
|
-
<li ><a href="#method-c-new">::new</a>
|
|
76
|
-
<li ><a href="#method-i-beginning">#beginning</a>
|
|
77
|
-
<li ><a href="#method-i-command">#command</a>
|
|
78
|
-
<li ><a href="#method-i-commands">#commands</a>
|
|
79
|
-
<li ><a href="#method-i-default_command">#default_command</a>
|
|
80
|
-
<li ><a href="#method-i-end_command">#end_command</a>
|
|
81
|
-
<li ><a href="#method-i-end_commands">#end_commands</a>
|
|
82
|
-
<li ><a href="#method-i-end_options">#end_options</a>
|
|
83
|
-
<li ><a href="#method-i-ending">#ending</a>
|
|
84
|
-
<li ><a href="#method-i-flag">#flag</a>
|
|
85
|
-
<li ><a href="#method-i-options">#options</a>
|
|
86
|
-
<li ><a href="#method-i-program_desc">#program_desc</a>
|
|
87
|
-
<li ><a href="#method-i-program_long_desc">#program_long_desc</a>
|
|
88
|
-
<li ><a href="#method-i-switch">#switch</a>
|
|
89
|
-
<li ><a href="#method-i-version">#version</a>
|
|
90
|
-
</ul>
|
|
91
|
-
</div>
|
|
92
85
|
|
|
86
|
+
<div class="nav-section">
|
|
87
|
+
<h3>Instance Methods</h3>
|
|
88
|
+
<ul class="link-list" role="directory">
|
|
89
|
+
<li ><a href="#method-i-beginning">beginning</a></li>
|
|
90
|
+
<li ><a href="#method-i-command">command</a></li>
|
|
91
|
+
<li ><a href="#method-i-commands">commands</a></li>
|
|
92
|
+
<li ><a href="#method-i-default_command">default_command</a></li>
|
|
93
|
+
<li ><a href="#method-i-end_command">end_command</a></li>
|
|
94
|
+
<li ><a href="#method-i-end_commands">end_commands</a></li>
|
|
95
|
+
<li ><a href="#method-i-end_options">end_options</a></li>
|
|
96
|
+
<li ><a href="#method-i-ending">ending</a></li>
|
|
97
|
+
<li ><a href="#method-i-flag">flag</a></li>
|
|
98
|
+
<li ><a href="#method-i-options">options</a></li>
|
|
99
|
+
<li ><a href="#method-i-program_desc">program_desc</a></li>
|
|
100
|
+
<li ><a href="#method-i-program_long_desc">program_long_desc</a></li>
|
|
101
|
+
<li ><a href="#method-i-switch">switch</a></li>
|
|
102
|
+
<li ><a href="#method-i-version">version</a></li>
|
|
103
|
+
</ul>
|
|
93
104
|
</div>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
<footer id="validator-badges" role="contentinfo">
|
|
109
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
110
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.14.0.
|
|
111
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
112
|
+
</footer>
|
|
113
|
+
|
|
94
114
|
</nav>
|
|
95
115
|
|
|
96
116
|
<main role="main" aria-labelledby="class-GLI::Commands::MarkdownDocumentListener">
|
|
97
|
-
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<ol role="navigation" aria-label="breadcrumb" class="breadcrumb">
|
|
120
|
+
|
|
121
|
+
<li>
|
|
122
|
+
|
|
123
|
+
<a href="../../GLI.html">GLI</a><span>::</span>
|
|
124
|
+
|
|
125
|
+
</li>
|
|
126
|
+
|
|
127
|
+
<li>
|
|
128
|
+
|
|
129
|
+
<a href="../../GLI/Commands.html">Commands</a><span>::</span>
|
|
130
|
+
|
|
131
|
+
</li>
|
|
132
|
+
|
|
133
|
+
<li>
|
|
134
|
+
|
|
135
|
+
<span>MarkdownDocumentListener</span>
|
|
136
|
+
|
|
137
|
+
</li>
|
|
138
|
+
|
|
139
|
+
</ol>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
<h1 id="class-GLI::Commands::MarkdownDocumentListener" class="anchor-link class">
|
|
98
143
|
class GLI::Commands::MarkdownDocumentListener
|
|
99
144
|
</h1>
|
|
100
145
|
|
|
@@ -104,27 +149,34 @@
|
|
|
104
149
|
|
|
105
150
|
</section>
|
|
106
151
|
|
|
107
|
-
<section id="5Buntitled-5D" class="documentation-section">
|
|
152
|
+
<section id="5Buntitled-5D" class="documentation-section anchor-link">
|
|
108
153
|
|
|
109
154
|
|
|
110
155
|
|
|
111
156
|
|
|
112
157
|
|
|
113
|
-
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
158
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section anchor-link">
|
|
114
159
|
<header>
|
|
115
160
|
<h3>Public Class Methods</h3>
|
|
116
161
|
</header>
|
|
117
162
|
|
|
118
|
-
<div id="method-c-new" class="method-detail ">
|
|
119
|
-
<div class="method-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
163
|
+
<div id="method-c-new" class="method-detail anchor-link ">
|
|
164
|
+
<div class="method-header">
|
|
165
|
+
<div class="method-heading">
|
|
166
|
+
<a href="#method-c-new" title="Link to this method">
|
|
167
|
+
<span class="method-name">new</span>
|
|
168
|
+
<span class="method-args">(_global_options, _options, _arguments, app)</span>
|
|
169
|
+
</a>
|
|
170
|
+
</div>
|
|
123
171
|
</div>
|
|
124
172
|
|
|
125
|
-
|
|
126
|
-
|
|
173
|
+
<div class="method-controls">
|
|
174
|
+
<details class="method-source-toggle">
|
|
175
|
+
<summary>Source</summary>
|
|
176
|
+
</details>
|
|
177
|
+
</div>
|
|
127
178
|
|
|
179
|
+
<div class="method-description">
|
|
128
180
|
<div class="method-source-code" id="new-source">
|
|
129
181
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 9</span>
|
|
130
182
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">_global_options</span>, <span class="ruby-identifier">_options</span>, <span class="ruby-identifier">_arguments</span>, <span class="ruby-identifier">app</span>)
|
|
@@ -139,6 +191,7 @@
|
|
|
139
191
|
<span class="ruby-ivar">@parent_command</span> = []
|
|
140
192
|
<span class="ruby-keyword">end</span></pre>
|
|
141
193
|
</div>
|
|
194
|
+
|
|
142
195
|
</div>
|
|
143
196
|
|
|
144
197
|
|
|
@@ -146,41 +199,56 @@
|
|
|
146
199
|
|
|
147
200
|
</section>
|
|
148
201
|
|
|
149
|
-
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
202
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section anchor-link">
|
|
150
203
|
<header>
|
|
151
204
|
<h3>Public Instance Methods</h3>
|
|
152
205
|
</header>
|
|
153
206
|
|
|
154
|
-
<div id="method-i-beginning" class="method-detail ">
|
|
155
|
-
<div class="method-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
207
|
+
<div id="method-i-beginning" class="method-detail anchor-link ">
|
|
208
|
+
<div class="method-header">
|
|
209
|
+
<div class="method-heading">
|
|
210
|
+
<a href="#method-i-beginning" title="Link to this method">
|
|
211
|
+
<span class="method-name">beginning</span>
|
|
212
|
+
<span class="method-args">()</span>
|
|
213
|
+
</a>
|
|
214
|
+
</div>
|
|
159
215
|
</div>
|
|
160
216
|
|
|
161
|
-
|
|
162
|
-
|
|
217
|
+
<div class="method-controls">
|
|
218
|
+
<details class="method-source-toggle">
|
|
219
|
+
<summary>Source</summary>
|
|
220
|
+
</details>
|
|
221
|
+
</div>
|
|
163
222
|
|
|
223
|
+
<div class="method-description">
|
|
164
224
|
<div class="method-source-code" id="beginning-source">
|
|
165
225
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 21</span>
|
|
166
226
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">beginning</span>
|
|
167
227
|
<span class="ruby-keyword">end</span></pre>
|
|
168
228
|
</div>
|
|
229
|
+
|
|
169
230
|
</div>
|
|
170
231
|
|
|
171
232
|
|
|
172
233
|
</div>
|
|
173
234
|
|
|
174
|
-
<div id="method-i-command" class="method-detail ">
|
|
175
|
-
<div class="method-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
235
|
+
<div id="method-i-command" class="method-detail anchor-link ">
|
|
236
|
+
<div class="method-header">
|
|
237
|
+
<div class="method-heading">
|
|
238
|
+
<a href="#method-i-command" title="Link to this method">
|
|
239
|
+
<span class="method-name">command</span>
|
|
240
|
+
<span class="method-args">(name, aliases, desc, long_desc, arg_name, arg_options)</span>
|
|
241
|
+
</a>
|
|
242
|
+
</div>
|
|
179
243
|
</div>
|
|
180
244
|
|
|
181
|
-
|
|
182
|
-
|
|
245
|
+
<div class="method-controls">
|
|
246
|
+
<details class="method-source-toggle">
|
|
247
|
+
<summary>Source</summary>
|
|
248
|
+
</details>
|
|
249
|
+
</div>
|
|
183
250
|
|
|
251
|
+
<div class="method-description">
|
|
184
252
|
<div class="method-source-code" id="command-source">
|
|
185
253
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 118</span>
|
|
186
254
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">command</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">aliases</span>, <span class="ruby-identifier">desc</span>, <span class="ruby-identifier">long_desc</span>, <span class="ruby-identifier">arg_name</span>, <span class="ruby-identifier">arg_options</span>)
|
|
@@ -196,21 +264,29 @@
|
|
|
196
264
|
<span class="ruby-identifier">increment_nest</span>
|
|
197
265
|
<span class="ruby-keyword">end</span></pre>
|
|
198
266
|
</div>
|
|
267
|
+
<p>Gives you a command in the current context and creates a new context of this command</p>
|
|
199
268
|
</div>
|
|
200
269
|
|
|
201
270
|
|
|
202
271
|
</div>
|
|
203
272
|
|
|
204
|
-
<div id="method-i-commands" class="method-detail ">
|
|
205
|
-
<div class="method-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
273
|
+
<div id="method-i-commands" class="method-detail anchor-link ">
|
|
274
|
+
<div class="method-header">
|
|
275
|
+
<div class="method-heading">
|
|
276
|
+
<a href="#method-i-commands" title="Link to this method">
|
|
277
|
+
<span class="method-name">commands</span>
|
|
278
|
+
<span class="method-args">()</span>
|
|
279
|
+
</a>
|
|
280
|
+
</div>
|
|
209
281
|
</div>
|
|
210
282
|
|
|
211
|
-
|
|
212
|
-
|
|
283
|
+
<div class="method-controls">
|
|
284
|
+
<details class="method-source-toggle">
|
|
285
|
+
<summary>Source</summary>
|
|
286
|
+
</details>
|
|
287
|
+
</div>
|
|
213
288
|
|
|
289
|
+
<div class="method-description">
|
|
214
290
|
<div class="method-source-code" id="commands-source">
|
|
215
291
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 111</span>
|
|
216
292
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">commands</span>
|
|
@@ -219,42 +295,58 @@
|
|
|
219
295
|
<span class="ruby-identifier">increment_nest</span>
|
|
220
296
|
<span class="ruby-keyword">end</span></pre>
|
|
221
297
|
</div>
|
|
298
|
+
|
|
222
299
|
</div>
|
|
223
300
|
|
|
224
301
|
|
|
225
302
|
</div>
|
|
226
303
|
|
|
227
|
-
<div id="method-i-default_command" class="method-detail ">
|
|
228
|
-
<div class="method-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
304
|
+
<div id="method-i-default_command" class="method-detail anchor-link ">
|
|
305
|
+
<div class="method-header">
|
|
306
|
+
<div class="method-heading">
|
|
307
|
+
<a href="#method-i-default_command" title="Link to this method">
|
|
308
|
+
<span class="method-name">default_command</span>
|
|
309
|
+
<span class="method-args">(name)</span>
|
|
310
|
+
</a>
|
|
311
|
+
</div>
|
|
232
312
|
</div>
|
|
233
313
|
|
|
234
|
-
|
|
235
|
-
|
|
314
|
+
<div class="method-controls">
|
|
315
|
+
<details class="method-source-toggle">
|
|
316
|
+
<summary>Source</summary>
|
|
317
|
+
</details>
|
|
318
|
+
</div>
|
|
236
319
|
|
|
320
|
+
<div class="method-description">
|
|
237
321
|
<div class="method-source-code" id="default_command-source">
|
|
238
322
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 139</span>
|
|
239
323
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">default_command</span>(<span class="ruby-identifier">name</span>)
|
|
240
324
|
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"#### [Default Command] #{name}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">nil?</span>
|
|
241
325
|
<span class="ruby-keyword">end</span></pre>
|
|
242
326
|
</div>
|
|
327
|
+
<p>Gives you the name of the current command in the current context</p>
|
|
243
328
|
</div>
|
|
244
329
|
|
|
245
330
|
|
|
246
331
|
</div>
|
|
247
332
|
|
|
248
|
-
<div id="method-i-end_command" class="method-detail ">
|
|
249
|
-
<div class="method-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
333
|
+
<div id="method-i-end_command" class="method-detail anchor-link ">
|
|
334
|
+
<div class="method-header">
|
|
335
|
+
<div class="method-heading">
|
|
336
|
+
<a href="#method-i-end_command" title="Link to this method">
|
|
337
|
+
<span class="method-name">end_command</span>
|
|
338
|
+
<span class="method-args">(_name)</span>
|
|
339
|
+
</a>
|
|
340
|
+
</div>
|
|
253
341
|
</div>
|
|
254
342
|
|
|
255
|
-
|
|
256
|
-
|
|
343
|
+
<div class="method-controls">
|
|
344
|
+
<details class="method-source-toggle">
|
|
345
|
+
<summary>Source</summary>
|
|
346
|
+
</details>
|
|
347
|
+
</div>
|
|
257
348
|
|
|
349
|
+
<div class="method-description">
|
|
258
350
|
<div class="method-source-code" id="end_command-source">
|
|
259
351
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 132</span>
|
|
260
352
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_command</span>(<span class="ruby-identifier">_name</span>)
|
|
@@ -263,62 +355,86 @@
|
|
|
263
355
|
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">"* * * * * *\n\n"</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@nest</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">2</span>
|
|
264
356
|
<span class="ruby-keyword">end</span></pre>
|
|
265
357
|
</div>
|
|
358
|
+
<p>Ends a command, and “pops” you back up one context</p>
|
|
266
359
|
</div>
|
|
267
360
|
|
|
268
361
|
|
|
269
362
|
</div>
|
|
270
363
|
|
|
271
|
-
<div id="method-i-end_commands" class="method-detail ">
|
|
272
|
-
<div class="method-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
364
|
+
<div id="method-i-end_commands" class="method-detail anchor-link ">
|
|
365
|
+
<div class="method-header">
|
|
366
|
+
<div class="method-heading">
|
|
367
|
+
<a href="#method-i-end_commands" title="Link to this method">
|
|
368
|
+
<span class="method-name">end_commands</span>
|
|
369
|
+
<span class="method-args">()</span>
|
|
370
|
+
</a>
|
|
371
|
+
</div>
|
|
276
372
|
</div>
|
|
277
373
|
|
|
278
|
-
|
|
279
|
-
|
|
374
|
+
<div class="method-controls">
|
|
375
|
+
<details class="method-source-toggle">
|
|
376
|
+
<summary>Source</summary>
|
|
377
|
+
</details>
|
|
378
|
+
</div>
|
|
280
379
|
|
|
380
|
+
<div class="method-description">
|
|
281
381
|
<div class="method-source-code" id="end_commands-source">
|
|
282
382
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 143</span>
|
|
283
383
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_commands</span>
|
|
284
384
|
<span class="ruby-identifier">decrement_nest</span>
|
|
285
385
|
<span class="ruby-keyword">end</span></pre>
|
|
286
386
|
</div>
|
|
387
|
+
|
|
287
388
|
</div>
|
|
288
389
|
|
|
289
390
|
|
|
290
391
|
</div>
|
|
291
392
|
|
|
292
|
-
<div id="method-i-end_options" class="method-detail ">
|
|
293
|
-
<div class="method-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
393
|
+
<div id="method-i-end_options" class="method-detail anchor-link ">
|
|
394
|
+
<div class="method-header">
|
|
395
|
+
<div class="method-heading">
|
|
396
|
+
<a href="#method-i-end_options" title="Link to this method">
|
|
397
|
+
<span class="method-name">end_options</span>
|
|
398
|
+
<span class="method-args">()</span>
|
|
399
|
+
</a>
|
|
400
|
+
</div>
|
|
297
401
|
</div>
|
|
298
402
|
|
|
299
|
-
|
|
300
|
-
|
|
403
|
+
<div class="method-controls">
|
|
404
|
+
<details class="method-source-toggle">
|
|
405
|
+
<summary>Source</summary>
|
|
406
|
+
</details>
|
|
407
|
+
</div>
|
|
301
408
|
|
|
409
|
+
<div class="method-description">
|
|
302
410
|
<div class="method-source-code" id="end_options-source">
|
|
303
411
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 108</span>
|
|
304
412
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_options</span>
|
|
305
413
|
<span class="ruby-keyword">end</span></pre>
|
|
306
414
|
</div>
|
|
415
|
+
|
|
307
416
|
</div>
|
|
308
417
|
|
|
309
418
|
|
|
310
419
|
</div>
|
|
311
420
|
|
|
312
|
-
<div id="method-i-ending" class="method-detail ">
|
|
313
|
-
<div class="method-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
421
|
+
<div id="method-i-ending" class="method-detail anchor-link ">
|
|
422
|
+
<div class="method-header">
|
|
423
|
+
<div class="method-heading">
|
|
424
|
+
<a href="#method-i-ending" title="Link to this method">
|
|
425
|
+
<span class="method-name">ending</span>
|
|
426
|
+
<span class="method-args">()</span>
|
|
427
|
+
</a>
|
|
428
|
+
</div>
|
|
317
429
|
</div>
|
|
318
430
|
|
|
319
|
-
|
|
320
|
-
|
|
431
|
+
<div class="method-controls">
|
|
432
|
+
<details class="method-source-toggle">
|
|
433
|
+
<summary>Source</summary>
|
|
434
|
+
</details>
|
|
435
|
+
</div>
|
|
321
436
|
|
|
437
|
+
<div class="method-description">
|
|
322
438
|
<div class="method-source-code" id="ending-source">
|
|
323
439
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 25</span>
|
|
324
440
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ending</span>
|
|
@@ -342,21 +458,29 @@
|
|
|
342
458
|
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">close</span>
|
|
343
459
|
<span class="ruby-keyword">end</span></pre>
|
|
344
460
|
</div>
|
|
461
|
+
<p>Called when processing has completed</p>
|
|
345
462
|
</div>
|
|
346
463
|
|
|
347
464
|
|
|
348
465
|
</div>
|
|
349
466
|
|
|
350
|
-
<div id="method-i-flag" class="method-detail ">
|
|
351
|
-
<div class="method-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
467
|
+
<div id="method-i-flag" class="method-detail anchor-link ">
|
|
468
|
+
<div class="method-header">
|
|
469
|
+
<div class="method-heading">
|
|
470
|
+
<a href="#method-i-flag" title="Link to this method">
|
|
471
|
+
<span class="method-name">flag</span>
|
|
472
|
+
<span class="method-args">(name, aliases, desc, long_desc, default_value, arg_name, must_match, _type)</span>
|
|
473
|
+
</a>
|
|
474
|
+
</div>
|
|
355
475
|
</div>
|
|
356
476
|
|
|
357
|
-
|
|
358
|
-
|
|
477
|
+
<div class="method-controls">
|
|
478
|
+
<details class="method-source-toggle">
|
|
479
|
+
<summary>Source</summary>
|
|
480
|
+
</details>
|
|
481
|
+
</div>
|
|
359
482
|
|
|
483
|
+
<div class="method-description">
|
|
360
484
|
<div class="method-source-code" id="flag-source">
|
|
361
485
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 80</span>
|
|
362
486
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">flag</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">aliases</span>, <span class="ruby-identifier">desc</span>, <span class="ruby-identifier">long_desc</span>, <span class="ruby-identifier">default_value</span>, <span class="ruby-identifier">arg_name</span>, <span class="ruby-identifier">must_match</span>, <span class="ruby-identifier">_type</span>)
|
|
@@ -372,21 +496,29 @@
|
|
|
372
496
|
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
|
|
373
497
|
<span class="ruby-keyword">end</span></pre>
|
|
374
498
|
</div>
|
|
499
|
+
<p>Gives you a flag in the current context</p>
|
|
375
500
|
</div>
|
|
376
501
|
|
|
377
502
|
|
|
378
503
|
</div>
|
|
379
504
|
|
|
380
|
-
<div id="method-i-options" class="method-detail ">
|
|
381
|
-
<div class="method-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
505
|
+
<div id="method-i-options" class="method-detail anchor-link ">
|
|
506
|
+
<div class="method-header">
|
|
507
|
+
<div class="method-heading">
|
|
508
|
+
<a href="#method-i-options" title="Link to this method">
|
|
509
|
+
<span class="method-name">options</span>
|
|
510
|
+
<span class="method-args">()</span>
|
|
511
|
+
</a>
|
|
512
|
+
</div>
|
|
385
513
|
</div>
|
|
386
514
|
|
|
387
|
-
|
|
388
|
-
|
|
515
|
+
<div class="method-controls">
|
|
516
|
+
<details class="method-source-toggle">
|
|
517
|
+
<summary>Source</summary>
|
|
518
|
+
</details>
|
|
519
|
+
</div>
|
|
389
520
|
|
|
521
|
+
<div class="method-description">
|
|
390
522
|
<div class="method-source-code" id="options-source">
|
|
391
523
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 70</span>
|
|
392
524
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">options</span>
|
|
@@ -398,21 +530,29 @@
|
|
|
398
530
|
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
|
|
399
531
|
<span class="ruby-keyword">end</span></pre>
|
|
400
532
|
</div>
|
|
533
|
+
|
|
401
534
|
</div>
|
|
402
535
|
|
|
403
536
|
|
|
404
537
|
</div>
|
|
405
538
|
|
|
406
|
-
<div id="method-i-program_desc" class="method-detail ">
|
|
407
|
-
<div class="method-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
539
|
+
<div id="method-i-program_desc" class="method-detail anchor-link ">
|
|
540
|
+
<div class="method-header">
|
|
541
|
+
<div class="method-heading">
|
|
542
|
+
<a href="#method-i-program_desc" title="Link to this method">
|
|
543
|
+
<span class="method-name">program_desc</span>
|
|
544
|
+
<span class="method-args">(desc)</span>
|
|
545
|
+
</a>
|
|
546
|
+
</div>
|
|
411
547
|
</div>
|
|
412
548
|
|
|
413
|
-
|
|
414
|
-
|
|
549
|
+
<div class="method-controls">
|
|
550
|
+
<details class="method-source-toggle">
|
|
551
|
+
<summary>Source</summary>
|
|
552
|
+
</details>
|
|
553
|
+
</div>
|
|
415
554
|
|
|
555
|
+
<div class="method-description">
|
|
416
556
|
<div class="method-source-code" id="program_desc-source">
|
|
417
557
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 47</span>
|
|
418
558
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">program_desc</span>(<span class="ruby-identifier">desc</span>)
|
|
@@ -422,21 +562,29 @@
|
|
|
422
562
|
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
|
|
423
563
|
<span class="ruby-keyword">end</span></pre>
|
|
424
564
|
</div>
|
|
565
|
+
<p>Gives you the program description</p>
|
|
425
566
|
</div>
|
|
426
567
|
|
|
427
568
|
|
|
428
569
|
</div>
|
|
429
570
|
|
|
430
|
-
<div id="method-i-program_long_desc" class="method-detail ">
|
|
431
|
-
<div class="method-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
571
|
+
<div id="method-i-program_long_desc" class="method-detail anchor-link ">
|
|
572
|
+
<div class="method-header">
|
|
573
|
+
<div class="method-heading">
|
|
574
|
+
<a href="#method-i-program_long_desc" title="Link to this method">
|
|
575
|
+
<span class="method-name">program_long_desc</span>
|
|
576
|
+
<span class="method-args">(desc)</span>
|
|
577
|
+
</a>
|
|
578
|
+
</div>
|
|
435
579
|
</div>
|
|
436
580
|
|
|
437
|
-
|
|
438
|
-
|
|
581
|
+
<div class="method-controls">
|
|
582
|
+
<details class="method-source-toggle">
|
|
583
|
+
<summary>Source</summary>
|
|
584
|
+
</details>
|
|
585
|
+
</div>
|
|
439
586
|
|
|
587
|
+
<div class="method-description">
|
|
440
588
|
<div class="method-source-code" id="program_long_desc-source">
|
|
441
589
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 54</span>
|
|
442
590
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">program_long_desc</span>(<span class="ruby-identifier">desc</span>)
|
|
@@ -444,21 +592,29 @@
|
|
|
444
592
|
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
|
|
445
593
|
<span class="ruby-keyword">end</span></pre>
|
|
446
594
|
</div>
|
|
595
|
+
|
|
447
596
|
</div>
|
|
448
597
|
|
|
449
598
|
|
|
450
599
|
</div>
|
|
451
600
|
|
|
452
|
-
<div id="method-i-switch" class="method-detail ">
|
|
453
|
-
<div class="method-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
601
|
+
<div id="method-i-switch" class="method-detail anchor-link ">
|
|
602
|
+
<div class="method-header">
|
|
603
|
+
<div class="method-heading">
|
|
604
|
+
<a href="#method-i-switch" title="Link to this method">
|
|
605
|
+
<span class="method-name">switch</span>
|
|
606
|
+
<span class="method-args">(name, aliases, desc, long_desc, negatable)</span>
|
|
607
|
+
</a>
|
|
608
|
+
</div>
|
|
457
609
|
</div>
|
|
458
610
|
|
|
459
|
-
|
|
460
|
-
|
|
611
|
+
<div class="method-controls">
|
|
612
|
+
<details class="method-source-toggle">
|
|
613
|
+
<summary>Source</summary>
|
|
614
|
+
</details>
|
|
615
|
+
</div>
|
|
461
616
|
|
|
617
|
+
<div class="method-description">
|
|
462
618
|
<div class="method-source-code" id="switch-source">
|
|
463
619
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 94</span>
|
|
464
620
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">switch</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">aliases</span>, <span class="ruby-identifier">desc</span>, <span class="ruby-identifier">long_desc</span>, <span class="ruby-identifier">negatable</span>)
|
|
@@ -475,21 +631,29 @@
|
|
|
475
631
|
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
|
|
476
632
|
<span class="ruby-keyword">end</span></pre>
|
|
477
633
|
</div>
|
|
634
|
+
<p>Gives you a switch in the current context</p>
|
|
478
635
|
</div>
|
|
479
636
|
|
|
480
637
|
|
|
481
638
|
</div>
|
|
482
639
|
|
|
483
|
-
<div id="method-i-version" class="method-detail ">
|
|
484
|
-
<div class="method-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
640
|
+
<div id="method-i-version" class="method-detail anchor-link ">
|
|
641
|
+
<div class="method-header">
|
|
642
|
+
<div class="method-heading">
|
|
643
|
+
<a href="#method-i-version" title="Link to this method">
|
|
644
|
+
<span class="method-name">version</span>
|
|
645
|
+
<span class="method-args">(version)</span>
|
|
646
|
+
</a>
|
|
647
|
+
</div>
|
|
488
648
|
</div>
|
|
489
649
|
|
|
490
|
-
|
|
491
|
-
|
|
650
|
+
<div class="method-controls">
|
|
651
|
+
<details class="method-source-toggle">
|
|
652
|
+
<summary>Source</summary>
|
|
653
|
+
</details>
|
|
654
|
+
</div>
|
|
492
655
|
|
|
656
|
+
<div class="method-description">
|
|
493
657
|
<div class="method-source-code" id="version-source">
|
|
494
658
|
<pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 60</span>
|
|
495
659
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">version</span>(<span class="ruby-identifier">version</span>)
|
|
@@ -502,6 +666,7 @@
|
|
|
502
666
|
<span class="ruby-keyword">end</span>
|
|
503
667
|
<span class="ruby-keyword">end</span></pre>
|
|
504
668
|
</div>
|
|
669
|
+
<p>Gives you the program version</p>
|
|
505
670
|
</div>
|
|
506
671
|
|
|
507
672
|
|
|
@@ -512,10 +677,3 @@
|
|
|
512
677
|
</section>
|
|
513
678
|
</main>
|
|
514
679
|
|
|
515
|
-
|
|
516
|
-
<footer id="validator-badges" role="contentinfo">
|
|
517
|
-
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
518
|
-
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
|
|
519
|
-
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
520
|
-
</footer>
|
|
521
|
-
|