Skip to content

Commit 66e9fef

Browse files
author
burak.uzunboy
committed
Documentation is added
1 parent 42e581d commit 66e9fef

29 files changed

Lines changed: 1881 additions & 204 deletions

‎docs/Classes.html‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@
5656
<li class="nav-group-task">
5757
<a href="Structs/APIConfiguration.html">APIConfiguration</a>
5858
</li>
59+
<li class="nav-group-task">
60+
<a href="Structs/APIError.html">APIError</a>
61+
</li>
62+
<li class="nav-group-task">
63+
<a href="Structs/APIResponse.html">APIResponse</a>
64+
</li>
5965
</ul>
6066
</li>
6167
</ul>

‎docs/Classes/NetworkLayer.html‎

Lines changed: 7 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@
5656
<li class="nav-group-task">
5757
<a href="../Structs/APIConfiguration.html">APIConfiguration</a>
5858
</li>
59+
<li class="nav-group-task">
60+
<a href="../Structs/APIError.html">APIError</a>
61+
</li>
62+
<li class="nav-group-task">
63+
<a href="../Structs/APIResponse.html">APIResponse</a>
64+
</li>
5965
</ul>
6066
</li>
6167
</ul>
@@ -227,99 +233,6 @@ <h4>Declaration</h4>
227233
</li>
228234
</ul>
229235
</div>
230-
<div class="task-group">
231-
<div class="task-name-container">
232-
<a name="/Public%20Methods"></a>
233-
<a name="//apple_ref/swift/Section/Public Methods" class="dashAnchor"></a>
234-
<a href="#/Public%20Methods">
235-
<h3 class="section-name">Public Methods</h3>
236-
</a>
237-
</div>
238-
<ul>
239-
<li class="item">
240-
<div>
241-
<code>
242-
<a name="/s:21iOSUsefulNetworkLayer0bC0C7execute_10completionyAA16APIConfigurationVyxG_yAC6ResultOy_xGctAA20ResponseBodyParsableCRbzlFZ"></a>
243-
<a name="//apple_ref/swift/Method/execute(_:completion:)" class="dashAnchor"></a>
244-
<a class="token" href="#/s:21iOSUsefulNetworkLayer0bC0C7execute_10completionyAA16APIConfigurationVyxG_yAC6ResultOy_xGctAA20ResponseBodyParsableCRbzlFZ">execute(_:completion:)</a>
245-
</code>
246-
</div>
247-
<div class="height-container">
248-
<div class="pointer-container"></div>
249-
<section class="section">
250-
<div class="pointer"></div>
251-
<div class="abstract">
252-
<p>Executes configured API.</p>
253-
254-
</div>
255-
<div class="declaration">
256-
<h4>Declaration</h4>
257-
<div class="language">
258-
<p class="aside-title">Swift</p>
259-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="n">execute</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Structs/APIConfiguration.html">APIConfiguration</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Classes/NetworkLayer/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span><span class="p">)</span><span class="o">-&gt;</span><span class="p">())</span> <span class="k">where</span> <span class="kt">T</span><span class="p">:</span><span class="kt"><a href="../Classes/ResponseBodyParsable.html">ResponseBodyParsable</a></span></code></pre>
260-
261-
</div>
262-
</div>
263-
<div>
264-
<h4>Parameters</h4>
265-
<table class="graybox">
266-
<tbody>
267-
<tr>
268-
<td>
269-
<code>
270-
<em>request</em>
271-
</code>
272-
</td>
273-
<td>
274-
<div>
275-
<p>All information/configurations needed to execute API</p>
276-
</div>
277-
</td>
278-
</tr>
279-
<tr>
280-
<td>
281-
<code>
282-
<em>completion</em>
283-
</code>
284-
</td>
285-
<td>
286-
<div>
287-
<p>Completion block which will be called when operation is completed</p>
288-
</div>
289-
</td>
290-
</tr>
291-
<tr>
292-
<td>
293-
<code>
294-
<em>error</em>
295-
</code>
296-
</td>
297-
<td>
298-
<div>
299-
<p>Returns reason of the error if operation fails. <code>nil</code> otherwise</p>
300-
</div>
301-
</td>
302-
</tr>
303-
<tr>
304-
<td>
305-
<code>
306-
<em>response</em>
307-
</code>
308-
</td>
309-
<td>
310-
<div>
311-
<p>Returns response with the specified type of response</p>
312-
</div>
313-
</td>
314-
</tr>
315-
</tbody>
316-
</table>
317-
</div>
318-
</section>
319-
</div>
320-
</li>
321-
</ul>
322-
</div>
323236
<div class="task-group">
324237
<ul>
325238
<li class="item">
@@ -375,7 +288,7 @@ <h4>Declaration</h4>
375288
<h4>Declaration</h4>
376289
<div class="language">
377290
<p class="aside-title">Swift</p>
378-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Cache</span> <span class="p">:</span> <span class="kt">URLCache</span></code></pre>
291+
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">Cache</span> <span class="p">:</span> <span class="kt">URLCache</span></code></pre>
379292

