Fix dumpers documentation.

This commit is contained in:
2019-04-20 16:24:17 +01:00
parent 4af686c068
commit b7b086b644
7 changed files with 38 additions and 88 deletions

View File

@@ -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;
}
}