From ffd8f7dccd4351a21133fa5f5f1810d0d83f6d89 Mon Sep 17 00:00:00 2001 From: Natalia Portillo Date: Mon, 20 Jul 2020 05:20:18 +0100 Subject: [PATCH] Inherit documentation. --- Interfaces/IFloppyImage.cs | 5 +++-- Interfaces/IOpticalMediaImage.cs | 1 + Interfaces/IReadOnlyFilesystem.cs | 1 + Interfaces/IWritableFloppyImage.cs | 5 +++-- Interfaces/IWritableImage.cs | 1 + 5 files changed, 9 insertions(+), 4 deletions(-) diff --git a/Interfaces/IFloppyImage.cs b/Interfaces/IFloppyImage.cs index 998148b..b79c272 100644 --- a/Interfaces/IFloppyImage.cs +++ b/Interfaces/IFloppyImage.cs @@ -41,11 +41,12 @@ using Aaru.CommonTypes.Structs; namespace Aaru.CommonTypes.Interfaces { + /// /// /// Abstract class to implement disk image reading plugins that can contain floppy images. This interface is /// needed because floppy formatting characteristics are not necesarily compatible with the whole. LBA-oriented - /// interface is defined by . All data returned by these methods is already decoded from its - /// corresponding bitstream. + /// interface is defined by . All data returned by these + /// methods is already decoded from its corresponding bitstream. /// public interface IFloppyImage : IMediaImage { diff --git a/Interfaces/IOpticalMediaImage.cs b/Interfaces/IOpticalMediaImage.cs index 026aae7..3df2084 100644 --- a/Interfaces/IOpticalMediaImage.cs +++ b/Interfaces/IOpticalMediaImage.cs @@ -42,6 +42,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.CommonTypes.Interfaces { + /// /// Abstract class to implement disk image reading plugins. public interface IOpticalMediaImage : IMediaImage, IPartitionableMediaImage, IVerifiableSectorsImage { diff --git a/Interfaces/IReadOnlyFilesystem.cs b/Interfaces/IReadOnlyFilesystem.cs index e23fde1..1a6fcba 100644 --- a/Interfaces/IReadOnlyFilesystem.cs +++ b/Interfaces/IReadOnlyFilesystem.cs @@ -44,6 +44,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.CommonTypes.Interfaces { + /// /// Interface to implement filesystem plugins. public interface IReadOnlyFilesystem : IFilesystem { diff --git a/Interfaces/IWritableFloppyImage.cs b/Interfaces/IWritableFloppyImage.cs index 2f093a5..a60eff6 100644 --- a/Interfaces/IWritableFloppyImage.cs +++ b/Interfaces/IWritableFloppyImage.cs @@ -41,11 +41,12 @@ using Aaru.CommonTypes.Structs; namespace Aaru.CommonTypes.Interfaces { + /// /// /// Abstract class to implement disk image reading plugins that can contain floppy images. This interface is /// needed because floppy formatting characteristics are not necesarily compatible with the whole LBA-oriented - /// interface defined by . All data expected by these methods is already decoded from its - /// corresponding bitstream. + /// interface defined by . All data expected by these methods + /// is already decoded from its corresponding bitstream. /// public interface IWritableFloppyImage : IFloppyImage, IWritableImage { diff --git a/Interfaces/IWritableImage.cs b/Interfaces/IWritableImage.cs index a30f539..4d4490a 100644 --- a/Interfaces/IWritableImage.cs +++ b/Interfaces/IWritableImage.cs @@ -44,6 +44,7 @@ using Schemas; namespace Aaru.CommonTypes.Interfaces { + /// /// /// Abstract class to implement disk image writing plugins. TODO: This interface is subject to change until /// notice.