Skip to content

Commit b5b60ad

Browse files
Sparkle-BotSparkle-Bot
committed
Update API documentation
1 parent 90a0ff7 commit b5b60ad

Some content is hidden

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

57 files changed

+180
-172
lines changed

‎documentation/api-reference/Classes/SPUDownloadData.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<header>
1717
<div class="content-wrapper">
1818
<p>
19-
<a href="../index.html">Sparkle 2.8.0 Docs</a>
19+
<a href="../index.html">Sparkle 2.8.1 Docs</a>
2020
<span class="no-mobile"> (59% documented)</span>
2121
</p>
2222

@@ -356,8 +356,8 @@ <h4>Declaration</h4>
356356
</div>
357357
<div class="footer-wrapper">
358358
<section id="footer">
359-
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-09-16)</p>
360-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
359+
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-11-15)</p>
360+
<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>
361361
</section>
362362
</div>
363363
</div>

‎documentation/api-reference/Classes/SPUStandardUpdaterController.html‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<header>
1717
<div class="content-wrapper">
1818
<p>
19-
<a href="../index.html">Sparkle 2.8.0 Docs</a>
19+
<a href="../index.html">Sparkle 2.8.1 Docs</a>
2020
<span class="no-mobile"> (59% documented)</span>
2121
</p>
2222

@@ -255,6 +255,8 @@ <h4>Declaration</h4>
255255

256256
<p>The updater is started automatically. See <code><a href="../Classes/SPUStandardUpdaterController.html#/c:objc(cs)SPUStandardUpdaterController(im)startUpdater">-startUpdater</a></code> for more information.</p>
257257

258+
<p>Note the <code><a href="../Classes/SPUStandardUpdaterController.html#/c:objc(cs)SPUStandardUpdaterController@updaterDelegate">updaterDelegate</a></code> and <code><a href="../Classes/SPUStandardUpdaterController.html#/c:objc(cs)SPUStandardUpdaterController@userDriverDelegate">userDriverDelegate</a></code> are weakly referenced, so you are responsible for keeping them alive.</p>
259+
258260
</div>
259261
<div class="declaration">
260262
<h4>Declaration</h4>
@@ -293,6 +295,8 @@ <h4>Declaration</h4>
293295
<p>You can specify whether or not you want to start the updater immediately.
294296
If you do not start the updater, you must invoke <code><a href="../Classes/SPUStandardUpdaterController.html#/c:objc(cs)SPUStandardUpdaterController(im)startUpdater">-startUpdater</a></code> at a later time to start it.</p>
295297

298+
<p>Note the <code><a href="../Classes/SPUStandardUpdaterController.html#/c:objc(cs)SPUStandardUpdaterController@updaterDelegate">updaterDelegate</a></code> and <code><a href="../Classes/SPUStandardUpdaterController.html#/c:objc(cs)SPUStandardUpdaterController@userDriverDelegate">userDriverDelegate</a></code> are weakly referenced, so you are responsible for keeping them alive.</p>
299+
296300
</div>
297301
<div class="declaration">
298302
<h4>Declaration</h4>
@@ -560,8 +564,8 @@ <h4>Declaration</h4>
560564
</div>
561565
<div class="footer-wrapper">
562566
<section id="footer">
563-
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-09-16)</p>
564-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
567+
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-11-15)</p>
568+
<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>
565569
</section>
566570
</div>
567571
</div>

‎documentation/api-reference/Classes/SPUStandardUserDriver.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<header>
1717
<div class="content-wrapper">
1818
<p>
19-
<a href="../index.html">Sparkle 2.8.0 Docs</a>
19+
<a href="../index.html">Sparkle 2.8.1 Docs</a>
2020
<span class="no-mobile"> (59% documented)</span>
2121
</p>
2222

@@ -115,7 +115,7 @@ <h4>Parameters</h4>
115115
</td>
116116
<td>
117117
<div>
118-
<p>The optional delegate to this user driver.</p>
118+
<p>The optional delegate to this user driver. Note the standard user driver weakly references the delegate, so you are responsible for keeping it alive.</p>
119119
</div>
120120
</td>
121121
</tr>
@@ -322,8 +322,8 @@ <h4>Declaration</h4>
322322
</div>
323323
<div class="footer-wrapper">
324324
<section id="footer">
325-
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-09-16)</p>
326-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
325+
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-11-15)</p>
326+
<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>
327327
</section>
328328
</div>
329329
</div>

‎documentation/api-reference/Classes/SPUUpdatePermissionRequest.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<header>
1717
<div class="content-wrapper">
1818
<p>
19-
<a href="../index.html">Sparkle 2.8.0 Docs</a>
19+
<a href="../index.html">Sparkle 2.8.1 Docs</a>
2020
<span class="no-mobile"> (59% documented)</span>
2121
</p>
2222

