Skip to content

Commit 6f1424c

Browse files
dannys42dannys42
committed
Update jazzy docs
1 parent 2119420 commit 6f1424c

Some content is hidden

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

50 files changed

+863
-679
lines changed

‎.jazzy.yaml

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module: SwiftJWT
2-
author: IBM
3-
github_url: https://github.com/IBM-Swift/Swift-JWT/
2+
author: IBM & Kitura Project Contributors
3+
github_url: https://github.com/Kitura/Swift-JWT/
44

55
theme: fullwidth
66
clean: true
@@ -10,5 +10,3 @@ readme: README.md
1010

1111
skip_undocumented: false
1212
hide_documentation_coverage: false
13-
14-
xcodebuild_arguments: [-project, SwiftJWT.xcodeproj, -target, SwiftJWT, LIBRARY_SEARCH_PATHS=.build/debug]

‎docs/Classes.html

+15-19
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="index.html">
24-
SwiftJWT Docs
24+
SwiftJWT 3.6.200 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -33,7 +33,7 @@
3333
</p>
3434

3535
<p class="header-col header-col--secondary">
36-
<a class="header-link" href="https://github.com/IBM-Swift/Swift-JWT/">
36+
<a class="header-link" href="https://github.com/Kitura/Swift-JWT/">
3737
<img class="header-icon" src="img/gh.png"/>
3838
View on GitHub
3939
</a>
@@ -109,7 +109,7 @@
109109
<article class="main-content">
110110

111111
<section class="section">
112-
<div class="section-content">
112+
<div class="section-content top-matter">
113113
<h1>Classes</h1>
114114
<p>The following classes are available globally.</p>
115115

@@ -148,10 +148,6 @@ <h4>Declaration</h4>
148148
</section>
149149
</div>
150150
</li>
151-
</ul>
152-
</div>
153-
<div class="task-group">
154-
<ul class="item-container">
155151
<li class="item">
156152
<div>
157153
<code>
@@ -180,10 +176,6 @@ <h4>Declaration</h4>
180176
</section>
181177
</div>
182178
</li>
183-
</ul>
184-
</div>
185-
<div class="task-group">
186-
<ul class="item-container">
187179
<li class="item">
188180
<div>
189181
<code>
@@ -218,9 +210,11 @@ <h4>Declaration</h4>
218210
<div class="task-name-container">
219211
<a name="/JWTEncoder"></a>
220212
<a name="//apple_ref/swift/Section/JWTEncoder" class="dashAnchor"></a>
221-
<a href="#/JWTEncoder">
222-
<h3 class="section-name">JWTEncoder</h3>
223-
</a>
213+
<div class="section-name-container">
214+
<a class="section-name-link" href="#/JWTEncoder"></a>
215+
<h3 class="section-name"><p>JWTEncoder</p>
216+
</h3>
217+
</div>
224218
</div>
225219
<ul class="item-container">
226220
<li class="item">
@@ -270,9 +264,11 @@ <h4>Declaration</h4>
270264
<div class="task-name-container">
271265
<a name="/JWTDecoder"></a>
272266
<a name="//apple_ref/swift/Section/JWTDecoder" class="dashAnchor"></a>
273-
<a href="#/JWTDecoder">
274-
<h3 class="section-name">JWTDecoder</h3>
275-
</a>
267+
<div class="section-name-container">
268+
<a class="section-name-link" href="#/JWTDecoder"></a>
269+
<h3 class="section-name"><p>JWTDecoder</p>
270+
</h3>
271+
</div>
276272
</div>
277273
<ul class="item-container">
278274
<li class="item">
@@ -323,8 +319,8 @@ <h4>Declaration</h4>
323319
</article>
324320
</div>
325321
<section class="footer">
326-
<p>&copy; 2019 <a class="link" href="https://github.com/IBM-Swift/Swift-JWT" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-09-25)</p>
327-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
322+
<p>&copy; 2020 <a class="link" href="https://github.com/Kitura/Swift-JWT" target="_blank" rel="external">IBM &amp; Kitura Project Contributors</a>. All rights reserved. (Last updated: 2020-11-25)</p>
323+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
328324
</section>
329325
</body>
330326
</div>

