Skip to content

Commit

Permalink
[6.0 release] re-gen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jessesquires committed Oct 4, 2024
1 parent 74e7483 commit b783956
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 26 deletions.
6 changes: 3 additions & 3 deletions docs/Protocols.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Protocols Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Foil 5.1.2 Docs</a> (100% documented)</p>
<p><a href="index.html">Foil Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="search.json">
Expand Down Expand Up @@ -119,8 +119,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-08-16)</p>
<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>
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-10-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/Protocols/UserDefaultsSerializable.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="UserDefaultsSerializable Protocol Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Foil 5.1.2 Docs</a> (100% documented)</p>
<p><a href="../index.html">Foil Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -200,8 +200,8 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-08-16)</p>
<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>
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-10-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/Structs.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Structures Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Foil 5.1.2 Docs</a> (100% documented)</p>
<p><a href="index.html">Foil Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="search.json">
Expand Down Expand Up @@ -132,8 +132,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-08-16)</p>
<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>
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-10-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/Structs/FoilDefaultStorage.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="FoilDefaultStorage Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Foil 5.1.2 Docs</a> (100% documented)</p>
<p><a href="../index.html">Foil Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -234,8 +234,8 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-08-16)</p>
<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>
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-10-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/Structs/FoilDefaultStorageOptional.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="FoilDefaultStorageOptional Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Foil 5.1.2 Docs</a> (100% documented)</p>
<p><a href="../index.html">Foil Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -222,8 +222,8 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-08-16)</p>
<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>
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-10-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
15 changes: 6 additions & 9 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<a title="Foil Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Foil 5.1.2 Docs</a> (100% documented)</p>
<p><a href="index.html">Foil Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jessesquires/Foil"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="search.json">
Expand Down Expand Up @@ -261,17 +261,14 @@ <h2 id='supported-platforms' class='heading'>Supported Platforms</h2>
<h2 id='requirements' class='heading'>Requirements</h2>

<ul>
<li>Swift 5.10+</li>
<li>Xcode 15.4+</li>
<li>Swift 6.0+</li>
<li>Xcode 16.0+</li>
<li><a href="https://github.com/realm/SwiftLint">SwiftLint</a></li>
</ul>
<h2 id='installation' class='heading'>Installation</h2>
<h3 id='a-href-http-cocoapods-org-cocoapods-a' class='heading'><a href="http://cocoapods.org">CocoaPods</a></h3>
<pre class="highlight ruby"><code><span class="n">pod</span> <span class="s1">'Foil'</span><span class="p">,</span> <span class="s1">'~&gt; 5.0.0'</span>
</code></pre>
<h3 id='a-href-https-swift-org-package-manager-swift-package-manager-a' class='heading'><a href="https://swift.org/package-manager/">Swift Package Manager</a></h3>
<pre class="highlight swift"><code><span class="nv">dependencies</span><span class="p">:</span> <span class="p">[</span>
<span class="o">.</span><span class="nf">package</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="s">"https://github.com/jessesquires/Foil.git"</span><span class="p">,</span> <span class="nv">from</span><span class="p">:</span> <span class="s">"5.0.0"</span><span class="p">)</span>
<span class="o">.</span><span class="nf">package</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="s">"https://github.com/jessesquires/Foil.git"</span><span class="p">,</span> <span class="nv">from</span><span class="p">:</span> <span class="s">"6.0.0"</span><span class="p">)</span>
<span class="p">]</span>
</code></pre>

Expand Down Expand Up @@ -307,8 +304,8 @@ <h2 id='license' class='heading'>License</h2>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-08-16)</p>
<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>
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-10-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/js/jazzy.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ function itemLinkToContent($link) {
return $link.parent().parent().next();
}

