aaru-dps/Aaru
1
0
Fork 0
mirror of https://github.com/aaru-dps/Aaru.git synced 2025-12-16 19:24:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Annotate or remove unused elements.

Browse Source
This commit is contained in:
Natalia Portillo
2023-10-05 01:05:11 +01:00
parent 7796540b5e
commit cfb704e3ef
30 changed files with 99 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Interfaces/IByteAddressableImage.cs
View File

@@ -37,6 +37,7 @@
// ****************************************************************************/
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Structs;
@@ -44,6 +45,11 @@ namespace Aaru.CommonTypes.Interfaces;
/// <inheritdoc />
/// <summary>Interface defining linear media (chips, game carts, etc) images</summary>
[SuppressMessage("ReSharper", "UnusedParameter.Global")]
[SuppressMessage("ReSharper", "UnusedMemberInSuper.Global")]
[SuppressMessage("ReSharper", "UnusedMember.Global")]
[SuppressMessage("ReSharper", "UnusedMethodReturnValue.Global")]
[SuppressMessage("ReSharper", "OutParameterValueIsAlwaysDiscarded.Global")]
public interface IByteAddressableImage : IBaseWritableImage
{
/// <summary>Gets or sets the current position</summary>

4
Interfaces/IFilter.cs
View File

@@ -37,6 +37,7 @@
// ****************************************************************************/
using System;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using Aaru.CommonTypes.Enums;
@@ -46,6 +47,9 @@ namespace Aaru.CommonTypes.Interfaces;
/// Defines a filter, that is, a transformation of the data from a file, like, for example, a compressor (e.g.
/// GZIP), or a container (e.g. AppleDouble)
/// </summary>
[SuppressMessage("ReSharper", "UnusedMember.Global")]
[SuppressMessage("ReSharper", "UnusedMethodReturnValue.Global")]
[SuppressMessage("ReSharper", "UnusedMemberInSuper.Global")]
public interface IFilter
{
/// <summary>Descriptive name of the plugin</summary>

2
Interfaces/IFloppyImage.cs
View File

@@ -36,6 +36,7 @@
// Copyright © 2011-2023 Natalia Portillo
// ****************************************************************************/
using System.Diagnostics.CodeAnalysis;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Structs;
@@ -48,6 +49,7 @@ namespace Aaru.CommonTypes.Interfaces;
/// interface is defined by <see cref="T:Aaru.CommonTypes.Interfaces.IMediaImage" />. All data returned by these
/// methods is already decoded from its corresponding bitstream.
/// </summary>
[SuppressMessage("ReSharper", "UnusedMember.Global")]
public interface IFloppyImage : IMediaImage
{
/// <summary>

3
Interfaces/IFluxImage.cs
View File

@@ -36,12 +36,15 @@
// Copyright © 2011-2023 Rebecca Wallander
// ****************************************************************************/
using System.Diagnostics.CodeAnalysis;
using Aaru.CommonTypes.Enums;
namespace Aaru.CommonTypes.Interfaces;
/// <inheritdoc />
/// <summary>Abstract class to implement flux reading plugins.</summary>
[SuppressMessage("ReSharper", "UnusedMethodReturnValue.Global")]
[SuppressMessage("ReSharper", "UnusedMemberInSuper.Global")]
public interface IFluxImage : IBaseImage
{
/// <summary>

3
Interfaces/IMediaGraph.cs
View File

@@ -33,11 +33,14 @@
// ****************************************************************************/
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.IO;
namespace Aaru.CommonTypes.Interfaces;
/// <summary>Defines the interface to draw the dump or verification status of a media in a picture.</summary>
[SuppressMessage("ReSharper", "UnusedMember.Global")]
[SuppressMessage("ReSharper", "UnusedMemberInSuper.Global")]
public interface IMediaGraph
{
/// <summary>Paints the specified sector in green</summary>

4
Interfaces/IOpticalMediaImage.cs
View File

@@ -37,6 +37,7 @@
// ****************************************************************************/
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Structs;
@@ -44,6 +45,9 @@ namespace Aaru.CommonTypes.Interfaces;
/// <inheritdoc cref="IMediaImage" />
/// <summary>Abstract class to implement disk image reading plugins.</summary>
[SuppressMessage("ReSharper", "UnusedMember.Global")]
[SuppressMessage("ReSharper", "UnusedMemberInSuper.Global")]
[SuppressMessage("ReSharper", "UnusedMethodReturnValue.Global")]
public interface IOpticalMediaImage : IMediaImage, IPartitionableMediaImage, IVerifiableSectorsImage
{
/// <summary>Gets the disc track extents (start, length).</summary>

2
Interfaces/IPluginRegister.cs
View File

@@ -38,10 +38,12 @@
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
namespace Aaru.CommonTypes.Interfaces;
/// <summary>Defines a register of all known plugins</summary>
[SuppressMessage("ReSharper", "UnusedMember.Global")]
public interface IPluginRegister
{
/// <summary>Gets all checksum plugins</summary>

6
Interfaces/IReadOnlyFilesystem.cs
View File

@@ -39,6 +39,7 @@
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Text;
using Aaru.CommonTypes.AaruMetadata;
@@ -51,6 +52,9 @@ namespace Aaru.CommonTypes.Interfaces;
/// <inheritdoc />
/// <summary>Defines the interface to implement reading the contents of a filesystem</summary>
[SuppressMessage("ReSharper", "UnusedMember.Global")]
[SuppressMessage("ReSharper", "UnusedMethodReturnValue.Global")]
[SuppressMessage("ReSharper", "UnusedMemberInSuper.Global")]
public interface IReadOnlyFilesystem : IFilesystem
{
/// <summary>Information about the filesystem as expected by Aaru Metadata</summary>
@@ -179,6 +183,7 @@ public interface IReadOnlyFilesystem : IFilesystem
}
/// <summary>Represents an opened file from a filesystem</summary>
[SuppressMessage("ReSharper", "UnusedMemberInSuper.Global")]
public interface IFileNode
{
/// <summary>Path to the file</summary>
@@ -192,6 +197,7 @@ public interface IFileNode
}
/// <summary>Represents an opened directory from a filesystem</summary>
[SuppressMessage("ReSharper", "UnusedMemberInSuper.Global")]
public interface IDirNode
{
/// <summary>Path to the directory</summary>

3
Interfaces/IVerifiableSectorsImage.cs
View File

@@ -38,10 +38,13 @@
// ****************************************************************************/
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
namespace Aaru.CommonTypes.Interfaces;
/// <summary>Defines an image that can verify the integrity of the sectors it contains</summary>
[SuppressMessage("ReSharper", "UnusedMember.Global")]
[SuppressMessage("ReSharper", "UnusedMethodReturnValue.Global")]
public interface IVerifiableSectorsImage
{
/// <summary>Verifies a sector.</summary>

2
Interfaces/IWritableFloppyImage.cs
View File

@@ -36,6 +36,7 @@
// Copyright © 2011-2023 Natalia Portillo
// ****************************************************************************/
using System.Diagnostics.CodeAnalysis;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Structs;
@@ -48,6 +49,7 @@ namespace Aaru.CommonTypes.Interfaces;
/// interface defined by <see cref="T:Aaru.CommonTypes.Interfaces.IMediaImage" />. All data expected by these methods
/// is already decoded from its corresponding bitstream.
/// </summary>
[SuppressMessage("ReSharper", "UnusedMember.Global")]
public interface IWritableFloppyImage : IFloppyImage, IWritableImage
{
/// <summary>

4
Interfaces/IWritableFluxImage.cs
View File

@@ -36,12 +36,16 @@
// Copyright © 2011-2023 Rebecca Wallander
// ****************************************************************************/
using System.Diagnostics.CodeAnalysis;
using Aaru.CommonTypes.Enums;
namespace Aaru.CommonTypes.Interfaces;
/// <inheritdoc cref="IWritableImage" />
/// <summary>Abstract class to implement flux writing plugins.</summary>
[SuppressMessage("ReSharper", "UnusedMember.Global")]
[SuppressMessage("ReSharper", "UnusedParameter.Global")]
[SuppressMessage("ReSharper", "UnusedMethodReturnValue.Global")]
public interface IWritableFluxImage : IFluxImage, IWritableImage
{
/// <summary>Writes a flux capture.</summary>

2
Interfaces/IWritableTapeImage.cs
View File

@@ -37,12 +37,14 @@
// Copyright © 2011-2023 Natalia Portillo
// ****************************************************************************/
using System.Diagnostics.CodeAnalysis;
using Aaru.CommonTypes.Structs;
namespace Aaru.CommonTypes.Interfaces;
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.ITapeImage" />
/// <summary>Defines an image that is writable and can store information about a streaming, digital, tape</summary>
[SuppressMessage("ReSharper", "UnusedMethodReturnValue.Global")]
public interface IWritableTapeImage : ITapeImage, IWritableImage
{
/// <summary>Registers a new file in the image</summary>