From 613f74ec8688232f92594e6fbe6c30123cebff06 Mon Sep 17 00:00:00 2001
From: Clyde D'Souza <clyd94@gmail.com>
Date: Sun, 25 Nov 2018 14:07:00 +1300
Subject: [PATCH] Added more comments to public methods

Updated version to 0.0.2.
---
 Src/Horoscope.TestConsole/Program.cs |  2 +-
 Src/Horoscope/Horoscope.csproj       | 13 ++++++++-----
 Src/Horoscope/Model/ZodiacModel.cs   | 23 +++++++++++++++++++++--
 Src/Horoscope/Zodiac.cs              | 24 ++++++++++++++++++++++++
 4 files changed, 54 insertions(+), 8 deletions(-)

diff --git a/Src/Horoscope.TestConsole/Program.cs b/Src/Horoscope.TestConsole/Program.cs
index 5fef0e1..fbfe998 100644
--- a/Src/Horoscope.TestConsole/Program.cs
+++ b/Src/Horoscope.TestConsole/Program.cs
@@ -11,7 +11,7 @@ static void Main(string[] args)
             var symbol = Zodiac.GetZodiacSignForDate(new DateTime(1966, 2, 12));
             Console.WriteLine(symbol.ZodiacName +" "+ symbol.ZodiacDuration);
             
-            symbol = Zodiac.GetZodiacSign(ZodiacSigns.Aquarius);
+            symbol = Zodiac.GetZodiacSign(ZodiacSigns.Capricorn);
             Console.WriteLine(symbol.ZodiacDuration);
 
             var allSymbols = Zodiac.GetAllZodiacSigns();
diff --git a/Src/Horoscope/Horoscope.csproj b/Src/Horoscope/Horoscope.csproj
index 102887f..903b57d 100644
--- a/Src/Horoscope/Horoscope.csproj
+++ b/Src/Horoscope/Horoscope.csproj
@@ -5,17 +5,20 @@
     <Authors>Clyde D'Souza</Authors>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
     <PackageId>Horoscope</PackageId>
-    <Version>0.0.1</Version>
+    <Version>0.0.2</Version>
     <Company />
     <PackageLicenseUrl>https://github.com/ClydeDz/horoscope-nuget/blob/master/LICENSE</PackageLicenseUrl>
     <RepositoryUrl>https://github.com/ClydeDz/horoscope-nuget</RepositoryUrl>
     <PackageProjectUrl>https://github.com/ClydeDz/horoscope-nuget/wiki</PackageProjectUrl>
-    <PackageTags>horoscope zodiac zodiac-signs development library</PackageTags>
+    <PackageTags>horoscope zodiac development library zodiac-signs</PackageTags>
     <Description>A .NET library for Zodiac signs. Get details on each Zodiac sign, pass a date and know which Zodiac sign it falls in or get a list of all Zodiac signs. Currently in beta.</Description>
     <Copyright>(c) 2018 Clyde D'Souza</Copyright>
-    <PackageReleaseNotes>Includes basic functionality to get Zodiac signs. Beta release.</PackageReleaseNotes>
-    <AssemblyVersion>0.0.0.1</AssemblyVersion>
-    <FileVersion>0.0.0.1</FileVersion>
+    <PackageReleaseNotes>0.0.2
+Includes basic functionality to get Zodiac signs.
+0.0.1
+Beta release.</PackageReleaseNotes>
+    <AssemblyVersion>0.0.0.2</AssemblyVersion>
+    <FileVersion>0.0.0.2</FileVersion>
     <PackageIconUrl>https://raw.githubusercontent.com/ClydeDz/horoscope-nuget/master/Icon.png</PackageIconUrl>
   </PropertyGroup>
 
