Skip to content

Commit

Permalink
[Docs] Gen docs for 0.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@jessesquires
jessesquires committed Jul 6, 2018
1 parent da6b934 commit 75d042a
Show file tree
Hide file tree
Showing 63 changed files with 1,569 additions and 759 deletions.
38 changes: 22 additions & 16 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

</head>
<body>
<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
Expand Down Expand Up @@ -75,6 +76,9 @@
<li class="nav-group-task">
<a href="Protocols/DiffableViewModel.html">DiffableViewModel</a>
</li>
<li class="nav-group-task">
<a href="Protocols/ReusableCellProtocol.html">ReusableCellProtocol</a>
</li>
<li class="nav-group-task">
<a href="Protocols/ReusableCellViewModelProtocol.html">ReusableCellViewModelProtocol</a>
</li>
Expand Down Expand Up @@ -138,26 +142,27 @@ <h1>Classes</h1>
<li class="item">
<div>
<code>
<a name="/c:@M@ReactiveLists@objc(cs)TableViewDriver"></a>
<a name="//apple_ref/swift/Class/TableViewDriver" class="dashAnchor"></a>
<a class="token" href="#/c:@M@ReactiveLists@objc(cs)TableViewDriver">TableViewDriver</a>
<a name="/c:@M@ReactiveLists@objc(cs)CollectionViewDriver"></a>
<a name="//apple_ref/swift/Class/CollectionViewDriver" class="dashAnchor"></a>
<a class="token" href="#/c:@M@ReactiveLists@objc(cs)CollectionViewDriver">CollectionViewDriver</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A data source that drives the table views appereance and behavior based on an underlying
<code><a href="Structs/TableViewModel.html">TableViewModel</a></code>.</p>
<p>A data source that drives the collection views appereance and behavior based on an underlying
<code><a href="Structs/CollectionViewModel.html">CollectionViewModel</a></code>.</p>

<a href="Classes/TableViewDriver.html" class="slightly-smaller">See more</a>
<a href="Classes/CollectionViewDriver.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">TableViewDriver</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
<pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">CollectionViewDriver</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

</div>
</div>
Expand All @@ -171,26 +176,27 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/c:@M@ReactiveLists@objc(cs)CollectionViewDriver"></a>
<a name="//apple_ref/swift/Class/CollectionViewDriver" class="dashAnchor"></a>
<a class="token" href="#/c:@M@ReactiveLists@objc(cs)CollectionViewDriver">CollectionViewDriver</a>
<a name="/c:@M@ReactiveLists@objc(cs)TableViewDriver"></a>
<a name="//apple_ref/swift/Class/TableViewDriver" class="dashAnchor"></a>
<a class="token" href="#/c:@M@ReactiveLists@objc(cs)TableViewDriver">TableViewDriver</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A data source that drives the collection views appereance and behavior based on an underlying
<code><a href="Structs/CollectionViewModel.html">CollectionViewModel</a></code>.</p>
<p>A data source that drives the table views appereance and behavior based on an underlying
<code><a href="Structs/TableViewModel.html">TableViewModel</a></code>.</p>

<a href="Classes/CollectionViewDriver.html" class="slightly-smaller">See more</a>
<a href="Classes/TableViewDriver.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">CollectionViewDriver</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
<pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">open</span> <span class="kd">class</span> <span class="kt">TableViewDriver</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

</div>
</div>
Expand All @@ -202,8 +208,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-02-07)</p>
<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>
<p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-07-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
36 changes: 20 additions & 16 deletions docs/Classes/CollectionViewDriver.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,9 @@
<li class="nav-group-task">
<a href="../Protocols/DiffableViewModel.html">DiffableViewModel</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/ReusableCellProtocol.html">ReusableCellProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/ReusableCellViewModelProtocol.html">ReusableCellViewModelProtocol</a>
</li>
Expand Down Expand Up @@ -132,7 +135,8 @@
<h1>CollectionViewDriver</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">CollectionViewDriver</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
<pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">CollectionViewDriver</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>

