Add converter XML documentation

Author: tobitege

OpenSourceToolkit.Converters/Base64Converter.cs

@@ -3,28 +3,55 @@
 
 namespace OpenSourceToolkit.Converters
 {
+    /// <summary>
+    /// Provides helpers for Base64 and URL-safe Base64 text conversion.
+    /// </summary>
     public static class Base64Converter
     {
+        /// <summary>
+        /// Encodes text as a Base64 string.
+        /// </summary>
+        /// <param name="text">The text to encode.</param>
+        /// <param name="encoding">The text encoding to use, or <c>null</c> to use UTF-8.</param>
+        /// <returns>The Base64-encoded text, or <c>null</c> when <paramref name="text"/> is <c>null</c>.</returns>
         public static string Encode(string text, Encoding encoding = null)
         {
             if (text == null) return null;
             var bytes = (encoding ?? Encoding.UTF8).GetBytes(text);
             return Convert.ToBase64String(bytes);
         }
 
+        /// <summary>
+        /// Decodes a Base64 string to text.
+        /// </summary>
+        /// <param name="base64">The Base64 string to decode.</param>
+        /// <param name="encoding">The text encoding to use, or <c>null</c> to use UTF-8.</param>
+        /// <returns>The decoded text, or <c>null</c> when <paramref name="base64"/> is <c>null</c>.</returns>
         public static string Decode(string base64, Encoding encoding = null)
         {
             if (base64 == null) return null;
             var bytes = Convert.FromBase64String(base64);
             return (encoding ?? Encoding.UTF8).GetString(bytes);
         }
 
+        /// <summary>
+        /// Encodes text as a URL-safe Base64 string without padding.
+        /// </summary>
+        /// <param name="text">The text to encode.</param>
+        /// <param name="encoding">The text encoding to use, or <c>null</c> to use UTF-8.</param>
+        /// <returns>The URL-safe Base64-encoded text.</returns>
         public static string EncodeUrlSafe(string text, Encoding encoding = null)
         {
             var base64 = Encode(text, encoding);
             return base64.Replace("+", "-").Replace("/", "_").TrimEnd('=');
         }
 
+        /// <summary>
+        /// Decodes a URL-safe Base64 string to text.
+        /// </summary>
+        /// <param name="base64Url">The URL-safe Base64 string to decode.</param>
+        /// <param name="encoding">The text encoding to use, or <c>null</c> to use UTF-8.</param>
+        /// <returns>The decoded text.</returns>
         public static string DecodeUrlSafe(string base64Url, Encoding encoding = null)
         {
             var base64 = base64Url.Replace("-", "+").Replace("_", "/");

OpenSourceToolkit.Converters/EthConverter.cs

@@ -3,26 +3,49 @@
 
 namespace OpenSourceToolkit.Converters
 {
+    /// <summary>
+    /// Provides conversion helpers for Ethereum denominations.
+    /// </summary>
     public static class EthConverter
     {
         // 1 ETH = 10^18 Wei
         // 1 Gwei = 10^9 Wei
 
+        /// <summary>
+        /// Converts Ether to Wei.
+        /// </summary>
+        /// <param name="eth">The Ether amount.</param>
+        /// <returns>The equivalent amount in Wei.</returns>
         public static decimal ToWei(decimal eth)
         {
             return eth * 1_000_000_000_000_000_000m;
         }
 
+        /// <summary>
+        /// Converts Ether to Gwei.
+        /// </summary>
+        /// <param name="eth">The Ether amount.</param>
+        /// <returns>The equivalent amount in Gwei.</returns>
         public static decimal ToGwei(decimal eth)
         {
             return eth * 1_000_000_000m;
         }
 
+        /// <summary>
+        /// Converts Wei to Ether.
+        /// </summary>
+        /// <param name="wei">The Wei amount.</param>
+        /// <returns>The equivalent amount in Ether.</returns>
         public static decimal FromWei(decimal wei)
         {
             return wei / 1_000_000_000_000_000_000m;
         }
 
+        /// <summary>
+        /// Converts Gwei to Ether.
+        /// </summary>
+        /// <param name="gwei">The Gwei amount.</param>
+        /// <returns>The equivalent amount in Ether.</returns>
         public static decimal FromGwei(decimal gwei)
         {
             return gwei / 1_000_000_000m;