Skip to content

Commit 28f32be

Browse files
SD10SD10
committed
Update docs for Moya 11.0
1 parent 45d8830 commit 28f32be

File tree

79 files changed

+2652
-683
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+2652
-683
lines changed

‎Classes.html

+17-4
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<a title="Classes Reference"></a>
1414
<header>
1515
<div class="content-wrapper">
16-
<p><a href="index.html">Moya Docs</a> (72% documented)</p>
16+
<p><a href="index.html">Moya Docs</a> (92% documented)</p>
1717
</div>
1818
</header>
1919
<div class="content-wrapper">
@@ -76,6 +76,9 @@
7676
<li class="nav-group-task">
7777
<a href="Enums/Task.html">Task</a>
7878
</li>
79+
<li class="nav-group-task">
80+
<a href="Enums/ValidationType.html">ValidationType</a>
81+
</li>
7982
</ul>
8083
</li>
8184
<li class="nav-group-name">
@@ -106,6 +109,9 @@
106109
<li class="nav-group-task">
107110
<a href="Protocols/Cancellable.html">Cancellable</a>
108111
</li>
112+
<li class="nav-group-task">
113+
<a href="Protocols/MoyaProviderType.html">MoyaProviderType</a>
114+
</li>
109115
<li class="nav-group-task">
110116
<a href="Protocols/PluginType.html">PluginType</a>
111117
</li>
@@ -186,14 +192,21 @@ <h1>Classes</h1>
186192
<div class="pointer"></div>
187193
<div class="abstract">
188194
<p>Class for reifying a target of the <code>Target</code> enum unto a concrete <code>Endpoint</code>.</p>
195+
<div class="aside aside-note">
196+
<p class="aside-title">Note</p>
197+
As of Moya 11.0.0 Endpoint is no longer generic.
198+
Existing code should work as is after removing the generic.
199+
See #1529 and #1524 for the discussion.
200+
201+
</div>
189202

190203
<a href="Classes/Endpoint.html" class="slightly-smaller">See more</a>
191204
</div>
192205
<div class="declaration">
193206
<h4>Declaration</h4>
194207
<div class="language">
195208
<p class="aside-title">Swift</p>
196-
<pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">Endpoint</span><span class="o">&lt;</span><span class="kt">Target</span><span class="o">&gt;</span></code></pre>
209+
<pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">Endpoint</span></code></pre>
197210

198211
</div>
199212
</div>
@@ -257,7 +270,7 @@ <h4>Declaration</h4>
257270
<h4>Declaration</h4>
258271
<div class="language">
259272
<p class="aside-title">Swift</p>
260-
<pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">MoyaProvider</span><span class="o">&lt;</span><span class="kt">Target</span><span class="p">:</span> <span class="kt"><a href="Protocols/TargetType.html">TargetType</a></span><span class="o">&gt;</span><span class="p">:</span> <span class="kt">MoyaProviderType</span></code></pre>
273+
<pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">MoyaProvider</span><span class="o">&lt;</span><span class="kt">Target</span><span class="p">:</span> <span class="kt"><a href="Protocols/TargetType.html">TargetType</a></span><span class="o">&gt;</span><span class="p">:</span> <span class="kt"><a href="Protocols/MoyaProviderType.html">MoyaProviderType</a></span></code></pre>
261274

262275
</div>
263276
</div>
@@ -397,7 +410,7 @@ <h4>Declaration</h4>
397410
</section>
398411
</section>
399412
<section id="footer">
400-
<p>&copy; 2017 <a class="link" href="https://github.com/Moya/Moya" target="_blank" rel="external">Ash Furrow</a>. All rights reserved. (Last updated: 2017-12-09)</p>
413+
<p>&copy; 2018 <a class="link" href="https://github.com/Moya/Moya" target="_blank" rel="external">Ash Furrow</a>. All rights reserved. (Last updated: 2018-02-07)</p>
401414
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
402415
</section>
403416
</article>

‎Classes/CancellableToken.html

