Update documentation.

This commit is contained in:
Kare Morstol
2018-04-18 00:56:44 +02:00
parent 1bd7fd623c
commit 4b25e7d10b
60 changed files with 3158 additions and 1341 deletions
+51 -12
View File
@@ -13,7 +13,7 @@
<a title="Extensions Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">SwiftShell Docs</a> (70% documented)</p>
<p><a href="index.html">SwiftShell Docs</a> (73% documented)</p>
<p class="header-right"><a href="https://github.com/kareman/SwiftShell"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
@@ -39,6 +39,9 @@
<li class="nav-group-task">
<a href="Classes/MainContext.html">MainContext</a>
</li>
<li class="nav-group-task">
<a href="Classes/PrintedAsyncCommand.html">PrintedAsyncCommand</a>
</li>
<li class="nav-group-task">
<a href="Classes/RunOutput.html">RunOutput</a>
</li>
@@ -51,10 +54,10 @@
<a href="Global Variables.html">Global Variables</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Global Variables.html#/s:10SwiftShell5FilesSo11FileManagerCv">Files</a>
<a href="Global Variables.html#/s:10SwiftShell5FilesSo11FileManagerCvp">Files</a>
</li>
<li class="nav-group-task">
<a href="Global Variables.html#/s:10SwiftShell4mainAA11MainContextCv">main</a>
<a href="Global Variables.html#/s:10SwiftShell4mainAA11MainContextCvp">main</a>
</li>
</ul>
</li>
@@ -84,6 +87,9 @@
<li class="nav-group-task">
<a href="Extensions/Process.html">Process</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Process.html">Process</a>
</li>
<li class="nav-group-task">
<a href="Extensions/String.html">String</a>
</li>
@@ -95,9 +101,6 @@
<li class="nav-group-task">
<a href="Functions.html#/s:10SwiftShell1poi10Foundation3URLVAE_SStF">+(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:10SwiftShell2eeoiSbAA12CommandErrorO_ADtF">==(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:10SwiftShell4exits5NeverOs5Error_p_SS4fileSi4linetF">exit(_:file:line:)</a>
</li>
@@ -117,23 +120,29 @@
<a href="Functions.html#/s:10SwiftShell4openAA14WritableStream_pSS10forWriting_Sb9overwriteSS10FoundationE8EncodingV8encodingtKF">open(forWriting:overwrite:encoding:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:10SwiftShell3runAA9RunOutputCSS_SayypGdSb07combineE0tF">run(_:_:combineOutput:)</a>
<a href="Functions.html#/s:10SwiftShell3runAA9RunOutputCSS_ypdSb07combineE0tF">run(_:_:combineOutput:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:10SwiftShell3runAA9RunOutputCSS4bash_Sb07combineE0tF">run(bash:combineOutput:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:10SwiftShell11runAndPrintySS_SayypGdtKF">runAndPrint(_:_:)</a>
<a href="Functions.html#/s:10SwiftShell11runAndPrintySS_ypdtKF">runAndPrint(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:10SwiftShell11runAndPrintySS4bash_tKF">runAndPrint(bash:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:10SwiftShell8runAsyncAA0D7CommandCSS_SayypGdSS4fileSi4linetF">runAsync(_:_:file:line:)</a>
<a href="Functions.html#/s:10SwiftShell8runAsyncAA0D7CommandCSS_ypdSS4fileSi4linetF">runAsync(_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:10SwiftShell8runAsyncAA0D7CommandCSS4bash_SS4fileSi4linetF">runAsync(bash:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:10SwiftShell16runAsyncAndPrintAA07PrintedD7CommandCSS_ypdSS4fileSi4linetF">runAsyncAndPrint(_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:10SwiftShell16runAsyncAndPrintAA07PrintedD7CommandCSS4bash_SS4fileSi4linetF">runAsyncAndPrint(bash:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:10SwiftShell7streamsAA14WritableStream_p_AA08ReadableE0_ptyF">streams()</a>
</li>
@@ -213,6 +222,36 @@
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Process%20extensions%20for%20Linux"></a>
<a name="//apple_ref/swift/Section/Process extensions for Linux" class="dashAnchor"></a>
<a href="#/Process%20extensions%20for%20Linux">
<h3 class="section-name">Process extensions for Linux</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/"></a>
<a name="//apple_ref/swift/Extension/Process" class="dashAnchor"></a>
<a class="token" href="#/">Process</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<a href="Extensions/Process.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
@@ -270,7 +309,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Let Strings run commands using itself as stdin.</p>
<p>Lets String run commands using itself as stdin.</p>
<a href="Extensions/String.html" class="slightly-smaller">See more</a>
</div>
@@ -309,7 +348,7 @@
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">LazyCollectionProtocol</span> <span class="p">:</span> <span class="kt">Collection</span><span class="p">,</span> <span class="kt">LazySequenceProtocol</span></code></pre>
<pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">LazyCollectionProtocol</span> <span class="p">:</span> <span class="kt">Collection</span><span class="p">,</span> <span class="kt">LazySequenceProtocol</span> <span class="k">where</span> <span class="k">Self</span><span class="o">.</span><span class="kt">Elements</span> <span class="p">:</span> <span class="kt">Collection</span></code></pre>
</div>
</div>
@@ -321,7 +360,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-04-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>