Added comments.

K-Society · Oct 6, 2023 · 2a4ad97 · 2a4ad97
1 parent 4dfb0bf
commit 2a4ad97
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/src/01/KSociety.SharpCubeProgrammer/CubeProgrammerApi.cs b/src/01/KSociety.SharpCubeProgrammer/CubeProgrammerApi.cs
@@ -918,6 +918,7 @@ public void UnlockChip()
 
         #region [Util]
 
+        /// <inheritdoc />
         public uint HexConverterToUint(string hex)
         {
             IFormatProvider formatProvider = CultureInfo.InvariantCulture.NumberFormat;
@@ -926,6 +927,7 @@ public uint HexConverterToUint(string hex)
             return parseResult ? result : 0;
         }
 
+        /// <inheritdoc />
         public int HexConverterToInt(string hex)
         {
             IFormatProvider formatProvider = CultureInfo.InvariantCulture.NumberFormat;
@@ -934,12 +936,14 @@ public int HexConverterToInt(string hex)
             return parseResult ? result : 0;
         }
 
+        /// <inheritdoc />
         public string HexConverterToString(uint hex)
         {
             var output = "0x" + hex.ToString("X");
             return output;
         }
 
+        /// <inheritdoc />
         public string HexConverterToString(int hex)
         {
             var output = "0x" + hex.ToString("X");

diff --git a/src/01/KSociety.SharpCubeProgrammer/Interface/ICubeProgrammerApi.cs b/src/01/KSociety.SharpCubeProgrammer/Interface/ICubeProgrammerApi.cs
@@ -325,12 +325,32 @@ public interface ICubeProgrammerApi
 
         #region [Util]
 
+        /// <summary>
+        /// HexConverterToUint
+        /// </summary>
+        /// <param name="hex"></param>
+        /// <returns></returns>
         uint HexConverterToUint(string hex);
 
+        /// <summary>
+        /// HexConverterToInt
+        /// </summary>
+        /// <param name="hex"></param>
+        /// <returns></returns>
         int HexConverterToInt(string hex);
 
+        /// <summary>
+        /// HexConverterToString
+        /// </summary>
+        /// <param name="hex"></param>
+        /// <returns></returns>
         string HexConverterToString(uint hex);
 
+        /// <summary>
+        /// HexConverterToString
+        /// </summary>
+        /// <param name="hex"></param>
+        /// <returns></returns>
         string HexConverterToString(int hex);
 
         #endregion