Added documentation generation and additional XML comments

Author: alex8obrien

CommonsLibrary.Logging/CommonsLibrary.Logging.csproj

@@ -18,6 +18,7 @@
     <RepositoryType>git</RepositoryType>
     <PackageTags>lib;library;c#;logging;logs</PackageTags>
     <PackageLicenseFile>LICENSE.md</PackageLicenseFile>
+    <GenerateDocumentationFile>True</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

CommonsLibrary.Logging/Log.cs

@@ -3,12 +3,21 @@
 
 namespace CommonsLibrary.Logging
 {
+    /// <summary>
+    /// Log container class
+    /// </summary>
+    /// <remarks>Depends on 'System' & 'System.IO' packages.</remarks>
     public class Log
     {
         private readonly string _filePath;
         private static Log? _logger;
 
         private Log(string filePath) => _filePath = filePath;
+        /// <summary>
+        /// Singleton used to retrieve the active logger
+        /// </summary>
+        /// <param name="filePath">Full file path of the log file</param>
+        /// <returns>Instance of the Log class</returns>
         public static Log GetLogger(string filePath) => _logger ??= new Log(filePath);
 
         private void WriteLog(LogLevel level, string message, Exception? exception = null)
@@ -17,12 +26,25 @@ private void WriteLog(LogLevel level, string message, Exception? exception = nul
             writer.WriteLine($"{DateTime.Now} {level} {exception} {message}");
         }
 
+        /// <summary>
+        /// Used to create Info level logs
+        /// </summary>
+        /// <param name="message">Message to be written</param>
         public void Info(string message) =>
             WriteLog(LogLevel.Info, message);
 
+        /// <summary>
+        /// Used to create Warning level logs
+        /// </summary>
+        /// <param name="message">Message to be written</param>
         public void Warning(string message) =>
             WriteLog(LogLevel.Warning, message);
 
+        /// <summary>
+        /// Used to create Error level logs
+        /// </summary>
+        /// <param name="message">Message to be written</param>
+        /// <param name="exception">Exception to be logged</param>
         public void Error(string message, Exception exception) =>
             WriteLog(LogLevel.Error, message, exception);
 

CommonsLibrary.Maths/CommonsLibrary.Maths.csproj

@@ -14,8 +14,8 @@
     <RepositoryUrl>https://github.com/alex8obrien/CommonsLibrary</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <PackageTags>lib;library;c#;math;maths</PackageTags>
-    <PackageLicenseFile>LICENSE.md</PackageLicenseFile>
 	<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
+	<GenerateDocumentationFile>True</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

CommonsLibrary.Maths/Constants.cs

@@ -2,6 +2,9 @@
 
 namespace CommonsLibrary.Maths
 {
+    /// <summary>
+    /// Collection of mathematical constants
+    /// </summary>
     public static class Constants
     {
         public const decimal E = 2.71828182845904523536028747135266249775724709369995957496696762772407663035354759457138217852516642742746m;

CommonsLibrary.Maths/Converts.cs

@@ -4,7 +4,6 @@ namespace CommonsLibrary.Maths
 {
     public static class Converts
     {
-        
         public static string UBinToOct(string input) => Convert.ToString(Convert.ToInt32(input, 2), 8);
         public static int UBinToDec(string input) => Convert.ToInt32(input, 2);
         public static string UBinToHex(string input) => Convert.ToInt32(input, 2).ToString("X");

CommonsLibrary/CommonsLibrary.csproj

@@ -16,6 +16,7 @@
 		<PackageId>Alex.CommonsLibrary</PackageId>
 		<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
 		<PackageLicenseFile>LICENSE.md</PackageLicenseFile>
+		<GenerateDocumentationFile>True</GenerateDocumentationFile>
 	</PropertyGroup>
 
 	<ItemGroup>

CommonsLibrary/FileIO.cs

@@ -3,6 +3,8 @@
 
 namespace CommonsLibrary
 {
+    /// <summary>Static class containing useful file methods.</summary>
+    /// <remarks>Requires the 'System.IO' package.</remarks>
     public static class FileIO
     {
         /// <summary>Calculates the number of lines in a file.</summary>