Add XML comments to public entities.

This commit is contained in:
2021-08-17 14:40:37 +01:00
parent c1287c00cf
commit a715b9b351
17 changed files with 13 additions and 5 deletions

View File

@@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filters
{
/// <inheritdoc />
/// <summary>Decodes AppleDouble files</summary>
[SuppressMessage("ReSharper", "UnusedMember.Local")]
public sealed class AppleDouble : IFilter

View File

@@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filters
{
/// <inheritdoc />
/// <summary>Decodes AppleSingle files</summary>
[SuppressMessage("ReSharper", "UnusedMember.Local")]
public sealed class AppleSingle : IFilter

View File

@@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filters
{
// TODO: Interpret fdScript
/// <inheritdoc />
/// <summary>Decodes MacBinary files</summary>
public sealed class MacBinary : IFilter
{

View File

@@ -40,7 +40,6 @@ using Aaru.Decoders.CD;
namespace Aaru.DiscImages
{
// TODO: Implement track flags
/// <inheritdoc />
/// <summary>
/// Implements reading and writing CDRWin cuesheet disc images
/// </summary>

View File

@@ -40,6 +40,7 @@ namespace Aaru.DiscImages
// Information from Quasi88's FORMAT.TXT file
// Japanese comments copied from there
// TODO: Solve media types
/// <inheritdoc />
/// <summary>
/// Implements reading Quasi88 disk images
/// </summary>

View File

@@ -114,7 +114,6 @@ namespace Aaru.DiscImages
return failingLbas.Count <= 0;
}
/// <inheritdoc />
public bool? VerifySector(ulong sectorAddress, uint track)
{
byte[] buffer = ReadSectorLong(sectorAddress, track);

View File

@@ -40,7 +40,6 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
// Checked using several images and strings inside Apple's DiskImages.framework
/// <inheritdoc />
/// <summary>
/// Implements reading and writing Apple DiskCopy 4.2 disk images
/// </summary>

View File

@@ -72,6 +72,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
/// <inheritdoc />
/// <summary>
/// Implements reading HD-Copy disk images
/// </summary>

View File

@@ -37,6 +37,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
/// <inheritdoc />
/// <summary>
/// Implements reading IMageDisk disk images
/// </summary>

View File

@@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
/// <inheritdoc />
/// <summary>
/// Implements reading and writing MaxiDisk disk images
/// </summary>

View File

@@ -40,6 +40,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
/// <inheritdoc />
/// <summary>
/// Implements reading and writing Parallels' disk images
/// </summary>

View File

@@ -39,6 +39,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
/// <inheritdoc />
/// <summary>
/// Implements reading partclone disk images
/// </summary>

View File

@@ -41,6 +41,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
/// <inheritdoc />
/// <summary>
/// Implements reading partimage disk images
/// </summary>

View File

@@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
/// <inheritdoc />
/// <summary>
/// Implements reading and writing QEMU's Copy On Write v2 and v3 disk images
/// </summary>

View File

@@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
/// <inheritdoc />
/// <summary>
/// Implements reading and writing QEMU Enhanced Disk images
/// </summary>

View File

@@ -38,7 +38,6 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
/// <inheritdoc />
/// <summary>
/// Implements reading and writing IBM's SaveDskF disk images
/// </summary>