Skip to content

Commit

Permalink
Update docs to 0.14.1
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewchang-bird committed Jul 30, 2020
1 parent 59be6fb commit d76d5e9
Show file tree
Hide file tree
Showing 79 changed files with 10,627 additions and 2 deletions.
181 changes: 181 additions & 0 deletions docs/0.14.1/ArgumentCaptor-1017688/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Mockingbird - ArgumentCaptor</title>
<link rel="stylesheet" type="text/css" href="/mockingbird/0.14.1/all.css" media="all" />
</head>
<body>
<header>
<a href="/mockingbird/0.14.1">
<strong>
Mockingbird
</strong>
<span>Documentation</span>
</a>
<sup>0.14.1</sup>
</header>

<!--
<form class="search">
<input type="search" placeholder="Search" />
</form>
-->

<nav>
<div class="wrapper">
<h2>On This Page</h2>
<ol><li><a href="#relationships">Relationships</a><ul><li><a href="#relationships">Superclass</a></li></ul></li><li><a href="#initializers">Initializers</a><ul><li class="initializer"><a href="#argumentcaptor.init(weak:)">init(weak:​)</a></li></ul></li><li><a href="#properties">Properties</a><ul><li class="property"><a href="#argumentcaptor.matcher">matcher</a></li><li class="property"><a href="#argumentcaptor.allvalues">all​Values</a></li><li class="property"><a href="#argumentcaptor.value">value</a></li></ul></li></ol>
</div>
</nav>

<main>
<article>
<h1>
<small>Class</small>
<code class="name">Argument​Captor</code>
</h1>

<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">class</span> <span class="type">ArgumentCaptor</span>&lt;<span class="variable">ParameterType</span>&gt;: <a href="/mockingbird/0.14.1/ArgumentMatcher-f013d1a"><span class="type">ArgumentMatcher</span></a></code></pre></body></html>
<div class="summary" role="doc-abstract">
<p>Captures method arguments passed during mock invocations.</p>

</div>
<div class="discussion">
<p>An argument captor extracts received argument values which can be used in other parts of the
test.</p>

<html><body><pre class="highlight"><code><span class="keyword">let</span> <span class="variable">bird</span> = <span class="variable">mock</span>(<span class="variable">Bird</span>.<span class="keyword">self</span>)
<span class="variable">bird</span>.<span class="type">name</span> = <span class="string literal">"</span><span class="string literal">Ryan</span><span class="string literal">"</span>

<span class="keyword">let</span> <span class="variable">nameCaptor</span> = <span class="variable">ArgumentCaptor</span>&lt;<span class="type">String</span>&gt;()
<span class="variable">verify</span>(<span class="variable">bird</span>.<span class="type">setName</span>(<span class="variable">nameCaptor</span>.<span class="type">matcher</span>)).<span class="type">wasCalled</span>()
<span class="variable">print</span>(<span class="variable">nameCaptor</span>.<span class="type">value</span>) <span class="comment">// Prints "Ryan"</span>
</code></pre></body></html>
</div>
<section id="relationships">
<h2 hidden>Relationships</h2>
<figure>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 2.36.0 (20140111.2315)
-->
<!-- Title: %3 Pages: 1 -->
<svg width="872pt" height="116pt"
viewBox="0.00 0.00 872.00 116.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 112)">
<title>%3</title>
<polygon fill="white" stroke="none" points="-4,4 -4,-112 868,-112 868,4 -4,4"/>
<!-- ArgumentCaptor -->
<g id="node1" class="node"><title>ArgumentCaptor</title>
<g id="a_node1"><a xlink:href="/mockingbird/0.14.1/ArgumentCaptor-1017688" xlink:title="ArgumentCaptor">
<path fill="none" stroke="black" stroke-width="3" d="M528,-108C528,-108 336,-108 336,-108 330,-108 324,-102 324,-96 324,-96 324,-84 324,-84 324,-78 330,-72 336,-72 336,-72 528,-72 528,-72 534,-72 540,-78 540,-84 540,-84 540,-96 540,-96 540,-102 534,-108 528,-108"/>
<text text-anchor="middle" x="432" y="-86.9484" font-family="Menlo" font-size="14.00">ArgumentCaptor</text>
</a>
</g>
</g>
<!-- ArgumentMatcher -->
<g id="node2" class="node"><title>ArgumentMatcher</title>
<path fill="none" stroke="black" d="M528,-36C528,-36 336,-36 336,-36 330,-36 324,-30 324,-24 324,-24 324,-12 324,-12 324,-6 330,-0 336,-0 336,-0 528,-0 528,-0 534,-0 540,-6 540,-12 540,-12 540,-24 540,-24 540,-30 534,-36 528,-36"/>
<text text-anchor="middle" x="432" y="-14.9484" font-family="Menlo" font-size="14.00">ArgumentMatcher</text>
</g>
<!-- ArgumentCaptor&#45;&gt;ArgumentMatcher -->
<g id="edge1" class="edge"><title>ArgumentCaptor&#45;&gt;ArgumentMatcher</title>
<path fill="none" stroke="black" d="M432,-71.6966C432,-63.9827 432,-54.7125 432,-46.1124"/>
<polygon fill="black" stroke="black" points="435.5,-46.1043 432,-36.1043 428.5,-46.1044 435.5,-46.1043"/>
</g>
</g>
</svg>


<figcaption hidden>Inheritance graph for ArgumentCaptor.</figcaption>
</figure>
<h3>Superclass</h3>
<dl>
<dt class="class"><code><a href="/mockingbird/0.14.1/ArgumentMatcher-f013d1a">ArgumentMatcher</a></code></dt>
<dd><p>Matches argument values with a comparator.</p>
</dd>
</dl>
</section>
<section id="initializers">
<h2>Initializers</h2>

<div role="article" class="initializer" id="argumentcaptor.init(weak:)">
<h3>
<code>init(weak:​)</code>
</h3>
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">init</span>(<span class="variable">weak</span>: <span class="type">Bool</span> = <span class="keyword">false</span>)</code></pre></body></html>
<div class="summary" role="doc-abstract">
<p>Create a new argument captor.</p>

</div>
<h4>Parameters</h4>

<table class="parameters">
<thead hidden>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>weak</th>
<td><code class="type">Bool</code></td></td>
<td><p>Whether captured arguments should be stored weakly.</p>
</td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="properties">
<h2>Properties</h2>

<div role="article" class="variable" id="argumentcaptor.matcher">
<h3>
<code>matcher</code>
</h3>
<html><body><pre class="highlight"><code><span class="keyword">var</span> <span class="variable">matcher</span>: <span class="type">ParameterType</span></code></pre></body></html>
<div class="summary" role="doc-abstract">
<p>Passed as a parameter to mock verification contexts.</p>

</div>
</div>
<div role="article" class="variable" id="argumentcaptor.allvalues">
<h3>
<code>all​Values</code>
</h3>
<html><body><pre class="highlight"><code><span class="keyword">var</span> <span class="variable">allValues</span>: [<span class="type">ParameterType</span>]</code></pre></body></html>
<div class="summary" role="doc-abstract">
<p>All recorded argument values.</p>

</div>
</div>
<div role="article" class="variable" id="argumentcaptor.value">
<h3>
<code>value</code>
</h3>
<html><body><pre class="highlight"><code><span class="keyword">var</span> <span class="variable">value</span>: <span class="type">ParameterType</span>?</code></pre></body></html>
<div class="summary" role="doc-abstract">
<p>The last recorded argument value.</p>

</div>
</div>
</section>



</article>
</main>

<footer>
<p>
Generated on <time datetime="2020-07-30T01:04:59-0700">July 30, 2020</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a> <span class="version">1.0.0-beta.3</span>.
</p>
</footer>
</body>
</html>
151 changes: 151 additions & 0 deletions docs/0.14.1/ArgumentMatcher-f013d1a/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Mockingbird - ArgumentMatcher</title>
<link rel="stylesheet" type="text/css" href="/mockingbird/0.14.1/all.css" media="all" />
</head>
<body>
<header>
<a href="/mockingbird/0.14.1">
<strong>
Mockingbird
</strong>
<span>Documentation</span>
</a>
<sup>0.14.1</sup>
</header>

