Add inheritdoc.

This commit is contained in:
2022-03-17 00:21:26 +00:00
parent d686e59cb7
commit f6245f954d
16 changed files with 16 additions and 2 deletions

View File

@@ -4,6 +4,7 @@ using System;
using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations;
using Aaru.CommonTypes.Enums; using Aaru.CommonTypes.Enums;
/// <inheritdoc />
/// <summary>Information needed to rebuild an iNES/NES 2.0 header from a ROM hash</summary> /// <summary>Information needed to rebuild an iNES/NES 2.0 header from a ROM hash</summary>
public class NesHeaderInfo : BaseModel public class NesHeaderInfo : BaseModel
{ {

View File

@@ -80,6 +80,7 @@ using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces; using Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Structs; using Aaru.CommonTypes.Structs;
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IWritableOpticalImage" />
/// <summary>Implements reading and writing AaruFormat media images</summary> /// <summary>Implements reading and writing AaruFormat media images</summary>
public sealed partial class AaruFormat : IWritableOpticalImage, IVerifiableImage, IWritableTapeImage public sealed partial class AaruFormat : IWritableOpticalImage, IVerifiableImage, IWritableTapeImage
{ {

View File

@@ -38,6 +38,7 @@ using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces; using Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Structs; using Aaru.CommonTypes.Structs;
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IWritableImage" />
/// <summary>Implements reading Basic Lisa Utility disk images</summary> /// <summary>Implements reading Basic Lisa Utility disk images</summary>
public sealed partial class Blu : IWritableImage, IVerifiableSectorsImage public sealed partial class Blu : IWritableImage, IVerifiableSectorsImage
{ {

View File

@@ -40,6 +40,7 @@ using Aaru.CommonTypes.Structs;
using Aaru.Decoders.CD; using Aaru.Decoders.CD;
// TODO: Implement track flags // TODO: Implement track flags
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IWritableOpticalImage" />
/// <summary>Implements reading and writing CDRWin cuesheet disc images</summary> /// <summary>Implements reading and writing CDRWin cuesheet disc images</summary>
public sealed partial class CdrWin : IWritableOpticalImage, IVerifiableImage public sealed partial class CdrWin : IWritableOpticalImage, IVerifiableImage
{ {

View File

@@ -42,6 +42,7 @@ using Aaru.CommonTypes.Structs;
using Aaru.Decoders.CD; using Aaru.Decoders.CD;
// TODO: Implement PCMCIA support // TODO: Implement PCMCIA support
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IOpticalMediaImage" />
/// <summary>Implements reading MAME CHD disk images</summary> /// <summary>Implements reading MAME CHD disk images</summary>
[SuppressMessage("ReSharper", "NotAccessedField.Local")] [SuppressMessage("ReSharper", "NotAccessedField.Local")]
public sealed partial class Chd : IOpticalMediaImage, IVerifiableImage public sealed partial class Chd : IOpticalMediaImage, IVerifiableImage

View File

@@ -38,6 +38,7 @@ using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces; using Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Structs; using Aaru.CommonTypes.Structs;
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IMediaImage" />
/// <summary>Implements reading CopyQM disk images</summary> /// <summary>Implements reading CopyQM disk images</summary>
public sealed partial class CopyQm : IMediaImage, IVerifiableImage public sealed partial class CopyQm : IMediaImage, IVerifiableImage
{ {

View File

@@ -37,6 +37,7 @@ using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces; using Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Structs; using Aaru.CommonTypes.Structs;
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IMediaImage" />
/// <summary>Implements reading DiscFerret flux images</summary> /// <summary>Implements reading DiscFerret flux images</summary>
public sealed partial class DiscFerret : IMediaImage, IVerifiableSectorsImage public sealed partial class DiscFerret : IMediaImage, IVerifiableSectorsImage
{ {

View File

@@ -40,6 +40,7 @@ using Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Structs; using Aaru.CommonTypes.Structs;
// Checked using several images and strings inside Apple's DiskImages.framework // Checked using several images and strings inside Apple's DiskImages.framework
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IWritableImage" />
/// <summary>Implements reading and writing Apple DiskCopy 4.2 disk images</summary> /// <summary>Implements reading and writing Apple DiskCopy 4.2 disk images</summary>
[SuppressMessage("ReSharper", "InconsistentNaming")] [SuppressMessage("ReSharper", "InconsistentNaming")]
public sealed partial class DiskCopy42 : IWritableImage, IVerifiableImage public sealed partial class DiskCopy42 : IWritableImage, IVerifiableImage

View File

@@ -38,6 +38,7 @@ using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces; using Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Structs; using Aaru.CommonTypes.Structs;
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IMediaImage" />
/// <summary>Implements reading KryoFlux flux images</summary> /// <summary>Implements reading KryoFlux flux images</summary>
[SuppressMessage("ReSharper", "InconsistentNaming")] [SuppressMessage("ReSharper", "InconsistentNaming")]
public sealed partial class KryoFlux : IMediaImage, IVerifiableSectorsImage public sealed partial class KryoFlux : IMediaImage, IVerifiableSectorsImage

View File

@@ -39,6 +39,7 @@ using Aaru.CommonTypes.Extents;
using Aaru.CommonTypes.Interfaces; using Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Structs; using Aaru.CommonTypes.Structs;
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IMediaImage" />
/// <summary>Implements reading partclone disk images</summary> /// <summary>Implements reading partclone disk images</summary>
public sealed partial class PartClone : IMediaImage, IVerifiableImage public sealed partial class PartClone : IMediaImage, IVerifiableImage
{ {

View File

@@ -41,6 +41,7 @@ using Aaru.CommonTypes.Extents;
using Aaru.CommonTypes.Interfaces; using Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Structs; using Aaru.CommonTypes.Structs;
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IMediaImage" />
/// <summary>Implements reading partimage disk images</summary> /// <summary>Implements reading partimage disk images</summary>
public sealed partial class Partimage : IMediaImage, IVerifiableImage public sealed partial class Partimage : IMediaImage, IVerifiableImage
{ {

View File

@@ -38,6 +38,7 @@ using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces; using Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Structs; using Aaru.CommonTypes.Structs;
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IWritableImage" />
/// <summary>Implements reading and writing IBM's SaveDskF disk images</summary> /// <summary>Implements reading and writing IBM's SaveDskF disk images</summary>
public sealed partial class SaveDskF : IWritableImage, IVerifiableImage public sealed partial class SaveDskF : IWritableImage, IVerifiableImage
{ {

View File

@@ -38,6 +38,7 @@ using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces; using Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Structs; using Aaru.CommonTypes.Structs;
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IMediaImage" />
/// <summary>Implements reading SuperCardPro flux images</summary> /// <summary>Implements reading SuperCardPro flux images</summary>
public sealed partial class SuperCardPro : IMediaImage, IVerifiableImage, IVerifiableSectorsImage public sealed partial class SuperCardPro : IMediaImage, IVerifiableImage, IVerifiableSectorsImage
{ {

View File

@@ -40,6 +40,7 @@ using Aaru.CommonTypes.Structs;
// Created following notes from Dave Dunfield // Created following notes from Dave Dunfield
// http://www.classiccmp.org/dunfield/img54306/td0notes.txt // http://www.classiccmp.org/dunfield/img54306/td0notes.txt
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IMediaImage" />
/// <summary>Implements reading of Sydex TeleDisk disk images</summary> /// <summary>Implements reading of Sydex TeleDisk disk images</summary>
public sealed partial class TeleDisk : IMediaImage, IVerifiableImage, IVerifiableSectorsImage public sealed partial class TeleDisk : IMediaImage, IVerifiableImage, IVerifiableSectorsImage
{ {