Skip to content

Commit 7b6e592

Browse files
gumobgumob
committed
docs: Update swfit docs
1 parent c4c52a9 commit 7b6e592

File tree

12 files changed

+18
-18
lines changed

12 files changed

+18
-18
lines changed

‎docs/swiftdoc/Classes.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ <h4>Declaration</h4>
136136
</article>
137137
</div>
138138
<section class="footer">
139-
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-27)</p>
139+
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-28)</p>
140140
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
141141
</section>
142142
</body>

‎docs/swiftdoc/Classes/Puny.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ <h4>Return Value</h4>
317317
</article>
318318
</div>
319319
<section class="footer">
320-
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-27)</p>
320+
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-28)</p>
321321
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
322322
</section>
323323
</body>

‎docs/swiftdoc/Extensions.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ <h4>Declaration</h4>
159159
</article>
160160
</div>
161161
<section class="footer">
162-
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-27)</p>
162+
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-28)</p>
163163
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
164164
</section>
165165
</body>

‎docs/swiftdoc/Extensions/String.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ <h4>Return Value</h4>
234234
</article>
235235
</div>
236236
<section class="footer">
237-
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-27)</p>
237+
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-28)</p>
238238
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
239239
</section>
240240
</body>

‎docs/swiftdoc/Extensions/Substring.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ <h4>Return Value</h4>
234234
</article>
235235
</div>
236236
<section class="footer">
237-
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-27)</p>
237+
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-28)</p>
238238
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
239239
</section>
240240
</body>

‎docs/swiftdoc/docsets/Punycode.docset/Contents/Resources/Documents/Classes.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ <h4>Declaration</h4>
136136
</article>
137137
</div>
138138
<section class="footer">
139-
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-27)</p>
139+
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-28)</p>
140140
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
141141
</section>
142142
</body>

‎docs/swiftdoc/docsets/Punycode.docset/Contents/Resources/Documents/Classes/Puny.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ <h4>Return Value</h4>
317317
</article>
318318
</div>
319319
<section class="footer">
320-
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-27)</p>
320+
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-28)</p>
321321
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
322322
</section>
323323
</body>

‎docs/swiftdoc/docsets/Punycode.docset/Contents/Resources/Documents/Extensions.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ <h4>Declaration</h4>
159159
</article>
160160
</div>
161161
<section class="footer">
162-
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-27)</p>
162+
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-28)</p>
163163
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
164164
</section>
165165
</body>

‎docs/swiftdoc/docsets/Punycode.docset/Contents/Resources/Documents/Extensions/String.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ <h4>Return Value</h4>
234234
</article>
235235
</div>
236236
<section class="footer">
237-
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-27)</p>
237+
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-28)</p>
238238
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
239239
</section>
240240
</body>

‎docs/swiftdoc/docsets/Punycode.docset/Contents/Resources/Documents/Extensions/Substring.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ <h4>Return Value</h4>
234234
</article>
235235
</div>
236236
<section class="footer">
237-
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-27)</p>
237+
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-28)</p>
238238
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
239239
</section>
240240
</body>

‎docs/swiftdoc/docsets/Punycode.docset/Contents/Resources/Documents/index.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,8 @@ <h3 id='cocoapods' class='heading'>CocoaPods</h3>
152152
</ul>
153153
<h2 id='usage' class='heading'>Usage</h2>
154154

155-
<p>Encode and decode IDNA:</p>
155+
<p>Full documentation is available at <a href="https://gumob.github.io/PunycodeSwift/swiftdoc/">https://gumob.github.io/PunycodeSwift/swiftdoc/</a>.</p>
156+
<h3 id='encode-and-decode-idna' class='heading'>Encode and decode IDNA:</h3>
156157
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Punycode</span>
157158

158159
<span class="k">var</span> <span class="nv">sushi</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"寿司"</span>
@@ -163,8 +164,7 @@ <h2 id='usage' class='heading'>Usage</h2>
163164
<span class="n">sushi</span> <span class="o">=</span> <span class="n">sushi</span><span class="o">.</span><span class="n">idnaDecoded</span><span class="o">!</span>
164165
<span class="nf">print</span><span class="p">(</span><span class="n">sushi</span><span class="p">)</span> <span class="c1">// "寿司"</span>
165166
</code></pre>
166-
167-
<p>Encode and decode Punycode directly:</p>
167+
<h3 id='encode-and-decode-punycode-directly' class='heading'>Encode and decode Punycode directly:</h3>
168168
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Punycode</span>
169169

170170
<span class="k">var</span> <span class="nv">sushi</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"寿司"</span>
@@ -186,7 +186,7 @@ <h2 id='copyright' class='heading'>Copyright</h2>
186186
</article>
187187
</div>
188188
<section class="footer">
189-
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-27)</p>
189+
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-28)</p>
190190
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
191191
</section>
192192
</body>

‎docs/swiftdoc/index.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,8 @@ <h3 id='cocoapods' class='heading'>CocoaPods</h3>
152152
</ul>
153153
<h2 id='usage' class='heading'>Usage</h2>
154154

155-
<p>Encode and decode IDNA:</p>
155+
<p>Full documentation is available at <a href="https://gumob.github.io/PunycodeSwift/swiftdoc/">https://gumob.github.io/PunycodeSwift/swiftdoc/</a>.</p>
156+
<h3 id='encode-and-decode-idna' class='heading'>Encode and decode IDNA:</h3>
156157
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Punycode</span>
157158

158159
<span class="k">var</span> <span class="nv">sushi</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"寿司"</span>
@@ -163,8 +164,7 @@ <h2 id='usage' class='heading'>Usage</h2>
163164
<span class="n">sushi</span> <span class="o">=</span> <span class="n">sushi</span><span class="o">.</span><span class="n">idnaDecoded</span><span class="o">!</span>
164165
<span class="nf">print</span><span class="p">(</span><span class="n">sushi</span><span class="p">)</span> <span class="c1">// "寿司"</span>
165166
</code></pre>
166-
167-
<p>Encode and decode Punycode directly:</p>
167+
<h3 id='encode-and-decode-punycode-directly' class='heading'>Encode and decode Punycode directly:</h3>
168168
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Punycode</span>
169169

170170
<span class="k">var</span> <span class="nv">sushi</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"寿司"</span>
@@ -186,7 +186,7 @@ <h2 id='copyright' class='heading'>Copyright</h2>
186186
</article>
187187
</div>
188188
<section class="footer">
189-
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-27)</p>
189+
<p>&copy; 2024 <a class="link" href="https://github.com/gumob" target="_blank" rel="external noopener">Kojiro Futamura</a>. All rights reserved. (Last updated: 2024-08-28)</p>
190190
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
191191
</section>
192192
</body>

0 commit comments

Comments
 (0)