Merge pull request #7 from ClydeDz/dev/1.0.0

Add comments to publicly accessibly methods, classes, etc.
ClydeDz · Dec 22, 2020 · c97c860 · c97c860
2 parents 31a7419 + ec54c1f
commit c97c860
Show file tree

Hide file tree

Showing 6 changed files with 105 additions and 11 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -12,6 +12,7 @@
 - [ ] My change requires a change to the documentation in the `README` file.
 - [ ] I have updated the documentation in the `README` file accordingly.
 - [ ] I have updated the version number in the [`Horoscope.nuspec`](https://github.com/ClydeDz/horoscope-nuget/blob/master/Src/Horoscope.nuspec) file using the [SemVer](https://semver.org/) format.
+- [ ] I have added `<summary>` comments to all publicly accessible methods, classes, etc.
 - [ ] I have added tests to cover my changes.
 - [ ] All new and existing tests passed.
 
diff --git a/Src/Horoscope.nuspec b/Src/Horoscope.nuspec
@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
   <metadata>
     <id>Horoscope</id>
-    <version>0.9.0</version>
+    <version>0.9.1</version>
     <title>Horoscope</title>
     <authors>Clyde D'Souza</authors>
     <owners>Clyde D'Souza</owners>
@@ -13,9 +13,7 @@
     <iconUrl>https://raw.githubusercontent.com/ClydeDz/horoscope-nuget/master/Icon.png</iconUrl>
     <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. Now includes Chinese zodiac signs and elements!</description>
     <summary>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.</summary>
-    <releaseNotes>Add contributing guidelines and a pull request template to the GitHub repository.
-
-    More release notes here: https://github.com/ClydeDz/horoscope-nuget/releases </releaseNotes>
+    <releaseNotes>Add contributing guidelines and a pull request template to the GitHub repository. More release notes here: https://github.com/ClydeDz/horoscope-nuget/releases </releaseNotes>
     <copyright>Copyright (c) 2018 Clyde D'Souza</copyright>
     <tags>horoscope zodiac development library zodiac-signs chinese-zodiac chinese-horoscope yinyang chinese-elements yin-yang</tags>
    <dependencies>

diff --git a/Src/Horoscope/Constants/ChineseZodiacSignsEnum.cs b/Src/Horoscope/Constants/ChineseZodiacSignsEnum.cs
@@ -5,17 +5,53 @@
     /// </summary>
     public enum ChineseZodiacSigns
     {
+        /// <summary>
+        /// Rat
+        /// </summary>
         Rat,
+        /// <summary>
+        /// Ox
+        /// </summary>
         Ox,
+        /// <summary>
+        /// Tiger
+        /// </summary>
         Tiger,
+        /// <summary>
+        /// Rabbit
+        /// </summary>
         Rabbit,
+        /// <summary>
+        /// Dragon
+        /// </summary>
         Dragon,
+        /// <summary>
+        /// Snake
+        /// </summary>
         Snake,
+        /// <summary>
+        /// Horse
+        /// </summary>
         Horse,
+        /// <summary>
+        /// Goat
+        /// </summary>
         Goat,
+        /// <summary>
+        /// Monkey
+        /// </summary>
         Monkey,
+        /// <summary>
+        /// Rooster
+        /// </summary>
         Rooster,
+        /// <summary>
+        /// Dog
+        /// </summary>
         Dog,
+        /// <summary>
+        /// Pig
+        /// </summary>
         Pig
     }
 
@@ -24,10 +60,25 @@ public enum ChineseZodiacSigns
     /// </summary>
     public enum ChineseZodiacElements
     {
+        /// <summary>
+        /// Wood
+        /// </summary>
         Wood,
+        /// <summary>
+        /// Fire
+        /// </summary>
         Fire,
+        /// <summary>
+        /// Earth
+        /// </summary>
         Earth,
+        /// <summary>
+        /// Metal
+        /// </summary>
         Metal,
+        /// <summary>
+        /// Water
+        /// </summary>
         Water
     }
 
@@ -36,7 +87,13 @@ public enum ChineseZodiacElements
     /// </summary>
     public enum YinYang
     {
+        /// <summary>
+        /// Yin
+        /// </summary>
         Yin,
+        /// <summary>
+        /// Yang
+        /// </summary>
         Yang
     }
 }
