Add UI child forms documentation

CoronaTracker/SubForms/CountriesSubForm.cs

@@ -15,6 +15,16 @@
 
 namespace CoronaTracker.SubForms
 {
+
+    /// <summary>
+    /// 
+    /// Countries Sub Form
+    /// 
+    /// GUI child of UI
+    /// Shows UI for get actual data from targeting country
+    /// 
+    /// </summary>
+
     public partial class CountriesSubForm : Form
     {
 
@@ -35,6 +45,9 @@ public CountriesSubForm()
             LogClass.Log($"Sub sub form successfully initialized");
         }
 
+        /// <summary>
+        /// Function to load default countries buttons
+        /// </summary>
         private void LoadCountriesDefault()
         {
             foreach(RegionInfo info in CultureInfo.GetCultures(CultureTypes.SpecificCultures).Select(x => new RegionInfo(x.LCID)))
@@ -95,6 +108,12 @@ private void textBox1_Enter(object sender, EventArgs e)
             LogClass.Log($"textBox1 enter event handler end");
         }
 
+        /// <summary>
+        /// Function to return Button with it defaults
+        /// </summary>
+        /// <returns>
+        /// Default Button
+        /// </returns>
         private Button CopyDefault()
         {
             Button button = new Button();
@@ -110,6 +129,10 @@ private Button CopyDefault()
             return button;
         }
 
+        /// <summary>
+        /// Function to refresh list of countries by specific parameters
+        /// </summary>
+        /// <param name="regex"> variable for parametres </param>
         public void LoadList(string regex = "")
         {
             LogClass.Log("Loading countries list" + (regex.Equals("") ? "" : " with parameters '" + regex + "'"));
@@ -129,11 +152,23 @@ public void LoadList(string regex = "")
             LogClass.Log("Successfully loaded");
         }
 
+        /// <summary>
+        /// Function to handle form load event
+        /// Load list with no parameters
+        /// </summary>
+        /// <param name="sender"> variable for sender </param>
+        /// <param name="e"> variable for event arguments </param>
         private void CountriesSubForm_Load(object sender, EventArgs e)
         {
             LoadList();
         }
 
+        /// <summary>
+        /// Function to handle country click event
+        /// Load country data in UI
+        /// </summary>
+        /// <param name="sender"> variable for sender </param>
+        /// <param name="e"> variable for event arguments </param>
         private void onClick(object sender, EventArgs e)
         {
             if (!ProgramVariables.CovidCache.ContainsKey(((Button)sender).Text))
@@ -156,7 +191,12 @@ private void onClick(object sender, EventArgs e)
             }
         }
 
