Skip to content

Commit ec0a461

Browse files
jessesquiresjessesquires
committed
[0.1.9] release. gen docs.
1 parent 8904667 commit ec0a461

31 files changed

+745
-60
lines changed

‎Sources/CollectionViewDriver.swift‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -613,6 +613,7 @@ extension CollectionViewDriver: UICollectionViewDelegateFlowLayout {
613613
// MARK: - CustomDebugStringConvertible
614614

615615
extension CollectionViewDriver {
616+
/// :nodoc:
616617
override public var debugDescription: String {
617618
MainActor.assumeIsolated {
618619
driverDebugDescription(self, self._emptyViewProvider, self._cellEventCoordinator)

‎docs/Classes.html‎

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@
4242
<li class="nav-group-task">
4343
<a href="Classes/CollectionViewDriver.html">CollectionViewDriver</a>
4444
</li>
45+
<li class="nav-group-task">
46+
<a href="Classes/RCKLogger.html">RCKLogger</a>
47+
</li>
4548
</ul>
4649
</li>
4750
<li class="nav-group-name">
@@ -78,6 +81,9 @@
7881
<li class="nav-group-task">
7982
<a href="Protocols/DiffableViewModel.html">DiffableViewModel</a>
8083
</li>
84+
<li class="nav-group-task">
85+
<a href="Protocols/Logging.html">Logging</a>
86+
</li>
8187
<li class="nav-group-task">
8288
<a href="Protocols/SupplementaryFooterViewModel.html">SupplementaryFooterViewModel</a>
8389
</li>
@@ -175,13 +181,43 @@ <h4>Declaration</h4>
175181
</section>
176182
</div>
177183
</li>
184+
<li class="item">
185+
<div>
186+
<code>
187+
<a name="/s:22ReactiveCollectionsKit9RCKLoggerC"></a>
188+
<a name="//apple_ref/swift/Class/RCKLogger" class="dashAnchor"></a>
189+
<a class="token" href="#/s:22ReactiveCollectionsKit9RCKLoggerC">RCKLogger</a>
190+
</code>
191+
</div>
192+
<div class="height-container">
193+
<div class="pointer-container"></div>
194+
<section class="section">
195+
<div class="pointer"></div>
196+
<div class="abstract">
197+
<p>A default <code><a href="Protocols/Logging.html">Logging</a></code> implementation to log debug messages.</p>
198+
199+
<p>You can set this logger for the <code><a href="Classes/CollectionViewDriver.html#/s:22ReactiveCollectionsKit20CollectionViewDriverC6loggerAA7Logging_pSgvp">CollectionViewDriver.logger</a></code>.</p>
200+
201+
<a href="Classes/RCKLogger.html" class="slightly-smaller">See more</a>
202+
</div>
203+
<div class="declaration">
204+
<h4>Declaration</h4>
205+
<div class="language">
206+
<p class="aside-title">Swift</p>
207+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">RCKLogger</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Logging.html">Logging</a></span></code></pre>
208+
209+
</div>
210+
</div>
211+
</section>
212+
</div>
213+
</li>
178214
</ul>
179215
</div>
180216
</section>
181217
</section>
182218
<section id="footer">
183-
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-10-14)</p>
184-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
219+
<p>&copy; 2025 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2025-12-08)</p>
220+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
185221
</section>
186222
</article>
187223
</div>

‎docs/Classes/CollectionViewDriver.html‎

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@
4444
<li class="nav-group-task">
4545
<a href="../Classes/CollectionViewDriver.html">CollectionViewDriver</a>
4646
</li>
47+
<li class="nav-group-task">
48+
<a href="../Classes/RCKLogger.html">RCKLogger</a>
49+
</li>
4750
</ul>
4851
</li>
4952
<li class="nav-group-name">
@@ -80,6 +83,9 @@
8083
<li class="nav-group-task">
8184
<a href="../Protocols/DiffableViewModel.html">DiffableViewModel</a>
8285
</li>
86+
<li class="nav-group-task">
87+
<a href="../Protocols/Logging.html">Logging</a>
88+
</li>
8389
<li class="nav-group-task">
8490
<a href="../Protocols/SupplementaryFooterViewModel.html">SupplementaryFooterViewModel</a>
8591
</li>
@@ -319,6 +325,41 @@ <h4>Declaration</h4>
319325
<pre class="highlight swift"><code><span class="kd">@MainActor</span>
320326
<span class="kd">public</span> <span class="k">weak</span> <span class="k">var</span> <span class="nv">flowLayoutDelegate</span><span class="p">:</span> <span class="kt">UICollectionViewDelegateFlowLayout</span><span class="p">?</span></code></pre>
321327

328+
</div>
329+
</div>
330+
</section>
331+
</div>
332+
</li>
333+
<li class="item">
334+
<div>
335+
<code>
336+
<a name="/s:22ReactiveCollectionsKit20CollectionViewDriverC6loggerAA7Logging_pSgvp"></a>
337+
<a name="//apple_ref/swift/Property/logger" class="dashAnchor"></a>
338+
<a class="token" href="#/s:22ReactiveCollectionsKit20CollectionViewDriverC6loggerAA7Logging_pSgvp">logger</a>
339+
</code>
340+
</div>
341+
<div class="height-container">
342+
<div class="pointer-container"></div>
343+
<section class="section">
344+
<div class="pointer"></div>
345+
<div class="abstract">
346+
<p>A debug logger to log messages that track the internal operations of the driver.
347+
The default value is <code>nil</code>.</p>
348+
<div class="aside aside-note">
349+
<p class="aside-title">Note</p>
350+
You may wish to set this property to the library-provided logger, <code><a href="../Classes/RCKLogger.html#/s:22ReactiveCollectionsKit9RCKLoggerC6sharedACvpZ">RCKLogger.shared</a></code>.
351+
However, you can also provide your own implementation via the <code><a href="../Protocols/Logging.html">Logging</a></code> protocol.
352+
353+
</div>
354+
355+
</div>
356+
<div class="declaration">
357+
<h4>Declaration</h4>
358+
<div class="language">
359+
<p class="aside-title">Swift</p>
360+
<pre class="highlight swift"><code><span class="kd">@MainActor</span>
361+
<span class="kd">public</span> <span class="k">var</span> <span class="nv">logger</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Logging.html">Logging</a></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>
362+
322363
</div>
323364
</div>
324365
</section>
@@ -708,8 +749,8 @@ <h4>Parameters</h4>
708749
</section>
709750
</section>
710751
<section id="footer">
711-
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-10-14)</p>
712-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
752+
<p>&copy; 2025 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2025-12-08)</p>
753+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
713754
</section>
714755
</article>
715756
</div>

