Fix dumpers documentation.

DiscImageChef.Core/Devices/Dumping/Dump.cs

@@ -14,9 +14,8 @@ namespace DiscImageChef.Core.Devices.Dumping
 {
     public partial class Dump
     {
-        readonly Device dev;
-        readonly string devicePath;
-
+        readonly Device                     dev;
+        readonly string                     devicePath;
         readonly bool                       doResume;
         readonly DumpLog                    dumpLog;
         readonly bool                       dumpRaw;
@@ -37,7 +36,9 @@ namespace DiscImageChef.Core.Devices.Dumping
         uint                                skip;
 
         /// <summary>
+        ///     Initializes dumpers
         /// </summary>
+        /// <param name="doResume">Should resume?</param>
         /// <param name="dev">Device</param>
         /// <param name="devicePath">Path to the device</param>
         /// <param name="outputPrefix">Prefix for output log files</param>
@@ -52,7 +53,11 @@ namespace DiscImageChef.Core.Devices.Dumping
         /// <param name="encoding">Encoding to use when analyzing dump</param>
         /// <param name="outputPath">Path to output file</param>
         /// <param name="formatOptions">Formats to pass to output file plugin</param>
+        /// <param name="notrim">Do not trim errors from skipped sectors</param>
         /// <param name="dumpFirstTrackPregap">Try to read and dump as much first track pregap as possible</param>
+        /// <param name="preSidecar">Sidecar to store in dumped image</param>
+        /// <param name="skip">How many sectors to skip reading on error</param>
+        /// <param name="nometadata">Create metadata sidecar after dump?</param>
         public Dump(bool                       doResume,     Device dev, string devicePath,
                     IWritableImage             outputPlugin, ushort retryPasses,
                     bool                       force,        bool   dumpRaw,      bool    persistent,
@@ -84,6 +89,9 @@ namespace DiscImageChef.Core.Devices.Dumping
             this.dumpFirstTrackPregap = dumpFirstTrackPregap;
         }
 
+        /// <summary>
+        ///     Starts dumping with the stablished fields and autodetecting the device type
+        /// </summary>
         public void Start()
         {
             if(dev.IsUsb && dev.UsbVendorId == 0x054C &&
@@ -128,12 +136,33 @@ namespace DiscImageChef.Core.Devices.Dumping
             fs.Close();
         }
 
-        public event EndProgressHandler    EndProgress;
-        public event InitProgressHandler   InitProgress;
-        public event UpdateStatusHandler   UpdateStatus;
-        public event ErrorMessageHandler   ErrorMessage;
-        public event ErrorMessageHandler   StoppingErrorMessage;
+        /// <summary>
+        ///     Event raised when the progress bar is not longer needed
+        /// </summary>
+        public event EndProgressHandler EndProgress;
+        /// <summary>
+        ///     Event raised when a progress bar is needed
+        /// </summary>
+        public event InitProgressHandler InitProgress;
+        /// <summary>
+        ///     Event raised to report status updates
+        /// </summary>
+        public event UpdateStatusHandler UpdateStatus;
+        /// <summary>
+        ///     Event raised to report a non-fatal error
+        /// </summary>
+        public event ErrorMessageHandler ErrorMessage;
+        /// <summary>
+        ///     Event raised to report a fatal error that stops the dumping operation and should call user's attention
+        /// </summary>
+        public event ErrorMessageHandler StoppingErrorMessage;
+        /// <summary>
+        ///     Event raised to update the values of a determinate progress bar
+        /// </summary>
         public event UpdateProgressHandler UpdateProgress;
-        public event PulseProgressHandler  PulseProgress;
+        /// <summary>
+        ///     Event raised to update the status of an undeterminate progress bar
+        /// </summary>
+        public event PulseProgressHandler PulseProgress;
     }
 }

DiscImageChef.Core/Devices/Dumping/MMC.cs

@@ -54,22 +54,6 @@ namespace DiscImageChef.Core.Devices.Dumping
         /// <summary>
         ///     Dumps an optical disc
         /// </summary>
-        /// <param name="dev">Device</param>
-        /// <param name="devicePath">Path to the device</param>
-        /// <param name="outputPrefix">Prefix for output data files</param>
-        /// <param name="outputPlugin">Plugin for output file</param>
-        /// <param name="retryPasses">How many times to retry</param>
-        /// <param name="force">Force to continue dump whenever possible</param>
-        /// <param name="dumpRaw">Dump raw/long sectors</param>
-        /// <param name="persistent">Store whatever data the drive returned on error</param>
-        /// <param name="stopOnError">Stop dump on first error</param>
-        /// <param name="resume">Information for dump resuming</param>
-        /// <param name="dumpLog">Dump logger</param>
-        /// <param name="encoding">Encoding to use when analyzing dump</param>
-        /// <param name="dskType">Disc type as detected in MMC layer</param>
-        /// <param name="dumpFirstTrackPregap">Try to read and dump as much Lead-in as possible</param>
-        /// <param name="outputPath">Path to output file</param>
-        /// <param name="formatOptions">Formats to pass to output file plugin</param>
         internal void Mmc(ref MediaType dskType)
         {
             bool   sense;

DiscImageChef.Core/Devices/Dumping/SBC.cs

@@ -59,23 +59,9 @@ namespace DiscImageChef.Core.Devices.Dumping
         /// <summary>
         ///     Dumps a SCSI Block Commands device or a Reduced Block Commands devices
         /// </summary>
-        /// <param name="dev">Device</param>
-        /// <param name="devicePath">Path to the device</param>
-        /// <param name="outputPrefix">Prefix for output data files</param>
-        /// <param name="outputPlugin">Plugin for output file</param>
-        /// <param name="retryPasses">How many times to retry</param>
-        /// <param name="force">Force to continue dump whenever possible</param>
-        /// <param name="dumpRaw">Dump long or scrambled sectors</param>
-        /// <param name="persistent">Store whatever data the drive returned on error</param>
-        /// <param name="stopOnError">Stop dump on first error</param>
-        /// <param name="resume">Information for dump resuming</param>
-        /// <param name="dumpLog">Dump logger</param>
-        /// <param name="encoding">Encoding to use when analyzing dump</param>
         /// <param name="opticalDisc">If device contains an optical disc (e.g. DVD or BD)</param>
         /// <param name="mediaTags">Media tags as retrieved in MMC layer</param>
         /// <param name="dskType">Disc type as detected in SCSI or MMC layer</param>
-        /// <param name="outputPath">Path to output file</param>
-        /// <param name="formatOptions">Formats to pass to output file plugin</param>
         internal void Sbc(Dictionary<MediaTagType, byte[]> mediaTags, ref MediaType dskType, bool opticalDisc)
         {
             bool         sense;

DiscImageChef.Core/Devices/Dumping/SCSI.cs

@@ -46,21 +46,6 @@ namespace DiscImageChef.Core.Devices.Dumping
         /// <summary>
         ///     Dumps a SCSI Block Commands device or a Reduced Block Commands devices
         /// </summary>
-        /// <param name="dev">Device</param>
-        /// <param name="devicePath">Path to the device</param>
-        /// <param name="outputPrefix">Prefix for output data files</param>
-        /// <param name="outputPlugin">Plugin for output file</param>
-        /// <param name="retryPasses">How many times to retry</param>
-        /// <param name="force">Force to continue dump whenever possible</param>
-        /// <param name="dumpRaw">Dump long or scrambled sectors</param>
-        /// <param name="persistent">Store whatever data the drive returned on error</param>
-        /// <param name="stopOnError">Stop dump on first error</param>
-        /// <param name="resume">Information for dump resuming</param>
-        /// <param name="dumpLog">Dump logger</param>
-        /// <param name="encoding">Encoding to use when analyzing dump</param>
-        /// <param name="dumpFirstTrackPregap">Try to read and dump as much Lead-in as possible</param>
-        /// <param name="outputPath">Path to output file</param>
-        /// <param name="formatOptions">Formats to pass to output file plugin</param>
         public void Scsi()
         {
             MediaType dskType = MediaType.Unknown;

DiscImageChef.Core/Devices/Dumping/SSC.cs

@@ -52,11 +52,6 @@ namespace DiscImageChef.Core.Devices.Dumping
         /// <summary>
         ///     Dumps the tape from a SCSI Streaming device
         /// </summary>
-        /// <param name="dev">Device</param>
-        /// <param name="devicePath">Path to the device</param>
-        /// <param name="outputPrefix">Prefix for output data files</param>
-        /// <param name="resume">Information for dump resuming</param>
-        /// <param name="dumpLog">Dump logger</param>
         internal void Ssc()
         {
             FixedSense?      fxSense;

DiscImageChef.Core/Devices/Dumping/SecureDigital.cs

@@ -55,21 +55,6 @@ namespace DiscImageChef.Core.Devices.Dumping
         /// <summary>
         ///     Dumps a MultiMediaCard or SecureDigital flash card
         /// </summary>
-        /// <param name="dev">Device</param>
-        /// <param name="devicePath">Path to the device</param>
-        /// <param name="outputPrefix">Prefix for output data files</param>
-        /// <param name="outputPlugin">Plugin for output file</param>
-        /// <param name="retryPasses">How many times to retry</param>
-        /// <param name="force">Force to continue dump whenever possible</param>
-        /// <param name="dumpRaw">Dump long or scrambled sectors</param>
-        /// <param name="persistent">Store whatever data the drive returned on error</param>
-        /// <param name="stopOnError">Stop dump on first error</param>
-        /// <param name="resume">Information for dump resuming</param>
-        /// <param name="dumpLog">Dump logger</param>
-        /// <param name="encoding">Encoding to use when analyzing dump</param>
-        /// <param name="outputPath">Path to output file</param>
-        /// <param name="formatOptions">Formats to pass to output file plugin</param>
-        /// <exception cref="ArgumentException">If you asked to dump long sectors from a SCSI Streaming device</exception>
         public void SecureDigital()
         {
             bool aborted;

DiscImageChef.Core/Devices/Dumping/XGD.cs

@@ -61,22 +61,8 @@ namespace DiscImageChef.Core.Devices.Dumping
         /// <summary>
         ///     Dumps an Xbox Game Disc using a Kreon drive
         /// </summary>
-        /// <param name="dev">Device</param>
-        /// <param name="devicePath">Path to the device</param>
-        /// <param name="outputPrefix">Prefix for output data files</param>
-        /// <param name="outputPlugin">Plugin for output file</param>
-        /// <param name="retryPasses">How many times to retry</param>
-        /// <param name="force">Force to continue dump whenever possible</param>
-        /// <param name="dumpRaw">Dump raw/long sectors</param>
-        /// <param name="persistent">Store whatever data the drive returned on error</param>
-        /// <param name="stopOnError">Stop dump on first error</param>
-        /// <param name="resume">Information for dump resuming</param>
-        /// <param name="dumpLog">Dump logger</param>
-        /// <param name="encoding">Encoding to use when analyzing dump</param>
         /// <param name="mediaTags">Media tags as retrieved in MMC layer</param>
         /// <param name="dskType">Disc type as detected in MMC layer</param>
-        /// <param name="outputPath">Path to output file</param>
-        /// <param name="formatOptions">Formats to pass to output file plugin</param>
         internal void Xgd(Dictionary<MediaTagType, byte[]> mediaTags, ref MediaType dskType)
         {
             bool       sense;