-
+        /// <summary>
+        /// Function to handle parameters text box text change event
+        /// Refresh countries list with specific parameters
+        /// </summary>
+        /// <param name="sender"> variable for sender </param>
+        /// <param name="e"> variable for event arguments </param>
         private void textBox1_TextChanged(object sender, EventArgs e)
         {
             if (!textBox1.Text.Equals(""))

CoronaTracker/SubForms/DashboardSubForm.cs

@@ -15,6 +15,16 @@
 
 namespace CoronaTracker.SubForms
 {
+
+    /// <summary>
+    /// 
+    /// Dashboard Sub Form
+    /// 
+    /// GUI child of UI
+    /// Shows UI with application important data
+    /// 
+    /// </summary>
+
     public partial class DashboardSubForm : Form
     {
 

CoronaTracker/SubForms/HomeSubForm.cs

@@ -9,6 +9,16 @@
 
 namespace CoronaTracker.SubForms
 {
+
+    /// <summary>
+    /// 
+    /// Home Sub Form
+    /// 
+    /// GUI child of UI
+    /// Shows UI for basic application data
+    /// 
+    /// </summary>
+
     public partial class HomeSubForm : Form
     {
 
@@ -31,6 +41,9 @@ public HomeSubForm()
 
         public delegate void timerDelDelegate();
         public timerDelDelegate timerDel;
+        /// <summary>
+        /// Delegate function to load current time into UI
+        /// </summary>
         void timerDelMethod() { label13.Text = $"{DateTime.Now.ToString("dd/MM/yyyy")}\n{DateTime.Now.ToString("HH:mm:ss")}";}
 
         /// <summary>
@@ -135,6 +148,12 @@ private void label11_Click(object sender, EventArgs e)
             System.Diagnostics.Process.Start("https://www.mockaroo.com");
         }
 
+        /// <summary>
+        /// Function to handle form closing event
+        /// Stop time timer
+        /// </summary>
+        /// <param name="sender"> variable for sender </param>
+        /// <param name="e"> variable for event arguments </param>
         private void HomeSubForm_FormClosing(object sender, FormClosingEventArgs e)
         {
             timer.ChangeStatus(false);

CoronaTracker/SubForms/PatientSubForm.cs

@@ -13,6 +13,15 @@
 namespace CoronaTracker.SubForms
 {
 
+    /// <summary>
+    /// 
+    /// Patient Sub Form
+    /// 
+    /// GUI child of UI
+    /// Shows UI for manipulate with patient's data
+    /// 
+    /// </summary>
+
     public partial class PatientSubForm : Form
     {
 
@@ -101,6 +110,12 @@ private void button1_Click(object sender, EventArgs e)
             LogClass.Log($"button1 click event handler end");
         }
 
+        /// <summary>
+        /// Function to handle form load event
+        /// Open default child form - List Sub Sub Form
+        /// </summary>
+        /// <param name="sender"> variable for sender </param>
+        /// <param name="e"> variable for event arguments </param>
         private void PatientSubForm_Load(object sender, EventArgs e)
         {
             OpenChildForm(new ListSubSubForm(), button1);

CoronaTracker/SubForms/SettingsSubForm.cs

@@ -14,6 +14,16 @@
 
 namespace CoronaTracker.SubForms
 {
+
+    /// <summary>
+    /// 
+    /// Settings Sub Form
+    /// 
+    /// GUI child of UI
+    /// Shows UI for user's settings or to edit other user's poses
+    /// 
+    /// </summary>
+
     public partial class SettingsSubForm : Form
     {
 
@@ -197,6 +207,13 @@ private void button5_Click(object sender, EventArgs e)
             LogClass.Log($"button5 click event handler end");
         }
 
+        /// <summary>
+        /// Function to handle form load event
+        /// Shows logged in user's data
+        /// Enable / Disable editing others users poses by logged in 
+        /// </summary>
+        /// <param name="sender"> variable for sender </param>
+        /// <param name="e"> variable for event arguments </param>
         private void SettingsSubForm_Load(object sender, EventArgs e)
         {
             EmployeeInstance employee = DatabaseMethods.GetEmployeeByID(ProgramVariables.ID);

CoronaTracker/SubForms/VaccineTypeSubForm.cs

@@ -13,6 +13,16 @@
 
 namespace CoronaTracker.SubForms
 {
+
+    /// <summary>
+    /// 
+    /// Vaccine Type Sub Form
+    /// 
+    /// GUI child of UI
+    /// Shows UI for manipulate with vaccine types
+    /// 
+    /// </summary>
+
     public partial class VaccineTypeSubForm : Form
     {
 
@@ -244,6 +254,12 @@ private void textBox1_TextChanged(object sender, EventArgs e)
             LogClass.Log($"textBox1 text changed event handler start");
         }
 
+        /// <summary>
+        /// Function to handle form load event
+        /// Load vaccines buttons
+        /// </summary>
+        /// <param name="sender"> variable for sender </param>
+        /// <param name="e"> variable for event arguments </param>
         private void VaccineTypeSubForm_Load(object sender, EventArgs e)
         {
             vaccineTypes = DatabaseMethods.GetVaccineTypes();