Add missing XML comments.

This commit is contained in:
2023-10-05 02:46:32 +01:00
parent 13a2bfdaf4
commit 6a86aea198
4 changed files with 17 additions and 0 deletions

View File

@@ -165,6 +165,8 @@ public partial class Dump
/// <param name="storeEncrypted">Store encrypted data as is</param>
/// <param name="titleKeys">Dump DVD CSS title keys</param>
/// <param name="ignoreCdrRunOuts">How many CD-R(W) run end sectors to ignore and regenerate</param>
/// <param name="createGraph">If set to <c>true</c> creates a graph of the dump.</param>
/// <param name="dimensions">Dimensions of graph in pixels for a square</param>
public Dump(bool doResume, Device dev, string devicePath, IBaseWritableImage outputPlugin, ushort retryPasses,
bool force, bool dumpRaw, bool persistent, bool stopOnError, Resume resume, DumpLog dumpLog,
Encoding encoding, string outputPrefix, string outputPath, Dictionary<string, string> formatOptions,

View File

@@ -56,6 +56,7 @@ sealed class MhddLog
/// <param name="blockSize">Bytes per block</param>
/// <param name="blocksToRead">How many blocks read at once</param>
/// <param name="private">Disable saving paths or serial numbers in log</param>
/// <param name="mediaGraphDimensions">Dimensions in pixel for a square that would contain the block map graph</param>
internal MhddLog(string outputFile, Device dev, ulong blocks, ulong blockSize, ulong blocksToRead, bool @private,
uint mediaGraphDimensions = 0)
{
@@ -154,6 +155,7 @@ sealed class MhddLog
/// <summary>Logs a new read</summary>
/// <param name="sector">Starting sector</param>
/// <param name="duration">Duration in milliseconds</param>
/// <param name="length">How many sectors where read at once</param>
internal void Write(ulong sector, double duration, uint length = 1)
{
if(_logFile == null)

View File

@@ -64,6 +64,10 @@ public static class CompactDisc
/// <param name="updateStatus">Status update callback</param>
/// <param name="smallestPregapLbaPerTrack">List of smallest known pregap per track</param>
/// <param name="dumping">Set if we are dumping, otherwise converting</param>
/// <param name="newPregapSectors">
/// Gets a list of the new sectors that should be considered part of a pregap, and then
/// re-read
/// </param>
/// <returns><c>true</c> if indexes have changed, <c>false</c> otherwise</returns>
public static bool WriteSubchannelToImage(MmcSubchannel supportedSubchannel, MmcSubchannel desiredSubchannel,
byte[] sub, ulong sectorAddress, uint length, SubchannelLog subLog,
@@ -304,6 +308,11 @@ public static class CompactDisc
/// <param name="updateStatus">Status update callback</param>
/// <param name="smallestPregapLbaPerTrack">List of smallest known pregap per track</param>
/// <param name="dumping">Set if we are dumping, otherwise converting</param>
/// <param name="newPregapSectors">
/// Gets a list of the new sectors that should be considered part of a pregap, and then
/// re-read
/// </param>
/// <param name="sectorAddress">Sector address the subchannel was read from</param>
/// <returns><c>true</c> if indexes have changed, <c>false</c> otherwise</returns>
static bool CheckIndexesFromSubchannel(byte[] deSub, Dictionary<byte, string> isrcs, byte currentTrackNumber,
ref string mcn, Track[] tracks, DumpLog dumpLog,

View File

@@ -231,6 +231,10 @@ public class SplitJoinStream : Stream
/// <param name="basePath">Base file path, directory path only</param>
/// <param name="counterFormat">Counter format, includes filename and a formatting string</param>
/// <param name="counterStart">Counter start, defaults to 0</param>
/// <param name="access">
/// A bitwise combination of the enumeration values that determines how the file can be accessed by a
/// <see cref="FileStream" /> object.
/// </param>
public void AddRange(string basePath, string counterFormat = "{0:D3}", int counterStart = 0,
FileAccess access = FileAccess.Read)
{