Skip to content

Commit db15da8

Browse files
twittembtwittemb
committed
project: update documentation
1 parent eab5443 commit db15da8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+554
-223
lines changed

‎RxFlow/Step.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
// Copyright (c) RxSwiftCommunity. All rights reserved.
77
//
88

9-
public final class StepContext {
9+
final class StepContext {
1010

1111
public var fromChildFlow: Flow?
1212
weak var withinFlow: Flow?

‎docs/Classes.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ <h1>Classes</h1>
126126
<h4>Declaration</h4>
127127
<div class="language">
128128
<p class="aside-title">Swift</p>
129-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">OneStepper</span><span class="p">:</span> <span class="kt"><a href="Protocols/Stepper.html">Stepper</a></span></code></pre>
129+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">OneStepper</span><span class="p">:</span> <span class="kt"><a href="Protocols/Stepper.html">Stepper</a></span></code></pre>
130130

131131
</div>
132132
</div>
@@ -155,7 +155,7 @@ <h4>Declaration</h4>
155155
<h4>Declaration</h4>
156156
<div class="language">
157157
<p class="aside-title">Swift</p>
158-
<pre class="highlight swift"><code><span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">CompositeStepper</span><span class="p">:</span> <span class="kt"><a href="Protocols/Stepper.html">Stepper</a></span></code></pre>
158+
<pre class="highlight"><code><span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">CompositeStepper</span><span class="p">:</span> <span class="kt"><a href="Protocols/Stepper.html">Stepper</a></span></code></pre>
159159

160160
</div>
161161
</div>
@@ -188,7 +188,7 @@ <h4>Declaration</h4>
188188
<h4>Declaration</h4>
189189
<div class="language">
190190
<p class="aside-title">Swift</p>
191-
<pre class="highlight swift"><code><span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">Coordinator</span><span class="p">:</span> <span class="kt"><a href="Protocols/HasDisposeBag.html">HasDisposeBag</a></span></code></pre>
191+
<pre class="highlight"><code><span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">Coordinator</span><span class="p">:</span> <span class="kt"><a href="Protocols/HasDisposeBag.html">HasDisposeBag</a></span><span class="p">,</span> <span class="kt"><a href="Protocols.html#/s:6RxFlow14SynchronizableP">Synchronizable</a></span></code></pre>
192192

193193
</div>
194194
</div>
@@ -220,7 +220,7 @@ <h4>Declaration</h4>
220220
<h4>Declaration</h4>
221221
<div class="language">
222222
<p class="aside-title">Swift</p>
223-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Flows</span></code></pre>
223+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Flows</span></code></pre>
224224

225225
</div>
226226
</div>
@@ -232,8 +232,8 @@ <h4>Declaration</h4>
232232
</section>
233233
</section>
234234
<section id="footer">
235-
<p>&copy; 2018 <a class="link" href="https://github.com/RxSwiftCommunity/RxFlow" target="_blank" rel="external">Thibault Wittemberg and RxSwiftCommunity</a>. All rights reserved. (Last updated: 2018-02-21)</p>
236-
<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>
235+
<p>&copy; 2018 <a class="link" href="https://github.com/RxSwiftCommunity/RxFlow" target="_blank" rel="external">Thibault Wittemberg and RxSwiftCommunity</a>. All rights reserved. (Last updated: 2018-03-04)</p>
236+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
237237
</section>
238238
</article>
239239
</div>

‎docs/Classes/CompositeStepper.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@
102102
<h1>CompositeStepper</h1>
103103
<div class="declaration">
104104
<div class="language">
105-
<pre class="highlight swift"><code><span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">CompositeStepper</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Stepper.html">Stepper</a></span></code></pre>
105+
<pre class="highlight"><code><span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">CompositeStepper</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Stepper.html">Stepper</a></span></code></pre>
106106

107107
</div>
108108
</div>
@@ -133,7 +133,7 @@ <h1>CompositeStepper</h1>
133133
<h4>Declaration</h4>
134134
<div class="language">
135135
<p class="aside-title">Swift</p>
136-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">steps</span><span class="p">:</span> <span class="kt">Observable</span><span class="o">&lt;</span><span class="kt"><a href="../Protocols.html#/s:6RxFlow4StepP">Step</a></span><span class="o">&gt;</span></code></pre>
136+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">steps</span><span class="p">:</span> <span class="kt">Observable</span><span class="o">&lt;</span><span class="kt"><a href="../Protocols.html#/s:6RxFlow4StepP">Step</a></span><span class="o">&gt;</span></code></pre>
137137

138138
</div>
139139
</div>
@@ -160,7 +160,7 @@ <h4>Declaration</h4>
160160
<h4>Declaration</h4>
161161
<div class="language">
162162
<p class="aside-title">Swift</p>
163-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">steppers</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Protocols/Stepper.html">Stepper</a></span><span class="p">])</span></code></pre>
163+
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">steppers</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Protocols/Stepper.html">Stepper</a></span><span class="p">])</span></code></pre>
164164