380293
</div>
381294
</div>

‎docs/Classes/NetworkLayer/Cache.html‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@
5656
<li class="nav-group-task">
5757
<a href="../../Structs/APIConfiguration.html">APIConfiguration</a>
5858
</li>
59+
<li class="nav-group-task">
60+
<a href="../../Structs/APIError.html">APIError</a>
61+
</li>
62+
<li class="nav-group-task">
63+
<a href="../../Structs/APIResponse.html">APIResponse</a>
64+
</li>
5965
</ul>
6066
</li>
6167
</ul>
@@ -66,7 +72,7 @@
6672
<h1>Cache</h1>
6773
<div class="declaration">
6874
<div class="language">
69-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Cache</span> <span class="p">:</span> <span class="kt">URLCache</span></code></pre>
75+
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">Cache</span> <span class="p">:</span> <span class="kt">URLCache</span></code></pre>
7076

7177
</div>
7278
</div>

‎docs/Classes/NetworkLayer/CachingTime.html‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@
5656
<li class="nav-group-task">
5757
<a href="../../Structs/APIConfiguration.html">APIConfiguration</a>
5858
</li>
59+
<li class="nav-group-task">
60+
<a href="../../Structs/APIError.html">APIError</a>
61+
</li>
62+
<li class="nav-group-task">
63+
<a href="../../Structs/APIResponse.html">APIResponse</a>
64+
</li>
5965
</ul>
6066
</li>
6167
</ul>

‎docs/Classes/NetworkLayer/RequestType.html‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@
5656
<li class="nav-group-task">
5757
<a href="../../Structs/APIConfiguration.html">APIConfiguration</a>
5858
</li>
59+
<li class="nav-group-task">
60+
<a href="../../Structs/APIError.html">APIError</a>
61+
</li>
62+
<li class="nav-group-task">
63+
<a href="../../Structs/APIResponse.html">APIResponse</a>
64+
</li>
5965
</ul>
6066
</li>
6167
</ul>

‎docs/Classes/NetworkLayer/Result.html‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@
5656
<li class="nav-group-task">
5757
<a href="../../Structs/APIConfiguration.html">APIConfiguration</a>
5858
</li>
59+
<li class="nav-group-task">
60+
<a href="../../Structs/APIError.html">APIError</a>
61+
</li>
62+
<li class="nav-group-task">
63+
<a href="../../Structs/APIResponse.html">APIResponse</a>
64+
</li>
5965
</ul>
6066
</li>
6167
</ul>
@@ -81,9 +87,9 @@ <h1>Result</h1>
8187
<li class="item">
8288
<div>
8389
<code>
84-
<a name="/s:21iOSUsefulNetworkLayer0bC0C6ResultO7successyAEy_xGxcAGmAA20ResponseBodyParsableCRbzlF"></a>
90+
<a name="/s:21iOSUsefulNetworkLayer0bC0C6ResultO7successyAEy_xGAA11APIResponseVyxGcAGmAA20ResponseBodyParsableCRbzlF"></a>
8591
<a name="//apple_ref/swift/Element/success(_:)" class="dashAnchor"></a>
86-
<a class="token" href="#/s:21iOSUsefulNetworkLayer0bC0C6ResultO7successyAEy_xGxcAGmAA20ResponseBodyParsableCRbzlF">success(_:)</a>
92+
<a class="token" href="#/s:21iOSUsefulNetworkLayer0bC0C6ResultO7successyAEy_xGAA11APIResponseVyxGcAGmAA20ResponseBodyParsableCRbzlF">success(_:)</a>
8793
</code>
8894
</div>
8995
<div class="height-container">
@@ -98,7 +104,7 @@ <h1>Result</h1>
98104
<h4>Declaration</h4>
99105
<div class="language">
100106
<p class="aside-title">Swift</p>
101-
<pre class="highlight swift"><code><span class="k">case</span> <span class="nf">success</span><span class="p">(</span><span class="kt">T</span><span class="p">)</span></code></pre>
107+
<pre class="highlight swift"><code><span class="k">case</span> <span class="nf">success</span><span class="p">(</span><span class="kt"><a href="../../Structs/APIResponse.html">APIResponse</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span><span class="p">)</span></code></pre>
102108

