Add more documentation to library (#147)

***NO_CI***

Author: josesimoes

nanoFirmwareFlasher.Library/CC13x26x2Operations.cs

@@ -11,8 +11,22 @@
 
 namespace nanoFramework.Tools.FirmwareFlasher
 {
+    /// <summary>
+    /// Class with operations available in CC13x26x2 devices.
+    /// </summary>
     public class CC13x26x2Operations
     {
+        /// <summary>
+        /// Perform firmware update on a CC13x26x2 device.
+        /// </summary>
+        /// <param name="targetName">Name of the target to update.</param>
+        /// <param name="fwVersion">Firmware version to update to.</param>
+        /// <param name="preview">Set to <see langword="true"/> to use preview version to update.</param>
+        /// <param name="updateFw">Set to <see langword="true"/> to force download of firmware package.</param>
+        /// <param name="applicationPath">Path to application to update along with the firmware update.</param>
+        /// <param name="deploymentAddress">Flash address to use when deploying an aplication.</param>
+        /// <param name="verbosity">Set verbosity level of progress and error messages.</param>
+        /// <returns>The <see cref="ExitCodes"/> with the operation result.</returns>
         public static async System.Threading.Tasks.Task<ExitCodes> UpdateFirmwareAsync(
             string targetName,
             string fwVersion,
@@ -125,6 +139,12 @@ public static async System.Threading.Tasks.Task<ExitCodes> UpdateFirmwareAsync(
             return programResult;
         }
 
+        /// <summary>
+        /// Perform instalation of XDS110 drivers.
+        /// </summary>
+        /// <param name="verbosityLevel">Set verbosity level of progress and error messages.</param>
+        /// <returns>The <see cref="ExitCodes"/> with the operation result.</returns>
+        /// <exception cref="UniflashCliExecutionException">Error occurred when executing an operation with Uniflash Client.</exception>
         public static ExitCodes InstallXds110Drivers(VerbosityLevel verbosityLevel)
         {
             try

nanoFirmwareFlasher.Library/CloudSmithPackageDetails.cs

@@ -6,9 +6,19 @@
 
 namespace nanoFramework.Tools.FirmwareFlasher
 {
+    /// <summary>
+    /// Class with details of a CloudSmith package.
+    /// </summary>
     public class CloudSmithPackageDetail
     {
+        /// <summary>
+        /// Package name.
+        /// </summary>
         public string Name { get; set; }
+
+        /// <summary>
+        /// Package version.
+        /// </summary>
         public string Version { get; set; }
     }
 }

nanoFirmwareFlasher.Library/Esp32Operations.cs

@@ -9,8 +9,20 @@
 
 namespace nanoFramework.Tools.FirmwareFlasher
 {
+    /// <summary>
+    /// Class with operations available in ESP32 devices.
+    /// </summary>
     public class Esp32Operations
     {
+        /// <summary>
+        /// Perform backup of current flash content of ESP32 device.
+        /// </summary>
+        /// <param name="tool"><see cref="EspTool"/> to use when performing update.</param>
+        /// <param name="device"><see cref="Esp32DeviceInfo"/> of device to update.</param>
+        /// <param name="backupPath">Path to store backup image.</param>
+        /// <param name="fileName">Name of backup file.</param>
+        /// <param name="verbosity">Set verbosity level of progress and error messages.</param>
+        /// <returns>The <see cref="ExitCodes"/> with the operation result.</returns>
         public static ExitCodes BackupFlash(
             EspTool tool,
             Esp32DeviceInfo device,
@@ -78,6 +90,22 @@ public static ExitCodes BackupFlash(
             return ExitCodes.OK;
         }
 
+        /// <summary>
+        /// Perform firmware update on a ESP32 device.
+        /// </summary>
+        /// <param name="tool"><see cref="EspTool"/> to use when performing update.</param>
+        /// <param name="device"><see cref="Esp32DeviceInfo"/> of device to update.</param>
+        /// <param name="targetName">Name of the target to update.</param>
+        /// <param name="updateFw">Set to <see langword="true"/> to force download of firmware package.</param>
+        /// <param name="fwVersion">Firmware version to update to.</param>
+        /// <param name="preview">Set to <see langword="true"/> to use preview version to update.</param>
+        /// <param name="applicationPath">Path to application to update along with the firmware update.</param>
+        /// <param name="deploymentAddress">Flash address to use when deploying an aplication.</param>
+        /// <param name="clrFile">Path to CLR file to use for firmware update.</param>
+        /// <param name="fitCheck"><see langword="true"/> to perform validation of update package against connected target.</param>
+        /// <param name="verbosity">Set verbosity level of progress and error messages.</param>
+        /// <param name="partitionTableSize">Size of partition table.</param>
+        /// <returns>The <see cref="ExitCodes"/> with the operation result.</returns>
         public static async System.Threading.Tasks.Task<ExitCodes> UpdateFirmwareAsync(
             EspTool espTool,
             Esp32DeviceInfo esp32Device,

nanoFirmwareFlasher.Library/JLinkCli.cs

@@ -14,6 +14,9 @@
 
 namespace nanoFramework.Tools.FirmwareFlasher
 {
+    /// <summary>
+    /// Class that performs the interface with the JLink CLI.
+    /// </summary>
     public class JLinkCli
     {
         /// <summary>

nanoFirmwareFlasher.Library/JLinkDevice.cs

@@ -11,6 +11,9 @@
 
 namespace nanoFramework.Tools.FirmwareFlasher
 {
+    /// <summary>
+    /// Class representing a connected J-Link device.
+    /// </summary>
     public class JLinkDevice : JLinkCli
     {
         /// <summary>

nanoFirmwareFlasher.Library/JLinkOperations.cs

@@ -10,8 +10,24 @@
 
 namespace nanoFramework.Tools.FirmwareFlasher
 {
+    /// <summary>
+    /// Class with operations available in J-Link connected devices.
+    /// </summary>
     public class JLinkOperations
     {
+        /// <summary>
+        /// Perform firmware update on a J-Link connected device.
+        /// </summary>
+        /// <param name="targetName">Name of the target to update.</param>
+        /// <param name="fwVersion">Firmware version to update to.</param>
+        /// <param name="preview">Set to <see langword="true"/> to use preview version to update.</param>
+        /// <param name="updateFw">Set to <see langword="true"/> to force download of firmware package.</param>
+        /// <param name="applicationPath">Path to application to update along with the firmware update.</param>
+        /// <param name="deploymentAddress">Flash address to use when deploying an aplication.</param>
+        /// <param name="probeId">ID of the J-Link probe to connect to.</param>
+        /// <param name="fitCheck"><see langword="true"/> to perform validation of update package against connected target.</param>
+        /// <param name="verbosity">Set verbosity level of progress and error messages.</param>
+        /// <returns>The <see cref="ExitCodes"/> with the operation result.</returns>
         public static async System.Threading.Tasks.Task<ExitCodes> UpdateFirmwareAsync(
             string targetName,
             string fwVersion,

nanoFirmwareFlasher.Library/nanoFirmwareFlasher.Library.csproj

@@ -26,6 +26,7 @@
     <PackageIcon>images\nf-logo.png</PackageIcon>
     <PackageTags>nanoFramework, nano Framework, NETNF, NETMF, Micro Framework, .net</PackageTags>
     <PackageReadmeFile>README.md</PackageReadmeFile>
+    <GenerateDocumentationFile>True</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>