From 02ffa86b6c306ad5630747e687c862ef54aab2a1 Mon Sep 17 00:00:00 2001 From: Natalia Portillo Date: Thu, 21 Dec 2017 16:42:20 +0000 Subject: [PATCH] REFACTOR: Parameter has no matching param tag in the XML comment. --- DiscImageChef.Devices/Device/ScsiCommands/ArchiveCorp.cs | 1 + DiscImageChef.Devices/Device/ScsiCommands/Kreon.cs | 1 + DiscImageChef.Devices/Device/ScsiCommands/Plextor.cs | 2 ++ DiscImageChef.Devices/Device/ScsiCommands/SPC.cs | 4 ++++ DiscImageChef.Helpers/StringHandlers.cs | 4 ++++ 5 files changed, 12 insertions(+) diff --git a/DiscImageChef.Devices/Device/ScsiCommands/ArchiveCorp.cs b/DiscImageChef.Devices/Device/ScsiCommands/ArchiveCorp.cs index f613a3d7..38c4ce63 100644 --- a/DiscImageChef.Devices/Device/ScsiCommands/ArchiveCorp.cs +++ b/DiscImageChef.Devices/Device/ScsiCommands/ArchiveCorp.cs @@ -41,6 +41,7 @@ namespace DiscImageChef.Devices /// /// Buffer. /// Sense buffer. + /// Address. /// Timeout. /// Duration. public bool ArchiveCorpRequestBlockAddress(out byte[] buffer, out byte[] senseBuffer, uint lba, uint timeout, diff --git a/DiscImageChef.Devices/Device/ScsiCommands/Kreon.cs b/DiscImageChef.Devices/Device/ScsiCommands/Kreon.cs index 3d1491d6..d4d5dc7f 100644 --- a/DiscImageChef.Devices/Device/ScsiCommands/Kreon.cs +++ b/DiscImageChef.Devices/Device/ScsiCommands/Kreon.cs @@ -215,6 +215,7 @@ namespace DiscImageChef.Devices /// Timeout. /// Duration. /// The SS sector. + /// Request number. public bool KreonExtractSs(out byte[] buffer, out byte[] senseBuffer, uint timeout, out double duration, byte requestNumber = 0x00) { diff --git a/DiscImageChef.Devices/Device/ScsiCommands/Plextor.cs b/DiscImageChef.Devices/Device/ScsiCommands/Plextor.cs index 7167794a..a438482e 100644 --- a/DiscImageChef.Devices/Device/ScsiCommands/Plextor.cs +++ b/DiscImageChef.Devices/Device/ScsiCommands/Plextor.cs @@ -347,6 +347,7 @@ namespace DiscImageChef.Devices /// true, if VariRec is supported, false otherwise. /// Buffer. /// Sense buffer. + /// Set if request is for DVD. /// Timeout. /// Duration. public bool PlextorGetVariRec(out byte[] buffer, out byte[] senseBuffer, bool dvd, uint timeout, @@ -466,6 +467,7 @@ namespace DiscImageChef.Devices /// true, if DVD+ book bitsetting is supported, false otherwise. /// Buffer. /// Sense buffer. + /// Set if bitset is for dual layer discs. /// Timeout. /// Duration. public bool PlextorGetBitsetting(out byte[] buffer, out byte[] senseBuffer, bool dualLayer, uint timeout, diff --git a/DiscImageChef.Devices/Device/ScsiCommands/SPC.cs b/DiscImageChef.Devices/Device/ScsiCommands/SPC.cs index 6834ae6f..8bcb0b68 100644 --- a/DiscImageChef.Devices/Device/ScsiCommands/SPC.cs +++ b/DiscImageChef.Devices/Device/ScsiCommands/SPC.cs @@ -725,8 +725,10 @@ namespace DiscImageChef.Devices /// true if the command failed and contains the sense buffer. /// Buffer with the data to be sent to the device /// Sense buffer. + /// Set to save pages between resets. /// Timeout in seconds. /// Duration in milliseconds it took for the device to execute the command. + /// Set if page is formatted. public bool ModeSelect(byte[] buffer, out byte[] senseBuffer, bool pageFormat, bool savePages, uint timeout, out double duration) { @@ -767,9 +769,11 @@ namespace DiscImageChef.Devices /// /// true if the command failed and contains the sense buffer. /// Buffer with the data to be sent to the device + /// Set to save pages between resets. /// Sense buffer. /// Timeout in seconds. /// Duration in milliseconds it took for the device to execute the command. + /// Set if page is formatted. public bool ModeSelect10(byte[] buffer, out byte[] senseBuffer, bool pageFormat, bool savePages, uint timeout, out double duration) { diff --git a/DiscImageChef.Helpers/StringHandlers.cs b/DiscImageChef.Helpers/StringHandlers.cs index 7f93ad32..356568b5 100644 --- a/DiscImageChef.Helpers/StringHandlers.cs +++ b/DiscImageChef.Helpers/StringHandlers.cs @@ -53,6 +53,8 @@ namespace DiscImageChef /// The corresponding C# string /// A null-terminated (aka C string) byte array in the specified encoding /// Encoding. + /// Set if encoding uses 16-bit characters. + /// Start decodint at this position public static string CToString(byte[] CString, Encoding encoding, bool twoBytes = false, int start = 0) { if(CString == null) return null; @@ -99,6 +101,7 @@ namespace DiscImageChef /// The corresponding C# string /// A length-prefixed (aka Pascal string) ASCII byte array /// Encoding. + /// Start decodint at this position public static string PascalToString(byte[] PascalString, Encoding encoding, int start = 0) { if(PascalString == null) return null; @@ -135,6 +138,7 @@ namespace DiscImageChef /// The corresponding C# string /// A space (' ', 0x20, ASCII SPACE) padded ASCII byte array /// Encoding. + /// Start decodint at this position public static string SpacePaddedToString(byte[] SpacePaddedString, Encoding encoding, int start = 0) { if(SpacePaddedString == null) return null;