-
Notifications
You must be signed in to change notification settings - Fork 1
/
ConfigParser.html
292 lines (292 loc) · 6.71 KB
/
ConfigParser.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>Runtime-onfiguration Documentation</title>
<link rel='stylesheet' href='../assets/codo.css' type='text/css'>
<script src='../assets/codo.js'></script>
<script src='../assets/search_data.js'></script>
</head>
<body>
<div id='base' data-path='../'></div>
<div id='header'>
<div id='menu'>
<a href='../README.md.html' title='rc'>rc</a>
»
<a href='../class_index.html' title='Index'>Index</a>
»
<span class='title'>ConfigParser</span>
<nav>
<ul>
<li class='noframes'>
(<a class='noframes' href='#'>no frames</a>)
</li>
</ul>
</nav>
<div id='search'>
<a id='class_list_link' href='../class_list.html'>Classes</a>
<a id='file_list_link' href='../file_list.html'>Files</a>
<a id='method_list_link' href='../method_list.html'>Methods</a>
<a id='extra_list_link' href='../extra_list.html'>Extras</a>
</div>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>Ctrl-T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
In frame mode you can toggle the list naviation frame on the left side:
</p>
<ul>
<li>
<span>Ctrl-L</span>
Toggle list view
</li>
</ul>
<p>
You can focus a list in frame mode or toggle a tab in frameless mode:
</p>
<ul>
<li>
<span>Ctrl-C</span>
Class list
</li>
<li>
<span>Ctrl-I</span>
Mixin list
</li>
<li>
<span>Ctrl-F</span>
File list
</li>
<li>
<span>Ctrl-M</span>
Method list
</li>
<li>
<span>Ctrl-E</span>
Extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>Ctrl-S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
<p>
In frameless mode you can close the list tab:
</p>
<ul>
<li>
<span>Esc</span>
Close list tab
</li>
</ul>
</div>
</div>
<div id='content'>
<h1>
Class:
ConfigParser
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>lib/config-parser.coffee</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<p>Configuration class</p>
</div>
<div class='tags'>
</div>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#constructor-instance'>
- (void) <strong>constructor</strong>(path)
</a>
</span>
<span class='constructor note title'>Constructor</span>
<span class='desc'>
Construct a ConfigParser.
</span>
</li>
<li>
<span class='signature'>
<a href='#pick-instance'>
- (ConfigParser) <strong>pick</strong>(callback = function() {})
</a>
</span>
<span class='desc'>
Pick config format.
</span>
</li>
<li>
<span class='signature'>
<a href='#parse-instance'>
- (ConfigParser) <strong>parse</strong>(format)
</a>
</span>
<span class='desc'>
Parse config.
</span>
</li>
<li>
<span class='signature'>
<a href='#stringify-instance'>
- (ConfigParser) <strong>stringify</strong>(format, callback)
</a>
</span>
<span class='desc'>
Stringify and save config.
</span>
</li>
</ul>
<h2>Constructor Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='constructor-instance'>
- (void) <strong>constructor</strong>(path)
</p>
<div class='docstring'>
<p>Construct a ConfigParser.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>@path</span>
<span class='type'>
(<tt>String</tt>)
</span>
—
<span class='desc'>path to file</span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='pick-instance'>
- (ConfigParser) <strong>pick</strong>(callback = function() {})
</p>
<div class='docstring'>
<p>Pick config format.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>callback</span>
<span class='type'>
(<tt>Function</tt>)
</span>
</li>
</ul>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span><tt><a href='../classes/ConfigParser.html'>ConfigParser</a></tt></li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='parse-instance'>
- (ConfigParser) <strong>parse</strong>(format)
</p>
<div class='docstring'>
<p>Parse config.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>format</span>
<span class='type'>
(<tt>String</tt>)
</span>
—
<span class='desc'>config format</span>
</li>
</ul>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span><tt><a href='../classes/ConfigParser.html'>ConfigParser</a></tt></li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='stringify-instance'>
- (ConfigParser) <strong>stringify</strong>(format, callback)
</p>
<div class='docstring'>
<p>Stringify and save config.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>format</span>
<span class='type'>
(<tt>String</tt>)
</span>
—
<span class='desc'>config format</span>
</li>
<li>
<span class='name'>callback</span>
<span class='type'>
(<tt>Function</tt>)
</span>
</li>
</ul>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span><tt><a href='../classes/ConfigParser.html'>ConfigParser</a></tt></li>
</ul>
</div>
</div>
</div>
</div>
<div id='footer'>
Generated on
Mon Feb 04 2013 14:02:40 GMT+0400 (MSK)
by
<a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
v1.5.4
(Node.js v0.8.18).
✲
Press Ctrl-h to see the keyboard shortcuts
✲
<a href='http://twitter.com/#!/netzpirat'>@netzpirat</a>
✲
<a href='https://mksoft.ch'>mksoft.ch</a>
</div>
</body>
</html>