Skip to content

Commit

Permalink
gen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jessesquires committed Jan 9, 2024
1 parent f42812e commit 527e771
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions docs/Protocols.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2023-03-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</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-01-09)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Protocols/UserDefaultsSerializable.html
Original file line number Diff line number Diff line change
Expand Up @@ -197,8 +197,8 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2023-03-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</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-01-09)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Structs.html
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2023-03-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</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-01-09)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Structs/WrappedDefault.html
Original file line number Diff line number Diff line change
Expand Up @@ -232,8 +232,8 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2023-03-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</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-01-09)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Structs/WrappedDefaultOptional.html
Original file line number Diff line number Diff line change
Expand Up @@ -220,8 +220,8 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2023-03-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</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-01-09)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
10 changes: 5 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ <h4 id='using-kvo' class='heading'>Using KVO</h4>
<h4 id='using-combine' class='heading'>Using Combine</h4>

<p><strong>Note:</strong> that <code>average</code> does not need the <code>@objc dynamic</code> annotation, <code>.receiveValue</code> will fire immediately with the current value of <code>average</code> and on every change after.</p>
<pre class="highlight swift"><code><span class="kt">AppSettings</span><span class="o">.</span><span class="n">shared</span><span class="o">.</span><span class="err">$</span><span class="n">average</span>
<pre class="highlight swift"><code><span class="kt">AppSettings</span><span class="o">.</span><span class="n">shared</span><span class="o">.</span><span class="n">$average</span>
<span class="o">.</span><span class="n">sink</span> <span class="p">{</span>
<span class="nf">print</span><span class="p">(</span><span class="nv">$0</span><span class="p">)</span>
<span class="p">}</span>
Expand Down Expand Up @@ -201,8 +201,8 @@ <h2 id='supported-platforms' class='heading'>Supported Platforms</h2>
<h2 id='requirements' class='heading'>Requirements</h2>

<ul>
<li>Swift 5.7+</li>
<li>Xcode 14.0+</li>
<li>Swift 5.9+</li>
<li>Xcode 15.0+</li>
<li><a href="https://github.com/realm/SwiftLint">SwiftLint</a></li>
</ul>
<h2 id='installation' class='heading'>Installation</h2>
Expand Down Expand Up @@ -245,8 +245,8 @@ <h2 id='license' class='heading'>License</h2>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2023-03-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</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-01-09)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/js/jquery.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/search.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV3keySSvp":{"name":"key","abstract":"<p>The key for the value in <code>UserDefaults</code>.</p>","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV12wrappedValuexSgvp":{"name":"wrappedValue","abstract":"<p>The value retrieved from <code>UserDefaults</code>, if any exists.</p>","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV14projectedValue7Combine12AnyPublisherVyxSgs5NeverOGvp":{"name":"projectedValue","abstract":"<p>A publisher that delivers updates to subscribers.</p>","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV3key12userDefaultsACyxGSS_So06NSUserG0Ctcfc":{"name":"init(key:userDefaults:)","abstract":"<p>Initializes the property wrapper.</p>","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV3keySSvp":{"name":"key","abstract":"<p>The key for the value in <code>UserDefaults</code>.</p>","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV12wrappedValuexvp":{"name":"wrappedValue","abstract":"<p>The value retrieved from <code>UserDefaults</code>.</p>","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV14projectedValue7Combine12AnyPublisherVyxs5NeverOGvp":{"name":"projectedValue","abstract":"<p>A publisher that delivers updates to subscribers.</p>","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV12wrappedValue3key12userDefaultsACyxGx_SSSo06NSUserH0Ctcfc":{"name":"init(wrappedValue:key:userDefaults:)","abstract":"<p>Initializes the property wrapper.</p>","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html":{"name":"WrappedDefault","abstract":"<p>A property wrapper that uses <code>UserDefaults</code> as a backing store,"},"Structs/WrappedDefaultOptional.html":{"name":"WrappedDefaultOptional","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:4Foil24UserDefaultsSerializableP11storedValuex06StoredF0Qz_tcfc":{"name":"init(storedValue:)","abstract":"<p>Initializes the object using the provided value.</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>"}}
{"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV3keySSvp":{"name":"key","abstract":"\u003cp\u003eThe key for the value in \u003ccode\u003eUserDefaults\u003c/code\u003e.\u003c/p\u003e","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV12wrappedValuexSgvp":{"name":"wrappedValue","abstract":"\u003cp\u003eThe value retrieved from \u003ccode\u003eUserDefaults\u003c/code\u003e, if any exists.\u003c/p\u003e","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV14projectedValue7Combine12AnyPublisherVyxSgs5NeverOGvp":{"name":"projectedValue","abstract":"\u003cp\u003eA publisher that delivers updates to subscribers.\u003c/p\u003e","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefaultOptional.html#/s:4Foil22WrappedDefaultOptionalV3key12userDefaultsACyxGSS_So06NSUserG0Ctcfc":{"name":"init(key:userDefaults:)","abstract":"\u003cp\u003eInitializes the property wrapper.\u003c/p\u003e","parent_name":"WrappedDefaultOptional"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV3keySSvp":{"name":"key","abstract":"\u003cp\u003eThe key for the value in \u003ccode\u003eUserDefaults\u003c/code\u003e.\u003c/p\u003e","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV12wrappedValuexvp":{"name":"wrappedValue","abstract":"\u003cp\u003eThe value retrieved from \u003ccode\u003eUserDefaults\u003c/code\u003e.\u003c/p\u003e","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV14projectedValue7Combine12AnyPublisherVyxs5NeverOGvp":{"name":"projectedValue","abstract":"\u003cp\u003eA publisher that delivers updates to subscribers.\u003c/p\u003e","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html#/s:4Foil14WrappedDefaultV12wrappedValue3key12userDefaultsACyxGx_SSSo06NSUserH0Ctcfc":{"name":"init(wrappedValue:key:userDefaults:)","abstract":"\u003cp\u003eInitializes the property wrapper.\u003c/p\u003e","parent_name":"WrappedDefault"},"Structs/WrappedDefault.html":{"name":"WrappedDefault","abstract":"\u003cp\u003eA property wrapper that uses \u003ccode\u003eUserDefaults\u003c/code\u003e as a backing store,"},"Structs/WrappedDefaultOptional.html":{"name":"WrappedDefaultOptional","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:4Foil24UserDefaultsSerializableP11storedValuex06StoredF0Qz_tcfc":{"name":"init(storedValue:)","abstract":"\u003cp\u003eInitializes the object using the provided value.\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"}}

0 comments on commit 527e771

Please sign in to comment.