spec/integration_specs/document_alamofire/after/docs/Classes/Request.html in jazzy-0.0.16 vs spec/integration_specs/document_alamofire/after/docs/Classes/Request.html in jazzy-0.0.17

- old
+ new

@@ -22,12 +22,13 @@ <body id="reference" class="Swift"> <a name="//apple_ref/swift/Class/Request" class="dashAnchor"></a> <a title="Request Class Reference"></a> <header> <div class="content-wrapper"> - <p class="header-text"><a href="../index.html">Alamofire Docs</a> (40% documented)</p> + <p class="header-text"><a href="../index.html">Alamofire Docs</a> (83% documented)</p> <p id="header-links"><a href="https://github.com/Alamofire/Alamofire"><img id="header-icon" src="../img/gh.png" height="16px" width="16px" />View on GitHub</a></p> + <p id="header-links"><a href="dash-feed://http%3A%2F%2Fstatic%2Erealm%2Eio%2Fjazzy_demo%2FAlamofire%2Fdocsets%2FAlamofire%2Exml"><img id="header-icon" src="../img/dash.png" height="16px" width="16px" />Install in Dash</a></p> </div> </header> <section id="valence"> <div class="content-wrapper"> <p id="hierarchial_navigation"> @@ -72,29 +73,26 @@ </li> <li class="part-name tasks"> <a href="../Extensions.html">Extensions</a> <ul class="nav-chapters"> <li class="nav-chapter"> - <a href="../Extensions.html#/s:SS">String</a> + <a href="../Extensions/Manager.html">Manager</a> </li> <li class="nav-chapter"> - <a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a> + <a href="../Extensions/Manager.html">Manager</a> </li> <li class="nav-chapter"> <a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a> </li> <li class="nav-chapter"> - <a href="../Extensions/Request.html">Request</a> + <a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a> </li> <li class="nav-chapter"> - <a href="../Extensions/Manager.html">Manager</a> - </li> - <li class="nav-chapter"> <a href="../Extensions.html#/s:C9Alamofire7Request">Request</a> </li> <li class="nav-chapter"> - <a href="../Extensions/Manager.html">Manager</a> + <a href="../Extensions/Request.html">Request</a> </li> <li class="nav-chapter"> <a href="../Extensions/Request.html">Request</a> </li> <li class="nav-chapter"> @@ -110,58 +108,61 @@ <a href="../Extensions/Request.html">Request</a> </li> <li class="nav-chapter"> <a href="../Extensions/Request.html">Request</a> </li> + <li class="nav-chapter"> + <a href="../Extensions.html#/s:SS">String</a> + </li> </ul> </li> <li class="part-name tasks"> <a href="../Functions.html">Functions</a> <ul class="nav-chapters"> <li class="nav-chapter"> - <a href="../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a> + <a href="../Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a> </li> <li class="nav-chapter"> - <a href="../Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a> + <a href="../Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a> </li> <li class="nav-chapter"> - <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a> + <a href="../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a> </li> <li class="nav-chapter"> - <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a> + <a href="../Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a> </li> <li class="nav-chapter"> - <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a> + <a href="../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a> </li> <li class="nav-chapter"> <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a> </li> <li class="nav-chapter"> - <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a> + <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a> </li> <li class="nav-chapter"> - <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a> + <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a> </li> <li class="nav-chapter"> - <a href="../Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a> + <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a> </li> <li class="nav-chapter"> - <a href="../Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a> + <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a> </li> <li class="nav-chapter"> - <a href="../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a> + <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a> </li> </ul> </li> <li class="part-name tasks"> <a href="../Protocols.html">Protocols</a> <ul class="nav-chapters"> <li class="nav-chapter"> - <a href="../Protocols/URLStringConvertible.html">URLStringConvertible</a> + <a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a> </li> <li class="nav-chapter"> - <a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a> + <a href="../Protocols/URLStringConvertible.html">URLStringConvertible</a> </li> </ul> </li> </ul> </nav> @@ -183,63 +184,63 @@ </div> <ul class="task-group-list"> <li class="item symbol"> <div class="task-group-term"> <code> - <a name="/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask"> - <a name="//apple_ref/swift/Property/task" class="dashAnchor"></a> - <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask">task</a> + <a name="/s:C9Alamofire7Request10Serializer"> + <a name="//apple_ref/swift/Alias/Serializer" class="dashAnchor"></a> + <a class="x-instance-method Swift" href="#/s:C9Alamofire7Request10Serializer">Serializer</a> </code> </div> <div class="height-container"> <div class="pointy-thing-container"></div> <section class="section instance-method"> <div class="pointy-thing"></div> <div class="abstract"> - <p class="para">The underlying task.</p> + <p class="para">A closure used by response handlers that takes a request, response, and data and returns a serialized object and any error that occured in the process.</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="Swift"> <p class="aside-title">Swift</p> - <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> + <pre class="highlight"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Serializer</span> <span class="o">=</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">NSData</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span></code></pre> </div> </div> <div class="result-description view-on-github"> - <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L526">Show on GitHub</a> + <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L613">Show on GitHub</a> </div> </section> </div> </li> <li class="item symbol"> <div class="task-group-term"> <code> - <a name="/s:C9Alamofire7Request10Serializer"> - <a name="//apple_ref/swift/Alias/Serializer" class="dashAnchor"></a> - <a class="x-instance-method Swift" href="#/s:C9Alamofire7Request10Serializer">Serializer</a> + <a name="/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask"> + <a name="//apple_ref/swift/Property/task" class="dashAnchor"></a> + <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask">task</a> </code> </div> <div class="height-container"> <div class="pointy-thing-container"></div> <section class="section instance-method"> <div class="pointy-thing"></div> <div class="abstract"> - <p class="para">A closure used by response handlers that takes a request, response, and data and returns a serialized object and any error that occured in the process.</p> + <p class="para">The underlying task.</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="Swift"> <p class="aside-title">Swift</p> - <pre class="highlight"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Serializer</span> <span class="o">=</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">NSData</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span></code></pre> + <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> </div> </div> <div class="result-description view-on-github"> - <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L613">Show on GitHub</a> + <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L526">Show on GitHub</a> </div> </section> </div> </li> <li class="item symbol"> @@ -290,11 +291,11 @@ <div class="declaration"> <h4>Declaration</h4> <div class="Swift"> <p class="aside-title">Swift</p> - <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> + <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> </div> </div> <div class="result-description view-on-github"> <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L532">Show on GitHub</a> @@ -320,11 +321,11 @@ <div class="declaration"> <h4>Declaration</h4> <div class="Swift"> <p class="aside-title">Swift</p> - <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> + <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> </div> </div> <div class="result-description view-on-github"> <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L535">Show on GitHub</a> @@ -350,11 +351,11 @@ <div class="declaration"> <h4>Declaration</h4> <div class="Swift"> <p class="aside-title">Swift</p> - <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> + <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> </div> </div> <div class="result-description view-on-github"> <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L538">Show on GitHub</a> @@ -524,11 +525,11 @@ <div class="declaration"> <h4>Declaration</h4> <div class="Swift"> <p class="aside-title">Swift</p> - <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> + <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> </div> </div> <div class="parameters"> <h4>Parameters</h4> @@ -677,10 +678,10 @@ <div class="declaration"> <h4>Declaration</h4> <div class="Swift"> <p class="aside-title">Swift</p> - <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> + <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> </div> </div> <div class="parameters"> <h4>Parameters</h4>