documentation fix

AsoSoft · Jul 3, 2022 · bca3b6c · bca3b6c
1 parent fbd5bfe
commit bca3b6c
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 2 deletions.
diff --git a/.vs/AsoSoftLibrary/v17/.suo b/.vs/AsoSoftLibrary/v17/.suo
diff --git a/G2P.cs b/G2P.cs
@@ -440,7 +440,7 @@ private static int SonorityIndex(char ch)
 			 return 1;
 	   }
 
-	   // for tests
+	   /// <summary>only for tests.</summary>
 	   public static Dictionary<string, int> AllCandidates(string grapheme)
 	   {
 		  return EVAL(Generator(g2pNormalize(grapheme)));

diff --git a/Normalize.cs b/Normalize.cs
@@ -265,6 +265,8 @@ public static string Normalize(string text,
 			 "۷", "٧", "7",
 			 "۸", "٨", "8",
 			 "۹", "٩", "9", };
+
+	   /// <summary>unifies numeral characters into desired numeral type from en (0123456789) or ar (٠١٢٣٤٥٦٧٨٩).</summary>
 	   public static string UnifyNumerals(string text, string NumeralType)
 	   {
 		  for (int i = 0; i < digits.Length; i += 3)
@@ -302,7 +304,7 @@ public static string TrimLine(string line)
 		  return line.Trim();
 	   }
 
-	   /// <summary>HTML Entity replacement for web crawled texts (e.g. "&eacute;" with "é")</summary>
+	   /// <summary>HTML Entity replacement for web crawled texts (e.g. "&amp;eacute;" with "é")</summary>
 	   public static string ReplaceHtmlEntity(string text)
 	   {
 		  return Regex.Replace(text, "&[a-zA-Z]+;", m => System.Net.WebUtility.HtmlDecode(m.Value));

diff --git a/Number2Word.cs b/Number2Word.cs
@@ -10,6 +10,7 @@ namespace AsoSoftLibrary
 {
     public static partial class AsoSoft
     {
+	   /// <summary>converts numerals into Central Kurdish words. It is useful in text-to-speech tools.</summary>
 	   public static string Number2Word(string text)
 	   {
 		  // convert numbers to latin

diff --git a/Sort.cs b/Sort.cs
@@ -6,12 +6,14 @@ namespace AsoSoftLibrary
 {
     public static partial class AsoSoft
     {
+	   /// <summary>Sorting a string list in correct order of Kurdish alphabet.</summary>
 	   public static List<string> KurdishSort(List<string> inputList)
 	   {
 		  var ku = new List<char>();
 		  ku.AddRange("ئءاآأإبپتثجچحخدڎڊذرڕزژسشصضطظعغفڤقكکگڴلڵمنوۆۊۉۋهھەیێ");
 		  return CustomSort(inputList, ku);
 	   }
+	   /// <summary>Sorting a string list in custom order.</summary>
 	   public static List<string> CustomSort(List<string> inputList, List<char> inputOrder)
 	   {
 		  var baseChar = 62000;//  9472;