standup_md 0.2.0 → 0.3.3

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,296 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>class StandupMD::Config::Entry - RDoc Documentation</title>
8
+
9
+ <script type="text/javascript">
10
+ var rdoc_rel_prefix = "../../";
11
+ var index_rel_prefix = "../../";
12
+ </script>
13
+
14
+ <script src="../../js/navigation.js" defer></script>
15
+ <script src="../../js/search.js" defer></script>
16
+ <script src="../../js/search_index.js" defer></script>
17
+ <script src="../../js/searcher.js" defer></script>
18
+ <script src="../../js/darkfish.js" defer></script>
19
+
20
+ <link href="../../css/fonts.css" rel="stylesheet">
21
+ <link href="../../css/rdoc.css" rel="stylesheet">
22
+
23
+
24
+
25
+
26
+ <body id="top" role="document" class="class">
27
+ <nav role="navigation">
28
+ <div id="project-navigation">
29
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
30
+ <h2>
31
+ <a href="../../index.html" rel="home">Home</a>
32
+ </h2>
33
+
34
+ <div id="table-of-contents-navigation">
35
+ <a href="../../table_of_contents.html#pages">Pages</a>
36
+ <a href="../../table_of_contents.html#classes">Classes</a>
37
+ <a href="../../table_of_contents.html#methods">Methods</a>
38
+ </div>
39
+ </div>
40
+
41
+ <div id="search-section" role="search" class="project-section initially-hidden">
42
+ <form action="#" method="get" accept-charset="utf-8">
43
+ <div id="search-field-wrapper">
44
+ <input id="search-field" role="combobox" aria-label="Search"
45
+ aria-autocomplete="list" aria-controls="search-results"
46
+ type="text" name="search" placeholder="Search" spellcheck="false"
47
+ title="Type to search, Up and Down to navigate, Enter to load">
48
+ </div>
49
+
50
+ <ul id="search-results" aria-label="Search Results"
51
+ aria-busy="false" aria-expanded="false"
52
+ aria-atomic="false" class="initially-hidden"></ul>
53
+ </form>
54
+ </div>
55
+
56
+ </div>
57
+
58
+
59
+
60
+ <div id="class-metadata">
61
+
62
+ <div id="parent-class-section" class="nav-section">
63
+ <h3>Parent</h3>
64
+
65
+
66
+ <p class="link">Object
67
+
68
+ </div>
69
+
70
+
71
+
72
+ <!-- Method Quickref -->
73
+ <div id="method-list-section" class="nav-section">
74
+ <h3>Methods</h3>
75
+
76
+ <ul class="link-list" role="directory">
77
+
78
+ <li ><a href="#method-c-new">::new</a>
79
+
80
+ <li ><a href="#method-i-reset">#reset</a>
81
+
82
+ </ul>
83
+ </div>
84
+
85
+ </div>
86
+ </nav>
87
+
88
+ <main role="main" aria-labelledby="class-StandupMD::Config::Entry">
89
+ <h1 id="class-StandupMD::Config::Entry" class="class">
90
+ class StandupMD::Config::Entry
91
+ </h1>
92
+
93
+ <section class="description">
94
+
95
+ <p>The configuration class for <a href="../Entry.html"><code>StandupMD::Entry</code></a></p>
96
+
97
+ </section>
98
+
99
+
100
+ <section id="5Buntitled-5D" class="documentation-section">
101
+
102
+
103
+
104
+
105
+
106
+ <section class="constants-list">
107
+ <header>
108
+ <h3>Constants</h3>
109
+ </header>
110
+ <dl>
111
+
112
+ <dt id="DEFAULTS">DEFAULTS
113
+
114
+ <dd><p>The default options.</p>
115
+
116
+ <p>@return [Hash]</p>
117
+
118
+
119
+ </dl>
120
+ </section>
121
+
122
+
123
+
124
+ <section class="attribute-method-details" class="method-section">
125
+ <header>
126
+ <h3>Attributes</h3>
127
+ </header>
128
+
129
+
130
+ <div id="attribute-i-current" class="method-detail">
131
+ <div class="method-heading attribute-method-heading">
132
+ <span class="method-name">current</span><span
133
+ class="attribute-access-type">[RW]</span>
134
+ </div>
135
+
136
+ <div class="method-description">
137
+
138
+ <p>Tasks for “Current” section.</p>
139
+
140
+ <p>@param [Array] current</p>
141
+
142
+ <p>@return [Array]</p>
143
+
144
+ </div>
145
+ </div>
146
+
147
+ <div id="attribute-i-impediments" class="method-detail">
148
+ <div class="method-heading attribute-method-heading">
149
+ <span class="method-name">impediments</span><span
150
+ class="attribute-access-type">[RW]</span>
151
+ </div>
152
+
153
+ <div class="method-description">
154
+
155
+ <p>Impediments for this entry.</p>
156
+
157
+ <p>@param [Array] impediments</p>
158
+
159
+ <p>@return [Array]</p>
160
+
161
+ </div>
162
+ </div>
163
+
164
+ <div id="attribute-i-notes" class="method-detail">
165
+ <div class="method-heading attribute-method-heading">
166
+ <span class="method-name">notes</span><span
167
+ class="attribute-access-type">[RW]</span>
168
+ </div>
169
+
170
+ <div class="method-description">
171
+
172
+ <p>Notes for this entry.</p>
173
+
174
+ <p>@param [Array] notes</p>
175
+
176
+ <p>@return [Array]</p>
177
+
178
+ </div>
179
+ </div>
180
+
181
+ <div id="attribute-i-previous" class="method-detail">
182
+ <div class="method-heading attribute-method-heading">
183
+ <span class="method-name">previous</span><span
184
+ class="attribute-access-type">[RW]</span>
185
+ </div>
186
+
187
+ <div class="method-description">
188
+
189
+ <p>Tasks for “Previous” section.</p>
190
+
191
+ <p>@param [Array] previous</p>
192
+
193
+ <p>@return [Array]</p>
194
+
195
+ </div>
196
+ </div>
197
+
198
+ </section>
199
+
200
+
201
+
202
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section">
203
+ <header>
204
+ <h3>Public Class Methods</h3>
205
+ </header>
206
+
207
+
208
+ <div id="method-c-new" class="method-detail ">
209
+
210
+ <div class="method-heading">
211
+ <span class="method-name">new</span><span
212
+ class="method-args">()</span>
213
+
214
+ <span class="method-click-advice">click to toggle source</span>
215
+
216
+ </div>
217
+
218
+
219
+ <div class="method-description">
220
+
221
+ <p>Initializes the config with default values.</p>
222
+
223
+
224
+
225
+
226
+ <div class="method-source-code" id="new-source">
227
+ <pre><span class="ruby-comment"># File lib/standup_md/config/entry.rb, line 55</span>
228
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
229
+ <span class="ruby-identifier">reset</span>
230
+ <span class="ruby-keyword">end</span></pre>
231
+ </div>
232
+
233
+ </div>
234
+
235
+
236
+
237
+
238
+ </div>
239
+
240
+
241
+ </section>
242
+
243
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
244
+ <header>
245
+ <h3>Public Instance Methods</h3>
246
+ </header>
247
+
248
+
249
+ <div id="method-i-reset" class="method-detail ">
250
+
251
+ <div class="method-heading">
252
+ <span class="method-name">reset</span><span
253
+ class="method-args">()</span>
254
+
255
+ <span class="method-click-advice">click to toggle source</span>
256
+
257
+ </div>
258
+
259
+
260
+ <div class="method-description">
261
+
262
+ <p>Sets all config values back to their defaults.</p>
263
+
264
+ <p>@return [Hash]</p>
265
+
266
+
267
+
268
+
269
+ <div class="method-source-code" id="reset-source">
270
+ <pre><span class="ruby-comment"># File lib/standup_md/config/entry.rb, line 63</span>
271
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
272
+ <span class="ruby-constant">DEFAULTS</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">&quot;@#{k}&quot;</span>, <span class="ruby-identifier">v</span>) }
273
+ <span class="ruby-keyword">end</span></pre>
274
+ </div>
275
+
276
+ </div>
277
+
278
+
279
+
280
+
281
+ </div>
282
+
283
+
284
+ </section>
285
+
286
+ </section>
287
+
288
+ </main>
289
+
290
+
291
+ <footer id="validator-badges" role="contentinfo">
292
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
293
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
294
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
295
+ </footer>
296
+
@@ -0,0 +1,212 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>class StandupMD::Config::EntryList - RDoc Documentation</title>
8
+
9
+ <script type="text/javascript">
10
+ var rdoc_rel_prefix = "../../";
11
+ var index_rel_prefix = "../../";
12
+ </script>
13
+
14
+ <script src="../../js/navigation.js" defer></script>
15
+ <script src="../../js/search.js" defer></script>
16
+ <script src="../../js/search_index.js" defer></script>
17
+ <script src="../../js/searcher.js" defer></script>
18
+ <script src="../../js/darkfish.js" defer></script>
19
+
20
+ <link href="../../css/fonts.css" rel="stylesheet">
21
+ <link href="../../css/rdoc.css" rel="stylesheet">
22
+
23
+
24
+
25
+
26
+ <body id="top" role="document" class="class">
27
+ <nav role="navigation">
28
+ <div id="project-navigation">
29
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
30
+ <h2>
31
+ <a href="../../index.html" rel="home">Home</a>
32
+ </h2>
33
+
34
+ <div id="table-of-contents-navigation">
35
+ <a href="../../table_of_contents.html#pages">Pages</a>
36
+ <a href="../../table_of_contents.html#classes">Classes</a>
37
+ <a href="../../table_of_contents.html#methods">Methods</a>
38
+ </div>
39
+ </div>
40
+
41
+ <div id="search-section" role="search" class="project-section initially-hidden">
42
+ <form action="#" method="get" accept-charset="utf-8">
43
+ <div id="search-field-wrapper">
44
+ <input id="search-field" role="combobox" aria-label="Search"
45
+ aria-autocomplete="list" aria-controls="search-results"
46
+ type="text" name="search" placeholder="Search" spellcheck="false"
47
+ title="Type to search, Up and Down to navigate, Enter to load">
48
+ </div>
49
+
50
+ <ul id="search-results" aria-label="Search Results"
51
+ aria-busy="false" aria-expanded="false"
52
+ aria-atomic="false" class="initially-hidden"></ul>
53
+ </form>
54
+ </div>
55
+
56
+ </div>
57
+
58
+
59
+
60
+ <div id="class-metadata">
61
+
62
+ <div id="parent-class-section" class="nav-section">
63
+ <h3>Parent</h3>
64
+
65
+
66
+ <p class="link">Object
67
+
68
+ </div>
69
+
70
+
71
+
72
+ <!-- Method Quickref -->
73
+ <div id="method-list-section" class="nav-section">
74
+ <h3>Methods</h3>
75
+
76
+ <ul class="link-list" role="directory">
77
+
78
+ <li ><a href="#method-i-initalize">#initalize</a>
79
+
80
+ <li ><a href="#method-i-reset">#reset</a>
81
+
82
+ </ul>
83
+ </div>
84
+
85
+ </div>
86
+ </nav>
87
+
88
+ <main role="main" aria-labelledby="class-StandupMD::Config::EntryList">
89
+ <h1 id="class-StandupMD::Config::EntryList" class="class">
90
+ class StandupMD::Config::EntryList
91
+ </h1>
92
+
93
+ <section class="description">
94
+
95
+ <p>The configuration class for <a href="../EntryList.html"><code>StandupMD::EntryList</code></a></p>
96
+
97
+ </section>
98
+
99
+
100
+ <section id="5Buntitled-5D" class="documentation-section">
101
+
102
+
103
+
104
+
105
+
106
+ <section class="constants-list">
107
+ <header>
108
+ <h3>Constants</h3>
109
+ </header>
110
+ <dl>
111
+
112
+ <dt id="DEFAULTS">DEFAULTS
113
+
114
+ <dd><p>The default options.</p>
115
+
116
+ <p>@return [Hash]</p>
117
+
118
+
119
+ </dl>
120
+ </section>
121
+
122
+
123
+
124
+
125
+
126
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
127
+ <header>
128
+ <h3>Public Instance Methods</h3>
129
+ </header>
130
+
131
+
132
+ <div id="method-i-initalize" class="method-detail ">
133
+
134
+ <div class="method-heading">
135
+ <span class="method-name">initalize</span><span
136
+ class="method-args">()</span>
137
+
138
+ <span class="method-click-advice">click to toggle source</span>
139
+
140
+ </div>
141
+
142
+
143
+ <div class="method-description">
144
+
145
+ <p>Initializes the config with default values.</p>
146
+
147
+
148
+
149
+
150
+ <div class="method-source-code" id="initalize-source">
151
+ <pre><span class="ruby-comment"># File lib/standup_md/config/entry_list.rb, line 18</span>
152
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initalize</span>
153
+ <span class="ruby-identifier">reset</span>
154
+ <span class="ruby-keyword">end</span></pre>
155
+ </div>
156
+
157
+ </div>
158
+
159
+
160
+
161
+
162
+ </div>
163
+
164
+
165
+ <div id="method-i-reset" class="method-detail ">
166
+
167
+ <div class="method-heading">
168
+ <span class="method-name">reset</span><span
169
+ class="method-args">()</span>
170
+
171
+ <span class="method-click-advice">click to toggle source</span>
172
+
173
+ </div>
174
+
175
+
176
+ <div class="method-description">
177
+
178
+ <p>Sets all config values back to their defaults.</p>
179
+
180
+ <p>@return [Hash]</p>
181
+
182
+
183
+
184
+
185
+ <div class="method-source-code" id="reset-source">
186
+ <pre><span class="ruby-comment"># File lib/standup_md/config/entry_list.rb, line 26</span>
187
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
188
+ <span class="ruby-constant">DEFAULTS</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">&quot;@#{k}&quot;</span>, <span class="ruby-identifier">v</span>) }
189
+ <span class="ruby-keyword">end</span></pre>
190
+ </div>
191
+
192
+ </div>
193
+
194
+
195
+
196
+
197
+ </div>
198
+
199
+
200
+ </section>
201
+
202
+ </section>
203
+
204
+ </main>
205
+
206
+
207
+ <footer id="validator-badges" role="contentinfo">
208
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
209
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
210
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
211
+ </footer>
212
+