// On doc load + hash-change, open any targetted item
// On doc load + hash-change, open any targeted item
function openCurrentItemIfClosed() {
if (window.jazzy.docset) {
return;
Expand Down
2 changes: 1 addition & 1 deletion docs/search.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"Structs/FoilDefaultStorageOptional.html#/s:4Foil0A22DefaultStorageOptionalV3keySSvp":{"name":"key","abstract":"\u003cp\u003eThe key for the value in \u003ccode\u003eUserDefaults\u003c/code\u003e.\u003c/p\u003e","parent_name":"FoilDefaultStorageOptional"},"Structs/FoilDefaultStorageOptional.html#/s:4Foil0A22DefaultStorageOptionalV12wrappedValuexSgvp":{"name":"wrappedValue","abstract":"\u003cp\u003eThe value retrieved from \u003ccode\u003eUserDefaults\u003c/code\u003e, if any exists.\u003c/p\u003e","parent_name":"FoilDefaultStorageOptional"},"Structs/FoilDefaultStorageOptional.html#/s:4Foil0A22DefaultStorageOptionalV14projectedValue7Combine12AnyPublisherVyxSgs5NeverOGvp":{"name":"projectedValue","abstract":"\u003cp\u003eA publisher that delivers updates to subscribers.\u003c/p\u003e","parent_name":"FoilDefaultStorageOptional"},"Structs/FoilDefaultStorageOptional.html#/s:4Foil0A22DefaultStorageOptionalV3key12userDefaultsACyxGSS_So06NSUserG0Ctcfc":{"name":"init(key:userDefaults:)","abstract":"\u003cp\u003eInitializes the property wrapper.\u003c/p\u003e","parent_name":"FoilDefaultStorageOptional"},"Structs/FoilDefaultStorage.html#/s:4Foil0A14DefaultStorageV3keySSvp":{"name":"key","abstract":"\u003cp\u003eThe key for the value in \u003ccode\u003eUserDefaults\u003c/code\u003e.\u003c/p\u003e","parent_name":"FoilDefaultStorage"},"Structs/FoilDefaultStorage.html#/s:4Foil0A14DefaultStorageV12wrappedValuexvp":{"name":"wrappedValue","abstract":"\u003cp\u003eThe value retrieved from \u003ccode\u003eUserDefaults\u003c/code\u003e.\u003c/p\u003e","parent_name":"FoilDefaultStorage"},"Structs/FoilDefaultStorage.html#/s:4Foil0A14DefaultStorageV14projectedValue7Combine12AnyPublisherVyxs5NeverOGvp":{"name":"projectedValue","abstract":"\u003cp\u003eA publisher that delivers updates to subscribers.\u003c/p\u003e","parent_name":"FoilDefaultStorage"},"Structs/FoilDefaultStorage.html#/s:4Foil0A14DefaultStorageV12wrappedValue3key12userDefaultsACyxGx_SSSo06NSUserH0Ctcfc":{"name":"init(wrappedValue:key:userDefaults:)","abstract":"\u003cp\u003eInitializes the property wrapper.\u003c/p\u003e","parent_name":"FoilDefaultStorage"},"Structs/FoilDefaultStorage.html":{"name":"FoilDefaultStorage","abstract":"\u003cp\u003eA property wrapper that uses \u003ccode\u003eUserDefaults\u003c/code\u003e as a backing store,"},"Structs/FoilDefaultStorageOptional.html":{"name":"FoilDefaultStorageOptional","abstract":"\u003cp\u003eA property wrapper that uses \u003ccode\u003eUserDefaults\u003c/code\u003e as a backing store,"},"Protocols/UserDefaultsSerializable.html#/s:4Foil24UserDefaultsSerializableP11StoredValueQa":{"name":"StoredValue","abstract":"\u003cp\u003eThe type of the value that is stored in \u003ccode\u003eUserDefaults\u003c/code\u003e.\u003c/p\u003e","parent_name":"UserDefaultsSerializable"},"Protocols/UserDefaultsSerializable.html#/s:4Foil24UserDefaultsSerializableP11storedValue06StoredF0Qzvp":{"name":"storedValue","abstract":"\u003cp\u003eThe value to store in \u003ccode\u003eUserDefaults\u003c/code\u003e.\u003c/p\u003e","parent_name":"UserDefaultsSerializable"},"Protocols/UserDefaultsSerializable.html#/s:4Foil24UserDefaultsSerializableP11storedValuexSg06StoredF0Qz_tcfc":{"name":"init(storedValue:)","abstract":"\u003cp\u003eInitializes the object using the provided value, or returns \u003ccode\u003enil\u003c/code\u003e if initialization fails.\u003c/p\u003e","parent_name":"UserDefaultsSerializable"},"Protocols/UserDefaultsSerializable.html":{"name":"UserDefaultsSerializable","abstract":"\u003cp\u003eDescribes a value that can be saved to and fetched from \u003ccode\u003eUserDefaults\u003c/code\u003e.\u003c/p\u003e"},"Protocols.html":{"name":"Protocols","abstract":"\u003cp\u003eThe following protocols are available globally.\u003c/p\u003e"},"Structs.html":{"name":"Structures","abstract":"\u003cp\u003eThe following structures are available globally.\u003c/p\u003e"}}
{"Structs/FoilDefaultStorageOptional.html#/s:4Foil0A22DefaultStorageOptionalV3keySSvp":{"name":"key","abstract":"<p>The key for the value in <code>UserDefaults</code>.</p>","parent_name":"FoilDefaultStorageOptional"},"Structs/FoilDefaultStorageOptional.html#/s:4Foil0A22DefaultStorageOptionalV12wrappedValuexSgvp":{"name":"wrappedValue","abstract":"<p>The value retrieved from <code>UserDefaults</code>, if any exists.</p>","parent_name":"FoilDefaultStorageOptional"},"Structs/FoilDefaultStorageOptional.html#/s:4Foil0A22DefaultStorageOptionalV14projectedValue7Combine12AnyPublisherVyxSgs5NeverOGvp":{"name":"projectedValue","abstract":"<p>A publisher that delivers updates to subscribers.</p>","parent_name":"FoilDefaultStorageOptional"},"Structs/FoilDefaultStorageOptional.html#/s:4Foil0A22DefaultStorageOptionalV3key12userDefaultsACyxGSS_So06NSUserG0Ctcfc":{"name":"init(key:userDefaults:)","abstract":"<p>Initializes the property wrapper.</p>","parent_name":"FoilDefaultStorageOptional"},"Structs/FoilDefaultStorage.html#/s:4Foil0A14DefaultStorageV3keySSvp":{"name":"key","abstract":"<p>The key for the value in <code>UserDefaults</code>.</p>","parent_name":"FoilDefaultStorage"},"Structs/FoilDefaultStorage.html#/s:4Foil0A14DefaultStorageV12wrappedValuexvp":{"name":"wrappedValue","abstract":"<p>The value retrieved from <code>UserDefaults</code>.</p>","parent_name":"FoilDefaultStorage"},"Structs/FoilDefaultStorage.html#/s:4Foil0A14DefaultStorageV14projectedValue7Combine12AnyPublisherVyxs5NeverOGvp":{"name":"projectedValue","abstract":"<p>A publisher that delivers updates to subscribers.</p>","parent_name":"FoilDefaultStorage"},"Structs/FoilDefaultStorage.html#/s:4Foil0A14DefaultStorageV12wrappedValue3key12userDefaultsACyxGx_SSSo06NSUserH0Ctcfc":{"name":"init(wrappedValue:key:userDefaults:)","abstract":"<p>Initializes the property wrapper.</p>","parent_name":"FoilDefaultStorage"},"Structs/FoilDefaultStorage.html":{"name":"FoilDefaultStorage","abstract":"<p>A property wrapper that uses <code>UserDefaults</code> as a backing store,"},"Structs/FoilDefaultStorageOptional.html":{"name":"FoilDefaultStorageOptional","abstract":"<p>A property wrapper that uses <code>UserDefaults</code> as a backing store,"},"Protocols/UserDefaultsSerializable.html#/s:4Foil24UserDefaultsSerializableP11StoredValueQa":{"name":"StoredValue","abstract":"<p>The type of the value that is stored in <code>UserDefaults</code>.</p>","parent_name":"UserDefaultsSerializable"},"Protocols/UserDefaultsSerializable.html#/s:4Foil24UserDefaultsSerializableP11storedValue06StoredF0Qzvp":{"name":"storedValue","abstract":"<p>The value to store in <code>UserDefaults</code>.</p>","parent_name":"UserDefaultsSerializable"},"Protocols/UserDefaultsSerializable.html#/s:4Foil24UserDefaultsSerializableP11storedValuexSg06StoredF0Qz_tcfc":{"name":"init(storedValue:)","abstract":"<p>Initializes the object using the provided value, or returns <code>nil</code> if initialization fails.</p>","parent_name":"UserDefaultsSerializable"},"Protocols/UserDefaultsSerializable.html":{"name":"UserDefaultsSerializable","abstract":"<p>Describes a value that can be saved to and fetched from <code>UserDefaults</code>.</p>"},"Protocols.html":{"name":"Protocols","abstract":"<p>The following protocols are available globally.</p>"},"Structs.html":{"name":"Structures","abstract":"<p>The following structures are available globally.</p>"}}

0 comments on commit b783956

Please sign in to comment.