DOCUMENTATION: Added XML documentation to DiscImageChef.Core.

DiscImageChef.Core/Devices/Scanning/ATA.cs

@@ -39,8 +39,19 @@ using DiscImageChef.Devices;
 
 namespace DiscImageChef.Core.Devices.Scanning
 {
+    /// <summary>
+    /// Implements scanning the media from an ATA device
+    /// </summary>
     public static class Ata
     {
+        /// <summary>
+        /// Scans the media from an ATA device
+        /// </summary>
+        /// <param name="mhddLogPath">Path to a MHDD log file</param>
+        /// <param name="ibgLogPath">Path to a IMGBurn log file</param>
+        /// <param name="devicePath">Device path</param>
+        /// <param name="dev">Device</param>
+        /// <returns>Scanning results</returns>
         public static ScanResults Scan(string mhddLogPath, string ibgLogPath, string devicePath, Device dev)
         {
             ScanResults results = new ScanResults();

DiscImageChef.Core/Devices/Scanning/SCSI.cs

@@ -42,6 +42,9 @@ using DiscImageChef.Devices;
 
 namespace DiscImageChef.Core.Devices.Scanning
 {
+    /// <summary>
+    /// Implements scanning the media from an SCSI device
+    /// </summary>
     public static class Scsi
     {
         public static ScanResults Scan(string mhddLogPath, string ibgLogPath, string devicePath, Device dev)

DiscImageChef.Core/Devices/Scanning/ScanResults.cs

@@ -34,25 +34,82 @@ using System.Collections.Generic;
 
 namespace DiscImageChef.Core.Devices.Scanning
 {
+    /// <summary>
+    /// Contains the results of a media scan
+    /// </summary>
     public struct ScanResults
     {
+        /// <summary>
+        /// Total time spent scanning
+        /// </summary>
         public double TotalTime;
+        /// <summary>
+        /// Total time spent by the device processing commands
+        /// </summary>
         public double ProcessingTime;
+        /// <summary>
+        /// Average scan speed
+        /// </summary>
         public double AvgSpeed;
+        /// <summary>
+        /// Maximum scan speed burst
+        /// </summary>
         public double MaxSpeed;
+        /// <summary>
+        /// Minimum scan speed
+        /// </summary>
         public double MinSpeed;
+        /// <summary>
+        /// Sectors that took less than 3 milliseconds to be processed
+        /// </summary>
         public ulong A;
+        /// <summary>
+        /// Sectors that took less than 10 milliseconds but more than 3 milliseconds to be processed
+        /// </summary>
         public ulong B;
+        /// <summary>
+        /// Sectors that took less than 50 milliseconds but more than 10 milliseconds to be processed
+        /// </summary>
         public ulong C;
+        /// <summary>
+        /// Sectors that took less than 150 milliseconds but more than 50 milliseconds to be processed
+        /// </summary>
         public ulong D;
+        /// <summary>
+        /// Sectors that took less than 500 milliseconds but more than 150 milliseconds to be processed
+        /// </summary>
         public ulong E;
+        /// <summary>
+        /// Sectors that took more than 500 milliseconds to be processed
+        /// </summary>
         public ulong F;
+        /// <summary>
+        /// List of sectors that could not be read
+        /// </summary>
         public List<ulong> UnreadableSectors;
+        /// <summary>
+        /// Slowest seek
+        /// </summary>
         public double SeekMax;
+        /// <summary>
+        /// Fastest seek
+        /// </summary>
         public double SeekMin;
+        /// <summary>
+        /// Total time spent seeking
+        /// </summary>
         public double SeekTotal;
+        /// <summary>
+        /// How many seeks have been done
+        /// </summary>
         public int SeekTimes;
+        /// <summary>
+        /// How many blocks were scanned
+        /// </summary>
         public ulong Blocks;
+        /// <summary>
+        /// How many blocks could not be read
+        /// </summary>
         public ulong Errored;
     }
 }

DiscImageChef.Core/Devices/Scanning/SecureDigital.cs

@@ -39,6 +39,9 @@ using DiscImageChef.Devices;
 
 namespace DiscImageChef.Core.Devices.Scanning
 {
+    /// <summary>
+    /// Implements scanning a SecureDigital or MultiMediaCard flash card
+    /// </summary>
     public static class SecureDigital
     {
         public static ScanResults Scan(string mhddLogPath, string ibgLogPath, string devicePath, Device dev)