Skip to content

Commit da12538

Browse files
committed
Update API documentation
1 parent 1dfa5b2 commit da12538

File tree

64 files changed

+2224
-337
lines changed

Some content is hidden

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

64 files changed

+2224
-337
lines changed

documentation/api-reference/Classes/SPUDownloadData.html

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

2323

@@ -50,7 +50,7 @@ <h1>SPUDownloadData</h1>
5050
</div>
5151
<div class="language">
5252
<p class="aside-title">Swift</p>
53-
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SPUDownloadData</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSSecureCoding</span></code></pre>
53+
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SPUDownloadData</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSSecureCoding</span><span class="p">,</span> <span class="kd">@unchecked</span> <span class="kt">Sendable</span></code></pre>
5454

5555
</div>
5656
</div>
@@ -311,6 +311,9 @@ <h4>Declaration</h4>
311311
<li class="nav-group-name">
312312
<a href="../Enums.html">Enumerations</a>
313313
<ul class="nav-group-tasks">
314+
<li class="nav-group-task">
315+
<a href="../Enums/SPUAppcastSigningValidationStatus.html">SPUAppcastSigningValidationStatus</a>
316+
</li>
314317
<li class="nav-group-task">
315318
<a href="../Enums/SPUNoUpdateFoundReason.html">SPUNoUpdateFoundReason</a>
316319
</li>
@@ -356,7 +359,7 @@ <h4>Declaration</h4>
356359
</div>
357360
<div class="footer-wrapper">
358361
<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-11-15)</p>
362+
<p>&copy; 2026 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2026-01-10)</p>
360363
<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>
361364
</section>
362365
</div>

documentation/api-reference/Classes/SPUStandardUpdaterController.html

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

2323

@@ -45,15 +45,16 @@ <h1>SPUStandardUpdaterController</h1>
4545
<div class="declaration">
4646
<div class="language">
4747
<p class="aside-title">Objective-C</p>
48-
<pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SPUStandardUpdaterController</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="p">{</span>
48+
<pre class="highlight objective_c"><code>
49+
<span class="k">@interface</span> <span class="nc">SPUStandardUpdaterController</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="p">{</span>
4950
<span class="n">id</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/SPUUpdaterDelegate.html">SPUUpdaterDelegate</a></span><span class="o">&gt;</span> <span class="n">updaterDelegate</span><span class="p">;</span>
5051
<span class="n">id</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/SPUStandardUserDriverDelegate.html">SPUStandardUserDriverDelegate</a></span><span class="o">&gt;</span> <span class="n">userDriverDelegate</span><span class="p">;</span>
5152
<span class="p">}</span></code></pre>
5253

5354
</div>
5455
<div class="language">
5556
<p class="aside-title">Swift</p>
56-
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SPUStandardUpdaterController</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
57+
<pre class="highlight swift"><code><span class="kd">@MainActor</span> <span class="kd">class</span> <span class="kt">SPUStandardUpdaterController</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
5758

5859
</div>
5960
</div>
@@ -270,7 +271,7 @@ <h4>Declaration</h4>
270271
</div>
271272
<div class="language">
272273
<p class="aside-title">Swift</p>
273-
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">updaterDelegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SPUUpdaterDelegate.html">SPUUpdaterDelegate</a></span><span class="p">?,</span> <span class="nv">userDriverDelegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SPUStandardUserDriverDelegate.html">SPUStandardUserDriverDelegate</a></span><span class="p">?)</span></code></pre>
274+
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">updaterDelegate</span><span class="p">:</span> <span class="p">(</span><span class="kd">any</span> <span class="kt"><a href="../Protocols/SPUUpdaterDelegate.html">SPUUpdaterDelegate</a></span><span class="p">)?,</span> <span class="nv">userDriverDelegate</span><span class="p">:</span> <span class="p">(</span><span class="kd">any</span> <span class="kt"><a href="../Protocols/SPUStandardUserDriverDelegate.html">SPUStandardUserDriverDelegate</a></span><span class="p">)?)</span></code></pre>
274275

275276
</div>
276277
</div>
@@ -311,7 +312,7 @@ <h4>Declaration</h4>
311312
</div>
312313
<div class="language">
313314
<p class="aside-title">Swift</p>
314-
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n">startingUpdater</span> <span class="nv">startUpdater</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">updaterDelegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SPUUpdaterDelegate.html">SPUUpdaterDelegate</a></span><span class="p">?,</span> <span class="nv">userDriverDelegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SPUStandardUserDriverDelegate.html">SPUStandardUserDriverDelegate</a></span><span class="p">?)</span></code></pre>
315+
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n">startingUpdater</span> <span class="nv">startUpdater</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">updaterDelegate</span><span class="p">:</span> <span class="p">(</span><span class="kd">any</span> <span class="kt"><a href="../Protocols/SPUUpdaterDelegate.html">SPUUpdaterDelegate</a></span><span class="p">)?,</span> <span class="nv">userDriverDelegate</span><span class="p">:</span> <span class="p">(</span><span class="kd">any</span> <span class="kt"><a href="../Protocols/SPUStandardUserDriverDelegate.html">SPUStandardUserDriverDelegate</a></span><span class="p">)?)</span></code></pre>
315316

