Skip to content

Commit 367eb93

Browse files
Ruslana003Ruslana003
authored
Fix typo and regenerate docs #trivial (#194)
* Fix typo in Flow.swift docs * Regenerate docs
1 parent 2cba1e0 commit 367eb93

Some content is hidden

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

58 files changed

+5413
-1165
lines changed

‎RxFlow/Flow.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ extension Flow {
5858
}
5959
}
6060

61-
/// Utility functions to synchronize Flows readyness
61+
/// Utility functions to synchronize Flows' readiness
6262
public enum Flows {
6363
public enum ExecuteStrategy {
6464
case ready

‎docs/Classes.html

+62-20
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@
1717
<a title="Classes Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="index.html">RxFlow 2.9.0 Docs</a> (0% documented)</p>
21-
<p class="header-right">
20+
<p><a href="index.html">RxFlow 2.13.0 Docs</a> (93% documented)</p>
21+
<div class="header-right">
2222
<form role="search" action="search.json">
2323
<input type="text" placeholder="Search documentation" data-typeahead>
2424
</form>
25-
</p>
25+
</div>
2626
</div>
2727
</header>
2828
<div class="content-wrapper">
2929
<p id="breadcrumbs">
3030
<a href="index.html">RxFlow Reference</a>
31-
<img id="carat" src="img/carat.png" />
31+
<img id="carat" src="img/carat.png" alt=""/>
3232
Classes Reference
3333
</p>
3434
</div>
@@ -82,10 +82,10 @@
8282
<a href="Extensions/Reactive.html">Reactive</a>
8383
</li>
8484
<li class="nav-group-task">
85-
<a href="Extensions.html#/UIViewController">UIViewController</a>
85+
<a href="Extensions.html#/c:objc(cs)UIViewController">UIViewController</a>
8686
</li>
8787
<li class="nav-group-task">
88-
<a href="Extensions.html#/UIWindow">UIWindow</a>
88+
<a href="Extensions.html#/c:objc(cs)UIWindow">UIWindow</a>
8989
</li>
9090
</ul>
9191
</li>
@@ -99,13 +99,24 @@
9999
<a href="Protocols/Presentable.html">Presentable</a>
100100
</li>
101101
<li class="nav-group-task">
102-
<a href="Protocols.html#/Step">Step</a>
102+
<a href="Protocols.html#/s:6RxFlow4StepP">Step</a>
103103
</li>
104104
<li class="nav-group-task">
105105
<a href="Protocols/Stepper.html">Stepper</a>
106106
</li>
107107
<li class="nav-group-task">
108-
<a href="Protocols.html#/Synchronizable">Synchronizable</a>
108+
<a href="Protocols.html#/s:6RxFlow14SynchronizableP">Synchronizable</a>
109+
</li>
110+
</ul>
111+
</li>
112+
<li class="nav-group-name">
113+
<a href="Typealiases.html">Type Aliases</a>
114+
<ul class="nav-group-tasks">
115+
<li class="nav-group-task">
116+
<a href="Typealiases.html#/s:6RxFlow11Coordinatora">Coordinator</a>
117+
</li>
118+
<li class="nav-group-task">
119+
<a href="Typealiases.html#/s:6RxFlow04NextB5Itemsa">NextFlowItems</a>
109120
</li>
110121
</ul>
111122
</li>
@@ -124,9 +135,9 @@ <h1>Classes</h1>
124135
<li class="item">
125136
<div>
126137
<code>
127-
<a name="/"></a>
138+
<a name="/c:@M@RxFlow@objc(cs)FlowCoordinator"></a>
128139
<a name="//apple_ref/swift/Class/FlowCoordinator" class="dashAnchor"></a>
129-
<a class="token" href="#/">FlowCoordinator</a>
140+
<a class="token" href="#/c:@M@RxFlow@objc(cs)FlowCoordinator">FlowCoordinator</a>
130141
</code>
131142
</div>
132143
<div class="height-container">
@@ -138,6 +149,14 @@ <h1>Classes</h1>
138149

139150
<a href="Classes/FlowCoordinator.html" class="slightly-smaller">See more</a>
140151
</div>
152+
<div class="declaration">
153+
<h4>Declaration</h4>
154+
<div class="language">
155+
<p class="aside-title">Swift</p>
156+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">FlowCoordinator</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
157+
158+
</div>
159+
</div>
141160
</section>
142161
</div>
143162
</li>
@@ -149,17 +168,17 @@ <h1>Classes</h1>
149168
<a name="//apple_ref/swift/Section/default implementation" class="dashAnchor"></a>
150169
<div class="section-name-container">
151170
<a class="section-name-link" href="#/default%20implementation"></a>
152-
<h3 class="section-name"><p>default implementation</p>
171+
<h3 class="section-name"><span>default implementation</span>
153172
</h3>
154173
</div>
155174
</div>
156175
<ul>
157176
<li class="item">
158177
<div>
159178
<code>
160-
<a name="/"></a>
179+
<a name="/s:6RxFlow10OneStepperC"></a>
161180
<a name="//apple_ref/swift/Class/OneStepper" class="dashAnchor"></a>
162-
<a class="token" href="#/">OneStepper</a>
181+
<a class="token" href="#/s:6RxFlow10OneStepperC">OneStepper</a>
163182
</code>
164183
</div>
165184
<div class="height-container">
@@ -171,15 +190,23 @@ <h3 class="section-name"><p>default implementation</p>
171190

172191
<a href="Classes/OneStepper.html" class="slightly-smaller">See more</a>
173192
</div>
193+
<div class="declaration">
194+
<h4>Declaration</h4>
195+
<div class="language">
196+
<p class="aside-title">Swift</p>
197+
<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>
198+
199+
</div>
200+
</div>
174201
</section>
175202
</div>
176203
</li>
177204
<li class="item">
178205
<div>
179206
<code>
180-
<a name="/"></a>
207+
<a name="/s:6RxFlow14DefaultStepperC"></a>
181208
<a name="//apple_ref/swift/Class/DefaultStepper" class="dashAnchor"></a>
182-
<a class="token" href="#/">DefaultStepper</a>
209+
<a class="token" href="#/s:6RxFlow14DefaultStepperC">DefaultStepper</a>
183210
</code>
184211
</div>
185212
<div class="height-container">
@@ -191,15 +218,23 @@ <h3 class="section-name"><p>default implementation</p>
191218

192219
<a href="Classes/DefaultStepper.html" class="slightly-smaller">See more</a>
193220
</div>
221+
<div class="declaration">
222+
<h4>Declaration</h4>
223+
<div class="language">
224+
<p class="aside-title">Swift</p>
225+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">DefaultStepper</span> <span class="p">:</span> <span class="kt"><a href="Classes/OneStepper.html">OneStepper</a></span></code></pre>
226+
227+
</div>
228+
</div>
194229
</section>
195230
</div>
196231
</li>
197232
<li class="item">
198233
<div>
199234
<code>
200-
<a name="/"></a>
235+
<a name="/s:6RxFlow16CompositeStepperC"></a>
201236
<a name="//apple_ref/swift/Class/CompositeStepper" class="dashAnchor"></a>
202-
<a class="token" href="#/">CompositeStepper</a>
237+
<a class="token" href="#/s:6RxFlow16CompositeStepperC">CompositeStepper</a>
203238
</code>
204239
</div>
205240
<div class="height-container">
@@ -212,6 +247,14 @@ <h3 class="section-name"><p>default implementation</p>
212247

213248
<a href="Classes/CompositeStepper.html" class="slightly-smaller">See more</a>
214249
</div>
250+
<div class="declaration">
251+
<h4>Declaration</h4>
252+
<div class="language">
253+
<p class="aside-title">Swift</p>
254+
<pre class="highlight swift"><code><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>
255+
256+
</div>
257+
</div>
215258
</section>
216259
</div>
217260
</li>
@@ -220,11 +263,10 @@ <h3 class="section-name"><p>default implementation</p>
220263
</section>
221264
</section>
222265
<section id="footer">
223-
<p>&copy; 2020 <a class="link" href="https://github.com/RxSwiftCommunity/RxFlow" target="_blank" rel="external">Thibault Wittemberg and RxSwiftCommunity</a>. All rights reserved. (Last updated: 2020-09-09)</p>
224-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
266+
<p>&copy; 2023 <a class="link" href="https://github.com/RxSwiftCommunity/RxFlow" target="_blank" rel="external noopener">Thibault Wittemberg and RxSwiftCommunity</a>. All rights reserved. (Last updated: 2023-11-27)</p>
267+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
225268
</section>
226269
</article>
227270
</div>
228271
</body>
229-
</div>
230272
</html>

‎docs/Classes/CompositeStepper.html

+77-17
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@
1717
<a title="CompositeStepper Class Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">RxFlow 2.9.0 Docs</a> (0% documented)</p>
21-
<p class="header-right">
20+
<p><a href="../index.html">RxFlow 2.13.0 Docs</a> (93% documented)</p>
21+
<div class="header-right">
2222
<form role="search" action="../search.json">
2323
<input type="text" placeholder="Search documentation" data-typeahead>
2424
</form>
25-
</p>
25+
</div>
2626
</div>
2727
</header>
2828
<div class="content-wrapper">
2929
<p id="breadcrumbs">
3030
<a href="../index.html">RxFlow Reference</a>
31-
<img id="carat" src="../img/carat.png" />
31+
<img id="carat" src="../img/carat.png" alt=""/>
3232
CompositeStepper Class Reference
3333
</p>
3434
</div>
@@ -82,10 +82,10 @@
8282
<a href="../Extensions/Reactive.html">Reactive</a>
8383
</li>
8484
<li class="nav-group-task">
85-
<a href="../Extensions.html#/UIViewController">UIViewController</a>
85+
<a href="../Extensions.html#/c:objc(cs)UIViewController">UIViewController</a>
8686
</li>
8787
<li class="nav-group-task">
88-
<a href="../Extensions.html#/UIWindow">UIWindow</a>
88+
<a href="../Extensions.html#/c:objc(cs)UIWindow">UIWindow</a>
8989
</li>
9090
</ul>
9191
</li>
@@ -99,13 +99,24 @@
9999
<a href="../Protocols/Presentable.html">Presentable</a>
100100
</li>
101101
<li class="nav-group-task">
102-
<a href="../Protocols.html#/Step">Step</a>
102+
<a href="../Protocols.html#/s:6RxFlow4StepP">Step</a>
103103
</li>
104104
<li class="nav-group-task">
105105
<a href="../Protocols/Stepper.html">Stepper</a>
106106
</li>
107107
<li class="nav-group-task">
108-
<a href="../Protocols.html#/Synchronizable">Synchronizable</a>
108+
<a href="../Protocols.html#/s:6RxFlow14SynchronizableP">Synchronizable</a>
109+
</li>
110+
</ul>
111+
</li>
112+
<li class="nav-group-name">
113+
<a href="../Typealiases.html">Type Aliases</a>
114+
<ul class="nav-group-tasks">
115+
<li class="nav-group-task">
116+
<a href="../Typealiases.html#/s:6RxFlow11Coordinatora">Coordinator</a>
117+
</li>
118+
<li class="nav-group-task">
119+
<a href="../Typealiases.html#/s:6RxFlow04NextB5Itemsa">NextFlowItems</a>
109120
</li>
110121
</ul>
111122
</li>
@@ -115,6 +126,13 @@
115126
<section>
116127
<section class="section">
117128
<h1>CompositeStepper</h1>
129+
<div class="declaration">
130+
<div class="language">
131+
132+
<pre class="highlight swift"><code><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>
133+
134+
</div>
135+
</div>
118136
<p>A Stepper that combines multiple steppers. All those Steppers will be associated
119137
to the Presentable that is given within the NextFlowItem</p>
120138

@@ -125,9 +143,9 @@ <h1>CompositeStepper</h1>
125143
<li class="item">
126144
<div>
127145
<code>
128-
<a name="/"></a>
146+
<a name="/s:6RxFlow7StepperP5steps0A5Relay07PublishE0CyAA4Step_pGvp"></a>
129147
<a name="//apple_ref/swift/Property/steps" class="dashAnchor"></a>
130-
<a class="token" href="#/">steps</a>
148+
<a class="token" href="#/s:6RxFlow7StepperP5steps0A5Relay07PublishE0CyAA4Step_pGvp">steps</a>
131149
</code>
132150
</div>
133151
<div class="height-container">
@@ -137,15 +155,23 @@ <h1>CompositeStepper</h1>
137155
<div class="abstract">
138156

139157
</div>
158+
<div class="declaration">
159+
<h4>Declaration</h4>
160+
<div class="language">
161+
<p class="aside-title">Swift</p>
162+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">steps</span><span class="p">:</span> <span class="kt">PublishRelay</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>
163+
164+
</div>
165+
</div>
140166
</section>
141167
</div>
142168
</li>
143169
<li class="item">
144170
<div>
145171
<code>
146-
<a name="/"></a>
172+
<a name="/s:6RxFlow16CompositeStepperC8steppersACSayAA0D0_pG_tcfc"></a>
147173
<a name="//apple_ref/swift/Method/init(steppers:)" class="dashAnchor"></a>
148-
<a class="token" href="#/">init(steppers:<wbr>)</a>
174+
<a class="token" href="#/s:6RxFlow16CompositeStepperC8steppersACSayAA0D0_pG_tcfc">init(steppers:<wbr>)</a>
149175
</code>
150176
</div>
151177
<div class="height-container">
@@ -156,15 +182,42 @@ <h1>CompositeStepper</h1>
156182
<p>Initialize</p>
157183

158184
</div>
185+
<div class="declaration">
186+
<h4>Declaration</h4>
187+
<div class="language">
188+
<p class="aside-title">Swift</p>
189+
<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>
190+
191+
</div>
192+
</div>
193+
<div>
194+
<h4>Parameters</h4>
195+
<table class="graybox">
196+
<tbody>
197+
<tr>
198+
<td>
199+
<code>
200+
<em>steppers</em>
201+
</code>
202+
</td>
203+
<td>
204+
<div>
205+
<p>all these Steppers will be observed by the Coordinator</p>
206+
</div>
207+
</td>
208+
</tr>
209+
</tbody>
210+
</table>
211+
</div>
159212
</section>
160213
</div>
161214
</li>
162215
<li class="item">
163216
<div>
164217
<code>
165-
<a name="/"></a>
218+
<a name="/s:6RxFlow7StepperP16readyToEmitStepsyyF"></a>
166219
<a name="//apple_ref/swift/Method/readyToEmitSteps()" class="dashAnchor"></a>
167-
<a class="token" href="#/">readyToEmitSteps()</a>
220+
<a class="token" href="#/s:6RxFlow7StepperP16readyToEmitStepsyyF">readyToEmitSteps()</a>
168221
</code>
169222
</div>
170223
<div class="height-container">
@@ -174,6 +227,14 @@ <h1>CompositeStepper</h1>
174227
<div class="abstract">
175228

176229
</div>
230+
<div class="declaration">
231+
<h4>Declaration</h4>
232+
<div class="language">
233+
<p class="aside-title">Swift</p>
234+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">readyToEmitSteps</span><span class="p">()</span></code></pre>
235+
236+
</div>
237+
</div>
177238
</section>
178239
</div>
179240
</li>
@@ -182,11 +243,10 @@ <h1>CompositeStepper</h1>
182243
</section>
183244
</section>
184245
<section id="footer">
185-
<p>&copy; 2020 <a class="link" href="https://github.com/RxSwiftCommunity/RxFlow" target="_blank" rel="external">Thibault Wittemberg and RxSwiftCommunity</a>. All rights reserved. (Last updated: 2020-09-09)</p>
186-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
246+
<p>&copy; 2023 <a class="link" href="https://github.com/RxSwiftCommunity/RxFlow" target="_blank" rel="external noopener">Thibault Wittemberg and RxSwiftCommunity</a>. All rights reserved. (Last updated: 2023-11-27)</p>
247+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
187248
</section>
188249
</article>
189250
</div>
190251
</body>
191-
</div>
192252
</html>

0 commit comments

Comments
 (0)