Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
@chris-araman
chris-araman committed Jun 15, 2021
1 parent 1b65f25 commit 42593e6
Show file tree
Hide file tree
Showing 8 changed files with 264 additions and 83 deletions.
7 changes: 4 additions & 3 deletions docs/Enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
CombineCloudKit 0.4.1-1-g83f5f81 Docs
CombineCloudKit 0.5.0 Docs
</a>
(100% documented)
</p>
Expand Down Expand Up @@ -118,12 +118,13 @@ <h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Progress</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Progress</span><span class="p">:</span> <span class="kt">RawRepresentable</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Progress</span><span class="p">:</span> <span class="kt">Comparable</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/chris-araman/CombineCloudKit/tree/83f5f812d4e9806bc62d02016d55d686badf329f/Sources/CombineCloudKit/Progress.swift#L10-L16">Show on GitHub</a>
<a href="https://github.com/chris-araman/CombineCloudKit/tree/1b65f25755f4371f11f19b1e3e542f1c127812ed/Sources/CombineCloudKit/Progress.swift#L10-L25">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -136,7 +137,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2021 <a class="link" href="https://github.com/chris-araman" target="_blank" rel="external">Chris Araman</a>. All rights reserved. (Last updated: 2021-06-14)</p>
<p>&copy; 2021 <a class="link" href="https://github.com/chris-araman" target="_blank" rel="external">Chris Araman</a>. All rights reserved. (Last updated: 2021-06-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
155 changes: 148 additions & 7 deletions docs/Enums/Progress.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
CombineCloudKit 0.4.1-1-g83f5f81 Docs
CombineCloudKit 0.5.0 Docs
</a>
(100% documented)
</p>
Expand Down Expand Up @@ -91,14 +91,15 @@ <h1>Progress</h1>
<div class="language">

<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Progress</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Progress</span><span class="p">:</span> <span class="kt">RawRepresentable</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Progress</span><span class="p">:</span> <span class="kt">Comparable</span></code></pre>

</div>
</div>
<p>Represents the completion progress of a <code>CKRecord</code> save or fetch operation.</p>

<div class="slightly-smaller">
<a href="https://github.com/chris-araman/CombineCloudKit/tree/83f5f812d4e9806bc62d02016d55d686badf329f/Sources/CombineCloudKit/Progress.swift#L10-L16">Show on GitHub</a>
<a href="https://github.com/chris-araman/CombineCloudKit/tree/1b65f25755f4371f11f19b1e3e542f1c127812ed/Sources/CombineCloudKit/Progress.swift#L10-L25">Show on GitHub</a>
</div>
</div>
</section>
Expand All @@ -107,6 +108,59 @@ <h1>Progress</h1>
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:15CombineCloudKit8ProgressO7percentACSd_tcfc"></a>
<a name="//apple_ref/swift/Method/init(percent:)" class="dashAnchor"></a>
<a class="token" href="#/s:15CombineCloudKit8ProgressO7percentACSd_tcfc">init(percent:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Initializes a <code>Progress</code> instance from a percentage expressed as a <code>Double</code> in the range [0.0, 100.0].</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">percent</span><span class="p">:</span> <span class="kt">Double</span><span class="p">)</span></code></pre>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>percent</em>
</code>
</td>
<td>
<div>
<p>A <code>Double</code> in the range [0.0, 100.0]. Values are clamped to this range.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The <code>Progress</code>.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/chris-araman/CombineCloudKit/tree/1b65f25755f4371f11f19b1e3e542f1c127812ed/Sources/CombineCloudKit/Progress.swift#L16-L18">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand All @@ -132,7 +186,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/chris-araman/CombineCloudKit/tree/83f5f812d4e9806bc62d02016d55d686badf329f/Sources/CombineCloudKit/Progress.swift#L12">Show on GitHub</a>
<a href="https://github.com/chris-araman/CombineCloudKit/tree/1b65f25755f4371f11f19b1e3e542f1c127812ed/Sources/CombineCloudKit/Progress.swift#L21">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -150,7 +204,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The save or fetch operation is incomplete. <code>percent</code> is a value indicating progress between unstarted (0.0) and complete (1.0), exclusive.</p>
<p>The save or fetch operation is incomplete. <code>percent</code> is a value indicating progress in the range [0.0, 100.0).</p>

</div>
<div class="declaration">
Expand All @@ -162,7 +216,94 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/chris-araman/CombineCloudKit/tree/83f5f812d4e9806bc62d02016d55d686badf329f/Sources/CombineCloudKit/Progress.swift#L15">Show on GitHub</a>
<a href="https://github.com/chris-araman/CombineCloudKit/tree/1b65f25755f4371f11f19b1e3e542f1c127812ed/Sources/CombineCloudKit/Progress.swift#L24">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:SY8rawValue03RawB0Qzvp"></a>
<a name="//apple_ref/swift/Property/rawValue" class="dashAnchor"></a>
<a class="token" href="#/s:SY8rawValue03RawB0Qzvp">rawValue</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">rawValue</span><span class="p">:</span> <span class="kt">Double</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/chris-araman/CombineCloudKit/tree/1b65f25755f4371f11f19b1e3e542f1c127812ed/Sources/CombineCloudKit/Progress.swift#L28-L35">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:SY8RawValueQa"></a>
<a name="//apple_ref/swift/Alias/RawValue" class="dashAnchor"></a>
<a class="token" href="#/s:SY8RawValueQa">RawValue</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">RawValue</span> <span class="o">=</span> <span class="kt">Double</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/chris-araman/CombineCloudKit/tree/1b65f25755f4371f11f19b1e3e542f1c127812ed/Sources/CombineCloudKit/Progress.swift#L">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:SY8rawValuexSg03RawB0Qz_tcfc"></a>
<a name="//apple_ref/swift/Method/init(rawValue:)" class="dashAnchor"></a>
<a class="token" href="#/s:SY8rawValuexSg03RawB0Qz_tcfc">init(rawValue:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">rawValue</span><span class="p">:</span> <span class="kt">Double</span><span class="p">)</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/chris-araman/CombineCloudKit/tree/1b65f25755f4371f11f19b1e3e542f1c127812ed/Sources/CombineCloudKit/Progress.swift#L39-L47">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -191,7 +332,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/chris-araman/CombineCloudKit/tree/83f5f812d4e9806bc62d02016d55d686badf329f/Sources/CombineCloudKit/Progress.swift#L19-L33">Show on GitHub</a>
<a href="https://github.com/chris-araman/CombineCloudKit/tree/1b65f25755f4371f11f19b1e3e542f1c127812ed/Sources/CombineCloudKit/Progress.swift#L51-L53">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -204,7 +345,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2021 <a class="link" href="https://github.com/chris-araman" target="_blank" rel="external">Chris Araman</a>. All rights reserved. (Last updated: 2021-06-14)</p>
<p>&copy; 2021 <a class="link" href="https://github.com/chris-araman" target="_blank" rel="external">Chris Araman</a>. All rights reserved. (Last updated: 2021-06-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
4 changes: 2 additions & 2 deletions docs/Extensions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
CombineCloudKit 0.4.1-1-g83f5f81 Docs
CombineCloudKit 0.5.0 Docs
</a>
(100% documented)
</p>
Expand Down Expand Up @@ -184,7 +184,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2021 <a class="link" href="https://github.com/chris-araman" target="_blank" rel="external">Chris Araman</a>. All rights reserved. (Last updated: 2021-06-14)</p>
<p>&copy; 2021 <a class="link" href="https://github.com/chris-araman" target="_blank" rel="external">Chris Araman</a>. All rights reserved. (Last updated: 2021-06-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
8 changes: 4 additions & 4 deletions docs/Protocols.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
CombineCloudKit 0.4.1-1-g83f5f81 Docs
CombineCloudKit 0.5.0 Docs
</a>
(100% documented)
</p>
Expand Down Expand Up @@ -135,7 +135,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/chris-araman/CombineCloudKit/tree/83f5f812d4e9806bc62d02016d55d686badf329f/Sources/CombineCloudKit/Protocols/CCKContainer.swift#L23-L26">Show on GitHub</a>
<a href="https://github.com/chris-araman/CombineCloudKit/tree/1b65f25755f4371f11f19b1e3e542f1c127812ed/Sources/CombineCloudKit/Protocols/CCKContainer.swift#L23-L26">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -179,7 +179,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/chris-araman/CombineCloudKit/tree/83f5f812d4e9806bc62d02016d55d686badf329f/Sources/CombineCloudKit/Protocols/CCKDatabase.swift#L23-L73">Show on GitHub</a>
<a href="https://github.com/chris-araman/CombineCloudKit/tree/1b65f25755f4371f11f19b1e3e542f1c127812ed/Sources/CombineCloudKit/Protocols/CCKDatabase.swift#L23-L73">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -192,7 +192,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2021 <a class="link" href="https://github.com/chris-araman" target="_blank" rel="external">Chris Araman</a>. All rights reserved. (Last updated: 2021-06-14)</p>
<p>&copy; 2021 <a class="link" href="https://github.com/chris-araman" target="_blank" rel="external">Chris Araman</a>. All rights reserved. (Last updated: 2021-06-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
Loading

0 comments on commit 42593e6

Please sign in to comment.