GitHub/SwiftShell
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation.

Browse Source
This commit is contained in:
Kare Morstol
2018-01-30 16:33:24 +01:00
parent 1d31d9aacb
commit 3ef0d7eee1
67 changed files with 5338 additions and 2823 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docsets/SwiftShell.docset/Contents/Resources/Documents/Extensions/Process.html
+35 -32
View File
@@ -14,7 +14,7 @@
<a title="Process Extension 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> (67% 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>
@@ -43,6 +43,12 @@
<li class="nav-group-task">
<a href="../Classes/RunOutput.html">RunOutput</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Signals.html">Signals</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Signals/Signal.html">– Signal</a>
</li>
<li class="nav-group-task">
<a href="../Classes/StdoutStream.html">StdoutStream</a>
</li>
@@ -52,15 +58,15 @@
<a href="../Global Variables.html">Global Variables</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Global Variables.html#/s:v10SwiftShell5FilesCSo11FileManager">Files</a>
<a href="../Global Variables.html#/s:10SwiftShell5FilesSo11FileManagerCv">Files</a>
</li>
<li class="nav-group-task">
<a href="../Global Variables.html#/s:v10SwiftShell4mainCS_11MainContext">main</a>
<a href="../Global Variables.html#/s:10SwiftShell4mainAA11MainContextCv">main</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Enums.html">Enums</a>
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/CommandError.html">CommandError</a>
@@ -94,49 +100,49 @@
<a href="../Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShelloi1pFTV10Foundation3URLSS_S1_">+(_:_:)</a>
<a href="../Functions.html#/s:10SwiftShell1poi10Foundation3URLVAE_SStF">+(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShelloi2eeFTOS_12CommandErrorS0__Sb">==(_:_:)</a>
<a href="../Functions.html#/s:10SwiftShell2eeoiSbAA12CommandErrorO_ADtF">==(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell4exitFTPs5Error_4fileSS4lineSi_Os5Never">exit(_:file:line:)</a>
<a href="../Functions.html#/s:10SwiftShell4exits5NeverOs5Error_p_SS4fileSi4linetF">exit(_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell4exiturFT12errormessagex9errorcodeSi4fileSS4lineSi_Os5Never">exit(errormessage:errorcode:file:line:)</a>
<a href="../Functions.html#/s:10SwiftShell4exits5NeverOx12errormessage_Si9errorcodeSS4fileSi4linetlF">exit(errormessage:errorcode:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell4openFzTSS8encodingVE10FoundationSS8Encoding_PS_14ReadableStream_">open(_:encoding:)</a>
<a href="../Functions.html#/s:10SwiftShell4openAA14ReadableStream_p10Foundation3URLV_SSADE8EncodingV8encodingtKF">open(_:encoding:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell4openFzTV10Foundation3URL8encodingVES0_SS8Encoding_PS_14ReadableStream_">open(_:encoding:)</a>
<a href="../Functions.html#/s:10SwiftShell4openAA14ReadableStream_pSS_SS10FoundationE8EncodingV8encodingtKF">open(_:encoding:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell4openFzT10forWritingSS9overwriteSb8encodingVE10FoundationSS8Encoding_PS_14WritableStream_">open(forWriting:overwrite:encoding:)</a>
<a href="../Functions.html#/s:10SwiftShell4openAA14WritableStream_p10Foundation3URLV10forWriting_Sb9overwriteSSADE8EncodingV8encodingtKF">open(forWriting:overwrite:encoding:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell4openFzT10forWritingV10Foundation3URL9overwriteSb8encodingVES0_SS8Encoding_PS_14WritableStream_">open(forWriting:overwrite:encoding:)</a>
<a href="../Functions.html#/s:10SwiftShell4openAA14WritableStream_pSS10forWriting_Sb9overwriteSS10FoundationE8EncodingV8encodingtKF">open(forWriting:overwrite:encoding:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell3runFTSSGSaP__13combineOutputSb_CS_9RunOutput">run(_:_:combineOutput:)</a>
<a href="../Functions.html#/s:10SwiftShell3runAA9RunOutputCSS_SayypGdSb07combineE0tF">run(_:_:combineOutput:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell3runFT4bashSS13combineOutputSb_CS_9RunOutput">run(bash:combineOutput:)</a>
<a href="../Functions.html#/s:10SwiftShell3runAA9RunOutputCSS4bash_Sb07combineE0tF">run(bash:combineOutput:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell11runAndPrintFztSSGSaP___T_">runAndPrint(_:_:)</a>
<a href="../Functions.html#/s:10SwiftShell11runAndPrintySS_SayypGdtKF">runAndPrint(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell11runAndPrintFzT4bashSS_T_">runAndPrint(bash:)</a>
<a href="../Functions.html#/s:10SwiftShell11runAndPrintySS4bash_tKF">runAndPrint(bash:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell8runAsyncFTSSGSaP__4fileSS4lineSi_CS_12AsyncCommand">runAsync(_:_:file:line:)</a>
<a href="../Functions.html#/s:10SwiftShell8runAsyncAA0D7CommandCSS_SayypGdSS4fileSi4linetF">runAsync(_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell8runAsyncFT4bashSS4fileSS4lineSi_CS_12AsyncCommand">runAsync(bash:file:line:)</a>
<a href="../Functions.html#/s:10SwiftShell8runAsyncAA0D7CommandCSS4bash_SS4fileSi4linetF">runAsync(bash:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell7streamsFT_TPS_14WritableStream_PS_14ReadableStream__">streams()</a>
<a href="../Functions.html#/s:10SwiftShell7streamsAA14WritableStream_p_AA08ReadableE0_ptyF">streams()</a>
</li>
</ul>
</li>
@@ -161,7 +167,7 @@
</ul>
</li>
<li class="nav-group-name">
<a href="../Structs.html">Structs</a>
<a href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/CustomContext.html">CustomContext</a>
@@ -180,8 +186,7 @@
<section>
<section class="section">
<h1>Process</h1>
<p>Undocumented</p>
</section>
<section class="section task-group-section">
<div class="task-group">
@@ -189,9 +194,9 @@
<li class="item">
<div>
<code>
<a name="/s:FE10SwiftShellCSo7Process15launchThrowablyFzT_T_"></a>
<a name="/s:So7ProcessC10SwiftShellE15launchThrowablyyyKF"></a>
<a name="//apple_ref/swift/Method/launchThrowably()" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo7Process15launchThrowablyFzT_T_">launchThrowably()</a>
<a class="token" href="#/s:So7ProcessC10SwiftShellE15launchThrowablyyyKF">launchThrowably()</a>
</code>
</div>
<div class="height-container">
@@ -200,7 +205,6 @@
<div class="pointer"></div>
<div class="abstract">
<p>Launch process.</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
CommandError.inAccessibleExecutable if command could not be executed.
@@ -212,7 +216,7 @@
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">launchThrowably</span><span class="p">()</span> <span class="k">throws</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">launchThrowably</span><span class="p">()</span> <span class="k">throws</span></code></pre>
</div>
</div>
@@ -222,9 +226,9 @@
<li class="item">
<div>
<code>
<a name="/s:FE10SwiftShellCSo7Process6finishFzT_T_"></a>
<a name="/s:So7ProcessC10SwiftShellE6finishyyKF"></a>
<a name="//apple_ref/swift/Method/finish()" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo7Process6finishFzT_T_">finish()</a>
<a class="token" href="#/s:So7ProcessC10SwiftShellE6finishyyKF">finish()</a>
</code>
</div>
<div class="height-container">
@@ -233,7 +237,6 @@
<div class="pointer"></div>
<div class="abstract">
<p>Wait until process is finished.</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
<code>CommandError.returnedErrorCode(command: String, errorcode: Int)</code> if the exit code is anything but 0.
@@ -245,7 +248,7 @@
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">finish</span><span class="p">()</span> <span class="k">throws</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">finish</span><span class="p">()</span> <span class="k">throws</span></code></pre>
</div>
</div>
@@ -257,8 +260,8 @@
</section>
</section>
<section id="footer">
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2017-04-28)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-01-30)</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>
</div>