documentation improvements

CHANGELOG.md

@@ -80,6 +80,9 @@ Much thanks to @stephenwade for his contributions to 0.10.0
     - Note that NetSparkle does not perform resumable downloads in between software instances
 - Fixed potential infinite software update download loop if the software keeps downloading corrupted files (corrupt files or ones that don't pass the DSA check).
 
+## Older
+For older changes, see [HISTORY.md](HISTORY.md).
+
 [Unreleased]: https://github.com/Deadpikle/NetSparkle/compare/8a8b393...develop
 [0.11.0]: https://github.com/Deadpikle/NetSparkle/compare/d2740a4...8a8b393
 [0.10.0]: https://github.com/Deadpikle/NetSparkle/compare/c5e1e49...d2740a4

HISTORY.md

@@ -1,4 +1,7 @@
 ## History
+
+**This is an old file. For an up-to-date changelog, see [CHANGELOG.md](CHANGELOG.md).**
+
 June 2016 Steffen Xonna: Forked the library to raise the security and change some handling for an better usability for the user.  
 
  - Introduce an SecurityMode

NetSparkle/NetSparkle.cs

@@ -136,13 +136,22 @@ public class Sparkle : IDisposable
         public event UpdateDetected UpdateDetected;
 
         /// <summary>
-        /// Event called for shutting down the application.
-        /// If CloseApplicationAsync is non-null, CloseApplication is never called.
+        /// Event for custom shutdown logic. If this is set, it is called instead of
+        /// Application.Current.Shutdown or Application.Exit.
+        /// If <see cref="CloseApplicationAsync"/> is set, this has no effect.
+        /// <para>Warning: The batch file that launches your executable only waits for 90 seconds before
+        /// giving up! Make sure that your software closes within 90 seconds if you implement this event!
+        /// If you need an event that can be canceled, use <see cref="AboutToExitForInstallerRun"/>.</para>
         /// </summary>
         public event CloseApplication CloseApplication;
 
         /// <summary>
-        /// Event called for shutting down the application asynchronously.
+        /// Event for asynchronous custom shutdown logic. If this is set, it is called instead of
+        /// Application.Current.Shutdown or Application.Exit.
+        /// This overrides <see cref="CloseApplication"/>.
+        /// <para>Warning: The batch file that launches your executable only waits for 90 seconds before
+        /// giving up! Make sure that your software closes within 90 seconds if you implement this event!
+        /// If you need an event that can be canceled, use <see cref="AboutToExitForInstallerRunAsync"/>.</para>
         /// </summary>
         public event CloseApplicationAsync CloseApplicationAsync;
 

README.md

@@ -55,7 +55,7 @@ _sparkle.AboutToExitForInstallerRun += ((x, cancellable) =>
 
 **Warning!** 
 
-The .bat file that launches your executable only waits for 90 seconds before giving up! Make sure that your software closes within 90 seconds of `CloseApplication`/`CloseApplicationAsync` being called if you implement those events!
+The .bat file that launches your executable only waits for 90 seconds before giving up! Make sure that your software closes within 90 seconds of [CloseApplication](#closeapplication)/[CloseApplicationAsync](#closeapplicationasync) being called if you implement those events! If you need an event that can be canceled, use [AboutToExitForInstallerRun](#abouttoexitforinstallerrun)/[AboutToExitForInstallerRunAsync](#abouttoexitforinstallerrunasync).
 
 ## Appcast
 
@@ -445,6 +445,8 @@ The user interface window that shows the release notes and asks the user to skip
 
 - [AboutToExitForInstallerRun](#abouttoexitforinstallerrun)
 - [AboutToExitForInstallerRunAsync](#abouttoexitforinstallerrunasync)
+- [CloseApplication](#closeapplication)
+- [CloseApplicationAsync](#closeapplicationasync)
 - [CheckLoopFinished](#checkloopfinished)
 - [CheckLoopStarted](#checkloopstarted)
 - [DownloadCanceled](#downloadcanceled)
@@ -470,6 +472,22 @@ Subscribe to this to get a chance to shut down gracefully before quitting. If [A
 
 Subscribe to this to get a chance to asynchronously shut down gracefully before quitting. This overrides [AboutToExitForInstallerRun](#abouttoexitforinstallerrun).
 
+### CloseApplication
+
+**Delegate**: void CloseApplication()
+
+Event for custom shutdown logic. If this is set, it is called instead of Application.Current.Shutdown or Application.Exit. If [CloseApplicationAsync](#closeapplicationasync) is set, this has no effect.
+
+**Warning**: The batch file that launches your executable only waits for 90 seconds before giving up! Make sure that your software closes within 90 seconds if you implement this event! If you need an event that can be canceled, use [AboutToExitForInstallerRun](#abouttoexitforinstallerrun).
+
+### CloseApplicationAsync
+
+**Delegate**: Task CloseApplicationAsync()
+
+Event for custom shutdown logic. If this is set, it is called instead of Application.Current.Shutdown or Application.Exit. This overrides [CloseApplication](#closeapplication).
+
+**Warning**: The batch file that launches your executable only waits for 90 seconds before giving up! Make sure that your software closes within 90 seconds if you implement this event! If you need an event that can be canceled, use [AboutToExitForInstallerRunAsync](#abouttoexitforinstallerrunasync).
+
 ### CheckLoopFinished
 
 **Delegate**: void NetSparkle.LoopFinishedOperation(object sender, bool updateRequired)