Add missing XML documentation inheritance.

This commit is contained in:
2021-08-17 14:25:12 +01:00
parent 00f605b0ca
commit 6dd5fb5c5c
136 changed files with 193 additions and 51 deletions

View File

@@ -41,6 +41,7 @@ namespace Aaru.Database
/// </summary>
public sealed class AaruContext : DbContext
{
/// <inheritdoc />
/// <summary>
/// Creates a database context with the specified options
/// </summary>

View File

@@ -34,11 +34,13 @@ using Microsoft.EntityFrameworkCore.Design;
namespace Aaru.Database
{
/// <inheritdoc />
/// <summary>
/// Database context factory, for design time
/// </summary>
public class AaruContextFactory : IDesignTimeDbContextFactory<AaruContext>
{
/// <inheritdoc />
/// <summary>
/// Creates a database context
/// </summary>

View File

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

View File

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

View File

@@ -32,6 +32,7 @@
namespace Aaru.Database.Models
{
/// <inheritdoc />
/// <summary>
/// Device found in usage
/// </summary>

View File

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

View File

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

View File

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

View File

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

View File

@@ -32,6 +32,7 @@
namespace Aaru.Database.Models
{
/// <inheritdoc />
/// <summary>
/// Model for name-count values.
/// </summary>

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -34,6 +34,7 @@ using System;
namespace Aaru.Devices
{
/// <inheritdoc />
/// <summary>Exception to be returned by the device constructor</summary>
public sealed class DeviceException : Exception
{

View File

@@ -44,6 +44,7 @@ namespace Aaru.Filesystems
{
// Information has been extracted looking at available disk images
// This may be missing fields, or not, I don't know russian so any help is appreciated
/// <inheritdoc />
/// <summary>
/// Implements detection of the AO-DOS filesystem
/// </summary>

View File

@@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the Apple File System (APFS)
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of Acorn's Advanced Data Filing System (ADFS)
/// </summary>

View File

@@ -44,6 +44,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of Amiga Fast File System (AFFS)
/// </summary>

View File

@@ -38,6 +38,7 @@ using Schemas;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements the Apple DOS 3 filesystem
/// </summary>

View File

@@ -40,6 +40,7 @@ namespace Aaru.Filesystems
{
// Information from Inside Macintosh
// https://developer.apple.com/legacy/library/documentation/mac/pdf/Files/File_Manager.pdf
/// <inheritdoc />
/// <summary>
/// Implements detection of the Apple Hierarchical File System (HFS)
/// </summary>

View File

@@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
// Information from Apple TechNote 1150: https://developer.apple.com/legacy/library/technotes/tn/tn1150.html
/// <inheritdoc />
/// <summary>
/// Implements detection of Apple Hierarchical File System Plus (HFS+)
/// </summary>

View File

@@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection for the AtheOS filesystem
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
// Information from Practical Filesystem Design, ISBN 1-55860-497-9
/// <inheritdoc />
/// <summary>
/// Implements detection of the Be (new) filesystem
/// </summary>

View File

@@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the b-tree filesystem (btrfs)
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the filesystem used in 8-bit Commodore microcomputers
/// </summary>

View File

@@ -39,6 +39,7 @@ using Schemas;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements the CP/M filesystem
/// </summary>

View File

@@ -44,6 +44,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the CRAM filesystem
/// </summary>

View File

@@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the filesystem described in ECMA-67
/// </summary>

View File

@@ -44,6 +44,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements identification for the SGI Extent FileSystem
/// </summary>

View File

@@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the Flash-Friendly File System (F2FS)
/// </summary>

View File

@@ -42,6 +42,7 @@ namespace Aaru.Filesystems
{
// TODO: Differentiate between Atari and X68k FAT, as this one uses a standard BPB.
// X68K uses cdate/adate from direntry for extending filename
/// <inheritdoc />
/// <summary>
/// Implements the File Allocation Table, aka FAT, filesystem (FAT12, FAT16 and FAT32 variants).
/// </summary>

View File

@@ -40,6 +40,7 @@ using Schemas;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements the Xbox File Allocation Table (FATX or XTAF) filesystem.
/// </summary>

View File

@@ -47,6 +47,7 @@ using ufs_daddr_t = System.Int32;
namespace Aaru.Filesystems
{
// Using information from Linux kernel headers
/// <inheritdoc />
/// <summary>
/// Implements detection of BSD Fast File System (FFS, aka UNIX File System)
/// </summary>

View File

@@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection for the Plan-9 Fossil on-disk filesystem
/// </summary>

View File

@@ -47,6 +47,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection for the HAMMER filesystem
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
// Information from an old unnamed document
/// <inheritdoc />
/// <summary>
/// Implements detection of IBM's High Performance File System (HPFS)
/// </summary>

View File

@@ -39,6 +39,7 @@ namespace Aaru.Filesystems
{
// Information from test floppy images created with OS/2 HPOFS 2.0
// Need to get IBM document GA32-0224 -> IBM 3995 Optical Library Dataserver Products: Optical Disk Format
/// <inheritdoc />
/// <summary>
/// Implements identification of IBM's High Performance Optical File System
/// </summary>

View File

@@ -42,6 +42,7 @@ using Schemas;
namespace Aaru.Filesystems
{
// This is coded following ECMA-119.
/// <inheritdoc />
/// <summary>
/// Implements the High Sierra, ISO9660 and CD-i filesystems
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of IBM's Journaled File System
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
// Information from http://www.hp9845.net/9845/projects/hpdir/#lif_filesystem
/// <inheritdoc />
/// <summary>
/// Implements detection of the LIF filesystem
/// </summary>

View File

@@ -40,6 +40,7 @@ namespace Aaru.Filesystems.LisaFS
{
// All information by Natalia Portillo
// Variable names from Lisa API
/// <inheritdoc />
/// <summary>
/// Implements the Apple Lisa File System
/// </summary>

View File

@@ -67,6 +67,7 @@ using time_t = System.Int32;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the Locus filesystem
/// </summary>

View File

@@ -43,12 +43,12 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <summary>
/// Implements detection for the MicroDOS filesystem.
///
/// Information from http://www.owg.ru/mkt/BK/MKDOS.TXT
/// Thanks to tarlabnor for translating it
/// </summary>
/// <inheritdoc />
/// <summary>
/// Implements detection for the MicroDOS filesystem.
/// Information from http://www.owg.ru/mkt/BK/MKDOS.TXT
/// Thanks to tarlabnor for translating it
/// </summary>
public sealed class MicroDOS : IFilesystem
{
const ushort MAGIC = 0xA72E;

View File

@@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
// Information from the Linux kernel
/// <inheritdoc />
/// <summary>
/// Implements detection of the MINIX filesystem
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the New Implementation of a Log-structured File System v2
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
// Information from Inside Windows NT
/// <inheritdoc />
/// <summary>
/// Implements detection of the New Technology File System (NTFS)
/// </summary>

View File

@@ -40,6 +40,7 @@ using Schemas;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the filesystem used by Nintendo Gamecube and Wii discs
/// </summary>

View File

@@ -52,6 +52,7 @@ namespace Aaru.Filesystems
// There is an ODS with signature "DECFILES11A", yet to be seen
// Time is a 64 bit unsigned integer, tenths of microseconds since 1858/11/17 00:00:00.
// TODO: Implement checksum
/// <inheritdoc />
/// <summary>
/// Implements detection of DEC's On-Disk Structure, aka the ODS filesystem
/// </summary>

View File

@@ -39,6 +39,7 @@ using Schemas;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements the 3DO Opera filesystem
/// </summary>

View File

@@ -38,6 +38,7 @@ using Schemas;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the PC-Engine CD file headers
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
// Not a filesystem, more like an executable header
/// <inheritdoc />
/// <summary>
/// Implements detection of NEC PC-FX headers
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the Professional File System
/// </summary>

View File

@@ -46,6 +46,7 @@ using Encoding = System.Text.Encoding;
namespace Aaru.Filesystems
{
// Information from Apple ProDOS 8 Technical Reference
/// <inheritdoc />
/// <summary>
/// Implements detection of Apple ProDOS filesystem
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of QNX 4 filesystem
/// </summary>

View File

@@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of QNX 6 filesystem
/// </summary>

View File

@@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the Locus filesystem
/// </summary>

View File

@@ -44,6 +44,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
// Information from http://www.trailing-edge.com/~shoppa/rt11fs/
/// <inheritdoc />
/// <summary>
/// Implements detection of the DEC RT-11 filesystem
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of Microsoft's Resilient filesystem (ReFS)
/// </summary>

View File

@@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the Reiser v3 filesystem
/// </summary>

View File

@@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the Reiser v4 filesystem
/// </summary>

View File

@@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the Smart File System
/// </summary>

View File

@@ -41,6 +41,7 @@ using Schemas;
namespace Aaru.Filesystems
{
// Based on FAT's BPB, cannot find a FAT or directory
/// <inheritdoc />
/// <summary>
/// Implements detection of the Solar OS filesystem
/// </summary>

View File

@@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the squash filesystem
/// </summary>

View File

@@ -44,6 +44,7 @@ using Schemas;
namespace Aaru.Filesystems
{
// Information from the Linux kernel
/// <inheritdoc />
/// <summary>
/// Implements detection of the UNIX System V filesystem
/// </summary>

View File

@@ -40,6 +40,7 @@ using Schemas;
namespace Aaru.Filesystems.UCSDPascal
{
// Information from Call-A.P.P.L.E. Pascal Disk Directory Structure
/// <inheritdoc />
/// <summary>
/// Implements the U.C.S.D. Pascal filesystem
/// </summary>

View File

@@ -45,6 +45,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
// TODO: Detect bootable
/// <inheritdoc />
/// <summary>
/// Implements detection of the Universal Disk Format filesystem
/// </summary>

View File

@@ -51,6 +51,7 @@ using time_t = System.Int64;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection for the Cray UNICOS filesystem
/// </summary>

View File

@@ -41,6 +41,7 @@ using Schemas;
namespace Aaru.Filesystems
{
// Information from the Linux kernel
/// <inheritdoc />
/// <summary>
/// Implements detection of the UNIX boot filesystem
/// </summary>

View File

@@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the VMware filesystem
/// </summary>

View File

@@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of the Veritas filesystem
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements detection of SGI's XFS
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
// Information from the Linux kernel
/// <inheritdoc />
/// <summary>
/// Implements detection for the Xia filesystem
/// </summary>

View File

@@ -61,6 +61,7 @@ namespace Aaru.Filesystems
* It can also be encoded little or big endian.
* Because of this variations, ZFS stored a header indicating the used encoding and endianess before the encoded nvlist.
*/
/// <inheritdoc />
/// <summary>
/// Implements detection for the Zettabyte File System (ZFS)
/// </summary>

View File

@@ -44,6 +44,7 @@ using ufs_daddr_t = System.Int32;
namespace Aaru.Filesystems
{
/// <inheritdoc />
/// <summary>
/// Implements identification of a dump(8) image (virtual filesystem on a file)
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
// Information from https://www.sans.org/reading-room/whitepapers/forensics/reverse-engineering-microsoft-exfat-file-system-33274
/// <inheritdoc />
/// <summary>
/// Implements detection of the exFAT filesystem
/// </summary>

View File

@@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Filesystems
{
// Information from the Linux kernel
/// <inheritdoc />
/// <summary>
/// Implements detection of the Linux extended filesystem v2, v3 and v4
/// </summary>

View File

@@ -40,6 +40,7 @@ using Schemas;
namespace Aaru.Filesystems
{
// Information from the Linux kernel
/// <inheritdoc />
/// <summary>
/// Implements detection of the Linux extended filesystem
/// </summary>

View File

@@ -48,13 +48,14 @@ namespace Aaru.Filters
readonly long _streamEnd;
readonly long _streamStart;
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified stream, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified stream, both inclusive.
/// </summary>
/// <param name="stream">Base stream</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(Stream stream, long start, long end)
{
if(start < 0)
@@ -74,18 +75,19 @@ namespace Aaru.Filters
_baseStream.Position = start;
}
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified file, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified file, both inclusive.
/// </summary>
/// <param name="path">A relative or absolute path for the file that the stream will encapsulate.</param>
/// <param name="mode">One of the enumeration values that determines how to open or create the file.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="FileStream" /> object.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="T:System.IO.FileStream" /> object.</param>
/// <param name="share">A bitwise combination of the enumeration values that determines how the file will be shared by processes.</param>
/// <param name="bufferSize">A positive Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096.</param>
/// <param name="options">A bitwise combination of the enumeration values that specifies additional file options.</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(string path, FileMode mode, FileAccess access, FileShare share, int bufferSize,
FileOptions options, long start, long end)
{
@@ -106,14 +108,15 @@ namespace Aaru.Filters
_baseStream.Position = start;
}
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified file, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified file, both inclusive.
/// </summary>
/// <param name="handle">A file handle for the file that the stream will encapsulate.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="FileStream" /> object.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="T:System.IO.FileStream" /> object.</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(SafeFileHandle handle, FileAccess access, long start, long end)
{
if(start < 0)
@@ -133,15 +136,16 @@ namespace Aaru.Filters
_baseStream.Position = start;
}
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified file, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified file, both inclusive.
/// </summary>
/// <param name="handle">A file handle for the file that the stream will encapsulate.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="FileStream" /> object.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="T:System.IO.FileStream" /> object.</param>
/// <param name="bufferSize">A positive Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096.</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(SafeFileHandle handle, FileAccess access, int bufferSize, long start, long end)
{
if(start < 0)
@@ -161,16 +165,17 @@ namespace Aaru.Filters
_baseStream.Position = start;
}
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified file, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified file, both inclusive.
/// </summary>
/// <param name="handle">A file handle for the file that the stream will encapsulate.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="FileStream" /> object.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="T:System.IO.FileStream" /> object.</param>
/// <param name="bufferSize">A positive Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096.</param>
/// <param name="isAsync">Specifies whether to use asynchronous I/O or synchronous I/O.</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(SafeFileHandle handle, FileAccess access, int bufferSize, bool isAsync, long start,
long end)
{
@@ -191,18 +196,19 @@ namespace Aaru.Filters
_baseStream.Position = start;
}
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified file, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified file, both inclusive.
/// </summary>
/// <param name="path">A relative or absolute path for the file that the stream will encapsulate.</param>
/// <param name="mode">One of the enumeration values that determines how to open or create the file.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="FileStream" /> object.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="T:System.IO.FileStream" /> object.</param>
/// <param name="share">A bitwise combination of the enumeration values that determines how the file will be shared by processes.</param>
/// <param name="bufferSize">A positive Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096.</param>
/// <param name="useAsync">Specifies whether to use asynchronous I/O or synchronous I/O.</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(string path, FileMode mode, FileAccess access, FileShare share, int bufferSize,
bool useAsync, long start, long end)
{
@@ -223,17 +229,18 @@ namespace Aaru.Filters
_baseStream.Position = start;
}
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified file, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified file, both inclusive.
/// </summary>
/// <param name="path">A relative or absolute path for the file that the stream will encapsulate.</param>
/// <param name="mode">One of the enumeration values that determines how to open or create the file.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="FileStream" /> object.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="T:System.IO.FileStream" /> object.</param>
/// <param name="share">A bitwise combination of the enumeration values that determines how the file will be shared by processes.</param>
/// <param name="bufferSize">A positive Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096.</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(string path, FileMode mode, FileAccess access, FileShare share, int bufferSize, long start,
long end)
{
@@ -254,16 +261,17 @@ namespace Aaru.Filters
_baseStream.Position = start;
}
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified file, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified file, both inclusive.
/// </summary>
/// <param name="path">A relative or absolute path for the file that the stream will encapsulate.</param>
/// <param name="mode">One of the enumeration values that determines how to open or create the file.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="FileStream" /> object.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="T:System.IO.FileStream" /> object.</param>
/// <param name="share">A bitwise combination of the enumeration values that determines how the file will be shared by processes.</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(string path, FileMode mode, FileAccess access, FileShare share, long start, long end)
{
if(start < 0)
@@ -283,15 +291,16 @@ namespace Aaru.Filters
_baseStream.Position = start;
}
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified file, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified file, both inclusive.
/// </summary>
/// <param name="path">A relative or absolute path for the file that the stream will encapsulate.</param>
/// <param name="mode">One of the enumeration values that determines how to open or create the file.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="FileStream" /> object.</param>
/// <param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by a <see cref="T:System.IO.FileStream" /> object.</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(string path, FileMode mode, FileAccess access, long start, long end)
{
if(start < 0)
@@ -311,14 +320,15 @@ namespace Aaru.Filters
_baseStream.Position = start;
}
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified file, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified file, both inclusive.
/// </summary>
/// <param name="path">A relative or absolute path for the file that the stream will encapsulate.</param>
/// <param name="mode">One of the enumeration values that determines how to open or create the file.</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(string path, FileMode mode, long start, long end)
{
if(start < 0)
@@ -338,17 +348,18 @@ namespace Aaru.Filters
_baseStream.Position = start;
}
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified byte array, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified byte array, both inclusive.
/// </summary>
/// <param name="buffer">The array of unsigned bytes to add at the end of this stream.</param>
/// <param name="index">The index into <paramref name="buffer"/> at which the stream begins.</param>
/// <param name="index">The index into <paramref name="buffer" /> at which the stream begins.</param>
/// <param name="count">The length in bytes to add to the end of the current stream.</param>
/// <param name="writable">The setting of the CanWrite property, currently ignored.</param>
/// <param name="publiclyVisible">Currently ignored.</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(byte[] buffer, int index, int count, bool writable, bool publiclyVisible, long start,
long end)
{
@@ -369,16 +380,17 @@ namespace Aaru.Filters
_baseStream.Position = start;
}
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified byte array, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified byte array, both inclusive.
/// </summary>
/// <param name="buffer">The array of unsigned bytes to add at the end of this stream.</param>
/// <param name="index">The index into <paramref name="buffer"/> at which the stream begins.</param>
/// <param name="index">The index into <paramref name="buffer" /> at which the stream begins.</param>
/// <param name="count">The length in bytes to add to the end of the current stream.</param>
/// <param name="writable">The setting of the CanWrite property, currently ignored.</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(byte[] buffer, int index, int count, bool writable, long start, long end)
{
if(start < 0)
@@ -398,15 +410,16 @@ namespace Aaru.Filters
_baseStream.Position = start;
}
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified byte array, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified byte array, both inclusive.
/// </summary>
/// <param name="buffer">The array of unsigned bytes to add at the end of this stream.</param>
/// <param name="index">The index into <paramref name="buffer"/> at which the stream begins.</param>
/// <param name="index">The index into <paramref name="buffer" /> at which the stream begins.</param>
/// <param name="count">The length in bytes to add to the end of the current stream.</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(byte[] buffer, int index, int count, long start, long end)
{
if(start < 0)
@@ -426,14 +439,15 @@ namespace Aaru.Filters
_baseStream.Position = start;
}
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified byte array, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified byte array, both inclusive.
/// </summary>
/// <param name="buffer">The array of unsigned bytes to add at the end of this stream.</param>
/// <param name="writable">The setting of the CanWrite property, currently ignored.</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(byte[] buffer, bool writable, long start, long end)
{
if(start < 0)
@@ -453,13 +467,14 @@ namespace Aaru.Filters
_baseStream.Position = start;
}
/// <inheritdoc />
/// <summary>
/// Initializes a stream that only allows reading from <paramref name="start"/> to <paramref name="end"/> of the specified byte array, both inclusive.
/// Initializes a stream that only allows reading from <paramref name="start" /> to <paramref name="end" /> of the specified byte array, both inclusive.
/// </summary>
/// <param name="buffer">The array of unsigned bytes to add at the end of this stream.</param>
/// <param name="start">Start position</param>
/// <param name="end">Last readable position</param>
/// <exception cref="ArgumentOutOfRangeException">Invalid range</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">Invalid range</exception>
public OffsetStream(byte[] buffer, long start, long end)
{
if(start < 0)

View File

@@ -8,6 +8,7 @@ using Microsoft.Win32.SafeHandles;
namespace Aaru.Filters
{
/// <inheritdoc />
/// <summary>
/// Implements a stream that joins two or more files (sequentially) as a single stream
/// </summary>

View File

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

View File

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

View File

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

View File

@@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
// TODO: Checksum sectors
/// <inheritdoc />
/// <summary>
/// Implements reading nibbelized Apple II disk images
/// </summary>

View File

@@ -39,6 +39,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
// TODO: Check writing
/// <inheritdoc />
/// <summary>
/// Implements reading and writing Apridisk disk images
/// </summary>

View File

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

View File

@@ -39,6 +39,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
// TODO: Too many unknowns, plus a completely unknown footer, to make this writable
/// <inheritdoc />
/// <summary>
/// Implements reading BlindWrite 4 disc images
/// </summary>

View File

@@ -39,6 +39,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
// TODO: Too many unknowns to make this writable
/// <inheritdoc />
/// <summary>
/// Implements reading BlindWrite 5/6/7 disc images
/// </summary>

View File

@@ -114,7 +114,6 @@ namespace Aaru.DiscImages
return failingLbas.Count <= 0;
}
/// <inheritdoc />
public bool? VerifySector(ulong sectorAddress, uint track)
{
byte[] buffer = ReadSectorLong(sectorAddress, track);

View File

@@ -40,6 +40,7 @@ using Aaru.Decoders.CD;
namespace Aaru.DiscImages
{
// TODO: Implement track flags
/// <inheritdoc />
/// <summary>
/// Implements reading and writing CDRWin cuesheet disc images
/// </summary>

View File

@@ -225,7 +225,6 @@ namespace Aaru.DiscImages
return failingLbas.Count <= 0;
}
/// <inheritdoc />
public bool? VerifySector(ulong sectorAddress, uint track)
{
byte[] buffer = ReadSectorLong(sectorAddress, track);

View File

@@ -154,7 +154,6 @@ namespace Aaru.DiscImages
return _expectedChecksum.SequenceEqual(calculated);
}
/// <inheritdoc />
public bool? VerifySector(ulong sectorAddress, uint track)
{
if(_isHdd)

View File

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

View File

@@ -39,6 +39,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
// TODO: CloneCD stores subchannel deinterleaved
/// <inheritdoc />
/// <summary>
/// Implements reading and writing CloneCD disc images
/// </summary>

View File

@@ -114,7 +114,6 @@ namespace Aaru.DiscImages
return failingLbas.Count <= 0;
}
/// <inheritdoc />
public bool? VerifySector(ulong sectorAddress, uint track)
{
byte[] buffer = ReadSectorLong(sectorAddress, track);

View File

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

View File

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

View File

@@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
// TODO: What are the real supported floppies for this image format?
/// <inheritdoc />
/// <summary>
/// Implements reading DIM disk images
/// </summary>

View File

@@ -40,6 +40,7 @@ using Aaru.CommonTypes.Structs;
namespace Aaru.DiscImages
{
// Checked using several images and strings inside Apple's DiskImages.framework
/// <inheritdoc />
/// <summary>
/// Implements reading and writing Apple DiskCopy 4.2 disk images
/// </summary>

Some files were not shown because too many files have changed in this diff Show More