From 163d2ce8db8856e5b24fbd6e710808224383cc7a Mon Sep 17 00:00:00 2001 From: Natalia Portillo Date: Mon, 20 Jul 2020 05:57:37 +0100 Subject: [PATCH] Add missing XML documentation. --- Aaru.Checksums | 2 +- Aaru.CommonTypes | 2 +- .../Devices/Dumping/CompactDisc/CdiReady.cs | 18 ++++++++---------- Aaru.Core/Devices/Dumping/CompactDisc/Data.cs | 7 +++++++ .../Devices/Dumping/CompactDisc/LeadOuts.cs | 14 ++++++++++++++ Aaru.Core/Devices/Dumping/Dump.cs | 12 ++++++++++++ Aaru.Core/Devices/Dumping/ResumeSupport.cs | 1 + Aaru.Core/Devices/Scanning/MediaScan.cs | 1 + Aaru.Core/Logging/DumpLog.cs | 1 + Aaru.Core/Logging/MHDDLog.cs | 1 + Aaru.Core/Logging/SubchannelLog.cs | 1 + Aaru.Core/Media/Info/CompactDisc.cs | 1 + Aaru.Devices/Device/ScsiCommands/Optical.cs | 2 ++ 13 files changed, 51 insertions(+), 12 deletions(-) diff --git a/Aaru.Checksums b/Aaru.Checksums index a0781c379..c6f338a35 160000 --- a/Aaru.Checksums +++ b/Aaru.Checksums @@ -1 +1 @@ -Subproject commit a0781c3792f0d38ef8951281d5ae67eb34eb0a00 +Subproject commit c6f338a35f212572bb12c29ffef3b984318f6a41 diff --git a/Aaru.CommonTypes b/Aaru.CommonTypes index ffd8f7dcc..2748ee6b3 160000 --- a/Aaru.CommonTypes +++ b/Aaru.CommonTypes @@ -1 +1 @@ -Subproject commit ffd8f7dccd4351a21133fa5f5f1810d0d83f6d89 +Subproject commit 2748ee6b3226465ac7505d54023d886e4b1edfe9 diff --git a/Aaru.Core/Devices/Dumping/CompactDisc/CdiReady.cs b/Aaru.Core/Devices/Dumping/CompactDisc/CdiReady.cs index 1286fa41b..a0b307f19 100644 --- a/Aaru.Core/Devices/Dumping/CompactDisc/CdiReady.cs +++ b/Aaru.Core/Devices/Dumping/CompactDisc/CdiReady.cs @@ -115,7 +115,6 @@ namespace Aaru.Core.Devices.Dumping // TODO: Set pregap for Track 1 // TODO: Detect errors in sectors /// Reads all CD user data - /// Extents with audio sectors /// Total number of positive sectors /// Size of the read sector in bytes /// Current read speed @@ -123,24 +122,23 @@ namespace Aaru.Core.Devices.Dumping /// Extents /// IMGBurn log /// Duration of image write - /// Last sector number /// Lead-out extents /// Maximum speed /// MHDD log /// Minimum speed - /// Is trim a new one? - /// Next cluster of sectors is all data /// Read offset - /// Device supports READ(6) - /// Device supports READ(10) - /// Device supports READ(12) - /// Device supports READ(16) - /// Device supports READ CD /// Sectors needed to fix offset /// Subchannel size in bytes /// Drive's maximum supported subchannel - /// Supports reading EDC and ECC /// Total commands duration + /// Is the drive returning CD-i Ready hidden track as audio? + /// Disc tracks + /// Subchannel log + /// Subchannel desired to save + /// List of disc ISRCs + /// Disc media catalogue number + /// List of subchannels not yet dumped correctly + /// List of smallest pregap relative address per track void ReadCdiReady(uint blockSize, ref double currentSpeed, DumpHardwareType currentTry, ExtentsULong extents, IbgLog ibgLog, ref double imageWriteDuration, ExtentsULong leadOutExtents, ref double maxSpeed, MhddLog mhddLog, ref double minSpeed, uint subSize, diff --git a/Aaru.Core/Devices/Dumping/CompactDisc/Data.cs b/Aaru.Core/Devices/Dumping/CompactDisc/Data.cs index 4d1562114..1299d8b64 100644 --- a/Aaru.Core/Devices/Dumping/CompactDisc/Data.cs +++ b/Aaru.Core/Devices/Dumping/CompactDisc/Data.cs @@ -79,6 +79,13 @@ namespace Aaru.Core.Devices.Dumping /// Drive's maximum supported subchannel /// Supports reading EDC and ECC /// Total commands duration + /// Disc tracks + /// Subchannel log + /// Subchannel desired to save + /// List of disc ISRCs + /// Disc media catalogue number + /// List of subchannels not yet dumped correctly + /// List of smallest pregap relative address per track void ReadCdData(ExtentsULong audioExtents, ulong blocks, uint blockSize, ref double currentSpeed, DumpHardwareType currentTry, ExtentsULong extents, IbgLog ibgLog, ref double imageWriteDuration, long lastSector, ExtentsULong leadOutExtents, ref double maxSpeed, MhddLog mhddLog, diff --git a/Aaru.Core/Devices/Dumping/CompactDisc/LeadOuts.cs b/Aaru.Core/Devices/Dumping/CompactDisc/LeadOuts.cs index 020c65271..84f1a1adf 100644 --- a/Aaru.Core/Devices/Dumping/CompactDisc/LeadOuts.cs +++ b/Aaru.Core/Devices/Dumping/CompactDisc/LeadOuts.cs @@ -69,6 +69,13 @@ namespace Aaru.Core.Devices.Dumping /// Drive's maximum supported subchannel /// Subchannel size in bytes /// Total commands duration + /// Disc tracks + /// Subchannel log + /// Subchannel desired to save + /// List of disc ISRCs + /// Disc media catalogue number + /// List of subchannels not yet dumped correctly + /// List of smallest pregap relative address per track void DumpCdLeadOuts(ulong blocks, uint blockSize, ref double currentSpeed, DumpHardwareType currentTry, ExtentsULong extents, IbgLog ibgLog, ref double imageWriteDuration, ExtentsULong leadOutExtents, ref double maxSpeed, MhddLog mhddLog, ref double minSpeed, @@ -246,6 +253,13 @@ namespace Aaru.Core.Devices.Dumping /// Drive's maximum supported subchannel /// Subchannel size in bytes /// Total commands duration + /// Disc tracks + /// Subchannel log + /// Subchannel desired to save + /// List of disc ISRCs + /// Disc media catalogue number + /// List of subchannels not yet dumped correctly + /// List of smallest pregap relative address per track void RetryCdLeadOuts(ulong blocks, uint blockSize, ref double currentSpeed, DumpHardwareType currentTry, ExtentsULong extents, IbgLog ibgLog, ref double imageWriteDuration, ExtentsULong leadOutExtents, ref double maxSpeed, MhddLog mhddLog, ref double minSpeed, diff --git a/Aaru.Core/Devices/Dumping/Dump.cs b/Aaru.Core/Devices/Dumping/Dump.cs index 465a16db3..8c09e43bc 100644 --- a/Aaru.Core/Devices/Dumping/Dump.cs +++ b/Aaru.Core/Devices/Dumping/Dump.cs @@ -115,6 +115,18 @@ namespace Aaru.Core.Devices.Dumping /// Sidecar to store in dumped image /// How many sectors to skip reading on error /// Create metadata sidecar after dump? + /// Fix audio offset + /// Debug mode + /// Desired subchannel to save to image + /// Desired drive speed + /// Disable saving paths or serial numbers in images and logs + /// Fix subchannel position (save where it says it belongs) + /// Retry reading incorrect or missing subchannels + /// Try to fix subchannel errors (but not Q CRC) + /// Try to fix subchannel Q CRC errors + /// Skip gap between CD-i Ready hidden track and track 1 audio + /// Error log + /// Generate missing subchannels public Dump(bool doResume, Device dev, string devicePath, IWritableImage outputPlugin, ushort retryPasses, bool force, bool dumpRaw, bool persistent, bool stopOnError, Resume resume, DumpLog dumpLog, Encoding encoding, string outputPrefix, string outputPath, Dictionary formatOptions, diff --git a/Aaru.Core/Devices/Dumping/ResumeSupport.cs b/Aaru.Core/Devices/Dumping/ResumeSupport.cs index b1ff8da71..c7a0c7a10 100644 --- a/Aaru.Core/Devices/Dumping/ResumeSupport.cs +++ b/Aaru.Core/Devices/Dumping/ResumeSupport.cs @@ -56,6 +56,7 @@ namespace Aaru.Core.Devices.Dumping /// Dumped extents /// Firmware revision /// Set to true if device is a streaming tape, false otherwise + /// Disable saving paths or serial numbers in images and logs /// If device uses CHS addressing /// /// If the provided resume does not correspond with the current in diff --git a/Aaru.Core/Devices/Scanning/MediaScan.cs b/Aaru.Core/Devices/Scanning/MediaScan.cs index d232b1323..b3adf30eb 100644 --- a/Aaru.Core/Devices/Scanning/MediaScan.cs +++ b/Aaru.Core/Devices/Scanning/MediaScan.cs @@ -49,6 +49,7 @@ namespace Aaru.Core.Devices.Scanning /// Path to a IMGBurn log file /// Device path /// Device + /// Enable seek test public MediaScan(string mhddLogPath, string ibgLogPath, string devicePath, Device dev, bool seekTest = true) { _mhddLogPath = mhddLogPath; diff --git a/Aaru.Core/Logging/DumpLog.cs b/Aaru.Core/Logging/DumpLog.cs index 6ec0057cb..b5ab0c79d 100644 --- a/Aaru.Core/Logging/DumpLog.cs +++ b/Aaru.Core/Logging/DumpLog.cs @@ -49,6 +49,7 @@ namespace Aaru.Core.Logging /// Initializes the dump log /// Output log file /// Device + /// Disable saving paths or serial numbers in log public DumpLog(string outputFile, Device dev, bool @private) { if(string.IsNullOrEmpty(outputFile)) diff --git a/Aaru.Core/Logging/MHDDLog.cs b/Aaru.Core/Logging/MHDDLog.cs index 0007f461e..406b9a5f3 100644 --- a/Aaru.Core/Logging/MHDDLog.cs +++ b/Aaru.Core/Logging/MHDDLog.cs @@ -51,6 +51,7 @@ namespace Aaru.Core.Logging /// Blocks in media /// Bytes per block /// How many blocks read at once + /// Disable saving paths or serial numbers in log internal MhddLog(string outputFile, Device dev, ulong blocks, ulong blockSize, ulong blocksToRead, bool @private) { diff --git a/Aaru.Core/Logging/SubchannelLog.cs b/Aaru.Core/Logging/SubchannelLog.cs index f882892c1..eb29c2fca 100644 --- a/Aaru.Core/Logging/SubchannelLog.cs +++ b/Aaru.Core/Logging/SubchannelLog.cs @@ -40,6 +40,7 @@ namespace Aaru.Core.Logging /// Initializes the dump log /// Output log file + /// Drive returns subchannel in BCD format public SubchannelLog(string outputFile, bool bcd) { if(string.IsNullOrEmpty(outputFile)) diff --git a/Aaru.Core/Media/Info/CompactDisc.cs b/Aaru.Core/Media/Info/CompactDisc.cs index c6ccc076d..685333b47 100644 --- a/Aaru.Core/Media/Info/CompactDisc.cs +++ b/Aaru.Core/Media/Info/CompactDisc.cs @@ -58,6 +58,7 @@ namespace Aaru.Core.Media.Info /// UpdateStatus event /// Drive offset /// Combined offset + /// Set to true if drive supports PLEXTOR READ CD-DA vendor command /// true if offset could be found, false otherwise [SuppressMessage("ReSharper", "TooWideLocalVariableScope")] public static void GetOffset(CdOffset cdOffset, Device dbDev, bool debug, Aaru.Devices.Device dev, diff --git a/Aaru.Devices/Device/ScsiCommands/Optical.cs b/Aaru.Devices/Device/ScsiCommands/Optical.cs index 514f4e7c9..f32dfdb18 100644 --- a/Aaru.Devices/Device/ScsiCommands/Optical.cs +++ b/Aaru.Devices/Device/ScsiCommands/Optical.cs @@ -42,6 +42,7 @@ namespace Aaru.Devices /// Set to true if is relative /// Logical block address where to start the search. /// Number of blocks to scan + /// How many blocks were found /// Timeout. /// Duration. /// @@ -55,6 +56,7 @@ namespace Aaru.Devices /// other parameters are met /// /// Number of contiguous blocks to find + /// First LBA found 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, out uint foundBlocks, uint timeout, out double duration)