Add XML comments to public entities.

This commit is contained in:
2021-08-17 13:56:05 +01:00
parent 0d18153610
commit 00f605b0ca
542 changed files with 6029 additions and 104 deletions

View File

@@ -48,6 +48,7 @@ namespace Aaru.DiscImages
{
public sealed partial class Nero
{
/// <inheritdoc />
public bool Open(IFilter imageFilter)
{
try
@@ -1568,6 +1569,7 @@ namespace Aaru.DiscImages
}
}
/// <inheritdoc />
public byte[] ReadDiskTag(MediaTagType tag)
{
switch(tag)
@@ -1579,15 +1581,20 @@ namespace Aaru.DiscImages
}
}
/// <inheritdoc />
public byte[] ReadSector(ulong sectorAddress) => ReadSectors(sectorAddress, 1);
/// <inheritdoc />
public byte[] ReadSectorTag(ulong sectorAddress, SectorTagType tag) => ReadSectorsTag(sectorAddress, 1, tag);
/// <inheritdoc />
public byte[] ReadSector(ulong sectorAddress, uint track) => ReadSectors(sectorAddress, 1, track);
/// <inheritdoc />
public byte[] ReadSectorTag(ulong sectorAddress, uint track, SectorTagType tag) =>
ReadSectorsTag(sectorAddress, 1, track, tag);
/// <inheritdoc />
public byte[] ReadSectors(ulong sectorAddress, uint length)
{
foreach(KeyValuePair<uint, ulong> kvp in from kvp in _offsetmap where sectorAddress >= kvp.Value
@@ -1599,6 +1606,7 @@ namespace Aaru.DiscImages
throw new ArgumentOutOfRangeException(nameof(sectorAddress), $"Sector address {sectorAddress} not found");
}
/// <inheritdoc />
public byte[] ReadSectorsTag(ulong sectorAddress, uint length, SectorTagType tag)
{
foreach(KeyValuePair<uint, ulong> kvp in from kvp in _offsetmap where sectorAddress >= kvp.Value
@@ -1610,6 +1618,7 @@ namespace Aaru.DiscImages
throw new ArgumentOutOfRangeException(nameof(sectorAddress), $"Sector address {sectorAddress} not found");
}
/// <inheritdoc />
public byte[] ReadSectors(ulong sectorAddress, uint length, uint track)
{
if(!_neroTracks.TryGetValue(track, out NeroTrack aaruTrack))
@@ -1746,6 +1755,7 @@ namespace Aaru.DiscImages
return buffer;
}
/// <inheritdoc />
public byte[] ReadSectorsTag(ulong sectorAddress, uint length, uint track, SectorTagType tag)
{
if(tag == SectorTagType.CdTrackFlags ||
@@ -2061,10 +2071,13 @@ namespace Aaru.DiscImages
return buffer;
}
/// <inheritdoc />
public byte[] ReadSectorLong(ulong sectorAddress) => ReadSectorsLong(sectorAddress, 1);
/// <inheritdoc />
public byte[] ReadSectorLong(ulong sectorAddress, uint track) => ReadSectorsLong(sectorAddress, 1, track);
/// <inheritdoc />
public byte[] ReadSectorsLong(ulong sectorAddress, uint length)
{
foreach(KeyValuePair<uint, ulong> kvp in from kvp in _offsetmap where sectorAddress >= kvp.Value
@@ -2076,6 +2089,7 @@ namespace Aaru.DiscImages
throw new ArgumentOutOfRangeException(nameof(sectorAddress), $"Sector address {sectorAddress} not found");
}
/// <inheritdoc />
public byte[] ReadSectorsLong(ulong sectorAddress, uint length, uint track)
{
if(!_isCd)
@@ -2223,9 +2237,11 @@ namespace Aaru.DiscImages
return buffer;
}
/// <inheritdoc />
public List<Track> GetSessionTracks(CommonTypes.Structs.Session session) =>
GetSessionTracks(session.SessionSequence);
/// <inheritdoc />
public List<Track> GetSessionTracks(ushort session) =>
Tracks.Where(track => track.TrackSession == session).ToList();
}