Skip to content

Commit 91e0133

Browse files
committed
- bump sourcekitten to 0.2.1 to improve declarations
- no more <<error type>> or default - closes jpsim#65 and jpsim#112
1 parent e5b3e6a commit 91e0133

File tree

29 files changed

+182
-47
lines changed

29 files changed

+182
-47
lines changed

document_alamofire/after/docs/Classes/Manager.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ <h4>Declaration</h4>
203203

204204
<div class="Swift">
205205
<p class="aside-title">Swift</p>
206-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="k">var</span> <span class="nv">sharedInstance</span><span class="p">:</span> <span class="kt">Manager</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
206+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="k">var</span> <span class="nv">sharedInstance</span><span class="p">:</span> <span class="kt">Manager</span></code></pre>
207207

208208
</div>
209209
</div>
@@ -263,7 +263,7 @@ <h4>Declaration</h4>
263263

264264
<div class="Swift">
265265
<p class="aside-title">Swift</p>
266-
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">startRequestsImmediately</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
266+
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">startRequestsImmediately</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span></code></pre>
267267

268268
</div>
269269
</div>
@@ -293,7 +293,7 @@ <h4>Declaration</h4>
293293

294294
<div class="Swift">
295295
<p class="aside-title">Swift</p>
296-
<pre class="highlight"><code><span class="kd">required</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">configuration</span><span class="p">:</span> <span class="kt">NSURLSessionConfiguration</span><span class="p">?</span> <span class="o">=</span> <span class="k">default</span><span class="p">)</span></code></pre>
296+
<pre class="highlight"><code><span class="kd">required</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">configuration</span><span class="p">:</span> <span class="kt">NSURLSessionConfiguration</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
297297

298298
</div>
299299
</div>
@@ -351,7 +351,7 @@ <h4>Declaration</h4>
351351

352352
<div class="Swift">
353353
<p class="aside-title">Swift</p>
354-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="n">_</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?</span> <span class="o">=</span> <span class="k">default</span><span class="p">,</span> <span class="nv">encoding</span><span class="p">:</span> <span class="kt">ParameterEncoding</span> <span class="o">=</span> <span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
354+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="n">_</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">encoding</span><span class="p">:</span> <span class="kt">ParameterEncoding</span> <span class="o">=</span> <span class="o">.</span><span class="kt">URL</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
355355

356356
</div>
357357
</div>

document_alamofire/after/docs/Classes/Request.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ <h4>Declaration</h4>
233233

234234
<div class="Swift">
235235
<p class="aside-title">Swift</p>
236-
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">task</span><span class="p">:</span> <span class="kt">NSURLSessionTask</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
236+
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">task</span><span class="p">:</span> <span class="kt">NSURLSessionTask</span></code></pre>
237237

238238
</div>
239239
</div>
@@ -293,7 +293,7 @@ <h4>Declaration</h4>
293293

294294
<div class="Swift">
295295
<p class="aside-title">Swift</p>
296-
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">NSURLRequest</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
296+
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">NSURLRequest</span></code></pre>
297297

298298
</div>
299299
</div>
@@ -323,7 +323,7 @@ <h4>Declaration</h4>
323323

324324
<div class="Swift">
325325
<p class="aside-title">Swift</p>
326-
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
326+
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?</span></code></pre>
327327

328328
</div>
329329
</div>
@@ -353,7 +353,7 @@ <h4>Declaration</h4>
353353

354354
<div class="Swift">
355355
<p class="aside-title">Swift</p>
356-
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">progress</span><span class="p">:</span> <span class="kt">NSProgress</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
356+
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">progress</span><span class="p">:</span> <span class="kt">NSProgress</span><span class="p">?</span></code></pre>
357357

358358
</div>
359359
</div>
@@ -527,7 +527,7 @@ <h4>Declaration</h4>
527527

528528
<div class="Swift">
529529
<p class="aside-title">Swift</p>
530-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">progress</span><span class="p">(</span><span class="nv">closure</span><span class="p">:</span> <span class="p">((</span><span class="kt">Int64</span><span class="p">,</span> <span class="kt">Int64</span><span class="p">,</span> <span class="kt">Int64</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
530+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">progress</span><span class="p">(</span><span class="nv">closure</span><span class="p">:</span> <span class="p">((</span><span class="kt">Int64</span><span class="p">,</span> <span class="kt">Int64</span><span class="p">,</span> <span class="kt">Int64</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
531531

532532
</div>
533533
</div>
@@ -680,7 +680,7 @@ <h4>Declaration</h4>
680680