‎docs/Classes/ClaimsMicroProfile.html

+9-8
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SwiftJWT Docs
24+
SwiftJWT 3.6.200 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -33,7 +33,7 @@
3333
</p>
3434

3535
<p class="header-col header-col--secondary">
36-
<a class="header-link" href="https://github.com/IBM-Swift/Swift-JWT/">
36+
<a class="header-link" href="https://github.com/Kitura/Swift-JWT/">
3737
<img class="header-icon" src="../img/gh.png"/>
3838
View on GitHub
3939
</a>
@@ -109,10 +109,11 @@
109109
<article class="main-content">
110110

111111
<section class="section">
112-
<div class="section-content">
112+
<div class="section-content top-matter">
113113
<h1>ClaimsMicroProfile</h1>
114114
<div class="declaration">
115115
<div class="language">
116+
116117
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ClaimsMicroProfile</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/Claims.html">Claims</a></span></code></pre>
117118

118119
</div>
@@ -131,7 +132,7 @@ <h1>ClaimsMicroProfile</h1>
131132
<code>
132133
<a name="/s:8SwiftJWT18ClaimsMicroProfileC3iss3sub3exp3iat3jti3upn6groupsACSS_SS10Foundation4DateVAMS2SSaySSGtcfc"></a>
133134
<a name="//apple_ref/swift/Method/init(iss:sub:exp:iat:jti:upn:groups:)" class="dashAnchor"></a>
134-
<a class="token" href="#/s:8SwiftJWT18ClaimsMicroProfileC3iss3sub3exp3iat3jti3upn6groupsACSS_SS10Foundation4DateVAMS2SSaySSGtcfc">init(iss:sub:exp:iat:jti:upn:groups:)</a>
135+
<a class="token" href="#/s:8SwiftJWT18ClaimsMicroProfileC3iss3sub3exp3iat3jti3upn6groupsACSS_SS10Foundation4DateVAMS2SSaySSGtcfc">init(iss:<wbr>sub:<wbr>exp:<wbr>iat:<wbr>jti:<wbr>upn:<wbr>groups:<wbr>)</a>
135136
</code>
136137
</div>
137138
<div class="height-container">
@@ -282,7 +283,7 @@ <h4>Declaration</h4>
282283
<section class="section">
283284
<div class="pointer"></div>
284285
<div class="abstract">
285-
<p>The <q>jti</q> (JWT ID) claim provides a unique identifier for the JWT.
286+
<p>The &ldquo;jti&rdquo; (JWT ID) claim provides a unique identifier for the JWT.
286287
The identifier value MUST be assigned in a manner that ensures that
287288
there is a negligible probability that the same value will be
288289
accidentally assigned to a different data object.</p>
@@ -312,7 +313,7 @@ <h4>Declaration</h4>
312313
<section class="section">
313314
<div class="pointer"></div>
314315
<div class="abstract">
315-
<p>This MP-JWT custom claim is the user principal name in the java.security.Principal interface, and is the caller principal name in javax.security.enterprise.identitystore.IdentityStore. If this claim is missing, fallback to the <q>preferred_username</q>, should be attempted, and if that claim is missing, fallback to the <q>sub</q> claim should be used.</p>
316+
<p>This MP-JWT custom claim is the user principal name in the java.security.Principal interface, and is the caller principal name in javax.security.enterprise.identitystore.IdentityStore. If this claim is missing, fallback to the &ldquo;preferred_username&rdquo;, should be attempted, and if that claim is missing, fallback to the &ldquo;sub&rdquo; claim should be used.</p>
316317

