Add missing Intellisense comments (#184)

***NO_CI***

Author: networkfusion

nanoFirmwareFlasher.Library/Esp32DeviceInfo.cs

@@ -65,15 +65,17 @@ public class Esp32DeviceInfo
         public PSRamAvailability PSRamAvailable { get; }
 
         /// <summary>
-        /// Constructor
+        /// Constructor.
         /// </summary>
-        /// <param name="toolVersion">Version of the esptool.py</param>
-        /// <param name="chipName">ESP32 chip name</param>
-        /// <param name="features">ESP32 chip features</param>
-        /// <param name="macAddress">MAC address of the ESP32 chip</param>
-        /// <param name="flashManufacturerId">Flash manufacturer ID</param>
-        /// <param name="flashDeviceModelId">Flash device type ID</param>
-        /// <param name="flashSize">The size of the flash in bytes</param>
+        /// <param name="chipType">The type of chip.</param>
+        /// <param name="chipName">ESP32 chip name.</param>
+        /// <param name="features">ESP32 chip features.</param>
+        /// <param name="crystal"> ESP32 crystal.</param>
+        /// <param name="macAddress">MAC address of the ESP32 chip.</param>
+        /// <param name="flashManufacturerId">Flash manufacturer ID.</param>
+        /// <param name="flashDeviceModelId">Flash device type ID.</param>
+        /// <param name="flashSize">The size of the flash in bytes.</param>
+        /// <param name="psramAvailability">Availability of PSRAM.</param>
         public Esp32DeviceInfo(
             string chipType,
             string chipName,
@@ -101,6 +103,11 @@ internal string GetFlashSizeAsString()
             return GetFlashSizeAsString(FlashSize);
         }
 
+        /// <summary>
+        /// Gets the flash size as a string.
+        /// </summary>
+        /// <param name="flashSize">The flash size.</param>
+        /// <returns>The flash size.</returns>
         public static string GetFlashSizeAsString(int flashSize)
         {
             return flashSize >= 0x10000 ? $"{flashSize / 0x100000}MB" : $"{flashSize / 0x400}kB";

nanoFirmwareFlasher.Library/Esp32Operations.cs

@@ -93,8 +93,8 @@ public static ExitCodes BackupFlash(
         /// <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="espTool"><see cref="EspTool"/> to use when performing update.</param>
+        /// <param name="esp32Device"><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>

nanoFirmwareFlasher.Library/EspTool.cs

@@ -77,6 +77,7 @@ public partial class EspTool
         /// <param name="flashMode">The flash mode for the esptool</param>
         /// <param name="flashFrequency">The flash frequency for the esptool</param>
         /// <param name="partitionTableSize">Partition table size to use</param>
+        /// <param name="verbosity">The verbosity level of messages</param>
         public EspTool(
             string serialPort,
             int baudRate,
@@ -458,6 +459,7 @@ internal ExitCodes EraseFlashSegment(uint startAddress, uint length)
         /// Write to the flash
         /// </summary>
         /// <param name="partsToWrite">dictionary which keys are the start addresses and the values are the complete filenames (the bin files)</param>
+        /// <param name="useStandardBaudrate">Use the standard baud rate (default is false).</param>
         /// <returns>true if successful</returns>
         internal ExitCodes WriteFlash(
             Dictionary<int, string> partsToWrite,

nanoFirmwareFlasher.Library/Exceptions/CantConnectToDfuDeviceException.cs

@@ -14,18 +14,35 @@ namespace nanoFramework.Tools.FirmwareFlasher
     [Serializable]
     public class CantConnectToDfuDeviceException : Exception
     {
+        /// <summary>
+        /// DFU device connection exception.
+        /// </summary>
         public CantConnectToDfuDeviceException()
         {
         }
 
+        /// <summary>
+        /// DFU device connection exception.
+        /// </summary>
+        /// <param name="message">Message to display.</param>
         public CantConnectToDfuDeviceException(string message) : base(message)
         {
         }
 
+        /// <summary>
+        /// DFU device connection exception.
+        /// </summary>
+        /// <param name="message">Message to display.</param>
+        /// <param name="innerException">The exception to display.</param>
         public CantConnectToDfuDeviceException(string message, Exception innerException) : base(message, innerException)
         {
         }
 
+        /// <summary>
+        /// DFU device connection exception.
+        /// </summary>
+        /// <param name="info">Serialized information.</param>
+        /// <param name="context">Streamed context.</param>
         protected CantConnectToDfuDeviceException(SerializationInfo info, StreamingContext context) : base(info, context)
         {
         }

nanoFirmwareFlasher.Library/Exceptions/CantConnectToJLinkDeviceException.cs

@@ -14,18 +14,35 @@ namespace nanoFramework.Tools.FirmwareFlasher
     [Serializable]
     public class CantConnectToJLinkDeviceException : Exception
     {
+        /// <summary>
+        /// Cannot connect to the J-Link device exception.
+        /// </summary>
         public CantConnectToJLinkDeviceException()
         {
         }
 
+        /// <summary>
+        /// Cannot connect to the JLINK device exception.
+        /// </summary>
+        /// <param name="message">Message to display.</param>
         public CantConnectToJLinkDeviceException(string message) : base(message)
         {
         }
 
+        /// <summary>
+        /// Cannot connect to the JLINK device exception.
+        /// </summary>
+        /// <param name="message">Message to display.</param>
+        /// <param name="innerException">The exception to display.</param>
         public CantConnectToJLinkDeviceException(string message, Exception innerException) : base(message, innerException)
         {
         }
 
+        /// <summary>
+        /// Cannot connect to the JLINK device exception.
+        /// </summary>
+        /// <param name="info">Serialized information.</param>
+        /// <param name="context">Streamed context.</param>
         protected CantConnectToJLinkDeviceException(SerializationInfo info, StreamingContext context) : base(info, context)
         {
         }

nanoFirmwareFlasher.Library/Exceptions/CantConnectToJtagDeviceException.cs

@@ -14,18 +14,35 @@ namespace nanoFramework.Tools.FirmwareFlasher
     [Serializable]
     public class CantConnectToJtagDeviceException : Exception
     {
+        /// <summary>
+        /// Cannot connect to JTAG device exception.
+        /// </summary>
         public CantConnectToJtagDeviceException()
         {
         }
 
+        /// <summary>
+        /// Cannot connect to JTAG device exception.
+        /// </summary>
+        /// <param name="message">Message to display.</param>
         public CantConnectToJtagDeviceException(string message) : base(message)
         {
         }
 
+        /// <summary>
+        /// Cannot connect to JTAG device exception.
+        /// </summary>
+        /// <param name="message">Message to display.</param>
+        /// <param name="innerException">The exception to display.</param>
         public CantConnectToJtagDeviceException(string message, Exception innerException) : base(message, innerException)
         {
         }
 
+        /// <summary>
+        /// Cannot connect to JTAG device exception.
+        /// </summary>
+        /// <param name="info">Serialized information.</param>
+        /// <param name="context">Streamed context.</param>
         protected CantConnectToJtagDeviceException(SerializationInfo info, StreamingContext context) : base(info, context)
         {
         }

nanoFirmwareFlasher.Library/Exceptions/CantConnectToNanoDeviceException.cs

@@ -14,18 +14,35 @@ namespace nanoFramework.Tools.FirmwareFlasher
     [Serializable]
     public class CantConnectToNanoDeviceException : Exception
     {
+        /// <summary>
+        /// Cannot connect to device exception.
+        /// </summary>
         public CantConnectToNanoDeviceException()
         {
         }
 
+        /// <summary>
+        /// Cannot connect to device exception.
+        /// </summary>
+        /// <param name="message">Message to display.</param>
         public CantConnectToNanoDeviceException(string message) : base(message)
         {
         }
 
+        /// <summary>
+        /// Cannot connect to device exception.
+        /// </summary>
+        /// <param name="message">Message to display.</param>
+        /// <param name="innerException">The exception to display.</param>
         public CantConnectToNanoDeviceException(string message, Exception innerException) : base(message, innerException)
         {
         }
 
+        /// <summary>
+        /// Cannot connect to device exception.
+        /// </summary>
+        /// <param name="info">Serialized information.</param>
+        /// <param name="context">Streamed context.</param>
         protected CantConnectToNanoDeviceException(SerializationInfo info, StreamingContext context) : base(info, context)
         {
         }

nanoFirmwareFlasher.Library/Exceptions/DfuFileDoesNotExistException.cs

@@ -14,18 +14,35 @@ namespace nanoFramework.Tools.FirmwareFlasher
     [Serializable]
     public class DfuFileDoesNotExistException : Exception
     {
+        /// <summary>
+        /// DFU file does not exist exception.
+        /// </summary>
         public DfuFileDoesNotExistException()
         {
         }
 
+        /// <summary>
+        /// DFU file does not exist exception.
+        /// </summary>
+        /// <param name="message">Message to display.</param>
         public DfuFileDoesNotExistException(string message) : base(message)
         {
         }
 
+        /// <summary>
+        /// DFU file does not exist exception.
+        /// </summary>
+        /// <param name="message">Message to display.</param>
+        /// <param name="innerException">The exception to display.</param>
         public DfuFileDoesNotExistException(string message, Exception innerException) : base(message, innerException)
         {
         }
 
+        /// <summary>
+        /// DFU file does not exist exception.
+        /// </summary>
+        /// <param name="info">Serialized information.</param>
+        /// <param name="context">Streamed context.</param>
         protected DfuFileDoesNotExistException(SerializationInfo info, StreamingContext context) : base(info, context)
         {
         }

nanoFirmwareFlasher.Library/Exceptions/DfuOperationFailedException.cs

@@ -14,18 +14,35 @@ namespace nanoFramework.Tools.FirmwareFlasher
     [Serializable]
     public class DfuOperationFailedException : Exception
     {
+        /// <summary>
+        /// DFU operation failed exception.
+        /// </summary>
         public DfuOperationFailedException()
         {
         }
 
+        /// <summary>
+        /// DFU operation failed exception.
+        /// </summary>
+        /// <param name="message">Message to display.</param>
         public DfuOperationFailedException(string message) : base(message)
         {
         }
 
+        /// <summary>
+        /// DFU operation failed exception.
+        /// </summary>
+        /// <param name="message">Message to display.</param>
+        /// <param name="innerException">The exception to display.</param>
         public DfuOperationFailedException(string message, Exception innerException) : base(message, innerException)
         {
         }
 
+        /// <summary>
+        /// DFU operation failed exception.
+        /// </summary>
+        /// <param name="info">Serialized information.</param>
+        /// <param name="context">Streamed context.</param>
         protected DfuOperationFailedException(SerializationInfo info, StreamingContext context) : base(info, context)
         {
         }

nanoFirmwareFlasher.Library/Exceptions/EraseEsp32FlashException.cs

@@ -19,15 +19,29 @@ public class EraseEsp32FlashException : Exception
         /// </summary>
         public string ExecutionError;
 
+        /// <summary>
+        /// ESP32 tool erase exception.
+        /// </summary>
+        /// <param name="message">Message to display.</param>
         public EraseEsp32FlashException(string message) : base(message)
         {
             ExecutionError = message;
         }
 
+        /// <summary>
+        /// ESP32 tool erase exception.
+        /// </summary>
+        /// <param name="message">Message to display.</param>
+        /// <param name="innerException">The exception to display.</param>
         public EraseEsp32FlashException(string message, Exception innerException) : base(message, innerException)
         {
         }
 
+        /// <summary>
+        /// ESP32 tool erase exception.
+        /// </summary>
+        /// <param name="info">Serialized information.</param>
+        /// <param name="context">Streamed context</param>
         protected EraseEsp32FlashException(SerializationInfo info, StreamingContext context) : base(info, context)
         {
         }