+18-13
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="CancellableToken Class Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html">Moya Docs</a> (72% documented)</p>
17+
<p><a href="../index.html">Moya Docs</a> (92% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
@@ -77,6 +77,9 @@
7777
<li class="nav-group-task">
7878
<a href="../Enums/Task.html">Task</a>
7979
</li>
80+
<li class="nav-group-task">
81+
<a href="../Enums/ValidationType.html">ValidationType</a>
82+
</li>
8083
</ul>
8184
</li>
8285
<li class="nav-group-name">
@@ -107,6 +110,9 @@
107110
<li class="nav-group-task">
108111
<a href="../Protocols/Cancellable.html">Cancellable</a>
109112
</li>
113+
<li class="nav-group-task">
114+
<a href="../Protocols/MoyaProviderType.html">MoyaProviderType</a>
115+
</li>
110116
<li class="nav-group-task">
111117
<a href="../Protocols/PluginType.html">PluginType</a>
112118
</li>
@@ -182,18 +188,17 @@ <h1>CancellableToken</h1>
182188
<li class="item">
183189
<div>
184190
<code>
185-
<a name="/s:4Moya16CancellableTokenC11isCancelledSbv"></a>
191+
<a name="/s:4Moya11CancellableP11isCancelledSbv"></a>
186192
<a name="//apple_ref/swift/Property/isCancelled" class="dashAnchor"></a>
187-
<a class="token" href="#/s:4Moya16CancellableTokenC11isCancelledSbv">isCancelled</a>
193+
<a class="token" href="#/s:4Moya11CancellableP11isCancelledSbv">isCancelled</a>
188194
</code>
189195
</div>
190196
<div class="height-container">
191197
<div class="pointer-container"></div>
192198
<section class="section">
193199
<div class="pointer"></div>
194200
<div class="abstract">
195-
<p>Undocumented</p>
196-
201+
197202
</div>
198203
<div class="declaration">
199204
<h4>Declaration</h4>
@@ -209,18 +214,17 @@ <h4>Declaration</h4>
209214
<li class="item">
210215
<div>
211216
<code>
212-
<a name="/s:4Moya16CancellableTokenC6cancelyyF"></a>
217+
<a name="/s:4Moya11CancellableP6cancelyyF"></a>
213218
<a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
214-
<a class="token" href="#/s:4Moya16CancellableTokenC6cancelyyF">cancel()</a>
219+
<a class="token" href="#/s:4Moya11CancellableP6cancelyyF">cancel()</a>
215220
</code>
216221
</div>
217222
<div class="height-container">
218223
<div class="pointer-container"></div>
219224
<section class="section">
220225
<div class="pointer"></div>
221226
<div class="abstract">
222-
<p>Undocumented</p>
223-
227+
224228
</div>
225229
<div class="declaration">
226230
<h4>Declaration</h4>
@@ -263,17 +267,18 @@ <h4>Declaration</h4>
263267
<li class="item">
264268
<div>
265269
<code>
266-
<a name="/s:s28CustomDebugStringConvertibleP16debugDescriptionSSv"></a>
270+
<a name="/s:4Moya16CancellableTokenC16debugDescriptionSSv"></a>
267271
<a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
268-
<a class="token" href="#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSv">debugDescription</a>
272+
<a class="token" href="#/s:4Moya16CancellableTokenC16debugDescriptionSSv">debugDescription</a>
269273
</code>
270274
</div>
271275
<div class="height-container">
272276
<div class="pointer-container"></div>
273277
<section class="section">
274278
<div class="pointer"></div>
275279
<div class="abstract">
276-
280+
<p>A textual representation of this instance, suitable for debugging.</p>
281+
277282
</div>
278283
<div class="declaration">
279284
<h4>Declaration</h4>
@@ -291,7 +296,7 @@ <h4>Declaration</h4>
291296
</section>
292297
</section>
293298
<section id="footer">
294-
<p>&copy; 2017 <a class="link" href="https://github.com/Moya/Moya" target="_blank" rel="external">Ash Furrow</a>. All rights reserved. (Last updated: 2017-12-09)</p>
299+
<p>&copy; 2018 <a class="link" href="https://github.com/Moya/Moya" target="_blank" rel="external">Ash Furrow</a>. All rights reserved. (Last updated: 2018-02-07)</p>
295300
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
296301
</section>
297302
</article>

‎Classes/CredentialsPlugin.html

+9-3
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="CredentialsPlugin Class Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html">Moya Docs</a> (72% documented)</p>
17+
<p><a href="../index.html">Moya Docs</a> (92% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
@@ -77,6 +77,9 @@
7777
<li class="nav-group-task">
7878
<a href="../Enums/Task.html">Task</a>
7979
</li>
80+
<li class="nav-group-task">
81+
<a href="../Enums/ValidationType.html">ValidationType</a>
82+
</li>
8083
</ul>
8184
</li>
8285
<li class="nav-group-name">
@@ -107,6 +110,9 @@
107110
<li class="nav-group-task">
108111
<a href="../Protocols/Cancellable.html">Cancellable</a>
109112
</li>
113+
<li class="nav-group-task">
114+
<a href="../Protocols/MoyaProviderType.html">MoyaProviderType</a>
115+
</li>
110116
<li class="nav-group-task">
111117
<a href="../Protocols/PluginType.html">PluginType</a>
112118
</li>
@@ -192,7 +198,7 @@ <h1>CredentialsPlugin</h1>
192198
<section class="section">
193199
<div class="pointer"></div>
194200
<div class="abstract">
195-
<p>Undocumented</p>
201+
<p>Initializes a CredentialsPlugin.</p>
196202

197203
</div>
198204
<div class="declaration">
@@ -248,7 +254,7 @@ <h4>Declaration</h4>
248254
</section>
249255
</section>
250256
<section id="footer">
251-
<p>&copy; 2017 <a class="link" href="https://github.com/Moya/Moya" target="_blank" rel="external">Ash Furrow</a>. All rights reserved. (Last updated: 2017-12-09)</p>
257+
<p>&copy; 2018 <a class="link" href="https://github.com/Moya/Moya" target="_blank" rel="external">Ash Furrow</a>. All rights reserved. (Last updated: 2018-02-07)</p>
252258
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
253259
</section>
254260
</article>

0 commit comments

Comments
 (0)