316317
</div>
317318
</div>
@@ -519,6 +520,9 @@ <h4>Declaration</h4>
519520
<li class="nav-group-name">
520521
<a href="../Enums.html">Enumerations</a>
521522
<ul class="nav-group-tasks">
523+
<li class="nav-group-task">
524+
<a href="../Enums/SPUAppcastSigningValidationStatus.html">SPUAppcastSigningValidationStatus</a>
525+
</li>
522526
<li class="nav-group-task">
523527
<a href="../Enums/SPUNoUpdateFoundReason.html">SPUNoUpdateFoundReason</a>
524528
</li>
@@ -564,7 +568,7 @@ <h4>Declaration</h4>
564568
</div>
565569
<div class="footer-wrapper">
566570
<section id="footer">
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>
571+
<p>&copy; 2026 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2026-01-10)</p>
568572
<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>
569573
</section>
570574
</div>

documentation/api-reference/Classes/SPUStandardUserDriver.html

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

2323

@@ -45,12 +45,13 @@ <h1>SPUStandardUserDriver</h1>
4545
<div class="declaration">
4646
<div class="language">
4747
<p class="aside-title">Objective-C</p>
48-
<pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SPUStandardUserDriver</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o">&lt;</span><span class="n"><a href="../Protocols/SPUUserDriver.html">SPUUserDriver</a></span><span class="o">&gt;</span></code></pre>
48+
<pre class="highlight objective_c"><code>
49+
<span class="k">@interface</span> <span class="nc">SPUStandardUserDriver</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o">&lt;</span><span class="n"><a href="../Protocols/SPUUserDriver.html">SPUUserDriver</a></span><span class="o">&gt;</span></code></pre>
4950

5051
</div>
5152
<div class="language">
5253
<p class="aside-title">Swift</p>
53-
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SPUStandardUserDriver</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt"><a href="../Protocols/SPUUserDriver.html">SPUUserDriver</a></span></code></pre>
54+
<pre class="highlight swift"><code><span class="kd">@MainActor</span> <span class="kd">class</span> <span class="kt">SPUStandardUserDriver</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt"><a href="../Protocols/SPUUserDriver.html">SPUUserDriver</a></span></code></pre>
5455

5556
</div>
5657
</div>
@@ -87,7 +88,7 @@ <h4>Declaration</h4>
8788
</div>
8889
<div class="language">
8990
<p class="aside-title">Swift</p>
90-
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">hostBundle</span><span class="p">:</span> <span class="kt">Bundle</span><span class="p">,</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SPUStandardUserDriverDelegate.html">SPUStandardUserDriverDelegate</a></span><span class="p">?)</span></code></pre>
91+
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">hostBundle</span><span class="p">:</span> <span class="kt">Bundle</span><span class="p">,</span> <span class="nv">delegate</span><span class="p">:</span> <span class="p">(</span><span class="kd">any</span> <span class="kt"><a href="../Protocols/SPUStandardUserDriverDelegate.html">SPUStandardUserDriverDelegate</a></span><span class="p">)?)</span></code></pre>
9192

9293
</div>
9394
</div>
@@ -277,6 +278,9 @@ <h4>Declaration</h4>
277278
<li class="nav-group-name">
278279
<a href="../Enums.html">Enumerations</a>
279280
<ul class="nav-group-tasks">
281+
<li class="nav-group-task">
282+
<a href="../Enums/SPUAppcastSigningValidationStatus.html">SPUAppcastSigningValidationStatus</a>
283+
</li>
280284
<li class="nav-group-task">
281285
<a href="../Enums/SPUNoUpdateFoundReason.html">SPUNoUpdateFoundReason</a>
282286
</li>
@@ -322,7 +326,7 @@ <h4>Declaration</h4>
322326
</div>
323327
<div class="footer-wrapper">
324328
<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-11-15)</p>
329+
<p>&copy; 2026 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2026-01-10)</p>
326330
<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>
327331
</section>
328332
</div>

documentation/api-reference/Classes/SPUUpdatePermissionRequest.html

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

2323

@@ -50,7 +50,7 @@ <h1>SPUUpdatePermissionRequest</h1>
5050
</div>
5151
<div class="language">
5252
<p class="aside-title">Swift</p>
53-
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SPUUpdatePermissionRequest</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSSecureCoding</span></code></pre>
53+
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">SPUUpdatePermissionRequest</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSSecureCoding</span><span class="p">,</span> <span class="kd">@unchecked</span> <span class="kt">Sendable</span></code></pre>
5454

5555
</div>
5656
</div>
@@ -265,6 +265,9 @@ <h4>Declaration</h4>
265265
<li class="nav-group-name">
266266
<a href="../Enums.html">Enumerations</a>
267267
<ul class="nav-group-tasks">
268+
<li class="nav-group-task">
269+
<a href="../Enums/SPUAppcastSigningValidationStatus.html">SPUAppcastSigningValidationStatus</a>
270+
</li>
268271
<li class="nav-group-task">
269272
<a href="../Enums/SPUNoUpdateFoundReason.html">SPUNoUpdateFoundReason</a>
270273
</li>
@@ -310,7 +313,7 @@ <h4>Declaration</h4>
310313
</div>
311314
<div class="footer-wrapper">
312315
<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-11-15)</p>
316+
<p>&copy; 2026 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2026-01-10)</p>
314317
<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>
315318
</section>
316319
</div>

0 commit comments

Comments
 (0)