From 430551773fa684cc4ec477df33e5d56d469e1f2a Mon Sep 17 00:00:00 2001
From: Elia Sulimanov <eliasulimanov@gmail.com>
Date: Wed, 17 Jun 2020 16:01:37 +0300
Subject: [PATCH] Done EncodingTable api docs

---
 source/Cosmos.System2/Text/EncodingTable.cs | 52 ++++++++++++++++++++-
 1 file changed, 51 insertions(+), 1 deletion(-)

diff --git a/source/Cosmos.System2/Text/EncodingTable.cs b/source/Cosmos.System2/Text/EncodingTable.cs
index 928b09778..d5148cc9e 100644
--- a/source/Cosmos.System2/Text/EncodingTable.cs
+++ b/source/Cosmos.System2/Text/EncodingTable.cs
@@ -3,15 +3,24 @@ using System.Text;
 using Cosmos.Debug.Kernel;
 
 namespace Cosmos.System.ExtendedASCII
-{   
+{
     /*
      * Ideally we should use Dictionary or HashTable here but are yet not working in Cosmos so I have done
      * this replacement class for now...
      */
+    /// <summary>
+    /// EncodingTable class. Used to manage codepage list.
+    /// </summary>
     internal static class EncodingTable
     {
+        /// <summary>
+        /// Debugger inctanse of the "System" with the "EncodingTable" tag.
+        /// </summary>
         private static Debugger mDebugger = new Debugger("System", "EncodingTable");
 
+        /// <summary>
+        /// Create new inctanse of the <see cref="EncodingTable"/> class.
+        /// </summary>
         static EncodingTable()
         {
             mDebugger.SendInternal("Inizializing Encoding Table");
@@ -20,11 +29,25 @@ namespace Cosmos.System.ExtendedASCII
             Add(858, "IBM0858", new CP858Enconding());
         }
 
+        /// <summary>
+        /// Struct which used to hold description and encoding.
+        /// </summary>
         private struct values
         {
+            /// <summary>
+            /// Description.
+            /// </summary>
             public string   desc;
+            /// <summary>
+            /// Encoding.
+            /// </summary>
             public Encoding encoding;
 
+            /// <summary>
+            /// Create new inctanse of the <see cref="values"/> struct.
+            /// </summary>
+            /// <param name="desc">Description.</param>
+            /// <param name="encoding">Encoding.</param>
             public values(string desc, Encoding encoding)
             {
                 this.desc = desc;
@@ -32,19 +55,46 @@ namespace Cosmos.System.ExtendedASCII
             }
         };
 
+        /// <summary>
+        /// Max codepage cache size.
+        /// </summary>
         const int MaxCodepageChacheSize = 2048;
+        /// <summary>
+        /// Codepage cache.
+        /// </summary>
         static values[] CodepageCache = new values[MaxCodepageChacheSize];
 
+        /// <summary>
+        /// Add encoding to the encoding table.
+        /// </summary>
+        /// <param name="codepage">Codepage.</param>
+        /// <param name="desc">Desciption.</param>
+        /// <param name="encoding">Encoding.</param>
         public static void Add(int codepage, string desc, Encoding encoding)
         {
             mDebugger.SendInternal($"Adding codepage {codepage} desc {desc}");
             CodepageCache[codepage] = new values(desc, encoding);
         }
 
+        /// <summary>
+        /// Get description, using codepage.
+        /// </summary>
+        /// <param name="codepage">Codepage.</param>
+        /// <returns>string value.</returns>
         public static string GetDescription(int codepage) => CodepageCache[codepage].desc;
 
+        /// <summary>
+        /// Get encoding, using codepage.
+        /// </summary>
+        /// <param name="codepage">Codepage.</param>
+        /// <returns>Encoding value.</returns>
         public static Encoding GetEncoding(int codepage) => CodepageCache[codepage].encoding;
 
+        /// <summary>
+        /// Get code page from description.
+        /// </summary>
+        /// <param name="desc">Description.</param>
+        /// <returns>int value, -1 if not found.</returns>
         public static int GetCodePageFromDesc(string desc)
         {
             for (int idx = 0; idx < MaxCodepageChacheSize; idx++)