Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Valentin Knabel committed Oct 23, 2016
1 parent 3cdc6d7 commit 82fd95b
Show file tree
Hide file tree
Showing 57 changed files with 1,247 additions and 857 deletions.
10 changes: 5 additions & 5 deletions docs/1-overview.html
View file
Expand Up @@ -19,7 +19,7 @@
<a class="header-link" href="index.html">
EasyInject Docs
</a>
(100% documented)
(99% documented)
</p>

<p class="header-col header-col--secondary">
Expand Down Expand Up @@ -100,9 +100,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/MutableInjector.html">MutableInjector</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols.html#/s:P10EasyInject10Providable">Providable</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -134,6 +131,9 @@
<li class="nav-group-name">
<a class="nav-group-name-link" href="Typealiases.html">Typealiases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:10EasyInject10Providable">Providable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:10EasyInject13ProvidableKey">ProvidableKey</a>
</li>
Expand Down Expand Up @@ -185,7 +185,7 @@
</article>
</div>
<section class="footer">
<p>&copy; 2016 <a class="link" href="https://twitter.com/vknabel" target="_blank" rel="external">Valentin Knabel</a>. All rights reserved. (Last updated: 2016-10-20)</p>
<p>&copy; 2016 <a class="link" href="https://twitter.com/vknabel" target="_blank" rel="external">Valentin Knabel</a>. All rights reserved. (Last updated: 2016-10-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
10 changes: 5 additions & 5 deletions docs/Classes.html
View file
Expand Up @@ -19,7 +19,7 @@
<a class="header-link" href="index.html">
EasyInject Docs
</a>
(100% documented)
(99% documented)
</p>

<p class="header-col header-col--secondary">
Expand Down Expand Up @@ -100,9 +100,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/MutableInjector.html">MutableInjector</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols.html#/s:P10EasyInject10Providable">Providable</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -134,6 +131,9 @@
<li class="nav-group-name">
<a class="nav-group-name-link" href="Typealiases.html">Typealiases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:10EasyInject10Providable">Providable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:10EasyInject13ProvidableKey">ProvidableKey</a>
</li>
Expand Down Expand Up @@ -223,7 +223,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2016 <a class="link" href="https://twitter.com/vknabel" target="_blank" rel="external">Valentin Knabel</a>. All rights reserved. (Last updated: 2016-10-20)</p>
<p>&copy; 2016 <a class="link" href="https://twitter.com/vknabel" target="_blank" rel="external">Valentin Knabel</a>. All rights reserved. (Last updated: 2016-10-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
26 changes: 13 additions & 13 deletions docs/Classes/GlobalInjector.html
View file
Expand Up @@ -20,7 +20,7 @@
<a class="header-link" href="../index.html">
EasyInject Docs
</a>
(100% documented)
(99% documented)
</p>

<p class="header-col header-col--secondary">
Expand Down Expand Up @@ -101,9 +101,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/MutableInjector.html">MutableInjector</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols.html#/s:P10EasyInject10Providable">Providable</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -135,6 +132,9 @@
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Typealiases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:10EasyInject10Providable">Providable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:10EasyInject13ProvidableKey">ProvidableKey</a>
</li>
Expand Down Expand Up @@ -257,24 +257,24 @@ <h4>Return Value</h4>
<li class="item">
<div>
<code>
<a name="/s:FC10EasyInject14GlobalInjector7resolveFzT3keyx_PS_10Providable_"></a>
<a name="/s:FC10EasyInject14GlobalInjector7resolveFzT3keyx_P_"></a>
<a name="//apple_ref/swift/Method/resolve(key:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC10EasyInject14GlobalInjector7resolveFzT3keyx_PS_10Providable_">resolve(key:)</a>
<a class="token" href="#/s:FC10EasyInject14GlobalInjector7resolveFzT3keyx_P_">resolve(key:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Implements <code><a href="../Protocols/MutableInjector.html#/s:FP10EasyInject15MutableInjector7resolveFzT3keywx3Key_PS_10Providable_">MutableInjector.resolve(key:)</a></code></p>
<p>Implements <code><a href="../Protocols/MutableInjector.html#/s:FP10EasyInject15MutableInjector7resolveFzT3keywx3Key_P_">MutableInjector.resolve(key:)</a></code></p>

</div>
<div class="declaration">
<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">resolve</span><span class="p">(</span><span class="nv">key</span><span class="p">:</span> <span class="kt">Key</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Protocols.html#/s:P10EasyInject10Providable">Providable</a></span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">resolve</span><span class="p">(</span><span class="nv">key</span><span class="p">:</span> <span class="kt">Key</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10EasyInject10Providable">Providable</a></span></code></pre>

</div>
</div>
Expand All @@ -284,24 +284,24 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:FC10EasyInject14GlobalInjector7provideFT3keyx12usingFactoryFzRGS0_x_PS_10Providable__T_"></a>
<a name="/s:FC10EasyInject14GlobalInjector7provideFT3keyx12usingFactoryFzRGS0_x_P__T_"></a>
<a name="//apple_ref/swift/Method/provide(key:usingFactory:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC10EasyInject14GlobalInjector7provideFT3keyx12usingFactoryFzRGS0_x_PS_10Providable__T_">provide(key:usingFactory:)</a>
<a class="token" href="#/s:FC10EasyInject14GlobalInjector7provideFT3keyx12usingFactoryFzRGS0_x_P__T_">provide(key:usingFactory:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Implements <code><a href="../Protocols/MutableInjector.html#/s:FP10EasyInject15MutableInjector7provideFT3keywx3Key12usingFactoryFzRxPS_10Providable__T_">MutableInjector.provide(key:usingFactory:)</a></code></p>
<p>Implements <code><a href="../Protocols/MutableInjector.html#/s:FP10EasyInject15MutableInjector7provideFT3keywx3Key12usingFactoryFzRxP__T_">MutableInjector.provide(key:usingFactory:)</a></code></p>

</div>
<div class="declaration">
<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">provide</span><span class="p">(</span><span class="nv">key</span><span class="p">:</span> <span class="kt">Key</span><span class="p">,</span> <span class="n">usingFactory</span> <span class="nv">factory</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="k">inout</span> <span class="kt">GlobalInjector</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Protocols.html#/s:P10EasyInject10Providable">Providable</a></span><span class="p">)</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">provide</span><span class="p">(</span><span class="nv">key</span><span class="p">:</span> <span class="kt">Key</span><span class="p">,</span> <span class="n">usingFactory</span> <span class="nv">factory</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="k">inout</span> <span class="kt">GlobalInjector</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10EasyInject10Providable">Providable</a></span><span class="p">)</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -401,7 +401,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2016 <a class="link" href="https://twitter.com/vknabel" target="_blank" rel="external">Valentin Knabel</a>. All rights reserved. (Last updated: 2016-10-20)</p>
<p>&copy; 2016 <a class="link" href="https://twitter.com/vknabel" target="_blank" rel="external">Valentin Knabel</a>. All rights reserved. (Last updated: 2016-10-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
26 changes: 13 additions & 13 deletions docs/Classes/LazilyInjectedProvider.html
View file
Expand Up @@ -20,7 +20,7 @@
<a class="header-link" href="../index.html">
EasyInject Docs
</a>
(100% documented)
(99% documented)
</p>

<p class="header-col header-col--secondary">
Expand Down Expand Up @@ -101,9 +101,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/MutableInjector.html">MutableInjector</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols.html#/s:P10EasyInject10Providable">Providable</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -135,6 +132,9 @@
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Typealiases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:10EasyInject10Providable">Providable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:10EasyInject13ProvidableKey">ProvidableKey</a>
</li>
Expand Down Expand Up @@ -165,17 +165,17 @@ <h1>LazilyInjectedProvider</h1>
<li class="item">
<div>
<code>
<a name="/s:FC10EasyInject22LazilyInjectedProvider7resolveFzT12withInjectorRx_PS_10Providable_"></a>
<a name="/s:FC10EasyInject22LazilyInjectedProvider7resolveFzT12withInjectorRx_P_"></a>
<a name="//apple_ref/swift/Method/resolve(withInjector:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC10EasyInject22LazilyInjectedProvider7resolveFzT12withInjectorRx_PS_10Providable_">resolve(withInjector:)</a>
<a class="token" href="#/s:FC10EasyInject22LazilyInjectedProvider7resolveFzT12withInjectorRx_P_">resolve(withInjector:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>See <code><a href="../Protocols/InjectedProvider.html#/s:FP10EasyInject16InjectedProvider7resolveFzT12withInjectorRwx8Injected_PS_10Providable_">InjectedProvider.resolve(withInjector:)</a></code>.</p>
<p>See <code><a href="../Protocols/InjectedProvider.html#/s:FP10EasyInject16InjectedProvider7resolveFzT12withInjectorRwx8Injected_P_">InjectedProvider.resolve(withInjector:)</a></code>.</p>

<div class="aside aside-throws">
<p class="aside-title">Throws</p>
Expand All @@ -188,7 +188,7 @@ <h1>LazilyInjectedProvider</h1>
<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">resolve</span><span class="p">(</span><span class="n">withInjector</span> <span class="nv">injector</span><span class="p">:</span> <span class="k">inout</span> <span class="kt">Injected</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Protocols.html#/s:P10EasyInject10Providable">Providable</a></span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">resolve</span><span class="p">(</span><span class="n">withInjector</span> <span class="nv">injector</span><span class="p">:</span> <span class="k">inout</span> <span class="kt">Injected</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10EasyInject10Providable">Providable</a></span></code></pre>

</div>
</div>
Expand All @@ -198,17 +198,17 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:FC10EasyInject22LazilyInjectedProvidercFT3keywx3Key12withInjectorRx12usingFactoryFzRxPS_10Providable__GS0_x_"></a>
<a name="/s:FC10EasyInject22LazilyInjectedProvidercFT3keywx3Key12withInjectorRx12usingFactoryFzRxP__GS0_x_"></a>
<a name="//apple_ref/swift/Method/init(key:withInjector:usingFactory:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC10EasyInject22LazilyInjectedProvidercFT3keywx3Key12withInjectorRx12usingFactoryFzRxPS_10Providable__GS0_x_">init(key:withInjector:usingFactory:)</a>
<a class="token" href="#/s:FC10EasyInject22LazilyInjectedProvidercFT3keywx3Key12withInjectorRx12usingFactoryFzRxP__GS0_x_">init(key:withInjector:usingFactory:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>See <code><a href="../Protocols/InjectedProvider.html#/s:FP10EasyInject16InjectedProvidercFT3keyWx8Injected3Key_12withInjectorRwxS1_12usingFactoryFzRwxS1_PS_10Providable__x">InjectedProvider.init(key:withInjector:usingFactory:)</a></code>.
<p>See <code><a href="../Protocols/InjectedProvider.html#/s:FP10EasyInject16InjectedProvidercFT3keyWx8Injected3Key_12withInjectorRwxS1_12usingFactoryFzRwxS1_P__x">InjectedProvider.init(key:withInjector:usingFactory:)</a></code>.
Won&rsquo;t evaluate factory.</p>

</div>
Expand All @@ -218,7 +218,7 @@ <h4>Declaration</h4>
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">key</span><span class="p">:</span> <span class="kt">Key</span><span class="p">,</span>
<span class="n">withInjector</span> <span class="nv">injector</span><span class="p">:</span> <span class="k">inout</span> <span class="kt">Injected</span><span class="p">,</span>
<span class="n">usingFactory</span> <span class="nv">factory</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="k">inout</span> <span class="kt">Injected</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Protocols.html#/s:P10EasyInject10Providable">Providable</a></span><span class="p">)</span></code></pre>
<span class="n">usingFactory</span> <span class="nv">factory</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="k">inout</span> <span class="kt">Injected</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10EasyInject10Providable">Providable</a></span><span class="p">)</span></code></pre>

</div>
</div>
Expand All @@ -233,7 +233,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2016 <a class="link" href="https://twitter.com/vknabel" target="_blank" rel="external">Valentin Knabel</a>. All rights reserved. (Last updated: 2016-10-20)</p>
<p>&copy; 2016 <a class="link" href="https://twitter.com/vknabel" target="_blank" rel="external">Valentin Knabel</a>. All rights reserved. (Last updated: 2016-10-24)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down

0 comments on commit 82fd95b

Please sign in to comment.