Add missing XML documentation.

This commit is contained in:
2020-07-20 05:57:37 +01:00
parent b52642af4e
commit 163d2ce8db
13 changed files with 51 additions and 12 deletions

View File

@@ -115,7 +115,6 @@ namespace Aaru.Core.Devices.Dumping
// TODO: Set pregap for Track 1 // TODO: Set pregap for Track 1
// TODO: Detect errors in sectors // TODO: Detect errors in sectors
/// <summary>Reads all CD user data</summary> /// <summary>Reads all CD user data</summary>
/// <param name="audioExtents">Extents with audio sectors</param>
/// <param name="blocks">Total number of positive sectors</param> /// <param name="blocks">Total number of positive sectors</param>
/// <param name="blockSize">Size of the read sector in bytes</param> /// <param name="blockSize">Size of the read sector in bytes</param>
/// <param name="currentSpeed">Current read speed</param> /// <param name="currentSpeed">Current read speed</param>
@@ -123,24 +122,23 @@ namespace Aaru.Core.Devices.Dumping
/// <param name="extents">Extents</param> /// <param name="extents">Extents</param>
/// <param name="ibgLog">IMGBurn log</param> /// <param name="ibgLog">IMGBurn log</param>
/// <param name="imageWriteDuration">Duration of image write</param> /// <param name="imageWriteDuration">Duration of image write</param>
/// <param name="lastSector">Last sector number</param>
/// <param name="leadOutExtents">Lead-out extents</param> /// <param name="leadOutExtents">Lead-out extents</param>
/// <param name="maxSpeed">Maximum speed</param> /// <param name="maxSpeed">Maximum speed</param>
/// <param name="mhddLog">MHDD log</param> /// <param name="mhddLog">MHDD log</param>
/// <param name="minSpeed">Minimum speed</param> /// <param name="minSpeed">Minimum speed</param>
/// <param name="newTrim">Is trim a new one?</param>
/// <param name="nextData">Next cluster of sectors is all data</param>
/// <param name="offsetBytes">Read offset</param> /// <param name="offsetBytes">Read offset</param>
/// <param name="read6">Device supports READ(6)</param>
/// <param name="read10">Device supports READ(10)</param>
/// <param name="read12">Device supports READ(12)</param>
/// <param name="read16">Device supports READ(16)</param>
/// <param name="readcd">Device supports READ CD</param>
/// <param name="sectorsForOffset">Sectors needed to fix offset</param> /// <param name="sectorsForOffset">Sectors needed to fix offset</param>
/// <param name="subSize">Subchannel size in bytes</param> /// <param name="subSize">Subchannel size in bytes</param>
/// <param name="supportedSubchannel">Drive's maximum supported subchannel</param> /// <param name="supportedSubchannel">Drive's maximum supported subchannel</param>
/// <param name="supportsLongSectors">Supports reading EDC and ECC</param>
/// <param name="totalDuration">Total commands duration</param> /// <param name="totalDuration">Total commands duration</param>
/// <param name="cdiReadyReadAsAudio">Is the drive returning CD-i Ready hidden track as audio?</param>
/// <param name="tracks">Disc tracks</param>
/// <param name="subLog">Subchannel log</param>
/// <param name="desiredSubchannel">Subchannel desired to save</param>
/// <param name="isrcs">List of disc ISRCs</param>
/// <param name="mcn">Disc media catalogue number</param>
/// <param name="subchannelExtents">List of subchannels not yet dumped correctly</param>
/// <param name="smallestPregapLbaPerTrack">List of smallest pregap relative address per track</param>
void ReadCdiReady(uint blockSize, ref double currentSpeed, DumpHardwareType currentTry, ExtentsULong extents, void ReadCdiReady(uint blockSize, ref double currentSpeed, DumpHardwareType currentTry, ExtentsULong extents,
IbgLog ibgLog, ref double imageWriteDuration, ExtentsULong leadOutExtents, IbgLog ibgLog, ref double imageWriteDuration, ExtentsULong leadOutExtents,
ref double maxSpeed, MhddLog mhddLog, ref double minSpeed, uint subSize, ref double maxSpeed, MhddLog mhddLog, ref double minSpeed, uint subSize,

View File

@@ -79,6 +79,13 @@ namespace Aaru.Core.Devices.Dumping
/// <param name="supportedSubchannel">Drive's maximum supported subchannel</param> /// <param name="supportedSubchannel">Drive's maximum supported subchannel</param>
/// <param name="supportsLongSectors">Supports reading EDC and ECC</param> /// <param name="supportsLongSectors">Supports reading EDC and ECC</param>
/// <param name="totalDuration">Total commands duration</param> /// <param name="totalDuration">Total commands duration</param>
/// <param name="tracks">Disc tracks</param>
/// <param name="subLog">Subchannel log</param>
/// <param name="desiredSubchannel">Subchannel desired to save</param>
/// <param name="isrcs">List of disc ISRCs</param>
/// <param name="mcn">Disc media catalogue number</param>
/// <param name="subchannelExtents">List of subchannels not yet dumped correctly</param>
/// <param name="smallestPregapLbaPerTrack">List of smallest pregap relative address per track</param>
void ReadCdData(ExtentsULong audioExtents, ulong blocks, uint blockSize, ref double currentSpeed, void ReadCdData(ExtentsULong audioExtents, ulong blocks, uint blockSize, ref double currentSpeed,
DumpHardwareType currentTry, ExtentsULong extents, IbgLog ibgLog, ref double imageWriteDuration, DumpHardwareType currentTry, ExtentsULong extents, IbgLog ibgLog, ref double imageWriteDuration,
long lastSector, ExtentsULong leadOutExtents, ref double maxSpeed, MhddLog mhddLog, long lastSector, ExtentsULong leadOutExtents, ref double maxSpeed, MhddLog mhddLog,

View File

@@ -69,6 +69,13 @@ namespace Aaru.Core.Devices.Dumping
/// <param name="supportedSubchannel">Drive's maximum supported subchannel</param> /// <param name="supportedSubchannel">Drive's maximum supported subchannel</param>
/// <param name="subSize">Subchannel size in bytes</param> /// <param name="subSize">Subchannel size in bytes</param>
/// <param name="totalDuration">Total commands duration</param> /// <param name="totalDuration">Total commands duration</param>
/// <param name="tracks">Disc tracks</param>
/// <param name="subLog">Subchannel log</param>
/// <param name="desiredSubchannel">Subchannel desired to save</param>
/// <param name="isrcs">List of disc ISRCs</param>
/// <param name="mcn">Disc media catalogue number</param>
/// <param name="subchannelExtents">List of subchannels not yet dumped correctly</param>
/// <param name="smallestPregapLbaPerTrack">List of smallest pregap relative address per track</param>
void DumpCdLeadOuts(ulong blocks, uint blockSize, ref double currentSpeed, DumpHardwareType currentTry, void DumpCdLeadOuts(ulong blocks, uint blockSize, ref double currentSpeed, DumpHardwareType currentTry,
ExtentsULong extents, IbgLog ibgLog, ref double imageWriteDuration, ExtentsULong extents, IbgLog ibgLog, ref double imageWriteDuration,
ExtentsULong leadOutExtents, ref double maxSpeed, MhddLog mhddLog, ref double minSpeed, ExtentsULong leadOutExtents, ref double maxSpeed, MhddLog mhddLog, ref double minSpeed,
@@ -246,6 +253,13 @@ namespace Aaru.Core.Devices.Dumping
/// <param name="supportedSubchannel">Drive's maximum supported subchannel</param> /// <param name="supportedSubchannel">Drive's maximum supported subchannel</param>
/// <param name="subSize">Subchannel size in bytes</param> /// <param name="subSize">Subchannel size in bytes</param>
/// <param name="totalDuration">Total commands duration</param> /// <param name="totalDuration">Total commands duration</param>
/// <param name="tracks">Disc tracks</param>
/// <param name="subLog">Subchannel log</param>
/// <param name="desiredSubchannel">Subchannel desired to save</param>
/// <param name="isrcs">List of disc ISRCs</param>
/// <param name="mcn">Disc media catalogue number</param>
/// <param name="subchannelExtents">List of subchannels not yet dumped correctly</param>
/// <param name="smallestPregapLbaPerTrack">List of smallest pregap relative address per track</param>
void RetryCdLeadOuts(ulong blocks, uint blockSize, ref double currentSpeed, DumpHardwareType currentTry, void RetryCdLeadOuts(ulong blocks, uint blockSize, ref double currentSpeed, DumpHardwareType currentTry,
ExtentsULong extents, IbgLog ibgLog, ref double imageWriteDuration, ExtentsULong extents, IbgLog ibgLog, ref double imageWriteDuration,
ExtentsULong leadOutExtents, ref double maxSpeed, MhddLog mhddLog, ref double minSpeed, ExtentsULong leadOutExtents, ref double maxSpeed, MhddLog mhddLog, ref double minSpeed,

View File

@@ -115,6 +115,18 @@ namespace Aaru.Core.Devices.Dumping
/// <param name="preSidecar">Sidecar to store in dumped image</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="skip">How many sectors to skip reading on error</param>
/// <param name="metadata">Create metadata sidecar after dump?</param> /// <param name="metadata">Create metadata sidecar after dump?</param>
/// <param name="fixOffset">Fix audio offset</param>
/// <param name="debug">Debug mode</param>
/// <param name="subchannel">Desired subchannel to save to image</param>
/// <param name="speed">Desired drive speed</param>
/// <param name="private">Disable saving paths or serial numbers in images and logs</param>
/// <param name="fixSubchannelPosition">Fix subchannel position (save where it says it belongs)</param>
/// <param name="retrySubchannel">Retry reading incorrect or missing subchannels</param>
/// <param name="fixSubchannel">Try to fix subchannel errors (but not Q CRC)</param>
/// <param name="fixSubchannelCrc">Try to fix subchannel Q CRC errors</param>
/// <param name="skipCdireadyHole">Skip gap between CD-i Ready hidden track and track 1 audio</param>
/// <param name="errorLog">Error log</param>
/// <param name="generateSubchannels">Generate missing subchannels</param>
public Dump(bool doResume, Device dev, string devicePath, IWritableImage outputPlugin, ushort retryPasses, public Dump(bool doResume, Device dev, string devicePath, IWritableImage outputPlugin, ushort retryPasses,
bool force, bool dumpRaw, bool persistent, bool stopOnError, Resume resume, DumpLog dumpLog, bool force, bool dumpRaw, bool persistent, bool stopOnError, Resume resume, DumpLog dumpLog,
Encoding encoding, string outputPrefix, string outputPath, Dictionary<string, string> formatOptions, Encoding encoding, string outputPrefix, string outputPath, Dictionary<string, string> formatOptions,

View File

@@ -56,6 +56,7 @@ namespace Aaru.Core.Devices.Dumping
/// <param name="extents">Dumped extents</param> /// <param name="extents">Dumped extents</param>
/// <param name="firmware">Firmware revision</param> /// <param name="firmware">Firmware revision</param>
/// <param name="isTape">Set to <c>true</c> if device is a streaming tape, <c>false</c> otherwise</param> /// <param name="isTape">Set to <c>true</c> if device is a streaming tape, <c>false</c> otherwise</param>
/// <param name="private">Disable saving paths or serial numbers in images and logs</param>
/// <exception cref="System.NotImplementedException">If device uses CHS addressing</exception> /// <exception cref="System.NotImplementedException">If device uses CHS addressing</exception>
/// <exception cref="System.InvalidOperationException"> /// <exception cref="System.InvalidOperationException">
/// If the provided resume does not correspond with the current in /// If the provided resume does not correspond with the current in

View File

@@ -49,6 +49,7 @@ namespace Aaru.Core.Devices.Scanning
/// <param name="ibgLogPath">Path to a IMGBurn log file</param> /// <param name="ibgLogPath">Path to a IMGBurn log file</param>
/// <param name="devicePath">Device path</param> /// <param name="devicePath">Device path</param>
/// <param name="dev">Device</param> /// <param name="dev">Device</param>
/// <param name="seekTest">Enable seek test</param>
public MediaScan(string mhddLogPath, string ibgLogPath, string devicePath, Device dev, bool seekTest = true) public MediaScan(string mhddLogPath, string ibgLogPath, string devicePath, Device dev, bool seekTest = true)
{ {
_mhddLogPath = mhddLogPath; _mhddLogPath = mhddLogPath;

View File

@@ -49,6 +49,7 @@ namespace Aaru.Core.Logging
/// <summary>Initializes the dump log</summary> /// <summary>Initializes the dump log</summary>
/// <param name="outputFile">Output log file</param> /// <param name="outputFile">Output log file</param>
/// <param name="dev">Device</param> /// <param name="dev">Device</param>
/// <param name="private">Disable saving paths or serial numbers in log</param>
public DumpLog(string outputFile, Device dev, bool @private) public DumpLog(string outputFile, Device dev, bool @private)
{ {
if(string.IsNullOrEmpty(outputFile)) if(string.IsNullOrEmpty(outputFile))

View File

@@ -51,6 +51,7 @@ namespace Aaru.Core.Logging
/// <param name="blocks">Blocks in media</param> /// <param name="blocks">Blocks in media</param>
/// <param name="blockSize">Bytes per block</param> /// <param name="blockSize">Bytes per block</param>
/// <param name="blocksToRead">How many blocks read at once</param> /// <param name="blocksToRead">How many blocks read at once</param>
/// <param name="private">Disable saving paths or serial numbers in log</param>
internal MhddLog(string outputFile, Device dev, ulong blocks, ulong blockSize, ulong blocksToRead, internal MhddLog(string outputFile, Device dev, ulong blocks, ulong blockSize, ulong blocksToRead,
bool @private) bool @private)
{ {

View File

@@ -40,6 +40,7 @@ namespace Aaru.Core.Logging
/// <summary>Initializes the dump log</summary> /// <summary>Initializes the dump log</summary>
/// <param name="outputFile">Output log file</param> /// <param name="outputFile">Output log file</param>
/// <param name="bcd">Drive returns subchannel in BCD format</param>
public SubchannelLog(string outputFile, bool bcd) public SubchannelLog(string outputFile, bool bcd)
{ {
if(string.IsNullOrEmpty(outputFile)) if(string.IsNullOrEmpty(outputFile))

View File

@@ -58,6 +58,7 @@ namespace Aaru.Core.Media.Info
/// <param name="updateStatus">UpdateStatus event</param> /// <param name="updateStatus">UpdateStatus event</param>
/// <param name="driveOffset">Drive offset</param> /// <param name="driveOffset">Drive offset</param>
/// <param name="combinedOffset">Combined offset</param> /// <param name="combinedOffset">Combined offset</param>
/// <param name="supportsPlextorReadCdDa">Set to <c>true</c> if drive supports PLEXTOR READ CD-DA vendor command</param>
/// <returns><c>true</c> if offset could be found, <c>false</c> otherwise</returns> /// <returns><c>true</c> if offset could be found, <c>false</c> otherwise</returns>
[SuppressMessage("ReSharper", "TooWideLocalVariableScope")] [SuppressMessage("ReSharper", "TooWideLocalVariableScope")]
public static void GetOffset(CdOffset cdOffset, Device dbDev, bool debug, Aaru.Devices.Device dev, public static void GetOffset(CdOffset cdOffset, Device dbDev, bool debug, Aaru.Devices.Device dev,

View File

@@ -42,6 +42,7 @@ namespace Aaru.Devices
/// <param name="relAddr">Set to <c>true</c> if <paramref name="lba" /> is relative</param> /// <param name="relAddr">Set to <c>true</c> if <paramref name="lba" /> is relative</param>
/// <param name="lba">Logical block address where to start the search.</param> /// <param name="lba">Logical block address where to start the search.</param>
/// <param name="scanLength">Number of blocks to scan</param> /// <param name="scanLength">Number of blocks to scan</param>
/// <param name="foundBlocks">How many blocks were found</param>
/// <param name="timeout">Timeout.</param> /// <param name="timeout">Timeout.</param>
/// <param name="duration">Duration.</param> /// <param name="duration">Duration.</param>
/// <param name="written"> /// <param name="written">
@@ -55,6 +56,7 @@ namespace Aaru.Devices
/// other parameters are met /// other parameters are met
/// </param> /// </param>
/// <param name="requested">Number of contiguous blocks to find</param> /// <param name="requested">Number of contiguous blocks to find</param>
/// <param name="foundLba">First LBA found</param>
public bool MediumScan(out byte[] senseBuffer, bool written, bool advancedScan, bool reverse, bool partial, public bool MediumScan(out byte[] senseBuffer, bool written, bool advancedScan, bool reverse, bool partial,
bool relAddr, uint lba, uint requested, uint scanLength, out uint foundLba, bool relAddr, uint lba, uint requested, uint scanLength, out uint foundLba,
out uint foundBlocks, uint timeout, out double duration) out uint foundBlocks, uint timeout, out double duration)