@@ -310,8 +310,8 @@ <h4>Declaration</h4>
310310
</div>
311311
<div class="footer-wrapper">
312312
<section id="footer">
313-
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-09-16)</p>
314-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
313+
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-11-15)</p>
314+
<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>
315315
</section>
316316
</div>
317317
</div>

‎documentation/api-reference/Classes/SPUUpdater.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<header>
1717
<div class="content-wrapper">
1818
<p>
19-
<a href="../index.html">Sparkle 2.8.0 Docs</a>
19+
<a href="../index.html">Sparkle 2.8.1 Docs</a>
2020
<span class="no-mobile"> (59% documented)</span>
2121
</p>
2222

@@ -164,7 +164,7 @@ <h4>Parameters</h4>
164164
</td>
165165
<td>
166166
<div>
167-
<p>The delegate for <code>SPUUpdater</code>.</p>
167+
<p>The delegate for <code>SPUUpdater</code>. Note the updater weakly references the delegate, so you are responsible for keeping it alive.</p>
168168
</div>
169169
</td>
170170
</tr>
@@ -1210,8 +1210,8 @@ <h4>Declaration</h4>
12101210
</div>
12111211
<div class="footer-wrapper">
12121212
<section id="footer">
1213-
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-09-16)</p>
1214-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
1213+
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-11-15)</p>
1214+
<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>
12151215
</section>
12161216
</div>
12171217
</div>

‎documentation/api-reference/Classes/SPUUpdaterSettings.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<header>
1717
<div class="content-wrapper">
1818
<p>
19-
<a href="../index.html">Sparkle 2.8.0 Docs</a>
19+
<a href="../index.html">Sparkle 2.8.1 Docs</a>
2020
<span class="no-mobile"> (59% documented)</span>
2121
</p>
2222

@@ -467,8 +467,8 @@ <h4>Declaration</h4>
467467
</div>
468468
<div class="footer-wrapper">
469469
<section id="footer">
470-
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-09-16)</p>
471-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
470+
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-11-15)</p>
471+
<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>
472472
</section>
473473
</div>
474474
</div>

‎documentation/api-reference/Classes/SPUUserUpdateState.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<header>
1717
<div class="content-wrapper">
1818
<p>
19-
<a href="../index.html">Sparkle 2.8.0 Docs</a>
19+
<a href="../index.html">Sparkle 2.8.1 Docs</a>
2020
<span class="no-mobile"> (59% documented)</span>
2121
</p>
2222

@@ -323,8 +323,8 @@ <h4>Declaration</h4>
323323
</div>
324324
<div class="footer-wrapper">
325325
<section id="footer">
326-
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-09-16)</p>
327-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
326+
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-11-15)</p>
327+
<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>
328328
</section>
329329
</div>
330330
</div>

‎documentation/api-reference/Classes/SUAppcast.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<header>
1717
<div class="content-wrapper">
1818
<p>
19-
<a href="../index.html">Sparkle 2.8.0 Docs</a>
19+
<a href="../index.html">Sparkle 2.8.1 Docs</a>
2020
<span class="no-mobile"> (59% documented)</span>
2121
</p>
2222

@@ -291,8 +291,8 @@ <h4>Declaration</h4>
291291
</div>
292292
<div class="footer-wrapper">
293293
<section id="footer">
294-
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-09-16)</p>
295-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
294+
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-11-15)</p>
295+
<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>
296296
</section>
297297
</div>
298298
</div>

‎documentation/api-reference/Classes/SUAppcastItem.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<header>
1717
<div class="content-wrapper">
1818
<p>
19-
<a href="../index.html">Sparkle 2.8.0 Docs</a>
19+
<a href="../index.html">Sparkle 2.8.1 Docs</a>
2020
<span class="no-mobile"> (59% documented)</span>
2121
</p>
2222

@@ -1601,8 +1601,8 @@ <h4>Declaration</h4>
16011601
</div>
16021602
<div class="footer-wrapper">
16031603
<section id="footer">
1604-
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-09-16)</p>
1605-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
1604+
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-11-15)</p>
1605+
<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>
16061606
</section>
16071607
</div>
16081608
</div>

‎documentation/api-reference/Classes/SUStandardVersionComparator.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<header>
1717
<div class="content-wrapper">
1818
<p>
19-
<a href="../index.html">Sparkle 2.8.0 Docs</a>
19+
<a href="../index.html">Sparkle 2.8.1 Docs</a>
2020
<span class="no-mobile"> (59% documented)</span>
2121
</p>
2222

@@ -366,8 +366,8 @@ <h4>Return Value</h4>
366366
</div>
367367
<div class="footer-wrapper">
368368
<section id="footer">
369-
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-09-16)</p>
370-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
369+
<p>&copy; 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-11-15)</p>
370+
<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>
371371
</section>
372372
</div>
373373
</div>

0 commit comments

Comments
 (0)