1 files changed, 7 insertions, 0 deletions
diff --git a/SwifTools/AutoUpdater/SparkleAutoUpdater.h b/SwifTools/AutoUpdater/SparkleAutoUpdater.h
index 95ca35e..c3394f7 100644
--- a/SwifTools/AutoUpdater/SparkleAutoUpdater.h
+++ b/SwifTools/AutoUpdater/SparkleAutoUpdater.h
@@ -11,12 +11,19 @@
 #include <SwifTools/AutoUpdater/AutoUpdater.h>
 
 namespace Swift {
+    /**
+     * @brief The SparkleAutoUpdater class provides integration with Sparkle.
+     * This enables automatic silent background updates. If using this in Qt you
+     * need to emit a NSApplicationWillTerminateNotification before you quit
+     * the application.
+     */
     class SparkleAutoUpdater : public AutoUpdater {
         public:
             SparkleAutoUpdater(const std::string& url);
             ~SparkleAutoUpdater();
 
             void checkForUpdates();
+            bool recommendRestartToUpdate();
 
         private:
             class Private;