diff --git a/Src/Horoscope/Model/ZodiacModel.cs b/Src/Horoscope/Model/ZodiacModel.cs
index 603c134..0f38dae 100644
--- a/Src/Horoscope/Model/ZodiacModel.cs
+++ b/Src/Horoscope/Model/ZodiacModel.cs
@@ -1,5 +1,8 @@
 namespace Horoscope.Model
 {
+    /// <summary>
+    /// The Zodiac sign object containing information on each Zodiac sign.
+    /// </summary>
     public class ZodiacModel
     {
         internal ZodiacModel(string name, string english, ZodiacDateModel start, ZodiacDateModel end)
@@ -10,12 +13,28 @@ internal ZodiacModel(string name, string english, ZodiacDateModel start, ZodiacD
             ZodiacEndDate = end;
         }
 
+        /// <summary>
+        /// The Zodiac latin name. 
+        /// Example: Capricorn.
+        /// </summary>
         public string ZodiacName { get; set; }
+
+        /// <summary>
+        /// The English translation of the Zodiac name.
+        /// Example: The Goat.
+        /// </summary>
         public string ZodiacEnglishTranslation { get; set; }
+
+        /// <summary>
+        /// The duration for this Zodiac sign.
+        /// Example: December 22 to January 19.
+        /// </summary>
+        public string ZodiacDuration { get { return $"{ToMonth(ZodiacStartDate.Month)} {ZodiacStartDate.Date} to {ToMonth(ZodiacEndDate.Month)} {ZodiacEndDate.Date}"; } }
+
         internal ZodiacDateModel ZodiacStartDate { get; set; }
+
         internal ZodiacDateModel ZodiacEndDate { get; set; }
-        public string ZodiacDuration { get { return $"{ToMonth(ZodiacStartDate.Month)} {ZodiacStartDate.Date} to {ToMonth(ZodiacEndDate.Month)} {ZodiacEndDate.Date}"; } }
-        
+
         internal string ToMonth(int month)
         {
             switch (month)
diff --git a/Src/Horoscope/Zodiac.cs b/Src/Horoscope/Zodiac.cs
index e399fbc..a878e35 100644
--- a/Src/Horoscope/Zodiac.cs
+++ b/Src/Horoscope/Zodiac.cs
@@ -5,6 +5,9 @@
 
 namespace Horoscope
 {
+    /// <summary>
+    /// List of all Zodiac signs
+    /// </summary>
     public enum ZodiacSigns
     {
         Pisces,
@@ -21,8 +24,16 @@ public enum ZodiacSigns
         Aries
     }
     
+    /// <summary>
+    /// Contains all methods pertaining to Zodiac signs.
+    /// </summary>
     public class Zodiac
     {        
+        /// <summary>
+        /// Gets the Zodiac sign for the date supplied.
+        /// </summary>
+        /// <param name="requestedDateTime">The date for which you want the Zodiac sign.</param>
+        /// <returns>A Zodiac sign object.</returns>
         public static ZodiacModel GetZodiacSignForDate(DateTime requestedDateTime)
         {
             var zodiacSymbol = InitializeAndGetAllZodiacSigns().Values
@@ -34,17 +45,30 @@ public static ZodiacModel GetZodiacSignForDate(DateTime requestedDateTime)
             return zodiacSymbol;
         }
 
+        /// <summary>
+        /// Get details of the Zodiac sign supplied.
+        /// </summary>
+        /// <param name="requestedZodiacSign">The Zodiac sign that you want more details about.</param>
+        /// <returns>A Zodiac sign object.</returns>
         public static ZodiacModel GetZodiacSign(ZodiacSigns requestedZodiacSign)
         {
             InitializeAndGetAllZodiacSigns().TryGetValue(requestedZodiacSign, out ZodiacModel zodiacSign);
             return zodiacSign;
         }
 
+        /// <summary>
+        /// Gets all Zodiac signs and details for each sign.
+        /// </summary>
+        /// <returns>List of Zodiac signs each as a Zodiac sign object.</returns>
         public static List<ZodiacModel> GetAllZodiacSigns()
         {
             return InitializeAndGetAllZodiacSigns().Values.ToList();
         }
 
+        /// <summary>
+        /// Loads all Zodiac signs and returns a complete object.
+        /// </summary>
+        /// <returns>Dictionary collection of Zodiac signs.</returns>
         private static Dictionary<ZodiacSigns, ZodiacModel> InitializeAndGetAllZodiacSigns()
         {
             Dictionary<ZodiacSigns, ZodiacModel> zodiacSigns = new Dictionary<ZodiacSigns, ZodiacModel>