103109
</div>
104110
</div>
@@ -108,9 +114,9 @@ <h4>Declaration</h4>
108114
<li class="item">
109115
<div>
110116
<code>
111-
<a name="/s:21iOSUsefulNetworkLayer0bC0C6ResultO5erroryAEy_xGSo7NSErrorCcAGmAA20ResponseBodyParsableCRbzlF"></a>
117+
<a name="/s:21iOSUsefulNetworkLayer0bC0C6ResultO5erroryAEy_xGAA8APIErrorVyxGcAGmAA20ResponseBodyParsableCRbzlF"></a>
112118
<a name="//apple_ref/swift/Element/error(_:)" class="dashAnchor"></a>
113-
<a class="token" href="#/s:21iOSUsefulNetworkLayer0bC0C6ResultO5erroryAEy_xGSo7NSErrorCcAGmAA20ResponseBodyParsableCRbzlF">error(_:)</a>
119+
<a class="token" href="#/s:21iOSUsefulNetworkLayer0bC0C6ResultO5erroryAEy_xGAA8APIErrorVyxGcAGmAA20ResponseBodyParsableCRbzlF">error(_:)</a>
114120
</code>
115121
</div>
116122
<div class="height-container">
@@ -125,7 +131,7 @@ <h4>Declaration</h4>
125131
<h4>Declaration</h4>
126132
<div class="language">
127133
<p class="aside-title">Swift</p>
128-
<pre class="highlight swift"><code><span class="k">case</span> <span class="nf">error</span><span class="p">(</span><span class="kt">NSError</span><span class="p">)</span></code></pre>
134+
<pre class="highlight swift"><code><span class="k">case</span> <span class="nf">error</span><span class="p">(</span><span class="kt"><a href="../../Structs/APIError.html">APIError</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span><span class="p">)</span></code></pre>
129135

130136
</div>
131137
</div>

‎docs/Classes/ResponseBodyParsable.html‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@
5656
<li class="nav-group-task">
5757
<a href="../Structs/APIConfiguration.html">APIConfiguration</a>
5858
</li>
59+
<li class="nav-group-task">
60+
<a href="../Structs/APIError.html">APIError</a>
61+
</li>
62+
<li class="nav-group-task">
63+
<a href="../Structs/APIResponse.html">APIResponse</a>
64+
</li>
5965
</ul>
6066
</li>
6167
</ul>

‎docs/Structs.html‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@
5656
<li class="nav-group-task">
5757
<a href="Structs/APIConfiguration.html">APIConfiguration</a>
5858
</li>
59+
<li class="nav-group-task">
60+
<a href="Structs/APIError.html">APIError</a>
61+
</li>
62+
<li class="nav-group-task">
63+
<a href="Structs/APIResponse.html">APIResponse</a>
64+
</li>
5965
</ul>
6066
</li>
6167
</ul>
@@ -98,6 +104,62 @@ <h4>Declaration</h4>
98104
</section>
99105
</div>
100106
</li>
107+
<li class="item">
108+
<div>
109+
<code>
110+
<a name="/s:21iOSUsefulNetworkLayer11APIResponseV"></a>
111+
<a name="//apple_ref/swift/Struct/APIResponse" class="dashAnchor"></a>
112+
<a class="token" href="#/s:21iOSUsefulNetworkLayer11APIResponseV">APIResponse</a>
113+
</code>
114+
</div>
115+
<div class="height-container">
116+
<div class="pointer-container"></div>
117+
<section class="section">
118+
<div class="pointer"></div>
119+
<div class="abstract">
120+
<p>Response of the API if request is completed successfully.</p>
121+
122+
<a href="Structs/APIResponse.html" class="slightly-smaller">See more</a>
123+
</div>
124+
<div class="declaration">
125+
<h4>Declaration</h4>
126+
<div class="language">
127+
<p class="aside-title">Swift</p>
128+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">APIResponse</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="Classes/ResponseBodyParsable.html">ResponseBodyParsable</a></span></code></pre>
129+
130+
</div>
131+
</div>
132+
</section>
133+
</div>
134+
</li>
135+
<li class="item">
136+
<div>
137+
<code>
138+
<a name="/s:21iOSUsefulNetworkLayer8APIErrorV"></a>
139+
<a name="//apple_ref/swift/Struct/APIError" class="dashAnchor"></a>
140+
<a class="token" href="#/s:21iOSUsefulNetworkLayer8APIErrorV">APIError</a>
141+
</code>
142+
</div>
143+
<div class="height-container">
144+
<div class="pointer-container"></div>
145+
<section class="section">
146+
<div class="pointer"></div>
147+
<div class="abstract">
148+
<p>Error result if the API request fails.</p>
149+
150+
<a href="Structs/APIError.html" class="slightly-smaller">See more</a>
151+
</div>
152+
<div class="declaration">
153+
<h4>Declaration</h4>
154+
<div class="language">
155+
<p class="aside-title">Swift</p>
156+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">APIError</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="Classes/ResponseBodyParsable.html">ResponseBodyParsable</a></span></code></pre>
157+
158+
</div>
159+
</div>
160+
</section>
161+
</div>
162+
</li>
101163
</ul>
102164
</div>
103165
</section>

0 commit comments

Comments
 (0)