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

@@ -39,6 +39,7 @@ namespace Aaru.DiscImages
{
public sealed partial class PartClone
{
/// <inheritdoc />
public bool Identify(IFilter imageFilter)
{
Stream stream = imageFilter.GetDataForkStream();

View File

@@ -39,6 +39,9 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
/// <summary>
/// Implements reading partclone disk images
/// </summary>
public sealed partial class PartClone : IMediaImage, IVerifiableImage
{
// The used block "bitmap" uses one byte per block

View File

@@ -39,12 +39,19 @@ namespace Aaru.DiscImages
{
public sealed partial class PartClone
{
/// <inheritdoc />
public string Name => "PartClone disk image";
/// <inheritdoc />
public Guid Id => new Guid("AB1D7518-B548-4099-A4E2-C29C53DDE0C3");
/// <inheritdoc />
public ImageInfo Info => _imageInfo;
/// <inheritdoc />
public string Author => "Natalia Portillo";
/// <inheritdoc />
public string Format => "PartClone";
/// <inheritdoc />
public List<DumpHardwareType> DumpHardware => null;
/// <inheritdoc />
public CICMMetadataType CicmMetadata => null;
}
}

View File

@@ -46,6 +46,7 @@ namespace Aaru.DiscImages
{
public sealed partial class PartClone
{
/// <inheritdoc />
public bool Open(IFilter imageFilter)
{
Stream stream = imageFilter.GetDataForkStream();
@@ -137,6 +138,7 @@ namespace Aaru.DiscImages
return true;
}
/// <inheritdoc />
public byte[] ReadSector(ulong sectorAddress)
{
if(sectorAddress > _imageInfo.Sectors - 1)
@@ -163,6 +165,7 @@ namespace Aaru.DiscImages
return sector;
}
/// <inheritdoc />
public byte[] ReadSectors(ulong sectorAddress, uint length)
{
if(sectorAddress > _imageInfo.Sectors - 1)

View File

@@ -37,18 +37,23 @@ namespace Aaru.DiscImages
{
public sealed partial class PartClone
{
/// <inheritdoc />
public byte[] ReadSectorTag(ulong sectorAddress, SectorTagType tag) =>
throw new FeatureUnsupportedImageException("Feature not supported by image format");
/// <inheritdoc />
public byte[] ReadSectorsTag(ulong sectorAddress, uint length, SectorTagType tag) =>
throw new FeatureUnsupportedImageException("Feature not supported by image format");
/// <inheritdoc />
public byte[] ReadDiskTag(MediaTagType tag) =>
throw new FeatureUnsupportedImageException("Feature not supported by image format");
/// <inheritdoc />
public byte[] ReadSectorLong(ulong sectorAddress) =>
throw new FeatureUnsupportedImageException("Feature not supported by image format");
/// <inheritdoc />
public byte[] ReadSectorsLong(ulong sectorAddress, uint length) =>
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}

View File

@@ -35,6 +35,7 @@ namespace Aaru.DiscImages
public sealed partial class PartClone
{
// TODO: All blocks contain a CRC32 that's incompatible with current implementation. Need to check for compatibility.
/// <inheritdoc />
public bool? VerifyMediaImage() => null;
}
}