<!--
<form class="search">
<input type="search" placeholder="Search" />
</form>
-->

<nav>
<div class="wrapper">
<h2>On This Page</h2>
<ol><li><a href="#relationships">Relationships</a><ul><li><a href="#relationships">Subclasses</a></li><li><a href="#relationships">Conforms To</a></li></ul></li><li><a href="#properties">Properties</a><ul><li class="property"><a href="#argumentmatcher.description">description</a></li></ul></li><li><a href="#methods">Methods</a><ul><li class="method"><a href="#argumentmatcher.==(lhs:rhs:)">==(lhs:​rhs:​)</a></li></ul></li></ol>
</div>
</nav>

<main>
<article>
<h1>
<small>Class</small>
<code class="name">Argument​Matcher</code>
</h1>

<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">class</span> <span class="type">ArgumentMatcher</span>: <span class="type">CustomStringConvertible</span></code></pre></body></html>
<div class="summary" role="doc-abstract">
<p>Matches argument values with a comparator.</p>

</div>
<section id="relationships">
<h2 hidden>Relationships</h2>
<figure>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 2.36.0 (20140111.2315)
-->
<!-- Title: %3 Pages: 1 -->
<svg width="1088pt" height="242pt"
viewBox="0.00 0.00 1087.98 241.73" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 237.733)">
<title>%3</title>
<polygon fill="white" stroke="none" points="-4,4 -4,-237.733 1083.98,-237.733 1083.98,4 -4,4"/>
<!-- ArgumentMatcher -->
<g id="node1" class="node"><title>ArgumentMatcher</title>
<g id="a_node1"><a xlink:href="/mockingbird/0.14.1/ArgumentMatcher-f013d1a" xlink:title="ArgumentMatcher">
<path fill="none" stroke="black" stroke-width="3" d="M537.993,-143.639C537.993,-143.639 345.993,-143.639 345.993,-143.639 339.993,-143.639 333.993,-137.639 333.993,-131.639 333.993,-131.639 333.993,-119.639 333.993,-119.639 333.993,-113.639 339.993,-107.639 345.993,-107.639 345.993,-107.639 537.993,-107.639 537.993,-107.639 543.993,-107.639 549.993,-113.639 549.993,-119.639 549.993,-119.639 549.993,-131.639 549.993,-131.639 549.993,-137.639 543.993,-143.639 537.993,-143.639"/>
<text text-anchor="middle" x="441.993" y="-122.587" font-family="Menlo" font-size="14.00">ArgumentMatcher</text>
</a>
</g>
</g>
<!-- Equatable -->
<g id="node3" class="node"><title>Equatable</title>
<path fill="none" stroke="black" d="M347.568,-36C347.568,-36 155.568,-36 155.568,-36 149.568,-36 143.568,-30 143.568,-24 143.568,-24 143.568,-12 143.568,-12 143.568,-6 149.568,-0 155.568,-0 155.568,-0 347.568,-0 347.568,-0 353.568,-0 359.568,-6 359.568,-12 359.568,-12 359.568,-24 359.568,-24 359.568,-30 353.568,-36 347.568,-36"/>
<text text-anchor="middle" x="251.568" y="-14.9484" font-family="Menlo" font-size="14.00">Equatable</text>
</g>
<!-- ArgumentMatcher&#45;&gt;Equatable -->
<g id="edge1" class="edge"><title>ArgumentMatcher&#45;&gt;Equatable</title>
<path fill="none" stroke="black" d="M410.12,-107.622C377.852,-89.3828 327.821,-61.1025 292.607,-41.1975"/>
<polygon fill="black" stroke="black" points="293.972,-37.949 283.545,-36.0751 290.528,-44.0428 293.972,-37.949"/>
</g>
<!-- CustomStringConvertible -->
<g id="node4" class="node"><title>CustomStringConvertible</title>
<path fill="none" stroke="black" d="M204,-233.733C204,-233.733 12,-233.733 12,-233.733 6,-233.733 0,-227.733 0,-221.733 0,-221.733 0,-209.733 0,-209.733 0,-203.733 6,-197.733 12,-197.733 12,-197.733 204,-197.733 204,-197.733 210,-197.733 216,-203.733 216,-209.733 216,-209.733 216,-221.733 216,-221.733 216,-227.733 210,-233.733 204,-233.733"/>
<text text-anchor="middle" x="108" y="-212.681" font-family="Menlo" font-size="14.00">CustomStringConvertible</text>
</g>
<!-- ArgumentMatcher&#45;&gt;CustomStringConvertible -->
<g id="edge3" class="edge"><title>ArgumentMatcher&#45;&gt;CustomStringConvertible</title>
<path fill="none" stroke="black" d="M375.207,-143.654C320.231,-158.484 242.261,-179.516 184.727,-195.036"/>
<polygon fill="black" stroke="black" points="183.699,-191.688 174.956,-197.671 185.522,-198.446 183.699,-191.688"/>
</g>
<!-- ArgumentCaptor -->
<g id="node2" class="node"><title>ArgumentCaptor</title>
<path fill="none" stroke="black" d="M1067.98,-161.305C1067.98,-161.305 875.981,-161.305 875.981,-161.305 869.981,-161.305 863.981,-155.305 863.981,-149.305 863.981,-149.305 863.981,-137.305 863.981,-137.305 863.981,-131.305 869.981,-125.305 875.981,-125.305 875.981,-125.305 1067.98,-125.305 1067.98,-125.305 1073.98,-125.305 1079.98,-131.305 1079.98,-137.305 1079.98,-137.305 1079.98,-149.305 1079.98,-149.305 1079.98,-155.305 1073.98,-161.305 1067.98,-161.305"/>
<text text-anchor="middle" x="971.981" y="-140.254" font-family="Menlo" font-size="14.00">ArgumentCaptor</text>
</g>
<!-- ArgumentCaptor&#45;&gt;ArgumentMatcher -->
<g id="edge2" class="edge"><title>ArgumentCaptor&#45;&gt;ArgumentMatcher</title>
<path fill="none" stroke="black" d="M863.772,-139.698C775.499,-136.756 650.981,-132.605 560.127,-129.577"/>
<polygon fill="black" stroke="black" points="560.166,-126.076 550.055,-129.241 559.933,-133.072 560.166,-126.076"/>
</g>
</g>
</svg>


