Added code documentation

NuciText.Obfuscation/INuciText.Obfuscation.cs

@@ -1,11 +1,30 @@
 namespace NuciText.Obfuscation
 {
+    /// <summary>
+    /// Defines the interface for the NuciText obfuscator.
+    /// </summary>
     public interface INuciTextObfuscator
     {
+        /// <summary>
+        /// Deobfuscates the specified text.
+        /// </summary>
+        /// <param name="text">The text to deobfuscate.</param>
+        /// <returns>The deobfuscated text.</returns>
         string Deobfuscate(string text);
 
+        /// <summary>
+        /// Obfuscates the specified text.
+        /// </summary>
+        /// <param name="text">The text to obfuscate.</param>
+        /// <returns>The obfuscated text.</returns>
         string Obfuscate(string text);
 
+        /// <summary>
+        /// Obfuscates the specified text using the provided options.
+        /// </summary>
+        /// <param name="text">The text to obfuscate.</param>
+        /// <param name="options">The options to use for obfuscation.</param>
+        /// <returns>The obfuscated text.</returns>
         string Obfuscate(string text, NuciTextObfuscatorOptions options);
     }
 }

NuciText.Obfuscation/NuciText.Obfuscation.cs

@@ -175,6 +175,11 @@ public NuciTextObfuscator(string seed) : this(seed.GetHashCode()) { }
 
         public NuciTextObfuscator() : this(Environment.TickCount) { }
 
+        /// <summary>
+        /// Deobfuscates the specified text.
+        /// </summary>
+        /// <param name="text">The text to deobfuscate.</param>
+        /// <returns>The deobfuscated text.</returns>
         public string Deobfuscate(string text)
         {
             if (text is null)
@@ -257,9 +262,20 @@ public string Deobfuscate(string text)
             return builder.ToString();
         }
 
+        /// <summary>
+        /// Obfuscates the specified text.
+        /// </summary>
+        /// <param name="text">The text to obfuscate.</param>
+        /// <returns>The obfuscated text.</returns>
         public string Obfuscate(string text)
             => Obfuscate(text, new NuciTextObfuscatorOptions());
 
+        /// <summary>
+        /// Obfuscates the specified text using the provided options.
+        /// </summary>
+        /// <param name="text">The text to obfuscate.</param>
+        /// <param name="options">The options to use for obfuscation.</param>
+        /// <returns>The obfuscated text.</returns>
         public string Obfuscate(string text, NuciTextObfuscatorOptions options)
         {
             if (text is null)

NuciText.Obfuscation/NuciTextObfuscatorOptions.cs

@@ -1,7 +1,13 @@
 namespace NuciText.Obfuscation
 {
+    /// <summary>
+    /// Defines the options for the NuciText obfuscator, allowing customisation of the obfuscation process.
+    /// </summary>
     public sealed class NuciTextObfuscatorOptions
     {
+        /// <summary>
+        /// Gets or sets a value indicating whether to use approximate replacements for characters.
+        /// </summary>
         public bool UseApproximateReplacements { get; set; } = false;
     }
 }

README.md

@@ -1,4 +1,4 @@
-[![Donate](https://img.shields.io/badge/-%E2%99%A5%20Donate-%23ff69b4)](https://hmlendea.go.ro/fund.html) [![Latest GitHub release](https://img.shields.io/github/v/release/hmlendea/nuciapi)](https://github.com/hmlendea/nuciapi/releases/latest) [![Build Status](https://github.com/hmlendea/nucitext.obfuscation/actions/workflows/dotnet.yml/badge.svg)](https://github.com/hmlendea/nucitext.obfuscation/actions/workflows/dotnet.yml)
+[![Donate](https://img.shields.io/badge/-%E2%99%A5%20Donate-%23ff69b4)](https://hmlendea.go.ro/fund.html) [![Latest GitHub release](https://img.shields.io/github/v/release/hmlendea/nucitext.obfuscation)](https://github.com/hmlendea/nucitext.obfuscation/releases/latest) [![Build Status](https://github.com/hmlendea/nucitext.obfuscation/actions/workflows/dotnet.yml/badge.svg)](https://github.com/hmlendea/nucitext.obfuscation/actions/workflows/dotnet.yml)
 
 # Installation