API doc update.

This commit is contained in:
Erik C. Thauvin 2021-10-18 16:30:53 -07:00
parent 7b77066980
commit aecca250ca
3 changed files with 8 additions and 9 deletions

View file

@ -146,7 +146,7 @@
<h2>Methods</h2>
<dl class="callables">
<dt id="addMessage" class="callable">
<span class="name"><a href="../dcat/CatResult/addMessage.html">addMessage</a></span><span class="signature">(<wbr><span class="parameter" id="addMessage-param-exitCode"><span class="type-annotation"><a href="https://api.dart.dev/stable/2.14.4/dart-core/int-class.html">int</a></span> <span class="parameter-name">exitCode</span>, </span><span class="parameter" id="addMessage-param-message"><span class="type-annotation"><a href="https://api.dart.dev/stable/2.14.4/dart-core/String-class.html">String</a></span> <span class="parameter-name">message</span>, </span><span class="parameter" id="addMessage-param-path">{<span class="type-annotation"><a href="https://api.dart.dev/stable/2.14.4/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">path</span>}</span>)
<span class="name"><a href="../dcat/CatResult/addMessage.html">addMessage</a></span><span class="signature">(<wbr><span class="parameter" id="addMessage-param-message"><span class="type-annotation"><a href="https://api.dart.dev/stable/2.14.4/dart-core/String-class.html">String</a></span> <span class="parameter-name">message</span>, </span><span class="parameter" id="addMessage-param-path">{<span class="type-annotation"><a href="https://api.dart.dev/stable/2.14.4/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">path</span>}</span>)
<span class="returntype parameter">&#8594; void</span>
</span>

View file

@ -53,8 +53,7 @@
<span class="returntype">void</span>
<span class="name ">addMessage</span>(<wbr><ol class="parameter-list"><li><span class="parameter" id="addMessage-param-exitCode"><span class="type-annotation"><a href="https://api.dart.dev/stable/2.14.4/dart-core/int-class.html">int</a></span> <span class="parameter-name">exitCode</span>, </span></li>
<li><span class="parameter" id="addMessage-param-message"><span class="type-annotation"><a href="https://api.dart.dev/stable/2.14.4/dart-core/String-class.html">String</a></span> <span class="parameter-name">message</span>, </span></li>
<span class="name ">addMessage</span>(<wbr><ol class="parameter-list"><li><span class="parameter" id="addMessage-param-message"><span class="type-annotation"><a href="https://api.dart.dev/stable/2.14.4/dart-core/String-class.html">String</a></span> <span class="parameter-name">message</span>, </span></li>
<li><span class="parameter" id="addMessage-param-path">{<span class="type-annotation"><a href="https://api.dart.dev/stable/2.14.4/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">path</span>}</span></li>
</ol>)
@ -70,8 +69,8 @@
<section class="summary source-code" id="source">
<h2><span>Implementation</span></h2>
<pre class="language-dart"><code class="language-dart">void addMessage(int exitCode, String message, {String? path}) {
this.exitCode = exitCode;
<pre class="language-dart"><code class="language-dart">void addMessage(String message, {String? path}) {
exitCode = exitFailure;
if (path != null &amp;&amp; path.isNotEmpty) {
messages.add(&#39;$path: $message&#39;);
} else {

View file

@ -93,10 +93,10 @@
if (paths.isEmpty) {
if (input != null) {
try {
await _writeStream(input, lastLine, output, numberNonBlank, showEnds,
await _copyStream(input, lastLine, output, numberNonBlank, showEnds,
showLineNumbers, showNonPrinting, showTabs, squeezeBlank);
} catch (e) {
result.addMessage(exitFailure, _formatError(e));
result.addMessage(_getErrorMessage(e));
}
}
} else {
@ -108,10 +108,10 @@
} else {
stream = File(path).openRead();
}
await _writeStream(stream, lastLine, output, numberNonBlank, showEnds,
await _copyStream(stream, lastLine, output, numberNonBlank, showEnds,
showLineNumbers, showNonPrinting, showTabs, squeezeBlank);
} catch (e) {
result.addMessage(exitFailure, _formatError(e), path: path);
result.addMessage(_getErrorMessage(e), path: path);
}
}
}