<figcaption hidden>Inheritance graph for ArgumentMatcher.</figcaption>
</figure>
<h3>Subclasses</h3>
<dl>
<dt class="class"><code><a href="/mockingbird/0.14.1/ArgumentCaptor-1017688">ArgumentCaptor</a></code></dt>
<dd><p>Captures method arguments passed during mock invocations.</p>
</dd>
</dl>
<h3>Conforms To</h3>
<dl>
<dt class="unknown"><code>CustomStringConvertible</code></dt>
<dt class="unknown"><code>Equatable</code></dt>
</dl>
</section>
<section id="properties">
<h2>Properties</h2>

<div role="article" class="variable" id="argumentmatcher.description">
<h3>
<code>description</code>
</h3>
<html><body><pre class="highlight"><code><span class="keyword">let</span> <span class="variable">description</span>: <span class="type">String</span></code></pre></body></html>
<div class="summary" role="doc-abstract">
<p>A description for test failure output.</p>

</div>
</div>
</section>
<section id="methods">
<h2>Methods</h2>

<div role="article" class="function" id="argumentmatcher.==(lhs:rhs:)">
<h3>
<code>==(lhs:​rhs:​)</code>
</h3>
<html><body><pre class="highlight"><code><span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">func</span> ==(<span class="variable">lhs</span>: <a href="/mockingbird/0.14.1/ArgumentMatcher-f013d1a"><span class="type">ArgumentMatcher</span></a>, <span class="variable">rhs</span>: <a href="/mockingbird/0.14.1/ArgumentMatcher-f013d1a"><span class="type">ArgumentMatcher</span></a>) -&gt; <span class="type">Bool</span></code></pre></body></html>
</div>
</section>



</article>
</main>

<footer>
<p>
Generated on <time datetime="2020-07-30T01:04:58-0700">July 30, 2020</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a> <span class="version">1.0.0-beta.3</span>.
</p>
</footer>
</body>
</html>
Loading

0 comments on commit d76d5e9

Please sign in to comment.