317318
</div>
318319
<div class="declaration">
@@ -388,8 +389,8 @@ <h4>Declaration</h4>
388389
</article>
389390
</div>
390391
<section class="footer">
391-
<p>&copy; 2019 <a class="link" href="https://github.com/IBM-Swift/Swift-JWT" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-09-25)</p>
392-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
392+
<p>&copy; 2020 <a class="link" href="https://github.com/Kitura/Swift-JWT" target="_blank" rel="external">IBM &amp; Kitura Project Contributors</a>. All rights reserved. (Last updated: 2020-11-25)</p>
393+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
393394
</section>
394395
</body>
395396
</div>

‎docs/Classes/ClaimsOpenID.html

+18-13
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SwiftJWT Docs
24+
SwiftJWT 3.6.200 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -33,7 +33,7 @@
3333
</p>
3434

3535
<p class="header-col header-col--secondary">
36-
<a class="header-link" href="https://github.com/IBM-Swift/Swift-JWT/">
36+
<a class="header-link" href="https://github.com/Kitura/Swift-JWT/">
3737
<img class="header-icon" src="../img/gh.png"/>
3838
View on GitHub
3939
</a>
@@ -109,10 +109,11 @@
109109
<article class="main-content">
110110

111111
<section class="section">
112-
<div class="section-content">
112+
<div class="section-content top-matter">
113113
<h1>ClaimsOpenID</h1>
114114
<div class="declaration">
115115
<div class="language">
116+
116117
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ClaimsOpenID</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/Claims.html">Claims</a></span></code></pre>
117118

118119
</div>
@@ -131,7 +132,7 @@ <h1>ClaimsOpenID</h1>
131132
<code>
132133
<a name="/s:8SwiftJWT12ClaimsOpenIDC3iss3sub3aud3exp3iat9auth_time5nonce3acr3amr3azp4name06given_Q007family_Q007middle_Q08nickname18preferred_username7profile7picture7website5email14email_verified6gender9birthdate8zoneinfo6locale12phone_number21phone_number_verified7address10updated_atACSS_SSSaySSG10Foundation4DateVA8_A8_SgSSSgA10_A5_SgA10_A10_A10_A10_A10_A10_A10_A10_A10_A10_A10_SbSgA10_A10_A10_A10_A10_A12_AA12AddressClaimVSgA9_tcfc"></a>
133134
<a name="//apple_ref/swift/Method/init(iss:sub:aud:exp:iat:auth_time:nonce:acr:amr:azp:name:given_name:family_name:middle_name:nickname:preferred_username:profile:picture:website:email:email_verified:gender:birthdate:zoneinfo:locale:phone_number:phone_number_verified:address:updated_at:)" class="dashAnchor"></a>
134-
<a class="token" href="#/s:8SwiftJWT12ClaimsOpenIDC3iss3sub3aud3exp3iat9auth_time5nonce3acr3amr3azp4name06given_Q007family_Q007middle_Q08nickname18preferred_username7profile7picture7website5email14email_verified6gender9birthdate8zoneinfo6locale12phone_number21phone_number_verified7address10updated_atACSS_SSSaySSG10Foundation4DateVA8_A8_SgSSSgA10_A5_SgA10_A10_A10_A10_A10_A10_A10_A10_A10_A10_A10_SbSgA10_A10_A10_A10_A10_A12_AA12AddressClaimVSgA9_tcfc">init(iss:sub:aud:exp:iat:auth_time:nonce:acr:amr:azp:name:given_name:family_name:middle_name:nickname:preferred_username:profile:picture:website:email:email_verified:gender:birthdate:zoneinfo:locale:phone_number:phone_number_verified:address:updated_at:)</a>
135+
<a class="token" href="#/s:8SwiftJWT12ClaimsOpenIDC3iss3sub3aud3exp3iat9auth_time5nonce3acr3amr3azp4name06given_Q007family_Q007middle_Q08nickname18preferred_username7profile7picture7website5email14email_verified6gender9birthdate8zoneinfo6locale12phone_number21phone_number_verified7address10updated_atACSS_SSSaySSG10Foundation4DateVA8_A8_SgSSSgA10_A5_SgA10_A10_A10_A10_A10_A10_A10_A10_A10_A10_A10_SbSgA10_A10_A10_A10_A10_A12_AA12AddressClaimVSgA9_tcfc">init(iss:<wbr>sub:<wbr>aud:<wbr>exp:<wbr>iat:<wbr>auth_time:<wbr>nonce:<wbr>acr:<wbr>amr:<wbr>azp:<wbr>name:<wbr>given_name:<wbr>family_name:<wbr>middle_name:<wbr>nickname:<wbr>preferred_username:<wbr>profile:<wbr>picture:<wbr>website:<wbr>email:<wbr>email_verified:<wbr>gender:<wbr>birthdate:<wbr>zoneinfo:<wbr>locale:<wbr>phone_number:<wbr>phone_number_verified:<wbr>address:<wbr>updated_at:<wbr>)</a>
135136
</code>
136137
</div>
137138
<div class="height-container">
@@ -189,9 +190,11 @@ <h4>Declaration</h4>
189190
<div class="task-name-container">
190191
<a name="/ID%20Token"></a>
191192
<a name="//apple_ref/swift/Section/ID Token" class="dashAnchor"></a>
192-
<a href="#/ID%20Token">
193-
<h3 class="section-name">ID Token</h3>
194-
</a>
193+
<div class="section-name-container">
194+
<a class="section-name-link" href="#/ID%20Token"></a>
195+
<h3 class="section-name"><p>ID Token</p>
196+
</h3>
197+
</div>
195198
</div>
196199
<ul class="item-container">
197200
<li class="item">
@@ -396,7 +399,7 @@ <h4>Declaration</h4>
396399
<section class="section">
397400
<div class="pointer"></div>
398401
<div class="abstract">
399-
<p>Authentication Context Class Reference. String specifying an Authentication Context Class Reference value that identifies the Authentication Context Class that the authentication performed satisfied. The value <q>0</q> indicates the End-User authentication did not meet the requirements of ISO/IEC 29115 level 1. Authentications with level 0 SHOULD NOT be used to authorize access to any resource of any monetary value. Parties using this claim will need to agree upon the meanings of the values used, which may be context-specific.</p>
402+
<p>Authentication Context Class Reference. String specifying an Authentication Context Class Reference value that identifies the Authentication Context Class that the authentication performed satisfied. The value &ldquo;0&rdquo; indicates the End-User authentication did not meet the requirements of ISO/IEC 29115 level 1. Authentications with level 0 SHOULD NOT be used to authorize access to any resource of any monetary value. Parties using this claim will need to agree upon the meanings of the values used, which may be context-specific.</p>
400403

