Add inheritdoc.

This commit is contained in:
2022-03-17 00:21:25 +00:00
parent 2ba38ebee3
commit 58ca08969c
6 changed files with 6 additions and 0 deletions

View File

@@ -44,6 +44,7 @@ using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Structs; using Aaru.CommonTypes.Structs;
using Schemas; using Schemas;
/// <inheritdoc />
/// <summary>Base interface for all writable images</summary> /// <summary>Base interface for all writable images</summary>
public interface IBaseWritableImage : IBaseImage public interface IBaseWritableImage : IBaseImage
{ {

View File

@@ -42,6 +42,7 @@ using System.Collections.Generic;
using Aaru.CommonTypes.Enums; using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Structs; using Aaru.CommonTypes.Structs;
/// <inheritdoc />
/// <summary>Interface defining linear media (chips, game carts, etc) images</summary> /// <summary>Interface defining linear media (chips, game carts, etc) images</summary>
public interface IByteAddressableImage : IBaseWritableImage public interface IByteAddressableImage : IBaseWritableImage
{ {

View File

@@ -41,6 +41,7 @@ namespace Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Enums; using Aaru.CommonTypes.Enums;
/// <inheritdoc />
/// <summary>Abstract class to implement disk image reading plugins.</summary> /// <summary>Abstract class to implement disk image reading plugins.</summary>
public interface IMediaImage : IBaseImage public interface IMediaImage : IBaseImage
{ {

View File

@@ -40,6 +40,7 @@ namespace Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Enums; using Aaru.CommonTypes.Enums;
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IMediaImage" />
/// <summary> /// <summary>
/// Abstract class to implement disk image writing plugins. TODO: This interface is subject to change until /// Abstract class to implement disk image writing plugins. TODO: This interface is subject to change until
/// notice. /// notice.

View File

@@ -42,6 +42,7 @@ using System.Collections.Generic;
using Aaru.CommonTypes.Enums; using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Structs; using Aaru.CommonTypes.Structs;
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IOpticalMediaImage" />
/// <summary>Defines an image that is writable and can store an optical disc (CD, DVD, etc)</summary> /// <summary>Defines an image that is writable and can store an optical disc (CD, DVD, etc)</summary>
public interface IWritableOpticalImage : IWritableImage, IOpticalMediaImage public interface IWritableOpticalImage : IWritableImage, IOpticalMediaImage
{ {

View File

@@ -41,6 +41,7 @@ namespace Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Structs; using Aaru.CommonTypes.Structs;
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.ITapeImage" />
/// <summary>Defines an image that is writable and can store information about a streaming, digital, tape</summary> /// <summary>Defines an image that is writable and can store information about a streaming, digital, tape</summary>
public interface IWritableTapeImage : ITapeImage, IWritableImage public interface IWritableTapeImage : ITapeImage, IWritableImage
{ {