681681
<div class="Swift">
682682
<p class="aside-title">Swift</p>
683-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="n">dispatch_queue_t</span><span class="p">?</span> <span class="o">=</span> <span class="k">default</span><span class="p">,</span> <span class="nv">serializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
683+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="n">dispatch_queue_t</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">serializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
684684

685685
</div>
686686
</div>

document_alamofire/after/docs/Enums.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ <h4>Declaration</h4>
202202

203203
<div class="Swift">
204204
<p class="aside-title">Swift</p>
205-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Method</span> <span class="p">:</span> <span class="kt">String</span></code></pre>
205+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Method</span><span class="p">:</span> <span class="kt">String</span></code></pre>
206206

207207
</div>
208208
</div>

document_alamofire/after/docs/Enums/ParameterEncoding.html

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ <h4>Declaration</h4>
203203

204204
<div class="Swift">
205205
<p class="aside-title">Swift</p>
206-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">encode</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSError</span><span class="p">?)</span></code></pre>
206+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">encode</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSError</span><span class="p">?)</span></code></pre>
207207

208208
</div>
209209
</div>
@@ -263,6 +263,15 @@ <h4>Return Value</h4>
263263
<div class="abstract">
264264
<p class="para">Uses the associated closure value to construct a new request given an existing request and parameters.</p>
265265
</div>
266+
<div class="declaration">
267+
<h4>Declaration</h4>
268+
269+
<div class="Swift">
270+
<p class="aside-title">Swift</p>
271+
<pre class="highlight"><code><span class="k">case</span> <span class="kt">Custom</span><span class="p">((</span><span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSError</span><span class="p">?))</span></code></pre>
272+
273+
</div>
274+
</div>
266275
<div class="result-description view-on-github">
267276
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L67">Show on GitHub</a>
268277
</div>
@@ -284,6 +293,15 @@ <h4>Return Value</h4>
284293
<div class="abstract">
285294
<p class="para">A query string to be set as or appended to any existing URL query for <code>GET</code>, <code>HEAD</code>, and <code>DELETE</code> requests, or set as the body for requests with any other HTTP method. The <code>Content-Type</code> HTTP header field of an encoded request with HTTP body is set to <code>application/x-www-form-urlencoded</code>. Since there is no published specification for how to encode collection types, the convention of appending <code>[]</code> to the key for array values (<code>foo[]=1&amp;foo[]=2</code>), and appending the key surrounded by square brackets for nested dictionary values (<code>foo[bar]=baz</code>).</p>
286295
</div>
296+
<div class="declaration">
297+
<h4>Declaration</h4>
298+
299+
<div class="Swift">
300+
<p class="aside-title">Swift</p>
301+
<pre class="highlight"><code><span class="k">case</span> <span class="kt">URL</span></code></pre>
302+
303+
</div>
304+
</div>
287305
<div class="result-description view-on-github">
288306
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L52">Show on GitHub</a>
289307
</div>
@@ -305,6 +323,15 @@ <h4>Return Value</h4>
305323
<div class="abstract">
306324
<p class="para">Uses <code>NSJSONSerialization</code> to create a JSON representation of the parameters object, which is set as the body of the request. The <code>Content-Type</code> HTTP header field of an encoded request is set to <code>application/json</code>.</p>
307325
</div>
326+
<div class="declaration">
327+
<h4>Declaration</h4>
328+
329+
<div class="Swift">
330+
<p class="aside-title">Swift</p>
331+
<pre class="highlight"><code><span class="k">case</span> <span class="kt">JSON</span></code></pre>
332+
333+
</div>
334+
</div>
308335
<div class="result-description view-on-github">
309336
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L57">Show on GitHub</a>
310337
</div>
@@ -326,6 +353,15 @@ <h4>Return Value</h4>
326353
<div class="abstract">
327354
<p class="para">Uses <code>NSPropertyListSerialization</code> to create a plist representation of the parameters object, according to the associated format and write options values, which is set as the body of the request. The <code>Content-Type</code> HTTP header field of an encoded request is set to <code>application/x-plist</code>.</p>
328355
</div>
356+
<div class="declaration">
357+
<h4>Declaration</h4>
358+
359+
<div class="Swift">
360+
<p class="aside-title">Swift</p>
361+
<pre class="highlight"><code><span class="k">case</span> <span class="kt">PropertyList</span><span class="p">(</span><span class="kt">NSPropertyListFormat</span><span class="p">,</span> <span class="kt">NSPropertyListWriteOptions</span><span class="p">)</span></code></pre>
362+
363+
</div>
364+
</div>
329365
<div class="result-description view-on-github">
330366
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L62">Show on GitHub</a>
331367
</div>

0 commit comments

Comments
 (0)