Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ekazaev
ekazaev committed Oct 17, 2019
1 parent 444faa1 commit 2dad207
Show file tree
Hide file tree
Showing 323 changed files with 4,717 additions and 4,171 deletions.
2 changes: 1 addition & 1 deletion RouteComposer.podspec
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'RouteComposer'
s.version = '2.3.1'
s.version = '2.3.2'
s.summary = 'Protocol oriented library that helps to handle view controllers composition, navigation and deep linking tasks.'
s.swift_version = '5.0'

Expand Down
26 changes: 13 additions & 13 deletions docs/Additional Assemblies.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Core Entities.html">Core Entities</a>
<a class="nav-group-name-link" href="Core%20Entities.html">Core Entities</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/Router.html">Router</a>
Expand All @@ -72,7 +72,7 @@
<a class="nav-group-task-link" href="Protocols/ContainerFactory.html">ContainerFactory</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Core Entities.html#/s:13RouteComposer6ActionP">Action</a>
<a class="nav-group-task-link" href="Core%20Entities.html#/s:13RouteComposer6ActionP">Action</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/ContainerAction.html">ContainerAction</a>
Expand Down Expand Up @@ -117,7 +117,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Additional Assemblies.html">Additional Assemblies</a>
<a class="nav-group-name-link" href="Additional%20Assemblies.html">Additional Assemblies</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SingleStep.html">SingleStep</a>
Expand Down Expand Up @@ -188,7 +188,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="UIViewController&#39;s protocols.html">UIViewController&#39;s protocols</a>
<a class="nav-group-name-link" href="UIViewController%27s%20protocols.html">UIViewController&#39;s protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/RoutingInterceptable.html">RoutingInterceptable</a>
Expand All @@ -199,7 +199,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="General Actions.html">General Actions</a>
<a class="nav-group-name-link" href="General%20Actions.html">General Actions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/GeneralAction.html">GeneralAction</a>
Expand Down Expand Up @@ -280,7 +280,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Other Guides.html">Other Guides</a>
<a class="nav-group-name-link" href="Other%20Guides.html">Other Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="contributing.html">CONTRIBUTING</a>
Expand All @@ -294,7 +294,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Other Classes.html">Other Classes</a>
<a class="nav-group-name-link" href="Other%20Classes.html">Other Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/ActionToStepIntegrator.html">ActionToStepIntegrator</a>
Expand All @@ -311,7 +311,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Other Extensions.html">Other Extensions</a>
<a class="nav-group-name-link" href="Other%20Extensions.html">Other Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Array.html">Array</a>
Expand All @@ -334,7 +334,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Other Protocols.html">Other Protocols</a>
<a class="nav-group-name-link" href="Other%20Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AbstractAction.html">AbstractAction</a>
Expand All @@ -361,7 +361,7 @@
<a class="nav-group-task-link" href="Protocols/InterceptableRouter.html">InterceptableRouter</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Other Protocols.html#/s:13RouteComposer9NilEntityP">NilEntity</a>
<a class="nav-group-task-link" href="Other%20Protocols.html#/s:13RouteComposer9NilEntityP">NilEntity</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SimpleContainerFactory.html">SimpleContainerFactory</a>
Expand All @@ -378,7 +378,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Other Structs.html">Other Structures</a>
<a class="nav-group-name-link" href="Other%20Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ActionConnectingAssembly.html">ActionConnectingAssembly</a>
Expand Down Expand Up @@ -580,8 +580,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2019-09-05)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.10.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2019 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2019-10-17)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
36 changes: 17 additions & 19 deletions docs/Assemblies.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Core Entities.html">Core Entities</a>
<a class="nav-group-name-link" href="Core%20Entities.html">Core Entities</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/Router.html">Router</a>
Expand All @@ -72,7 +72,7 @@
<a class="nav-group-task-link" href="Protocols/ContainerFactory.html">ContainerFactory</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Core Entities.html#/s:13RouteComposer6ActionP">Action</a>
<a class="nav-group-task-link" href="Core%20Entities.html#/s:13RouteComposer6ActionP">Action</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/ContainerAction.html">ContainerAction</a>
Expand Down Expand Up @@ -117,7 +117,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Additional Assemblies.html">Additional Assemblies</a>
<a class="nav-group-name-link" href="Additional%20Assemblies.html">Additional Assemblies</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SingleStep.html">SingleStep</a>
Expand Down Expand Up @@ -188,7 +188,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="UIViewController&#39;s protocols.html">UIViewController&#39;s protocols</a>
<a class="nav-group-name-link" href="UIViewController%27s%20protocols.html">UIViewController&#39;s protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/RoutingInterceptable.html">RoutingInterceptable</a>
Expand All @@ -199,7 +199,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="General Actions.html">General Actions</a>
<a class="nav-group-name-link" href="General%20Actions.html">General Actions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/GeneralAction.html">GeneralAction</a>
Expand Down Expand Up @@ -280,7 +280,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Other Guides.html">Other Guides</a>
<a class="nav-group-name-link" href="Other%20Guides.html">Other Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="contributing.html">CONTRIBUTING</a>
Expand All @@ -294,7 +294,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Other Classes.html">Other Classes</a>
<a class="nav-group-name-link" href="Other%20Classes.html">Other Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/ActionToStepIntegrator.html">ActionToStepIntegrator</a>
Expand All @@ -311,7 +311,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Other Extensions.html">Other Extensions</a>
<a class="nav-group-name-link" href="Other%20Extensions.html">Other Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Array.html">Array</a>
Expand All @@ -334,7 +334,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Other Protocols.html">Other Protocols</a>
<a class="nav-group-name-link" href="Other%20Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AbstractAction.html">AbstractAction</a>
Expand All @@ -361,7 +361,7 @@
<a class="nav-group-task-link" href="Protocols/InterceptableRouter.html">InterceptableRouter</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Other Protocols.html#/s:13RouteComposer9NilEntityP">NilEntity</a>
<a class="nav-group-task-link" href="Other%20Protocols.html#/s:13RouteComposer9NilEntityP">NilEntity</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SimpleContainerFactory.html">SimpleContainerFactory</a>
Expand All @@ -378,7 +378,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Other Structs.html">Other Structures</a>
<a class="nav-group-name-link" href="Other%20Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ActionConnectingAssembly.html">ActionConnectingAssembly</a>
Expand Down Expand Up @@ -632,12 +632,10 @@ <h3 id='usage' class='heading'>Usage</h3>
<span class="o">.</span><span class="nf">addCase</span><span class="p">(</span><span class="nv">from</span><span class="p">:</span> <span class="kt">ClassFinder</span><span class="o">&lt;</span><span class="kt">UINavigationController</span><span class="p">,</span> <span class="kt">ProductContext</span><span class="o">&gt;</span><span class="p">(</span><span class="nv">options</span><span class="p">:</span> <span class="o">.</span><span class="n">currentVisibleOnly</span><span class="p">))</span>

