Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@aaplmath
aaplmath committed Jul 24, 2020
1 parent aabe732 commit 9d4a4c5
Show file tree
Hide file tree
Showing 34 changed files with 4,217 additions and 229 deletions.
18 changes: 13 additions & 5 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,23 @@
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>

<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">CaffeineKit Docs</a> (100% documented)</p>
<p><a href="index.html">CaffeineKit 0.3.2 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/aaplmath/CaffeineKit"><img src="img/gh.png"/>View on GitHub</a></p>
<p class="header-right"><a href="dash-feed://https%3A%2F%2Faaplmath%2Egithub%2Eio%2FCaffeineKit%2Fdocsets%2FCaffeineKit%2Exml"><img src="img/dash.png"/>Install in Dash</a></p>
<p class="header-right"><a href="dash-feed://https%3A%2F%2Faaplmath.github.io%2FCaffeineKit%2Fdocsets%2FCaffeineKit.xml"><img src="img/dash.png"/>Install in Dash</a></p>
<p class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -89,7 +97,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Caffeination.swift#L12-L347">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Caffeination.swift#L12-L355">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -99,8 +107,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>Copyright &copy; 2019 aaplmath. CaffeineKit is made available under the <a class="link" href="https://github.com/aaplmath/CaffeineKit/blob/master/LICENSE" target="_blank" rel="external">MIT License</a>.</p>
<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>
<p>Copyright &copy; 2020 aaplmath. CaffeineKit is made available under the <a class="link" href="https://github.com/aaplmath/CaffeineKit/blob/master/LICENSE" target="_blank" rel="external">MIT License</a>.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
87 changes: 51 additions & 36 deletions docs/Classes/Caffeination.html
View file

Large diffs are not rendered by default.

61 changes: 39 additions & 22 deletions docs/Classes/Caffeination/Opt.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,23 @@
<script src="../../js/jquery.min.js" defer></script>
<script src="../../js/jazzy.js" defer></script>

<script src="../../js/lunr.min.js" defer></script>
<script src="../../js/typeahead.jquery.js" defer></script>
<script src="../../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Enum/Opt" class="dashAnchor"></a>
<a title="Opt Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../../index.html">CaffeineKit Docs</a> (100% documented)</p>
<p><a href="../../index.html">CaffeineKit 0.3.2 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/aaplmath/CaffeineKit"><img src="../../img/gh.png"/>View on GitHub</a></p>
<p class="header-right"><a href="dash-feed://https%3A%2F%2Faaplmath%2Egithub%2Eio%2FCaffeineKit%2Fdocsets%2FCaffeineKit%2Exml"><img src="../../img/dash.png"/>Install in Dash</a></p>
<p class="header-right"><a href="dash-feed://https%3A%2F%2Faaplmath.github.io%2FCaffeineKit%2Fdocsets%2FCaffeineKit.xml"><img src="../../img/dash.png"/>Install in Dash</a></p>
<p class="header-right">
<form role="search" action="../../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -59,12 +67,21 @@
<h1>Opt</h1>
<div class="declaration">
<div class="language">

<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Opt</span></code></pre>

</div>
</div>
<p>An customization option for a <code><a href="../../Classes/Caffeination.html">Caffeination</a></code>.</p>
<p>A customization option for a <code><a href="../../Classes/Caffeination.html">Caffeination</a></code>.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
Any given <code><a href="../../Classes/Caffeination.html">Caffeination</a></code> can be passed only <strong>one</strong> of each <code>Opt</code>. So, for instance, it is valid to pass a <code>.timed</code> and <code>.process</code> Opt; however, it is not possible to have two different <code>.process</code> Opts.

</div>