</div>
</div>
Expand All @@ -153,9 +157,9 @@ <h3 class="section-name">Properties</h3>
<li class="item">
<div>
<code>
<a name="/s:13ReactiveLists20CollectionViewDriverC010collectionD0So012UICollectionD0Cv"></a>
<a name="/s:13ReactiveLists20CollectionViewDriverC010collectionD0So012UICollectionD0Cvp"></a>
<a name="//apple_ref/swift/Property/collectionView" class="dashAnchor"></a>
<a class="token" href="#/s:13ReactiveLists20CollectionViewDriverC010collectionD0So012UICollectionD0Cv">collectionView</a>
<a class="token" href="#/s:13ReactiveLists20CollectionViewDriverC010collectionD0So012UICollectionD0Cvp">collectionView</a>
</code>
</div>
<div class="height-container">
Expand All @@ -180,9 +184,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgv"></a>
<a name="/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgvp"></a>
<a name="//apple_ref/swift/Property/collectionViewModel" class="dashAnchor"></a>
<a class="token" href="#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgv">collectionViewModel</a>
<a class="token" href="#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgvp">collectionViewModel</a>
</code>
</div>
<div class="height-container">
Expand All @@ -195,12 +199,12 @@ <h4>Declaration</h4>
<p>When this property is set, the UI of the related <code>UICollectionView</code> will be updated.
If not only the content of individual cells/sections has changed, but instead
cells/sections were moved/inserted/deleted, the behavior of this setter depends on the
value of the <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbv">automaticDiffingEnabled</a></code> property.</p>
value of the <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbvp">automaticDiffingEnabled</a></code> property.</p>

<p>If <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbv">automaticDiffingEnabled</a></code> is set to <code>true</code>, and cells/sections have been moved/inserted/deleted,
<p>If <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbvp">automaticDiffingEnabled</a></code> is set to <code>true</code>, and cells/sections have been moved/inserted/deleted,
updating this property will result in the UI of the collection view being updated automatically.</p>

<p>If <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbv">automaticDiffingEnabled</a></code> is set to <code>false</code>, and cells/sections have been moved/inserted/deleted,
<p>If <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbvp">automaticDiffingEnabled</a></code> is set to <code>false</code>, and cells/sections have been moved/inserted/deleted,
the caller must update the <code>UICollectionView</code> state manually, to bring it back in sync with
the new model, e.g. by calling <code>reloadData()</code> on the collection view.</p>

Expand All @@ -209,7 +213,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">collectionViewModel</span><span class="p">:</span> <span class="kt"><a href="../Structs/CollectionViewModel.html">CollectionViewModel</a></span><span class="p">?</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">collectionViewModel</span><span class="p">:</span> <span class="nf">CollectionViewModel</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

</div>
</div>
Expand All @@ -219,21 +223,21 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbv"></a>
<a name="/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbvp"></a>
<a name="//apple_ref/swift/Property/automaticDiffingEnabled" class="dashAnchor"></a>
<a class="token" href="#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbv">automaticDiffingEnabled</a>
<a class="token" href="#/s:13ReactiveLists20CollectionViewDriverC23automaticDiffingEnabledSbvp">automaticDiffingEnabled</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>If this property is set to <code>true</code>, updating the <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgv">collectionViewModel</a></code> will always
<p>If this property is set to <code>true</code>, updating the <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgvp">collectionViewModel</a></code> will always
automatically lead to updating the UI state of the <code>UICollectionView</code>, even if cells/sections
were moved/inserted/deleted.</p>

<p>For details, see the documentation for <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgv">CollectionViewDriver.collectionViewModel</a></code>.</p>
<p>For details, see the documentation for <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgvp">CollectionViewDriver.collectionViewModel</a></code>.</p>

</div>
<div class="declaration">
Expand Down Expand Up @@ -374,7 +378,7 @@ <h3 class="section-name">Change and UI Update Handling</h3>
<div class="abstract">
<p>Updates all currently visible cells and sections, such that they reflect the latest
state decribed in their respective view models. Typically this method should not be
called directly, as it is called automatically whenever the <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgv">collectionViewModel</a></code> property
called directly, as it is called automatically whenever the <code><a href="../Classes/CollectionViewDriver.html#/s:13ReactiveLists20CollectionViewDriverC010collectionD5ModelAA0cdG0VSgvp">collectionViewModel</a></code> property
is updated.</p>

</div>
Expand All @@ -394,8 +398,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-02-07)</p>
<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>
<p>&copy; 2018 <a class="link" href="https://twitter.com/PlanGrid" target="_blank" rel="external">PlanGrid</a>. All rights reserved. (Last updated: 2018-07-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
Loading

0 comments on commit 75d042a

Please sign in to comment.