diff --git a/Src/Horoscope/Constants/ZodiacSignsEnum.cs b/Src/Horoscope/Constants/ZodiacSignsEnum.cs
@@ -5,17 +5,53 @@
     /// </summary>
     public enum ZodiacSigns
     {
+        /// <summary>
+        /// Pisces
+        /// </summary>
         Pisces,
+        /// <summary>
+        /// Aquarius
+        /// </summary>
         Aquarius,
+        /// <summary>
+        /// Virgo
+        /// </summary>
         Virgo,
+        /// <summary>
+        /// Taurus
+        /// </summary>
         Taurus,
+        /// <summary>
+        /// Scorpio
+        /// </summary>
         Scorpio,
+        /// <summary>
+        /// Sagittarius
+        /// </summary>
         Sagittarius,
+        /// <summary>
+        /// Libra
+        /// </summary>
         Libra,
+        /// <summary>
+        /// Leo
+        /// </summary>
         Leo,
+        /// <summary>
+        /// Gemini
+        /// </summary>
         Gemini,
+        /// <summary>
+        /// Capricorn
+        /// </summary>
         Capricorn,
+        /// <summary>
+        /// Cancer
+        /// </summary>
         Cancer,
+        /// <summary>
+        /// Aries
+        /// </summary>
         Aries
     }
 }
diff --git a/Src/Horoscope/Horoscope.csproj b/Src/Horoscope/Horoscope.csproj
@@ -1,25 +1,24 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <Authors>Clyde D'Souza</Authors>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
     <PackageId>Horoscope</PackageId>
-    <Version>0.9.0</Version>
+    <Version>0.9.1</Version>
     <Company />
     <PackageLicenseUrl></PackageLicenseUrl>
     <RepositoryUrl>https://github.com/ClydeDz/horoscope-nuget</RepositoryUrl>
     <PackageProjectUrl>https://github.com/ClydeDz/horoscope-nuget</PackageProjectUrl>
     <PackageTags>horoscope zodiac development library zodiac-signs chinese-zodiac chinese-horoscope yinyang chinese-elements yin-yang</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. Now includes Chinese zodiac signs and elements!</Description>
     <Copyright>Copyright (c) 2018 Clyde D'Souza</Copyright>
-    <PackageReleaseNotes>Now includes Chinese zodiac signs, fixed elements (i.e., wood, fire, earth, metal, water) and yin yang associated with each Chinese zodiac sign. 
-
-More release notes here: https://github.com/ClydeDz/horoscope-nuget/releases</PackageReleaseNotes>
-    <AssemblyVersion>0.9.0.0</AssemblyVersion>
-    <FileVersion>0.0.0.0</FileVersion>
+    <PackageReleaseNotes>Now includes Chinese zodiac signs, fixed elements (i.e., wood, fire, earth, metal, water) and yin yang associated with each Chinese zodiac sign. More release notes here: https://github.com/ClydeDz/horoscope-nuget/releases</PackageReleaseNotes>
+    <AssemblyVersion>0.9.1.0</AssemblyVersion>
+    <FileVersion>0.9.1.0</FileVersion>
     <PackageIconUrl>https://raw.githubusercontent.com/ClydeDz/horoscope-nuget/master/Icon.png</PackageIconUrl>
     <Product>Horoscope</Product>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
   </PropertyGroup>
 

diff --git a/Src/Horoscope/Model/BaseZodiacModel.cs b/Src/Horoscope/Model/BaseZodiacModel.cs
@@ -1,5 +1,8 @@
 namespace Horoscope.Model
 {
+    /// <summary>
+    /// Base Zodiac sign object containing information common to all Zodiac signs.
+    /// </summary>
     public class BaseZodiacModel
     {
         internal BaseZodiacModel(string zodiacName, string zodiacEnglishTranslation)