‎docs/Classes/RCKLogger.html‎

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>RCKLogger Class Reference</title>
5+
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
6+
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
7+
<meta charset='utf-8'>
8+
<script src="../js/jquery.min.js" defer></script>
9+
<script src="../js/jazzy.js" defer></script>
10+
11+
<script src="../js/lunr.min.js" defer></script>
12+
<script src="../js/typeahead.jquery.js" defer></script>
13+
<script src="../js/jazzy.search.js" defer></script>
14+
</head>
15+
<body>
16+
<a name="//apple_ref/swift/Class/RCKLogger" class="dashAnchor"></a>
17+
<a title="RCKLogger Class Reference"></a>
18+
<header>
19+
<div class="content-wrapper">
20+
<p><a href="../index.html">ReactiveCollectionsKit Docs</a> (100% documented)</p>
21+
<p class="header-right"><a href="https://github.com/jessesquires/ReactiveCollectionsKit"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
22+
<div class="header-right">
23+
<form role="search" action="../search.json">
24+
<input type="text" placeholder="Search documentation" data-typeahead>
25+
</form>
26+
</div>
27+
</div>
28+
</header>
29+
<div class="content-wrapper">
30+
<p id="breadcrumbs">
31+
<a href="../index.html">ReactiveCollectionsKit</a>
32+
<img id="carat" src="../img/carat.png" alt=""/>
33+
<a href="../Classes.html">Classes</a>
34+
<img id="carat" src="../img/carat.png" alt=""/>
35+
RCKLogger Class Reference
36+
</p>
37+
</div>
38+
<div class="content-wrapper">
39+
<nav class="sidebar">
40+
<ul class="nav-groups">
41+
<li class="nav-group-name">
42+
<a href="../Classes.html">Classes</a>
43+
<ul class="nav-group-tasks">
44+
<li class="nav-group-task">
45+
<a href="../Classes/CollectionViewDriver.html">CollectionViewDriver</a>
46+
</li>
47+
<li class="nav-group-task">
48+
<a href="../Classes/RCKLogger.html">RCKLogger</a>
49+
</li>
50+
</ul>
51+
</li>
52+
<li class="nav-group-name">
53+
<a href="../Enums.html">Enumerations</a>
54+
<ul class="nav-group-tasks">
55+
<li class="nav-group-task">
56+
<a href="../Enums/ViewRegistrationMethod.html">ViewRegistrationMethod</a>
57+
</li>
58+
<li class="nav-group-task">
59+
<a href="../Enums/ViewRegistrationViewType.html">ViewRegistrationViewType</a>
60+
</li>
61+
</ul>
62+
</li>
63+
<li class="nav-group-name">
64+
<a href="../Extensions.html">Extensions</a>
65+
<ul class="nav-group-tasks">
66+
<li class="nav-group-task">
67+
<a href="../Extensions.html#/s:s11AnyHashableV">AnyHashable</a>
68+
</li>
69+
<li class="nav-group-task">
70+
<a href="../Extensions/UICollectionView.html">UICollectionView</a>
71+
</li>
72+
</ul>
73+
</li>
74+
<li class="nav-group-name">
75+
<a href="../Protocols.html">Protocols</a>
76+
<ul class="nav-group-tasks">
77+
<li class="nav-group-task">
78+
<a href="../Protocols/CellEventCoordinator.html">CellEventCoordinator</a>
79+
</li>
80+
<li class="nav-group-task">
81+
<a href="../Protocols/CellViewModel.html">CellViewModel</a>
82+
</li>
83+
<li class="nav-group-task">
84+
<a href="../Protocols/DiffableViewModel.html">DiffableViewModel</a>
85+
</li>
86+
<li class="nav-group-task">
87+
<a href="../Protocols/Logging.html">Logging</a>
88+
</li>
89+
<li class="nav-group-task">
90+
<a href="../Protocols/SupplementaryFooterViewModel.html">SupplementaryFooterViewModel</a>
91+
</li>
92+
<li class="nav-group-task">
93+
<a href="../Protocols/SupplementaryHeaderViewModel.html">SupplementaryHeaderViewModel</a>
94+
</li>
95+
<li class="nav-group-task">
96+
<a href="../Protocols/SupplementaryViewModel.html">SupplementaryViewModel</a>
97+
</li>
98+
<li class="nav-group-task">
99+
<a href="../Protocols/ViewRegistrationProvider.html">ViewRegistrationProvider</a>
100+
</li>
101+
</ul>
102+
</li>
103+
<li class="nav-group-name">
104+
<a href="../Structs.html">Structures</a>
105+
<ul class="nav-group-tasks">
106+
<li class="nav-group-task">
107+
<a href="../Structs/AnyCellViewModel.html">AnyCellViewModel</a>
108+
</li>
109+
<li class="nav-group-task">
110+
<a href="../Structs/AnySupplementaryViewModel.html">AnySupplementaryViewModel</a>
111+
</li>
112+
<li class="nav-group-task">
113+
<a href="../Structs/CollectionViewDriverOptions.html">CollectionViewDriverOptions</a>
114+
</li>
115+
<li class="nav-group-task">
116+
<a href="../Structs/CollectionViewModel.html">CollectionViewModel</a>
117+
</li>
118+
<li class="nav-group-task">
119+
<a href="../Structs/EmptyViewProvider.html">EmptyViewProvider</a>
120+
</li>
121+
<li class="nav-group-task">
122+
<a href="../Structs/SectionViewModel.html">SectionViewModel</a>
123+
</li>
124+
<li class="nav-group-task">
125+
<a href="../Structs/ViewRegistration.html">ViewRegistration</a>
126+
</li>
127+
</ul>
128+
</li>
129+
<li class="nav-group-name">
130+
<a href="../Typealiases.html">Type Aliases</a>
131+
<ul class="nav-group-tasks">
132+
<li class="nav-group-task">
133+
<a href="../Typealiases.html#/s:22ReactiveCollectionsKit21SupplementaryViewKinda">SupplementaryViewKind</a>
134+
</li>
135+
<li class="nav-group-task">
136+
<a href="../Typealiases.html#/s:22ReactiveCollectionsKit16UniqueIdentifiera">UniqueIdentifier</a>
137+
</li>
138+
</ul>
139+
</li>
140+
</ul>
141+
</nav>
142+
<article class="main-content">
143+
<section>
144+
<section class="section">
145+
<h1>RCKLogger</h1>
146+
<div class="declaration">
147+
<div class="language">
148+
149+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">RCKLogger</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/Logging.html">Logging</a></span></code></pre>
150+
151+
</div>
152+
</div>
153+
<p>A default <code><a href="../Protocols/Logging.html">Logging</a></code> implementation to log debug messages.</p>
154+
155+
<p>You can set this logger for the <code><a href="../Classes/CollectionViewDriver.html#/s:22ReactiveCollectionsKit20CollectionViewDriverC6loggerAA7Logging_pSgvp">CollectionViewDriver.logger</a></code>.</p>
156+
157+
</section>
158+
<section class="section task-group-section">
159+
<div class="task-group">
160+
<ul>
161+
<li class="item">
162+
<div>
163+
<code>
164+
<a name="/s:22ReactiveCollectionsKit9RCKLoggerC6sharedACvpZ"></a>
165+
<a name="//apple_ref/swift/Variable/shared" class="dashAnchor"></a>
166+
<a class="token" href="#/s:22ReactiveCollectionsKit9RCKLoggerC6sharedACvpZ">shared</a>
167+
</code>
168+
</div>
169+
<div class="height-container">
170+
<div class="pointer-container"></div>
171+
<section class="section">
172+
<div class="pointer"></div>
173+
<div class="abstract">
174+
<p>The shared logger instance.</p>
175+
176+
</div>
177+
<div class="declaration">
178+
<h4>Declaration</h4>
179+
<div class="language">
180+
<p class="aside-title">Swift</p>
181+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">shared</span><span class="p">:</span> <span class="kt">RCKLogger</span></code></pre>
182+
183+
</div>
184+
</div>
185+
</section>
186+
</div>
187+
</li>
188+
</ul>
189+
</div>
190+
</section>
191+
</section>
192+
<section id="footer">
193+
<p>&copy; 2025 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2025-12-08)</p>
194+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
195+
</section>
196+
</article>
197+
</div>
198+
</body>
199+
</html>

‎docs/Enums.html‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@
4242
<li class="nav-group-task">
4343
<a href="Classes/CollectionViewDriver.html">CollectionViewDriver</a>
4444
</li>
45+
<li class="nav-group-task">
46+
<a href="Classes/RCKLogger.html">RCKLogger</a>
47+
</li>
4548
</ul>
4649
</li>
4750
<li class="nav-group-name">
@@ -78,6 +81,9 @@
7881
<li class="nav-group-task">
7982
<a href="Protocols/DiffableViewModel.html">DiffableViewModel</a>
8083
</li>
84+
<li class="nav-group-task">
85+
<a href="Protocols/Logging.html">Logging</a>
86+
</li>
8187
<li class="nav-group-task">
8288
<a href="Protocols/SupplementaryFooterViewModel.html">SupplementaryFooterViewModel</a>
8389
</li>
@@ -202,8 +208,8 @@ <h4>Declaration</h4>
202208
</section>
203209
</section>
204210
<section id="footer">
205-
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-10-14)</p>
206-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
211+
<p>&copy; 2025 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2025-12-08)</p>
212+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
207213
</section>
208214
</article>
209215
</div>

0 commit comments

Comments
 (0)