Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Jazzy documentation #9

Merged
merged 2 commits into from
Nov 17, 2021
Merged

Add Jazzy documentation #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92cdbb9
Include docs folder in project
nicorichard Nov 17, 2021
70c951e
Merge branch 'code-commenting' into code-commenting-docs
nicorichard Nov 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .jazzy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
author: SkipTheDishes
author_url: https://www.skipthedishes.com
github_url: https://github.com/justeattakeaway/Genything
output: docs
228 changes: 228 additions & 0 deletions docs/Classes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,228 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Classes Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<link rel="stylesheet" type="text/css" href="css/katex.min.css" />
<meta charset='utf-8'>
<script src="js/jquery.min.js" defer></script>
<script src="js/katex.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">Genything 0.0.2 Docs</a> (63% documented)</p>
<p class="header-right"><a href="https://github.com/justeattakeaway/Genything"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</div>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">Genything Reference</a>
<img id="carat" src="img/carat.png" alt=""/>
Classes Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/Context.html">Context</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/ContextDefaults.html">ContextDefaults</a>
</li>
<li class="nav-group-task">
<a href="Enums/Determinism.html">Determinism</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Extensions/AnyBidirectionalCollection.html">AnyBidirectionalCollection</a>
</li>
<li class="nav-group-task">
<a href="Extensions/AnySequence.html">AnySequence</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Array.html">Array</a>
</li>
<li class="nav-group-task">
<a href="Extensions/ArraySlice.html">ArraySlice</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Bool.html">Bool</a>
</li>
<li class="nav-group-task">
<a href="Extensions/CGFloat.html">CGFloat</a>
</li>
<li class="nav-group-task">
<a href="Extensions/CLLocationCoordinate2D.html">CLLocationCoordinate2D</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Character.html">Character</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Date.html">Date</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Dictionary.html">Dictionary</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Double.html">Double</a>
</li>
<li class="nav-group-task">
<a href="Extensions/EmptyCollection.html">EmptyCollection</a>
</li>
<li class="nav-group-task">
<a href="Extensions.html#/s:Sf">Float</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Int.html">Int</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Int32.html">Int32</a>
</li>
<li class="nav-group-task">
<a href="Extensions.html#/s:s5Int64V">Int64</a>
</li>
<li class="nav-group-task">
<a href="Extensions/LazySequence.html">LazySequence</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Optional.html">Optional</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Range.html">Range</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Repeated.html">Repeated</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Result.html">Result</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Set.html">Set</a>
</li>
<li class="nav-group-task">
<a href="Extensions/String.html">String</a>
</li>
<li class="nav-group-task">
<a href="Extensions/UInt.html">UInt</a>
</li>
<li class="nav-group-task">
<a href="Extensions/UInt32.html">UInt32</a>
</li>
<li class="nav-group-task">
<a href="Extensions/UUID.html">UUID</a>
</li>
<li class="nav-group-task">
<a href="Extensions/UnicodeScalar.html">UnicodeScalar</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/Arbitrary.html">Arbitrary</a>
</li>
<li class="nav-group-task">
<a href="Protocols/RandomInRangeable.html">RandomInRangeable</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/AnyRandomNumberGenerator.html">AnyRandomNumberGenerator</a>
</li>
<li class="nav-group-task">
<a href="Structs/Gen.html">Gen</a>
</li>
<li class="nav-group-task">
<a href="Structs/Gen/GenComposer.html">– GenComposer</a>
</li>
<li class="nav-group-task">
<a href="Structs/Gen/FilterError.html">– FilterError</a>
</li>
<li class="nav-group-task">
<a href="Structs/LCRNG.html">LCRNG</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Classes</h1>
<p>The following classes are available globally.</p>

</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:9Genything7ContextC"></a>
<a name="//apple_ref/swift/Class/Context" class="dashAnchor"></a>
<a class="token" href="#/s:9Genything7ContextC">Context</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>

<a href="Classes/Context.html" class="slightly-smaller">See more</a>
</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">class</span> <span class="kt">Context</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://www.skipthedishes.com" target="_blank" rel="external noopener">SkipTheDishes</a>. All rights reserved. (Last updated: 2021-11-17)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</html>
Loading