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

@@ -44,6 +44,7 @@ namespace Aaru.DiscImages
{
public sealed partial class MaxiDisk
{
/// <inheritdoc />
public bool Create(string path, MediaType mediaType, Dictionary<string, string> options, ulong sectors,
uint sectorSize)
{
@@ -113,6 +114,7 @@ namespace Aaru.DiscImages
return true;
}
/// <inheritdoc />
public bool WriteMediaTag(byte[] data, MediaTagType tag)
{
ErrorMessage = "Writing media tags is not supported.";
@@ -120,6 +122,7 @@ namespace Aaru.DiscImages
return false;
}
/// <inheritdoc />
public bool WriteSector(byte[] data, ulong sectorAddress)
{
if(!IsWriting)
@@ -153,6 +156,7 @@ namespace Aaru.DiscImages
return true;
}
/// <inheritdoc />
public bool WriteSectors(byte[] data, ulong sectorAddress, uint length)
{
if(!IsWriting)
@@ -186,6 +190,7 @@ namespace Aaru.DiscImages
return true;
}
/// <inheritdoc />
public bool WriteSectorLong(byte[] data, ulong sectorAddress)
{
ErrorMessage = "Writing sectors with tags is not supported.";
@@ -193,6 +198,7 @@ namespace Aaru.DiscImages
return false;
}
/// <inheritdoc />
public bool WriteSectorsLong(byte[] data, ulong sectorAddress, uint length)
{
ErrorMessage = "Writing sectors with tags is not supported.";
@@ -200,6 +206,7 @@ namespace Aaru.DiscImages
return false;
}
/// <inheritdoc />
public bool Close()
{
if(!IsWriting)
@@ -241,8 +248,10 @@ namespace Aaru.DiscImages
return true;
}
/// <inheritdoc />
public bool SetMetadata(ImageInfo metadata) => true;
/// <inheritdoc />
public bool SetGeometry(uint cylinders, uint heads, uint sectorsPerTrack)
{
if(cylinders > 90)
@@ -273,6 +282,7 @@ namespace Aaru.DiscImages
return true;
}
/// <inheritdoc />
public bool WriteSectorTag(byte[] data, ulong sectorAddress, SectorTagType tag)
{
ErrorMessage = "Unsupported feature";
@@ -280,6 +290,7 @@ namespace Aaru.DiscImages
return false;
}
/// <inheritdoc />
public bool WriteSectorsTag(byte[] data, ulong sectorAddress, uint length, SectorTagType tag)
{
ErrorMessage = "Unsupported feature";
@@ -287,8 +298,10 @@ namespace Aaru.DiscImages
return false;
}
/// <inheritdoc />
public bool SetDumpHardware(List<DumpHardwareType> dumpHardware) => false;
/// <inheritdoc />
public bool SetCicmMetadata(CICMMetadataType metadata) => false;
}
}