Add function summaries

Author: CyanCoding

app/Project Tracker Installer/Project Tracker Installer/Installer.cs

@@ -9,6 +9,14 @@
 
 namespace Project_Tracker_Installer {
 	class Installer {
+        /// <summary>
+        /// Installs the latest Project Tracker program to the user's computer.
+        /// </summary>
+        /// <param name="PROGRAM_PATH">The path of the unzipped program.</param>
+        /// <param name="INSTALL_DIRECTORY">The directory to install to.</param>
+        /// <param name="ONLINE_PROGRAM_LINK">The URL to the program download.</param>
+        /// <param name="ZIP_PATH">The zip path to download to and extract from.</param>
+        /// <returns></returns>
         public bool InstallProgram(string PROGRAM_PATH, string INSTALL_DIRECTORY, string ONLINE_PROGRAM_LINK, string ZIP_PATH) {
             if (System.IO.File.Exists(PROGRAM_PATH)) {
                 System.IO.File.Delete(PROGRAM_PATH);
@@ -32,6 +40,16 @@ public bool InstallProgram(string PROGRAM_PATH, string INSTALL_DIRECTORY, string
 
         }
 
+        /// <summary>
+        /// Creates a program uninstall registry and a shortcut.
+        /// </summary>
+        /// <param name="REGISTRY">The title of the registry entry to create.</param>
+        /// <param name="PROGRAM_TITLE">The title of the program.</param>
+        /// <param name="PROGRAM_VERSION">The version of the program we're installing.</param>
+        /// <param name="ICON_PATH">The path to the icon.</param>
+        /// <param name="PROGRAM_PATH">The path to the installed program.</param>
+        /// <param name="INSTALL_DIRECTORY">The directory of the installed program.</param>
+        /// <param name="SHORTCUT_LOCATION">The path for the shortcut.</param>
         public void CreateUninstaller(string REGISTRY, string PROGRAM_TITLE, string PROGRAM_VERSION, string ICON_PATH, string PROGRAM_PATH, string INSTALL_DIRECTORY, string SHORTCUT_LOCATION) {
             RegistryKey keyCheck = Registry.CurrentUser.OpenSubKey(REGISTRY);
 

app/Project Tracker Installer/Project Tracker Installer/MainWindow.xaml.cs

@@ -42,6 +42,9 @@ public MainWindow() {
             startup();
         }
 
+        /// <summary>
+        /// Retrieves the latest available version from the server.
+        /// </summary>
         private void GetVersion(object sender, AsyncCompletedEventArgs e) {
             try {
                 PROGRAM_VERSION = File.ReadAllText(VERSION_PATH);
@@ -66,6 +69,9 @@ private void GetVersion(object sender, AsyncCompletedEventArgs e) {
             }
         }
 
+        /// <summary>
+        /// Startup method, runs when code execution begins.
+        /// </summary>
         void startup() {
             subTitle.Content = "Version: " + PROGRAM_VERSION;
 
@@ -168,9 +174,9 @@ void startup() {
             }
         }
 
-        /*
-         * When the user clicks to open the Projet Tracker program
-         */
+         /// <summary>
+         /// Launches the program from PROGRAM_PATH.
+         /// </summary>
         private void LaunchButtonClick(object sender, RoutedEventArgs e) {
             ProcessStartInfo start = new ProcessStartInfo {
                 // Enter the executable to run, including the complete path
@@ -183,10 +189,10 @@ private void LaunchButtonClick(object sender, RoutedEventArgs e) {
             Environment.Exit(0);
         }
 
-
-        /* When the user clicks the reinstall button
-        * This runs the same install button procedure, just deletes the contents of the program first and sets uninstall to false
-        */
+        /// <summary>
+        /// Runs when the user clicks on the reinstall button.
+        /// Uninstalls and then installs the program.
+        /// </summary>
         private void ReinstallButtonClick(object sender, RoutedEventArgs e) {
             reinstallButton.Visibility = Visibility.Hidden;
             installButton.Visibility = Visibility.Hidden;
@@ -218,9 +224,11 @@ private void ReinstallButtonClick(object sender, RoutedEventArgs e) {
 
             FinalResult("Project Tracker has been installed!");
         }
-        /*
-         * When the user clicks on the install button
-         */
+
+         /// <summary>
+         /// Runs when the user clicks on the install button.
+         /// If the program is already installed, it becomes an uninstall button.
+         /// </summary>
         private void InstallButtonClick(object sender, RoutedEventArgs e) {
             if (retrying == true) {
                 installButton.Content = "Install";
@@ -329,11 +337,15 @@ private void InstallButtonClick(object sender, RoutedEventArgs e) {
 
                     FinalResult("Successfully uninstalled!");
                 }));
-
             }
 
         }
 
+        /// <summary>
+        /// A final display presented to the user after code execution has finished.
+        /// Used to display the success or failure of the installation.
+        /// </summary>
+        /// <param name="main">The main title text.</param>
         public void FinalResult(string main) {
             Dispatcher.Invoke(new Action(() => {
                 installBar.Visibility = Visibility.Hidden;
@@ -366,6 +378,9 @@ public void FinalResult(string main) {
             }));
         }
 
+        /// <summary>
+        /// Runs before window is closed after the user closes the program.
+        /// </summary>
         private void Window_Closing(object sender, CancelEventArgs e) {
             Environment.Exit(0);
         }

app/Project Tracker Installer/Project Tracker Installer/Uninstaller.cs

@@ -5,6 +5,15 @@
 
 namespace Project_Tracker_Installer {
 	class Uninstaller {
+        /// <summary>
+        /// Main uninstall function.
+        /// Prompts user to delete data and deletes every other file.
+        /// </summary>
+        /// <param name="DATA_DIRECTORY_PATH">The directory where the user's data lies.</param>
+        /// <param name="INSTALLER_PATH">The path of the installer to not delete.</param>
+        /// <param name="INSTALL_DIRECTORY">The path of the install program directory.</param>
+        /// <param name="REGISTRY">The title of the registry entry to remove.</param>
+        /// <param name="SHORTCUT_LOCATION">The path of the shortcut to delete.</param>
 		public void Uninstall(string DATA_DIRECTORY_PATH, string INSTALLER_PATH, string INSTALL_DIRECTORY, string REGISTRY = "", string SHORTCUT_LOCATION = "") {
             if (Directory.Exists(DATA_DIRECTORY_PATH)) {
                 var deleteData = MessageBox.Show("Do you wish to delete your projects data?", "Project Tracker Installer", MessageBoxButtons.YesNo, MessageBoxIcon.Question);
@@ -30,6 +39,11 @@ public void Uninstall(string DATA_DIRECTORY_PATH, string INSTALLER_PATH, string
 
         }
 
+        /// <summary>
+        /// Deletes the registry value for the program.
+        /// </summary>
+        /// <param name="REGISTRY">The title of the registry entry to remove.</param>
+        /// <param name="SHORTCUT_LOCATION">The path of the shortcut to delete.</param>
         private void RemoveRegistry(string REGISTRY, string SHORTCUT_LOCATION) {
             Registry.CurrentUser.DeleteSubKey(REGISTRY);
             File.Delete(SHORTCUT_LOCATION);