Add intellisense documentation for the GenerateStringFromPattern() me…

…thod.
tpierrain · Jan 25, 2021 · 0fa7490 · 0fa7490
1 parent 3e253f2
commit 0fa7490
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/Diverse/Diverse.csproj b/Diverse/Diverse.csproj
@@ -13,7 +13,7 @@
     <RepositoryUrl>https://github.com/42skillz/Diverse</RepositoryUrl>
     <RepositoryType></RepositoryType>
     <PackageTags>Fuzzers Inclusive Diversity Diverse Deterministic tooling tests test unit acceptance extensibility Fuzzer</PackageTags>
-    <PackageReleaseNotes></PackageReleaseNotes>
+    <PackageReleaseNotes>Add intellisense documentation for the GenerateStringFromPattern() method.</PackageReleaseNotes>
     <AssemblyVersion>0.9.0.0</AssemblyVersion>
     <FileVersion>0.9.0.0</FileVersion>
     <Version>0.9.0.0</Version>

diff --git a/Diverse/Fuzzer.cs b/Diverse/Fuzzer.cs
@@ -752,9 +752,9 @@ private static Maybe<string> LastChanceToFindAdjective(Feeling? feeling,
         }
 
         /// <summary>
-        /// Generates a string from a given 'diverse' format.
+        /// Generates a string from a given 'diverse' format (# for a single digit number, X for upper-cased letter, x for lower-cased letter). 
         /// </summary>
-        /// <param name="diverseFormat">The 'diverse' format to use.</param>
+        /// <param name="diverseFormat">The 'diverse' format to use (# for a single digit number, X for upper-cased letter, x for lower-cased letter).</param>
         /// <returns>A randomly generated string following the 'diverse' format.</returns>
         public string GenerateStringFromPattern(string diverseFormat)
         {

diff --git a/Diverse/IFuzzStrings.cs b/Diverse/IFuzzStrings.cs
@@ -15,10 +15,10 @@ public interface IFuzzStrings
         string GenerateAdjective(Feeling? feeling);
 
         /// <summary>
-        /// Generates a string from a given 'diverse' format.
+        /// Generates a string from a given 'diverse' format (# for a single digit number, X for upper-cased letter, x for lower-cased letter). 
         /// </summary>
-        /// <param name="diverseFormat">The 'diverse' format to use.</param>
-        /// <returns>A randomly generated string followin the 'diverse' format.</returns>
+        /// <param name="diverseFormat">The 'diverse' format to use (# for a single digit number, X for upper-cased letter, x for lower-cased letter).</param>
+        /// <returns>A randomly generated string following the 'diverse' format.</returns>
         string GenerateStringFromPattern(string diverseFormat);
     }
 }
diff --git a/Diverse/Strings/StringFuzzer.cs b/Diverse/Strings/StringFuzzer.cs
@@ -40,10 +40,10 @@ public string GenerateAdjective(Feeling? feeling = null)
         }
 
         /// <summary>
-        /// Generates a string from a given 'diverse' format.
+        /// Generates a string from a given 'diverse' format (# for a single digit number, X for upper-cased letter, x for lower-cased letter). 
         /// </summary>
-        /// <param name="diverseFormat">The 'diverse' format to use.</param>
-        /// <returns>A randomly generated string followin the 'diverse' format.</returns>
+        /// <param name="diverseFormat">The 'diverse' format to use (# for a single digit number, X for upper-cased letter, x for lower-cased letter).</param>
+        /// <returns>A randomly generated string following the 'diverse' format.</returns>
         public string GenerateStringFromPattern(string diverseFormat)
         {
             var builder = new StringBuilder(diverseFormat.Length);