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

@@ -46,6 +46,7 @@ namespace Aaru.DiscImages
{
public sealed partial class Qed
{
/// <inheritdoc />
public bool Create(string path, MediaType mediaType, Dictionary<string, string> options, ulong sectors,
uint sectorSize)
{
@@ -134,6 +135,7 @@ namespace Aaru.DiscImages
return true;
}
/// <inheritdoc />
public bool WriteMediaTag(byte[] data, MediaTagType tag)
{
ErrorMessage = "Writing media tags is not supported.";
@@ -141,6 +143,7 @@ namespace Aaru.DiscImages
return false;
}
/// <inheritdoc />
public bool WriteSector(byte[] data, ulong sectorAddress)
{
if(!IsWriting)
@@ -215,6 +218,7 @@ namespace Aaru.DiscImages
}
// TODO: This can be optimized
/// <inheritdoc />
public bool WriteSectors(byte[] data, ulong sectorAddress, uint length)
{
if(!IsWriting)
@@ -256,6 +260,7 @@ namespace Aaru.DiscImages
return true;
}
/// <inheritdoc />
public bool WriteSectorLong(byte[] data, ulong sectorAddress)
{
ErrorMessage = "Writing sectors with tags is not supported.";
@@ -263,6 +268,7 @@ namespace Aaru.DiscImages
return false;
}
/// <inheritdoc />
public bool WriteSectorsLong(byte[] data, ulong sectorAddress, uint length)
{
ErrorMessage = "Writing sectors with tags is not supported.";
@@ -270,6 +276,7 @@ namespace Aaru.DiscImages
return false;
}
/// <inheritdoc />
public bool Close()
{
if(!IsWriting)
@@ -298,10 +305,13 @@ namespace Aaru.DiscImages
return true;
}
/// <inheritdoc />
public bool SetMetadata(ImageInfo metadata) => true;
/// <inheritdoc />
public bool SetGeometry(uint cylinders, uint heads, uint sectorsPerTrack) => true;
/// <inheritdoc />
public bool WriteSectorTag(byte[] data, ulong sectorAddress, SectorTagType tag)
{
ErrorMessage = "Writing sectors with tags is not supported.";
@@ -309,6 +319,7 @@ namespace Aaru.DiscImages
return false;
}
/// <inheritdoc />
public bool WriteSectorsTag(byte[] data, ulong sectorAddress, uint length, SectorTagType tag)
{
ErrorMessage = "Writing sectors with tags is not supported.";
@@ -316,8 +327,10 @@ namespace Aaru.DiscImages
return false;
}
/// <inheritdoc />
public bool SetDumpHardware(List<DumpHardwareType> dumpHardware) => false;
/// <inheritdoc />
public bool SetCicmMetadata(CICMMetadataType metadata) => false;
}
}