165165
</div>
166166
</div>
@@ -191,8 +191,8 @@ <h4>Parameters</h4>
191191
</section>
192192
</section>
193193
<section id="footer">
194-
<p>&copy; 2018 <a class="link" href="https://github.com/RxSwiftCommunity/RxFlow" target="_blank" rel="external">Thibault Wittemberg and RxSwiftCommunity</a>. All rights reserved. (Last updated: 2018-02-21)</p>
195-
<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>
194+
<p>&copy; 2018 <a class="link" href="https://github.com/RxSwiftCommunity/RxFlow" target="_blank" rel="external">Thibault Wittemberg and RxSwiftCommunity</a>. All rights reserved. (Last updated: 2018-03-04)</p>
195+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
196196
</section>
197197
</article>
198198
</div>

‎docs/Classes/Coordinator.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@
102102
<h1>Coordinator</h1>
103103
<div class="declaration">
104104
<div class="language">
105-
<pre class="highlight swift"><code><span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">Coordinator</span><span class="p">:</span> <span class="kt"><a href="../Protocols/HasDisposeBag.html">HasDisposeBag</a></span></code></pre>
105+
<pre class="highlight"><code><span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">Coordinator</span><span class="p">:</span> <span class="kt"><a href="../Protocols/HasDisposeBag.html">HasDisposeBag</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols.html#/s:6RxFlow14SynchronizableP">Synchronizable</a></span></code></pre>
106106

107107
</div>
108108
</div>
@@ -133,7 +133,7 @@ <h1>Coordinator</h1>
133133
<h4>Declaration</h4>
134134
<div class="language">
135135
<p class="aside-title">Swift</p>
136-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">()</span></code></pre>
136+
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">()</span></code></pre>
137137

138138
</div>
139139
</div>
@@ -160,7 +160,7 @@ <h4>Declaration</h4>
160160
<h4>Declaration</h4>
161161
<div class="language">
162162
<p class="aside-title">Swift</p>
163-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">coordinate</span> <span class="p">(</span><span class="nv">flow</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Flow.html">Flow</a></span><span class="p">,</span> <span class="n">withStepper</span> <span class="nv">stepper</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Stepper.html">Stepper</a></span><span class="p">)</span></code></pre>
163+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">coordinate</span> <span class="p">(</span><span class="nv">flow</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Flow.html">Flow</a></span><span class="p">,</span> <span class="n">withStepper</span> <span class="nv">stepper</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Stepper.html">Stepper</a></span><span class="p">)</span></code></pre>
164164

165165
</div>
166166
</div>
@@ -222,7 +222,7 @@ <h4>Parameters</h4>
222222
<h4>Declaration</h4>
223223
<div class="language">
224224
<p class="aside-title">Swift</p>
225-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">rx</span><span class="p">:</span> <span class="kt">Reactive</span><span class="o">&lt;</span><span class="kt">Coordinator</span><span class="o">&gt;</span></code></pre>
225+
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">rx</span><span class="p">:</span> <span class="kt">Reactive</span><span class="o">&lt;</span><span class="kt">Coordinator</span><span class="o">&gt;</span></code></pre>
226226

227227
</div>
228228
</div>
@@ -234,8 +234,8 @@ <h4>Declaration</h4>
234234
</section>
235235
</section>
236236
<section id="footer">
237-
<p>&copy; 2018 <a class="link" href="https://github.com/RxSwiftCommunity/RxFlow" target="_blank" rel="external">Thibault Wittemberg and RxSwiftCommunity</a>. All rights reserved. (Last updated: 2018-02-21)</p>
238-
<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>
237+
<p>&copy; 2018 <a class="link" href="https://github.com/RxSwiftCommunity/RxFlow" target="_blank" rel="external">Thibault Wittemberg and RxSwiftCommunity</a>. All rights reserved. (Last updated: 2018-03-04)</p>
238+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
239239
</section>
240240
</article>
241241
</div>

0 commit comments

Comments
 (0)