<span class="c1">// Otherwise - create a UINavigationController and present modally</span>
<span class="o">.</span><span class="nf">assemble</span><span class="p">(</span><span class="k">default</span><span class="p">:</span> <span class="p">{</span>
<span class="k">return</span> <span class="kt">ChainAssembly</span><span class="o">.</span><span class="nf">from</span><span class="p">(</span><span class="kt">NavigationControllerStep</span><span class="o">&lt;</span><span class="kt">UINavigationController</span><span class="p">,</span> <span class="kt">ProductContext</span><span class="o">&gt;</span><span class="p">())</span>
<span class="o">.</span><span class="nf">using</span><span class="p">(</span><span class="kt">GeneralAction</span><span class="o">.</span><span class="nf">presentModally</span><span class="p">())</span>
<span class="o">.</span><span class="nf">from</span><span class="p">(</span><span class="kt">GeneralStep</span><span class="o">.</span><span class="nf">current</span><span class="p">())</span>
<span class="o">.</span><span class="nf">assemble</span><span class="p">()</span>
<span class="p">})</span>
<span class="o">.</span><span class="nf">assemble</span><span class="p">(</span><span class="k">default</span><span class="p">:</span> <span class="kt">ChainAssembly</span><span class="o">.</span><span class="nf">from</span><span class="p">(</span><span class="kt">NavigationControllerStep</span><span class="o">&lt;</span><span class="kt">UINavigationController</span><span class="p">,</span> <span class="kt">ProductContext</span><span class="o">&gt;</span><span class="p">())</span>
<span class="o">.</span><span class="nf">using</span><span class="p">(</span><span class="kt">GeneralAction</span><span class="o">.</span><span class="nf">presentModally</span><span class="p">())</span>
<span class="o">.</span><span class="nf">from</span><span class="p">(</span><span class="kt">GeneralStep</span><span class="o">.</span><span class="nf">current</span><span class="p">())</span>
<span class="o">.</span><span class="nf">assemble</span><span class="p">())</span>
</code></pre>

<a href="Classes/SwitchAssembly.html" class="slightly-smaller">See more</a>
Expand Down Expand Up @@ -732,8 +730,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2019-09-05)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.10.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2019 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2019-10-17)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Loading

0 comments on commit 2dad207

Please sign in to comment.