<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Caffeination.swift#L18-L174">Show on GitHub</a>
</div>
</section>
<section class="section task-group-section">
<div class="task-group">
Expand Down Expand Up @@ -94,7 +111,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Caffeination.swift#L17">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Caffeination.swift#L20">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -124,7 +141,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Caffeination.swift#L20">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Caffeination.swift#L23">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -154,7 +171,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Caffeination.swift#L23">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Caffeination.swift#L26">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -189,7 +206,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Caffeination.swift#L29">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Caffeination.swift#L32">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -224,7 +241,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Caffeination.swift#L35">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Caffeination.swift#L38">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -234,7 +251,7 @@ <h4>Declaration</h4>
<code>
<a name="/s:11CaffeineKit12CaffeinationC3OptO7processyAEs5Int32VcAEmF"></a>
<a name="//apple_ref/swift/Element/process(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CaffeineKit12CaffeinationC3OptO7processyAEs5Int32VcAEmF">process(_:)</a>
<a class="token" href="#/s:11CaffeineKit12CaffeinationC3OptO7processyAEs5Int32VcAEmF">process(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -254,7 +271,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Caffeination.swift#L38">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Caffeination.swift#L41">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -264,7 +281,7 @@ <h4>Declaration</h4>
<code>
<a name="/s:11CaffeineKit12CaffeinationC3OptO5timedyAESdcAEmF"></a>
<a name="//apple_ref/swift/Element/timed(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CaffeineKit12CaffeinationC3OptO5timedyAESdcAEmF">timed(_:)</a>
<a class="token" href="#/s:11CaffeineKit12CaffeinationC3OptO5timedyAESdcAEmF">timed(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -284,7 +301,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Caffeination.swift#L41">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Caffeination.swift#L44">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -314,7 +331,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Caffeination.swift#L44-L48">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Caffeination.swift#L47-L51">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -344,7 +361,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Caffeination.swift#L51-L70">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Caffeination.swift#L54-L73">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -354,7 +371,7 @@ <h4>Declaration</h4>
<code>
<a name="/s:11CaffeineKit12CaffeinationC3OptO4fromyAESgSSFZ"></a>
<a name="//apple_ref/swift/Method/from(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CaffeineKit12CaffeinationC3OptO4fromyAESgSSFZ">from(_:)</a>
<a class="token" href="#/s:11CaffeineKit12CaffeinationC3OptO4fromyAESgSSFZ">from(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -402,7 +419,7 @@ <h4>Return Value</h4>
<p>An <code>Opt</code> corresponding to the argument passed, or <code>nil</code> if the argument was not recognized.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Caffeination.swift#L78-L93">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Caffeination.swift#L81-L96">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -412,7 +429,7 @@ <h4>Return Value</h4>
<code>
<a name="/s:11CaffeineKit12CaffeinationC3OptO4fromyAESgSaySSGFZ"></a>
<a name="//apple_ref/swift/Method/from(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CaffeineKit12CaffeinationC3OptO4fromyAESgSaySSGFZ">from(_:)</a>
<a class="token" href="#/s:11CaffeineKit12CaffeinationC3OptO4fromyAESgSaySSGFZ">from(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -467,7 +484,7 @@ <h4>Return Value</h4>
<p>An <code>Opt</code> corresponding to the argument, or <code>nil</code>.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Caffeination.swift#L105-L125">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Caffeination.swift#L108-L128">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -477,7 +494,7 @@ <h4>Return Value</h4>
<code>
<a name="/s:11CaffeineKit12CaffeinationC3OptO5array4fromSayAEGSgSaySSG_tFZ"></a>
<a name="//apple_ref/swift/Method/array(from:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CaffeineKit12CaffeinationC3OptO5array4fromSayAEGSgSaySSG_tFZ">array(from:)</a>
<a class="token" href="#/s:11CaffeineKit12CaffeinationC3OptO5array4fromSayAEGSgSaySSG_tFZ">array(from:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -531,7 +548,7 @@ <h4>Return Value</h4>
<p>An array of <code>Opt</code>s corresponding to the values passed, or <code>nil</code>.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Caffeination.swift#L136-L170">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Caffeination.swift#L139-L173">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -541,8 +558,8 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>Copyright &copy; 2019 aaplmath. CaffeineKit is made available under the <a class="link" href="https://github.com/aaplmath/CaffeineKit/blob/master/LICENSE" target="_blank" rel="external">MIT License</a>.</p>
<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>
<p>Copyright &copy; 2020 aaplmath. CaffeineKit is made available under the <a class="link" href="https://github.com/aaplmath/CaffeineKit/blob/master/LICENSE" target="_blank" rel="external">MIT License</a>.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
20 changes: 14 additions & 6 deletions docs/Enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,23 @@
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>

<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Enumerations" class="dashAnchor"></a>
<a title="Enumerations Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">CaffeineKit Docs</a> (100% documented)</p>
<p><a href="index.html">CaffeineKit 0.3.2 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/aaplmath/CaffeineKit"><img src="img/gh.png"/>View on GitHub</a></p>
<p class="header-right"><a href="dash-feed://https%3A%2F%2Faaplmath%2Egithub%2Eio%2FCaffeineKit%2Fdocsets%2FCaffeineKit%2Exml"><img src="img/dash.png"/>Install in Dash</a></p>
<p class="header-right"><a href="dash-feed://https%3A%2F%2Faaplmath.github.io%2FCaffeineKit%2Fdocsets%2FCaffeineKit.xml"><img src="img/dash.png"/>Install in Dash</a></p>
<p class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -89,7 +97,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Enums.swift#L9-L34">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Enums.swift#L9-L34">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -120,7 +128,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.0/Sources/CaffeineKit/Enums.swift#L37-L43">Show on GitHub</a>
<a href="https://github.com/aaplmath/CaffeineKit/tree/v0.3.2/Sources/CaffeineKit/Enums.swift#L37-L46">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -130,8 +138,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>Copyright &copy; 2019 aaplmath. CaffeineKit is made available under the <a class="link" href="https://github.com/aaplmath/CaffeineKit/blob/master/LICENSE" target="_blank" rel="external">MIT License</a>.</p>
<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>
<p>Copyright &copy; 2020 aaplmath. CaffeineKit is made available under the <a class="link" href="https://github.com/aaplmath/CaffeineKit/blob/master/LICENSE" target="_blank" rel="external">MIT License</a>.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
Loading

0 comments on commit 9d4a4c5

Please sign in to comment.