Skip to content
This repository has been archived by the owner on Aug 30, 2022. It is now read-only.

Commit

Permalink
Updated docs with Jazzy.
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark Johnson authored and mjohnson12 committed Oct 25, 2019
1 parent 7e1eae6 commit 430a2d2
Show file tree
Hide file tree
Showing 23 changed files with 116 additions and 60 deletions.
6 changes: 3 additions & 3 deletions docs/Classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L14-L132">Show on GitHub</a>
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L14-L161">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -154,7 +154,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Sign/EosioEccSign.swift#L15-L100">Show on GitHub</a>
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Sign/EosioEccSign.swift#L15-L117">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -168,7 +168,7 @@ <h4>Declaration</h4>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
8 changes: 4 additions & 4 deletions docs/Classes/EccRecoverKey.html
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ <h4>Return Value</h4>
<p>The public key.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L28-L63">Show on GitHub</a>
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L28-L78">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -288,7 +288,7 @@ <h4>Return Value</h4>
<p>The public key.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L74-L111">Show on GitHub</a>
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L89-L140">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -382,7 +382,7 @@ <h4>Return Value</h4>
<p>The recovery id (0-3).</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L122-L130">Show on GitHub</a>
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L151-L159">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -396,7 +396,7 @@ <h4>Return Value</h4>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Classes/EosioEccSign.html
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ <h4>Return Value</h4>
<p>A signature (header byte + r + s).</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Sign/EosioEccSign.swift#L27-L98">Show on GitHub</a>
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Sign/EosioEccSign.swift#L27-L115">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -190,7 +190,7 @@ <h4>Return Value</h4>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Enums.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h4>Declaration</h4>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Enums/EllipticCurveType.html
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ <h4>Parameters</h4>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Structs.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h4>Declaration</h4>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Structs/EcdsaSignature.html
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ <h4>Parameters</h4>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
6 changes: 6 additions & 0 deletions docs/css/jazzy.css
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,7 @@ pre code {

html.dash .header, html.dash .breadcrumbs, html.dash .navigation {
display: none; }

html.dash .height-container {
display: block; }

Expand All @@ -342,14 +343,17 @@ form[role=search] input {
border-radius: 1em; }
.loading form[role=search] input {
background: white url(../img/spinner.gif) center right 4px no-repeat; }

form[role=search] .tt-menu {
margin: 0;
min-width: 300px;
background: #fbfbfb;
color: #333;
border: 1px solid #ddd; }

form[role=search] .tt-highlight {
font-weight: bold; }

form[role=search] .tt-suggestion {
font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif;
padding: 0 8px; }
Expand All @@ -362,11 +366,13 @@ form[role=search] .tt-suggestion {
font-weight: normal;
font-size: 0.9em;
padding-left: 16px; }

form[role=search] .tt-suggestion:hover,
form[role=search] .tt-suggestion.tt-cursor {
cursor: pointer;
background-color: #4183c4;
color: #fff; }

form[role=search] .tt-suggestion:hover .doc-parent-name,
form[role=search] .tt-suggestion.tt-cursor .doc-parent-name {
color: #fff; }
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L14-L132">Show on GitHub</a>
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L14-L161">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -154,7 +154,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Sign/EosioEccSign.swift#L15-L100">Show on GitHub</a>
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Sign/EosioEccSign.swift#L15-L117">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -168,7 +168,7 @@ <h4>Declaration</h4>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ <h4>Return Value</h4>
<p>The public key.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L28-L63">Show on GitHub</a>
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L28-L78">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -288,7 +288,7 @@ <h4>Return Value</h4>
<p>The public key.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L74-L111">Show on GitHub</a>
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L89-L140">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -382,7 +382,7 @@ <h4>Return Value</h4>
<p>The recovery id (0-3).</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L122-L130">Show on GitHub</a>
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Recover/EccRecoverKey.swift#L151-L159">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -396,7 +396,7 @@ <h4>Return Value</h4>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ <h4>Return Value</h4>
<p>A signature (header byte + r + s).</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Sign/EosioEccSign.swift#L27-L98">Show on GitHub</a>
<a href="https://github.com/EOSIO/eosio-swift-ecc/tree/master/EosioSwiftEcc/Sign/EosioEccSign.swift#L27-L115">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -190,7 +190,7 @@ <h4>Return Value</h4>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h4>Declaration</h4>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ <h4>Parameters</h4>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h4>Declaration</h4>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ <h4>Parameters</h4>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,7 @@ pre code {

html.dash .header, html.dash .breadcrumbs, html.dash .navigation {
display: none; }

html.dash .height-container {
display: block; }

Expand All @@ -342,14 +343,17 @@ form[role=search] input {
border-radius: 1em; }
.loading form[role=search] input {
background: white url(../img/spinner.gif) center right 4px no-repeat; }

form[role=search] .tt-menu {
margin: 0;
min-width: 300px;
background: #fbfbfb;
color: #333;
border: 1px solid #ddd; }

form[role=search] .tt-highlight {
font-weight: bold; }

form[role=search] .tt-suggestion {
font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif;
padding: 0 8px; }
Expand All @@ -362,11 +366,13 @@ form[role=search] .tt-suggestion {
font-weight: normal;
font-size: 0.9em;
padding-left: 16px; }

form[role=search] .tt-suggestion:hover,
form[role=search] .tt-suggestion.tt-cursor {
cursor: pointer;
background-color: #4183c4;
color: #fff; }

form[role=search] .tt-suggestion:hover .doc-parent-name,
form[role=search] .tt-suggestion.tt-cursor .doc-parent-name {
color: #fff; }
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ <h2 id='installation' class='heading'>Installation</h2>
<pre class="highlight ruby"><code><span class="n">use_frameworks!</span>

<span class="n">target</span> <span class="s2">"Your Target"</span> <span class="k">do</span>
<span class="n">pod</span> <span class="s2">"EosioSwiftEcc"</span><span class="p">,</span> <span class="s2">"~&gt; 0.1.3"</span>
<span class="n">pod</span> <span class="s2">"EosioSwiftEcc"</span><span class="p">,</span> <span class="s2">"~&gt; 0.2.0"</span>
<span class="k">end</span>
</code></pre>

Expand Down Expand Up @@ -153,7 +153,7 @@ <h2 id='important' class='heading'>Important</h2>
</div>
<section class="footer">
<p>Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.</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>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Loading

0 comments on commit 430a2d2

Please sign in to comment.