SparkleProject/sparkle-project.github.io
1
0
Fork 0
mirror of https://github.com/sparkle-project/sparkle-project.github.io.git synced 2025-11-01 15:35:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update API documentation

Browse Source
This commit is contained in:
Sparkle-Bot
2025-02-23 14:54:02 +00:00
parent 45f77df62d
commit d03e2c2e69
60 changed files with 196 additions and 178 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/api-reference/Protocols/SPUStandardUserDriverDelegate.html
+3 -3
View File
@@ -16,7 +16,7 @@
<header>
<div class="content-wrapper">
<p>
<a href="../index.html">Sparkle 2.6.4 Docs</a>
<a href="../index.html">Sparkle 2.7.0 Docs</a>
<span class="no-mobile"> (59% documented)</span>
</p>
@@ -819,8 +819,8 @@ please see <code><a href="../Protocols/SPUStandardUserDriverDelegate.html#/c:obj
</div>
<div class="footer-wrapper">
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2024-07-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<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-02-23)</p>
<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>
</section>
</div>
</div>
documentation/api-reference/Protocols/SPUUpdaterDelegate.html
+15 -6
View File
@@ -16,7 +16,7 @@
<header>
<div class="content-wrapper">
<p>
<a href="../index.html">Sparkle 2.6.4 Docs</a>
<a href="../index.html">Sparkle 2.7.0 Docs</a>
<span class="no-mobile"> (59% documented)</span>
</p>
@@ -198,7 +198,7 @@ This feature was added in Sparkle 2.</p>
<div>
<h4>Return Value</h4>
<p>The set of channel names the updater is allowed to find new updates in. An empty set is the default behavior,
which means the updater will only look for updates in the default channel.</p>
which means the updater will only look for updates in the default channel. The default channel is always included in the allowed set.</p>
</div>
</section>
</div>
@@ -346,7 +346,11 @@ This feature was added in Sparkle 2.</p>
<div class="abstract">
<p>Returns whether Sparkle should prompt the user about checking for new updates automatically.</p>
<p>Use this to override the default behavior.</p>
<p>Use this to override the default behavior, which is to prompt for permission to check for updates on second app launch
(if SUEnableAutomaticChecks is not specified).</p>
<p>This method is not called if SUEnableAutomaticChecks is defined in Info.plist or
if the user has responded to a permission prompt before.</p>
</div>
<div class="declaration">
@@ -1730,13 +1734,18 @@ This method can be used to explicitly prevent a relaunch.</p>
<code>
<a name="/c:objc(pl)SPUUpdaterDelegate(im)versionComparatorForUpdater:"></a>
<a name="//apple_ref/objc/Method/-versionComparatorForUpdater:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)SPUUpdaterDelegate(im)versionComparatorForUpdater:">-versionComparatorForUpdater:<wbr></a>
<a class="token discouraged" href="#/c:objc(pl)SPUUpdaterDelegate(im)versionComparatorForUpdater:">-versionComparatorForUpdater:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="aside aside-deprecated">
<p class="aside-title">Deprecated</p>
<p>Custom version comparators are deprecated because they are incompatible with how the system compares different versions of an app.</p>
</div>
<div class="abstract">
<p>Returns an object that compares version numbers to determine their arithmetic relation to each other.</p>
@@ -2455,8 +2464,8 @@ even if you provide a custom comparator here.</p>
</div>
<div class="footer-wrapper">
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2024-07-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<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-02-23)</p>
<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>
</section>
</div>
</div>
documentation/api-reference/Protocols/SPUUserDriver.html
+3 -3
View File
@@ -16,7 +16,7 @@
<header>
<div class="content-wrapper">
<p>
<a href="../index.html">Sparkle 2.6.4 Docs</a>
<a href="../index.html">Sparkle 2.7.0 Docs</a>
<span class="no-mobile"> (59% documented)</span>
</p>
@@ -1485,8 +1485,8 @@ Note this handler should not be invoked if <code>applicationTerminated</code> is
</div>
<div class="footer-wrapper">
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2024-07-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<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-02-23)</p>
<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>
</section>
</div>
</div>
documentation/api-reference/Protocols/SUUpdaterDelegate.html
+3 -3
View File
@@ -16,7 +16,7 @@
<header>
<div class="content-wrapper">
<p>
<a href="../index.html">Sparkle 2.6.4 Docs</a>
<a href="../index.html">Sparkle 2.7.0 Docs</a>
<span class="no-mobile"> (59% documented)</span>
</p>
@@ -1447,8 +1447,8 @@
</div>
<div class="footer-wrapper">
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2024-07-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<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-02-23)</p>
<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>
</section>
</div>
</div>
documentation/api-reference/Protocols/SUVersionComparison.html
+3 -3
View File
@@ -16,7 +16,7 @@
<header>
<div class="content-wrapper">
<p>
<a href="../index.html">Sparkle 2.6.4 Docs</a>
<a href="../index.html">Sparkle 2.7.0 Docs</a>
<span class="no-mobile"> (59% documented)</span>
</p>
@@ -262,8 +262,8 @@ and NSOrderedSame if they are equivalent.</p>
</div>
<div class="footer-wrapper">
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2024-07-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<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-02-23)</p>
<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>
</section>
</div>
</div>
documentation/api-reference/Protocols/SUVersionDisplay.html
+3 -3
View File
@@ -16,7 +16,7 @@
<header>
<div class="content-wrapper">
<p>
<a href="../index.html">Sparkle 2.6.4 Docs</a>
<a href="../index.html">Sparkle 2.7.0 Docs</a>
<span class="no-mobile"> (59% documented)</span>
</p>
@@ -448,8 +448,8 @@ can be displayed while also leaving out unnecessary/confusing parts.</p>
</div>
<div class="footer-wrapper">
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2024-07-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<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-02-23)</p>
<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>
</section>
</div>
</div>