Merge pull request #39 from CyanCoding/cyancoding-test-branch

Add summaries to the functions

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);

app/Project Tracker/Project Tracker/AddNewItem.xaml.cs

@@ -19,6 +19,9 @@ public AddNewItem() {
 			inputBox.Focus();
 		}
 
+		/// <summary>
+		/// Adds the item to the current table when the return key is pressed.
+		/// </summary>
 		private void KeyPress(object sender, KeyEventArgs e) {
 			if (e.Key == Key.Return) {
 				if (inputBox.Text != "") {
@@ -42,6 +45,9 @@ private void KeyPress(object sender, KeyEventArgs e) {
 			}
 		}
 
+		/// <summary>
+		/// Adds the item to the current table when the finish button is pressed.
+		/// </summary>
 		private void finishButton_Click(object sender, RoutedEventArgs e) {
 			if (inputBox.Text != "") {
 				if (Passthrough.SelectedIndex == 0) {
@@ -63,11 +69,17 @@ private void finishButton_Click(object sender, RoutedEventArgs e) {
 			}
 		}
 
+		/// <summary>
+		/// Cancels the operation and hides the window.
+		/// </summary>
 		private void cancelButton_Click(object sender, RoutedEventArgs e) {
 			Passthrough.IsAdding = false;
 			this.Hide();
 		}
 
+		/// <summary>
+		/// Saves the item to the editing file.
+		/// </summary>
 		private void Save() {
 			StringBuilder sb = new StringBuilder();
 			StringWriter sw = new StringWriter(sb);

app/Project Tracker/Project Tracker/AddNewProgram.xaml.cs

@@ -52,7 +52,10 @@ public AddNewProgram() {
 			projectTitleInputBox.Focus();
 		}
 
-		private void FirstForward() { // Moving from project title to project duration
+		/// <summary>
+		/// Moves the form from the project title to the project duration.
+		/// </summary>
+		private void FirstForward() {
 			if (projectTitleInputBox.Text != "") {
 				level = 1;
 
@@ -75,7 +78,10 @@ private void FirstForward() { // Moving from project title to project duration
 			}
 		}
 
-		private void SecondForward() { // Moving from project duration to error list
+		/// <summary>
+		/// Moves the form from the project duration to the error list.
+		/// </summary>
+		private void SecondForward() {
 			durationSuccess[0] = CheckValid(projectHourInputBox.Text, "hour");
 			durationSuccess[1] = CheckValid(projectMinuteInputBox.Text, "minute");
 			durationSuccess[2] = CheckValid(projectSecondInputBox.Text, "second");
@@ -111,7 +117,10 @@ private void SecondForward() { // Moving from project duration to error list
 			}
 		}
 
-		private void ThirdForward() { // Moving from error list to feature list
+		/// <summary>
+		/// Moves the form from the error list to the feature list.
+		/// </summary>
+		private void ThirdForward() {
 			level = 3;
 			projectTitleText.Text = "Features";
 
@@ -124,7 +133,10 @@ private void ThirdForward() { // Moving from error list to feature list
 			projectFeatureInputBox.Focus();
 		}
 
-		private void FourthForward() { // Moving from feature list to comment list
+		/// <summary>
+		/// Moves the form from the feature list to the comment list.
+		/// </summary>
+		private void FourthForward() {
 			level = 4;
 			projectTitleText.Text = "Comments";
 
@@ -137,7 +149,10 @@ private void FourthForward() { // Moving from feature list to comment list
 			projectCommentInputBox.Focus();
 		}
 
-		private void FifthForward() { // Moving from comment list to percent complete
+		/// <summary>
+		/// Moves the form from the comment list to the final result
+		/// </summary>
+		private void FifthForward() {
 			level = 5;
 			projectTitleText.Text = "Percent complete";
 
@@ -161,6 +176,9 @@ private void FifthForward() { // Moving from comment list to percent complete
 			commentResult.Visibility = Visibility.Visible;
 		}
 
+		/// <summary>
+		/// Finalizes the project and writes the files to the data folder.
+		/// </summary>
 		private void Finish() { // Creating file for new project
 			if (!Directory.Exists(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData) + "/Project Tracker")) {
 				Directory.CreateDirectory(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData) + "/Project Tracker");
@@ -254,6 +272,12 @@ private void FifthForward() { // Moving from comment list to percent complete
 		 * Checks the validitiy of the duration values to make sure they are real numbers.
 		 */
 
+		/// <summary>
+		/// Checks to make sure that numbers are valid.
+		/// </summary>
+		/// <param name="value">The string of the number to test.</param>
+		/// <param name="identifier">The name for that number.</param>
+		/// <returns>Returns true if a valid number and false if not.</returns>
 		private bool CheckValid(string value, string identifier) {
 			try {
 				Int32.Parse(value);
@@ -266,6 +290,9 @@ private bool CheckValid(string value, string identifier) {
 			}
 		}
 
+		/// <summary>
+		/// Advances to the next item in the form.
+		/// </summary>
 		private void nextButton_Click(object sender, RoutedEventArgs e) {
 			switch (level) {
 				case 0:
@@ -294,6 +321,12 @@ private void nextButton_Click(object sender, RoutedEventArgs e) {
 			}
 		}
 
+		/// <summary>
+		/// Adds a row to the current table.
+		/// </summary>
+		/// <param name="value">The value to add to the table.</param>
+		/// <param name="table">The table to add to.</param>
+		/// <param name="tableCount">Which table we're adding to (0 = error, 1 = feature, 2 = comment).</param>
 		private void AddRow(string value, Table table, int tableCount) {
 			table.RowGroups[0].Rows.Add(new TableRow());
 
@@ -332,6 +365,9 @@ private void AddRow(string value, Table table, int tableCount) {
 			newRow.Cells.Add(new TableCell(new Paragraph(new Run(value))));
 		}
 
+		/// <summary>
+		/// Checks the table input box value and adds a row if valid.
+		/// </summary>
 		private void AddValue(object sender, MouseButtonEventArgs e) {
 			if (level == 2) { // Error table
 				if (projectErrorInputBox.Text != "") {
@@ -356,6 +392,9 @@ private void AddValue(object sender, MouseButtonEventArgs e) {
 			}
 		}
 
+		/// <summary>
+		/// Advances through the thread or adds to the table depending on current view.
+		/// </summary>
 		private void KeyPress(object sender, KeyEventArgs e) {
 			if (e.Key == Key.Return) {
 				if (level == 0) { // Title page
@@ -394,7 +433,10 @@ private void KeyPress(object sender, KeyEventArgs e) {
 
 		}
 
-		private void FirstBack() { // From duration to project title
+		/// <summary>
+		/// Moves the form from the project duration to the project title. 
+		/// </summary>
+		private void FirstBack() {
 			level = 0;
 
 			cancelButton.Content = "Cancel";
@@ -410,7 +452,10 @@ private void FirstBack() { // From duration to project title
 			projectTitleInputBox.Focus();
 		}
 
-		private void SecondBack() { // From errors to duration
+		/// <summary>
+		/// Moves the form from the error list to the project duration.
+		/// </summary>
+		private void SecondBack() {
 			level = 1;
 
 			this.Height = 190;
@@ -428,7 +473,10 @@ private void SecondBack() { // From errors to duration
 			errorAddButton.Visibility = Visibility.Hidden;
 		}
 
-		private void ThirdBack() { // From features to errors
+		/// <summary>
+		/// Moves the form from the feature list to the error list.
+		/// </summary>
+		private void ThirdBack() {
 			level = 2;
 
 			projectTitleText.Text = "Errors";
@@ -441,7 +489,10 @@ private void ThirdBack() { // From features to errors
 			projectFeatureInputBox.Visibility = Visibility.Hidden;
 		}
 
-		private void FourthBack() { // From comments to features
+		/// <summary>
+		/// Moves the form from the comment list to the feature list.
+		/// </summary>
+		private void FourthBack() {
 			level = 3;
 
 			projectTitleText.Text = "Features";
@@ -454,7 +505,10 @@ private void FourthBack() { // From comments to features
 			projectCommentInputBox.Visibility = Visibility.Hidden;
 		}
 
-		private void FifthBack() { // From percent complete to comments
+		/// <summary>
+		/// Moves the form from the final window to the comment list.
+		/// </summary>
+		private void FifthBack() {
 			level = 4;
 
 			this.Height = 350;
@@ -472,6 +526,9 @@ private void FifthBack() { // From percent complete to comments
 			commentResult.Visibility = Visibility.Hidden;
 		}
 
+		/// <summary>
+		/// Moves the form in a reverse order when the back/cancel button is pressed.
+		/// </summary>
 		private void cancelButton_Click(object sender, RoutedEventArgs e) {
 			switch (level) {
 				case 0: