Skip to content
This repository was archived by the owner on Apr 20, 2024. It is now read-only.

Commit 0e20d97

Browse files
committed
Jazzy docs updated
1 parent 05d19dd commit 0e20d97

File tree

124 files changed

+48536
-0
lines changed

Some content is hidden

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

124 files changed

+48536
-0
lines changed

Sugar.json

Lines changed: 10460 additions & 0 deletions
Large diffs are not rendered by default.

docs/Classes.html

Lines changed: 455 additions & 0 deletions
Large diffs are not rendered by default.

docs/Classes/CurrentURLContainer.html

Lines changed: 267 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,267 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>CurrentURLContainer Class Reference</title>
5+
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
6+
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
7+
<meta charset='utf-8'>
8+
<script src="../js/jquery.min.js" defer></script>
9+
<script src="../js/jazzy.js" defer></script>
10+
11+
</head>
12+
<body>
13+
<a name="//apple_ref/swift/Class/CurrentURLContainer" class="dashAnchor"></a>
14+
<a title="CurrentURLContainer Class Reference"></a>
15+
<header>
16+
<div class="content-wrapper">
17+
<p><a href="../index.html">Sugar Docs</a> (54% documented)</p>
18+
</div>
19+
</header>
20+
<div class="content-wrapper">
21+
<p id="breadcrumbs">
22+
<a href="../index.html">Sugar Reference</a>
23+
<img id="carat" src="../img/carat.png" />
24+
CurrentURLContainer Class Reference
25+
</p>
26+
</div>
27+
<div class="content-wrapper">
28+
<nav class="sidebar">
29+
<ul class="nav-groups">
30+
<li class="nav-group-name">
31+
<a href="../Classes.html">Classes</a>
32+
<ul class="nav-group-tasks">
33+
<li class="nav-group-task">
34+
<a href="../Classes/CurrentURLContainer.html">CurrentURLContainer</a>
35+
</li>
36+
<li class="nav-group-task">
37+
<a href="../Classes/CurrentURLProvider.html">CurrentURLProvider</a>
38+
</li>
39+
<li class="nav-group-task">
40+
<a href="../Classes/CurrentUserContainer.html">CurrentUserContainer</a>
41+
</li>
42+
<li class="nav-group-task">
43+
<a href="../Classes/CurrentUserProvider.html">CurrentUserProvider</a>
44+
</li>
45+
<li class="nav-group-task">
46+
<a href="../Classes/JWTAuthenticationMiddleware.html">JWTAuthenticationMiddleware</a>
47+
</li>
48+
<li class="nav-group-task">
49+
<a href="../Classes/NumberFormatTag.html">NumberFormatTag</a>
50+
</li>
51+
</ul>
52+
</li>
53+
<li class="nav-group-name">
54+
<a href="../Enums.html">Enumerations</a>
55+
<ul class="nav-group-tasks">
56+
<li class="nav-group-task">
57+
<a href="../Enums/AuthenticationError.html">AuthenticationError</a>
58+
</li>
59+
<li class="nav-group-task">
60+
<a href="../Enums/Either.html">Either</a>
61+
</li>
62+
</ul>
63+
</li>
64+
<li class="nav-group-name">
65+
<a href="../Extensions.html">Extensions</a>
66+
<ul class="nav-group-tasks">
67+
<li class="nav-group-task">
68+
<a href="../Extensions/Array.html">Array</a>
69+
</li>
70+
<li class="nav-group-task">
71+
<a href="../Extensions/Bool.html">Bool</a>
72+
</li>
73+
<li class="nav-group-task">
74+
<a href="../Extensions/CommandConfig.html">CommandConfig</a>
75+
</li>
76+
<li class="nav-group-task">
77+
<a href="../Extensions/Date.html">Date</a>
78+
</li>
79+
<li class="nav-group-task">
80+
<a href="../Extensions/Environment.html">Environment</a>
81+
</li>
82+
<li class="nav-group-task">
83+
<a href="../Extensions/Environment/EnvironmentError.html">– EnvironmentError</a>
84+
</li>
85+
<li class="nav-group-task">
86+
<a href="../Extensions/Future.html">Future</a>
87+
</li>
88+
<li class="nav-group-task">
89+
<a href="../Extensions/LeafTagConfig.html">LeafTagConfig</a>
90+
</li>
91+
<li class="nav-group-task">
92+
<a href="../Extensions/Model.html">Model</a>
93+
</li>
94+
<li class="nav-group-task">
95+
<a href="../Extensions/Numeric.html">Numeric</a>
96+
</li>
97+
<li class="nav-group-task">
98+
<a href="../Extensions/Optional.html">Optional</a>
99+
</li>
100+
<li class="nav-group-task">
101+
<a href="../Extensions/RedisClient.html">RedisClient</a>
102+
</li>
103+
<li class="nav-group-task">
104+
<a href="../Extensions/String.html">String</a>
105+
</li>
106+
<li class="nav-group-task">
107+
<a href="../Extensions/TagContext.html">TagContext</a>
108+
</li>
109+
<li class="nav-group-task">
110+
<a href="../Extensions/TimeInterval.html">TimeInterval</a>
111+
</li>
112+
<li class="nav-group-task">
113+
<a href="../Extensions/URL.html">URL</a>
114+
</li>
115+
<li class="nav-group-task">
116+
<a href="../Extensions/Validator.html">Validator</a>
117+
</li>
118+
<li class="nav-group-task">
119+
<a href="../Extensions/ViewRenderer.html">ViewRenderer</a>
120+
</li>
121+
</ul>
122+
</li>
123+
<li class="nav-group-name">
124+
<a href="../Functions.html">Functions</a>
125+
<ul class="nav-group-tasks">
126+
<li class="nav-group-task">
127+
<a href="../Functions.html#/s:5Sugar9assertEnvyS2SKF">assertEnv(_:)</a>
128+
</li>
129+
<li class="nav-group-task">
130+
<a href="../Functions.html#/s:5Sugar3envySSSgSSF">env(_:)</a>
131+
</li>
132+
<li class="nav-group-task">
133+
<a href="../Functions.html#/s:5Sugar3envyS2S_SStF">env(_:_:)</a>
134+
</li>
135+
<li class="nav-group-task">
136+
<a href="../Functions.html#/s:5Sugar11syncFlatten7futures2on3NIO15EventLoopFutureCySayxGGSayAGyxGyKcG_AE0gH5Group_ptlF">syncFlatten(futures:on:)</a>
137+
</li>
138+
<li class="nav-group-task">
139+
<a href="../Functions.html#/s:5Sugar12validateThat4only3has3for2on3NIO15EventLoopFutureCySay10Validation0L5Error_pGGxSg_q_Sgs7KeyPathCyxq_G11DatabaseKit0P11Connectable_pt6Fluent5ModelRzs28CustomDebugStringConvertibleR_SER_SQR_r0_lF">validateThat(only:has:for:on:)</a>
140+
</li>
141+
</ul>
142+
</li>
143+
<li class="nav-group-name">
144+
<a href="../Protocols.html">Protocols</a>
145+
<ul class="nav-group-tasks">
146+
<li class="nav-group-task">
147+
<a href="../Protocols/Creatable.html">Creatable</a>
148+
</li>
149+
<li class="nav-group-task">
150+
<a href="../Protocols/ExpireableSubjectPayload.html">ExpireableSubjectPayload</a>
151+
</li>
152+
<li class="nav-group-task">
153+
<a href="../Protocols/HasPassword.html">HasPassword</a>
154+
</li>
155+
<li class="nav-group-task">
156+
<a href="../Protocols/HasReadablePassword.html">HasReadablePassword</a>
157+
</li>
158+
<li class="nav-group-task">
159+
<a href="../Protocols/HasReadableUsername.html">HasReadableUsername</a>
160+
</li>
161+
<li class="nav-group-task">
162+
<a href="../Protocols/HasUpdatablePassword.html">HasUpdatablePassword</a>
163+
</li>
164+
<li class="nav-group-task">
165+
<a href="../Protocols/HasUpdatableUsername.html">HasUpdatableUsername</a>
166+
</li>
167+
<li class="nav-group-task">
168+
<a href="../Protocols/JWTAuthenticatable.html">JWTAuthenticatable</a>
169+
</li>
170+
<li class="nav-group-task">
171+
<a href="../Protocols/Loginable.html">Loginable</a>
172+
</li>
173+
<li class="nav-group-task">
174+
<a href="../Protocols/PublicRepresentable.html">PublicRepresentable</a>
175+
</li>
176+
<li class="nav-group-task">
177+
<a href="../Protocols/Seedable.html">Seedable</a>
178+
</li>
179+
<li class="nav-group-task">
180+
<a href="../Protocols.html#/s:5Sugar13SelfCreatableP">SelfCreatable</a>
181+
</li>
182+
<li class="nav-group-task">
183+
<a href="../Protocols/Updatable.html">Updatable</a>
184+
</li>
185+
</ul>
186+
</li>
187+
<li class="nav-group-name">
188+
<a href="../Structs.html">Structures</a>
189+
<ul class="nav-group-tasks">
190+
<li class="nav-group-task">
191+
<a href="../Structs/CurrentURLMiddleware.html">CurrentURLMiddleware</a>
192+
</li>
193+
<li class="nav-group-task">
194+
<a href="../Structs/CurrentUserMiddleware.html">CurrentUserMiddleware</a>
195+
</li>
196+
<li class="nav-group-task">
197+
<a href="../Structs/ExpireableJWTSigner.html">ExpireableJWTSigner</a>
198+
</li>
199+
<li class="nav-group-task">
200+
<a href="../Structs/PasswordRegex.html">PasswordRegex</a>
201+
</li>
202+
<li class="nav-group-task">
203+
<a href="../Structs/Payload.html">Payload</a>
204+
</li>
205+
<li class="nav-group-task">
206+
<a href="../Structs/SeederCommand.html">SeederCommand</a>
207+
</li>
208+
</ul>
209+
</li>
210+
</ul>
211+
</nav>
212+
<article class="main-content">
213+
<section>
214+
<section class="section">
215+
<h1>CurrentURLContainer</h1>
216+
<div class="declaration">
217+
<div class="language">
218+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">CurrentURLContainer</span> <span class="p">:</span> <span class="kt">Codable</span><span class="p">,</span> <span class="kt">Service</span></code></pre>
219+
220+
</div>
221+
</div>
222+
<p>Undocumented</p>
223+
224+
</section>
225+
<section class="section task-group-section">
226+
<div class="task-group">
227+
<ul>
228+
<li class="item">
229+
<div>
230+
<code>
231+
<a name="/s:5Sugar19CurrentURLContainerC4pathSSvp"></a>
232+
<a name="//apple_ref/swift/Property/path" class="dashAnchor"></a>
233+
<a class="token" href="#/s:5Sugar19CurrentURLContainerC4pathSSvp">path</a>
234+
</code>
235+
</div>
236+
<div class="height-container">
237+
<div class="pointer-container"></div>
238+
<section class="section">
239+
<div class="pointer"></div>
240+
<div class="abstract">
241+
<p>Undocumented</p>
242+
243+
</div>
244+
<div class="declaration">
245+
<h4>Declaration</h4>
246+
<div class="language">
247+
<p class="aside-title">Swift</p>
248+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">path</span><span class="p">:</span> <span class="kt">String</span></code></pre>
249+
250+
</div>
251+
</div>
252+
</section>
253+
</div>
254+
</li>
255+
</ul>
256+
</div>
257+
</section>
258+
</section>
259+
<section id="footer">
260+
<p>&copy; 2019 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2019-08-01)</p>
261+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.10.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
262+
</section>
263+
</article>
264+
</div>
265+
</body>
266+
</div>
267+
</html>

0 commit comments

Comments
 (0)