Update documentation.

This commit is contained in:
Kare Morstol
2018-03-04 17:25:54 +01:00
parent a7c41d63ef
commit 1bd7fd623c
56 changed files with 81 additions and 139 deletions
@@ -314,6 +314,11 @@
<div class="pointer"></div>
<div class="abstract">
<p>Wait for this command to finish.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
Will hang if the unread output of either standard output or standard error is larger than 64KB (<a href="https://github.com/kareman/SwiftShell/issues/52">#52</a>). To work around this problem, read all the output first, even if you&rsquo;re not going to use it.
</div>
<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.
@@ -331,7 +336,7 @@
</div>
<div>
<h4>Return Value</h4>
<p>itself</p>
<p>self</p>
</div>
</section>
</div>
@@ -418,7 +423,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-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</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>