401404
</div>
402405
<div class="declaration">
@@ -470,9 +473,11 @@ <h4>Declaration</h4>
470473
<div class="task-name-container">
471474
<a name="/Standard%20Claims"></a>
472475
<a name="//apple_ref/swift/Section/Standard Claims" class="dashAnchor"></a>
473-
<a href="#/Standard%20Claims">
474-
<h3 class="section-name">Standard Claims</h3>
475-
</a>
476+
<div class="section-name-container">
477+
<a class="section-name-link" href="#/Standard%20Claims"></a>
478+
<h3 class="section-name"><p>Standard Claims</p>
479+
</h3>
480+
</div>
476481
</div>
477482
<ul class="item-container">
478483
<li class="item">
@@ -996,8 +1001,8 @@ <h4>Declaration</h4>
9961001
</article>
9971002
</div>
9981003
<section class="footer">
999-
<p>&copy; 2019 <a class="link" href="https://github.com/IBM-Swift/Swift-JWT" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-09-25)</p>
1000-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
1004+
<p>&copy; 2020 <a class="link" href="https://github.com/Kitura/Swift-JWT" target="_blank" rel="external">IBM &amp; Kitura Project Contributors</a>. All rights reserved. (Last updated: 2020-11-25)</p>
1005+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
10011006
</section>
10021007
</body>
10031008
</div>

0 commit comments

Comments
 (0)