More documentation inheritance.

This commit is contained in:
2021-08-17 16:12:30 +01:00
parent c6f5ece939
commit 1f7bcc83f1
24 changed files with 20 additions and 5 deletions

View File

@@ -34,6 +34,7 @@ using System;
namespace Aaru.Database.Models namespace Aaru.Database.Models
{ {
/// <inheritdoc />
/// <summary> /// <summary>
/// CD read offset /// CD read offset
/// </summary> /// </summary>

View File

@@ -32,6 +32,7 @@
namespace Aaru.Database.Models namespace Aaru.Database.Models
{ {
/// <inheritdoc />
/// <summary> /// <summary>
/// Aaru version /// Aaru version
/// </summary> /// </summary>

View File

@@ -39,6 +39,7 @@ using Schemas;
namespace Aaru.Filesystems namespace Aaru.Filesystems
{ {
// Information from Inside Macintosh Volume II // Information from Inside Macintosh Volume II
/// <inheritdoc />
/// <summary> /// <summary>
/// Implements the Apple Macintosh File System /// Implements the Apple Macintosh File System
/// </summary> /// </summary>

View File

@@ -38,6 +38,7 @@ using SharpCompress.Compressors.BZip2;
namespace Aaru.Filters namespace Aaru.Filters
{ {
/// <inheritdoc />
/// <summary>Decompress bz2 files while reading</summary> /// <summary>Decompress bz2 files while reading</summary>
public class BZip2 : IFilter public class BZip2 : IFilter
{ {

View File

@@ -38,6 +38,7 @@ using Aaru.Helpers;
namespace Aaru.Filters namespace Aaru.Filters
{ {
/// <inheritdoc />
/// <summary>Decompress gzip files while reading</summary> /// <summary>Decompress gzip files while reading</summary>
public sealed class GZip : IFilter public sealed class GZip : IFilter
{ {

View File

@@ -38,6 +38,7 @@ using SharpCompress.Compressors.LZMA;
namespace Aaru.Filters namespace Aaru.Filters
{ {
/// <inheritdoc />
/// <summary>Decompress lzip files while reading</summary> /// <summary>Decompress lzip files while reading</summary>
public sealed class LZip : IFilter public sealed class LZip : IFilter
{ {

View File

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

View File

@@ -37,6 +37,7 @@ using SharpCompress.Compressors.Xz;
namespace Aaru.Filters namespace Aaru.Filters
{ {
/// <inheritdoc />
/// <summary>Decompress xz files while reading</summary> /// <summary>Decompress xz files while reading</summary>
public sealed class XZ : IFilter public sealed class XZ : IFilter
{ {

View File

@@ -36,6 +36,7 @@ using Aaru.CommonTypes.Interfaces;
namespace Aaru.Filters namespace Aaru.Filters
{ {
/// <inheritdoc />
/// <summary>No filter for reading files not recognized by any filter</summary> /// <summary>No filter for reading files not recognized by any filter</summary>
public sealed class ZZZNoFilter : IFilter public sealed class ZZZNoFilter : IFilter
{ {

View File

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

View File

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

View File

@@ -41,6 +41,7 @@ namespace Aaru.DiscImages
{ {
// TODO: Doesn't support compositing from several files // TODO: Doesn't support compositing from several files
// TODO: Doesn't support silences that are not in files // TODO: Doesn't support silences that are not in files
/// <inheritdoc />
/// <summary> /// <summary>
/// Implements reading and writing cdrdao cuesheet disc images /// Implements reading and writing cdrdao cuesheet disc images
/// </summary> /// </summary>

View File

@@ -53,6 +53,7 @@ namespace Aaru.DiscImages
* 2) High compression, algorithm unknown * 2) High compression, algorithm unknown
* Then the data for whole tracks follow. * Then the data for whole tracks follow.
*/ */
/// <inheritdoc />
/// <summary> /// <summary>
/// Implements reading and writing CisCopy disk images /// Implements reading and writing CisCopy disk images
/// </summary> /// </summary>

View File

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

View File

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

View File

@@ -41,6 +41,7 @@ namespace Aaru.DiscImages
{ {
// Support separate data files? Never seen a DiscJuggler image using them anyways... // Support separate data files? Never seen a DiscJuggler image using them anyways...
// TODO: Too many unknowns to make this writable // TODO: Too many unknowns to make this writable
/// <inheritdoc />
/// <summary> /// <summary>
/// Implements reading DiscJuggler disc images /// Implements reading DiscJuggler disc images
/// </summary> /// </summary>

View File

@@ -30,6 +30,7 @@
// Copyright © 2011-2021 Natalia Portillo // Copyright © 2011-2021 Natalia Portillo
// ****************************************************************************/ // ****************************************************************************/
// ReSharper disable InconsistentNaming
namespace Aaru.DiscImages namespace Aaru.DiscImages
{ {
public sealed partial class DiskCopy42 public sealed partial class DiskCopy42

View File

@@ -41,6 +41,7 @@ namespace Aaru.DiscImages
{ {
// TODO: There seems no be no clear definition on how to treat pregaps that are not included in the file, so this is just appending it to start of track // TODO: There seems no be no clear definition on how to treat pregaps that are not included in the file, so this is just appending it to start of track
// TODO: This format doesn't support to specify pregaps that are included in the file (like Redump ones) // TODO: This format doesn't support to specify pregaps that are included in the file (like Redump ones)
/// <inheritdoc />
/// <summary> /// <summary>
/// Implements reading Dreamcast GDI disc images /// Implements reading Dreamcast GDI disc images
/// </summary> /// </summary>

View File

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

View File

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

View File

@@ -38,6 +38,7 @@ namespace Aaru.DiscImages
{ {
public sealed partial class Vhd public sealed partial class Vhd
{ {
/// <inheritdoc />
public bool Identify(IFilter imageFilter) public bool Identify(IFilter imageFilter)
{ {
Stream imageStream = imageFilter.GetDataForkStream(); Stream imageStream = imageFilter.GetDataForkStream();

View File

@@ -39,6 +39,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages namespace Aaru.DiscImages
{ {
// Info from Neko Project II emulator // Info from Neko Project II emulator
/// <inheritdoc />
/// <summary> /// <summary>
/// Implements reading Virtual98 disk images /// Implements reading Virtual98 disk images
/// </summary> /// </summary>

View File

@@ -39,6 +39,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages namespace Aaru.DiscImages
{ {
/// <inheritdoc />
/// <summary> /// <summary>
/// Implements reading and writing raw (sector by sector) images /// Implements reading and writing raw (sector by sector) images
/// </summary> /// </summary>