From 6dd5fb5c5cd47c1dfaf02fd94f4ef52be5ec667a Mon Sep 17 00:00:00 2001 From: Natalia Portillo Date: Tue, 17 Aug 2021 14:25:12 +0100 Subject: [PATCH] Add missing XML documentation inheritance. --- Aaru.Database/Context.cs | 1 + Aaru.Database/ContextFactory.cs | 2 + Aaru.Database/Models/BaseOperatingSystem.cs | 1 + Aaru.Database/Models/Command.cs | 1 + Aaru.Database/Models/DeviceStat.cs | 1 + Aaru.Database/Models/Filesystem.cs | 1 + Aaru.Database/Models/Filter.cs | 1 + Aaru.Database/Models/Media.cs | 1 + Aaru.Database/Models/MediaFormat.cs | 1 + Aaru.Database/Models/NameCountModel.cs | 1 + Aaru.Database/Models/OperatingSystem.cs | 1 + Aaru.Database/Models/Partition.cs | 1 + Aaru.Database/Models/RemoteApplication.cs | 1 + Aaru.Database/Models/RemoteArchitecture.cs | 1 + Aaru.Database/Models/RemoteOperatingSystem.cs | 1 + Aaru.Devices/Device/DeviceException.cs | 1 + Aaru.Filesystems/AODOS.cs | 1 + Aaru.Filesystems/APFS.cs | 1 + Aaru.Filesystems/Acorn.cs | 1 + Aaru.Filesystems/AmigaDOS.cs | 1 + Aaru.Filesystems/AppleDOS/AppleDOS.cs | 1 + Aaru.Filesystems/AppleHFS/AppleHFS.cs | 1 + Aaru.Filesystems/AppleHFSPlus.cs | 1 + Aaru.Filesystems/AtheOS.cs | 1 + Aaru.Filesystems/BFS.cs | 1 + Aaru.Filesystems/BTRFS.cs | 1 + Aaru.Filesystems/CBM.cs | 1 + Aaru.Filesystems/CPM/CPM.cs | 1 + Aaru.Filesystems/Cram.cs | 1 + Aaru.Filesystems/ECMA67.cs | 1 + Aaru.Filesystems/EFS.cs | 1 + Aaru.Filesystems/F2FS.cs | 1 + Aaru.Filesystems/FAT/FAT.cs | 1 + Aaru.Filesystems/FATX/FATX.cs | 1 + Aaru.Filesystems/FFS.cs | 1 + Aaru.Filesystems/Fossil.cs | 1 + Aaru.Filesystems/HAMMER.cs | 1 + Aaru.Filesystems/HPFS.cs | 1 + Aaru.Filesystems/HPOFS/HPOFS.cs | 1 + Aaru.Filesystems/ISO9660/ISO9660.cs | 1 + Aaru.Filesystems/JFS.cs | 1 + Aaru.Filesystems/LIF.cs | 1 + Aaru.Filesystems/LisaFS/LisaFS.cs | 1 + Aaru.Filesystems/Locus.cs | 1 + Aaru.Filesystems/MicroDOS.cs | 12 +-- Aaru.Filesystems/MinixFS.cs | 1 + Aaru.Filesystems/NILFS2.cs | 1 + Aaru.Filesystems/NTFS.cs | 1 + Aaru.Filesystems/Nintendo.cs | 1 + Aaru.Filesystems/ODS.cs | 1 + Aaru.Filesystems/Opera/Opera.cs | 1 + Aaru.Filesystems/PCEngine.cs | 1 + Aaru.Filesystems/PCFX.cs | 1 + Aaru.Filesystems/PFS.cs | 1 + Aaru.Filesystems/ProDOS.cs | 1 + Aaru.Filesystems/QNX4.cs | 1 + Aaru.Filesystems/QNX6.cs | 1 + Aaru.Filesystems/RBF.cs | 1 + Aaru.Filesystems/RT11.cs | 1 + Aaru.Filesystems/ReFS.cs | 1 + Aaru.Filesystems/Reiser.cs | 1 + Aaru.Filesystems/Reiser4.cs | 1 + Aaru.Filesystems/SFS.cs | 1 + Aaru.Filesystems/SolarFS.cs | 1 + Aaru.Filesystems/Squash.cs | 1 + Aaru.Filesystems/SysV.cs | 1 + Aaru.Filesystems/UCSDPascal/UCSDPascal.cs | 1 + Aaru.Filesystems/UDF.cs | 1 + Aaru.Filesystems/UNICOS.cs | 1 + Aaru.Filesystems/UNIXBFS.cs | 1 + Aaru.Filesystems/VMfs.cs | 1 + Aaru.Filesystems/VxFS.cs | 1 + Aaru.Filesystems/XFS.cs | 1 + Aaru.Filesystems/Xia.cs | 1 + Aaru.Filesystems/ZFS.cs | 1 + Aaru.Filesystems/dump.cs | 1 + Aaru.Filesystems/exFAT.cs | 1 + Aaru.Filesystems/ext2FS.cs | 1 + Aaru.Filesystems/extFS.cs | 1 + Aaru.Filters/OffsetStream.cs | 97 +++++++++++-------- Aaru.Filters/SplitJoinStream.cs | 1 + Aaru.Images/Alcohol120/Alcohol120.cs | 1 + Aaru.Images/Anex86/Anex86.cs | 1 + Aaru.Images/Apple2MG/Apple2MG.cs | 1 + Aaru.Images/AppleNIB/AppleNIB.cs | 1 + Aaru.Images/Apridisk/Apridisk.cs | 1 + Aaru.Images/BLU/BLU.cs | 1 + Aaru.Images/BlindWrite4/BlindWrite4.cs | 1 + Aaru.Images/BlindWrite5/BlindWrite5.cs | 1 + Aaru.Images/CDRDAO/Verify.cs | 1 - Aaru.Images/CDRWin/CDRWin.cs | 1 + Aaru.Images/CDRWin/Verify.cs | 1 - Aaru.Images/CHD/Verify.cs | 1 - Aaru.Images/CPCDSK/CPCDSK.cs | 1 + Aaru.Images/CloneCD/CloneCD.cs | 1 + Aaru.Images/CloneCD/Verify.cs | 1 - Aaru.Images/CopyQM/CopyQM.cs | 1 + Aaru.Images/DART/DART.cs | 1 + Aaru.Images/DIM/DIM.cs | 1 + Aaru.Images/DiskCopy42/DiskCopy42.cs | 1 + Aaru.Images/DiskDupe/DiskDupe.cs | 1 + Aaru.Images/DriDiskCopy/DriDiskCopy.cs | 1 + Aaru.Images/NDIF/NDIF.cs | 1 + Aaru.Images/NHDr0/NHDr0.cs | 1 + Aaru.Images/Nero/Nero.cs | 1 + Aaru.Images/QCOW/QCOW.cs | 1 + Aaru.Images/RayDIM/RayDIM.cs | 1 + Aaru.Images/RsIde/RsIde.cs | 1 + Aaru.Images/SaveDskF/SaveDskF.cs | 1 + Aaru.Images/UkvFdi/UkvFdi.cs | 1 + Aaru.Images/VDI/VDI.cs | 1 + Aaru.Images/VHDX/VHDX.cs | 1 + Aaru.Images/VMware/VMware.cs | 1 + Aaru.Partitions/Acorn.cs | 1 + Aaru.Partitions/AppleMap.cs | 1 + Aaru.Partitions/Apricot.cs | 1 + Aaru.Partitions/Atari.cs | 1 + Aaru.Partitions/BSD.cs | 1 + Aaru.Partitions/DEC.cs | 1 + Aaru.Partitions/DragonFlyBSD.cs | 1 + Aaru.Partitions/GPT.cs | 1 + Aaru.Partitions/Human68k.cs | 1 + Aaru.Partitions/MBR.cs | 1 + Aaru.Partitions/NeXT.cs | 1 + Aaru.Partitions/PC98.cs | 1 + Aaru.Partitions/Plan9.cs | 1 + Aaru.Partitions/RDB.cs | 1 + Aaru.Partitions/RioKarma.cs | 1 + Aaru.Partitions/SGI.cs | 1 + Aaru.Partitions/Sun.cs | 1 + Aaru.Partitions/UNIX.cs | 1 + Aaru.Partitions/VTOC.cs | 1 + Aaru.Partitions/XENIX.cs | 1 + Aaru.Partitions/Xbox.cs | 1 + Aaru.Tests/Structs.cs | 1 + Aaru.sln.DotSettings | 1 + 136 files changed, 193 insertions(+), 51 deletions(-) diff --git a/Aaru.Database/Context.cs b/Aaru.Database/Context.cs index 07edcd6f3..8b4a81c30 100644 --- a/Aaru.Database/Context.cs +++ b/Aaru.Database/Context.cs @@ -41,6 +41,7 @@ namespace Aaru.Database /// public sealed class AaruContext : DbContext { + /// /// /// Creates a database context with the specified options /// diff --git a/Aaru.Database/ContextFactory.cs b/Aaru.Database/ContextFactory.cs index bed05c9fc..3e90e35e2 100644 --- a/Aaru.Database/ContextFactory.cs +++ b/Aaru.Database/ContextFactory.cs @@ -34,11 +34,13 @@ using Microsoft.EntityFrameworkCore.Design; namespace Aaru.Database { + /// /// /// Database context factory, for design time /// public class AaruContextFactory : IDesignTimeDbContextFactory { + /// /// /// Creates a database context /// diff --git a/Aaru.Database/Models/BaseOperatingSystem.cs b/Aaru.Database/Models/BaseOperatingSystem.cs index 5092793f5..275b95f0c 100644 --- a/Aaru.Database/Models/BaseOperatingSystem.cs +++ b/Aaru.Database/Models/BaseOperatingSystem.cs @@ -32,6 +32,7 @@ namespace Aaru.Database.Models { + /// /// /// Operating system statistics /// diff --git a/Aaru.Database/Models/Command.cs b/Aaru.Database/Models/Command.cs index 4455de1cb..37f1424aa 100644 --- a/Aaru.Database/Models/Command.cs +++ b/Aaru.Database/Models/Command.cs @@ -32,6 +32,7 @@ namespace Aaru.Database.Models { + /// /// /// Command statistics. /// diff --git a/Aaru.Database/Models/DeviceStat.cs b/Aaru.Database/Models/DeviceStat.cs index d4e0211a6..205941e00 100644 --- a/Aaru.Database/Models/DeviceStat.cs +++ b/Aaru.Database/Models/DeviceStat.cs @@ -32,6 +32,7 @@ namespace Aaru.Database.Models { + /// /// /// Device found in usage /// diff --git a/Aaru.Database/Models/Filesystem.cs b/Aaru.Database/Models/Filesystem.cs index 6a3117c8d..09d0158f6 100644 --- a/Aaru.Database/Models/Filesystem.cs +++ b/Aaru.Database/Models/Filesystem.cs @@ -32,6 +32,7 @@ namespace Aaru.Database.Models { + /// /// /// Filesystem found /// diff --git a/Aaru.Database/Models/Filter.cs b/Aaru.Database/Models/Filter.cs index 354713c31..2e0b8d4db 100644 --- a/Aaru.Database/Models/Filter.cs +++ b/Aaru.Database/Models/Filter.cs @@ -32,6 +32,7 @@ namespace Aaru.Database.Models { + /// /// /// Filter used /// diff --git a/Aaru.Database/Models/Media.cs b/Aaru.Database/Models/Media.cs index 10c7d8a5b..9231052ad 100644 --- a/Aaru.Database/Models/Media.cs +++ b/Aaru.Database/Models/Media.cs @@ -32,6 +32,7 @@ namespace Aaru.Database.Models { + /// /// /// Media type found /// diff --git a/Aaru.Database/Models/MediaFormat.cs b/Aaru.Database/Models/MediaFormat.cs index 8f9da5dec..9cc0ed03c 100644 --- a/Aaru.Database/Models/MediaFormat.cs +++ b/Aaru.Database/Models/MediaFormat.cs @@ -32,6 +32,7 @@ namespace Aaru.Database.Models { + /// /// /// Media image format /// diff --git a/Aaru.Database/Models/NameCountModel.cs b/Aaru.Database/Models/NameCountModel.cs index 874396209..b4cd4ed79 100644 --- a/Aaru.Database/Models/NameCountModel.cs +++ b/Aaru.Database/Models/NameCountModel.cs @@ -32,6 +32,7 @@ namespace Aaru.Database.Models { + /// /// /// Model for name-count values. /// diff --git a/Aaru.Database/Models/OperatingSystem.cs b/Aaru.Database/Models/OperatingSystem.cs index 697cb771b..59a9bdb99 100644 --- a/Aaru.Database/Models/OperatingSystem.cs +++ b/Aaru.Database/Models/OperatingSystem.cs @@ -32,6 +32,7 @@ namespace Aaru.Database.Models { + /// /// /// Operating system /// diff --git a/Aaru.Database/Models/Partition.cs b/Aaru.Database/Models/Partition.cs index eecebf11d..8d207117d 100644 --- a/Aaru.Database/Models/Partition.cs +++ b/Aaru.Database/Models/Partition.cs @@ -32,6 +32,7 @@ namespace Aaru.Database.Models { + /// /// /// Partitioning scheme /// diff --git a/Aaru.Database/Models/RemoteApplication.cs b/Aaru.Database/Models/RemoteApplication.cs index 4b48b5b75..8635e75be 100644 --- a/Aaru.Database/Models/RemoteApplication.cs +++ b/Aaru.Database/Models/RemoteApplication.cs @@ -32,6 +32,7 @@ namespace Aaru.Database.Models { + /// /// /// Remote application /// diff --git a/Aaru.Database/Models/RemoteArchitecture.cs b/Aaru.Database/Models/RemoteArchitecture.cs index 75df98a8b..423f264b7 100644 --- a/Aaru.Database/Models/RemoteArchitecture.cs +++ b/Aaru.Database/Models/RemoteArchitecture.cs @@ -32,6 +32,7 @@ namespace Aaru.Database.Models { + /// /// /// Remote architecture /// diff --git a/Aaru.Database/Models/RemoteOperatingSystem.cs b/Aaru.Database/Models/RemoteOperatingSystem.cs index 0da5e617f..42b8d2a68 100644 --- a/Aaru.Database/Models/RemoteOperatingSystem.cs +++ b/Aaru.Database/Models/RemoteOperatingSystem.cs @@ -32,6 +32,7 @@ namespace Aaru.Database.Models { + /// /// /// Remote operating system /// diff --git a/Aaru.Devices/Device/DeviceException.cs b/Aaru.Devices/Device/DeviceException.cs index 5169146c1..0d8b618e1 100644 --- a/Aaru.Devices/Device/DeviceException.cs +++ b/Aaru.Devices/Device/DeviceException.cs @@ -34,6 +34,7 @@ using System; namespace Aaru.Devices { + /// /// Exception to be returned by the device constructor public sealed class DeviceException : Exception { diff --git a/Aaru.Filesystems/AODOS.cs b/Aaru.Filesystems/AODOS.cs index dab05ecb6..61a8d72ff 100644 --- a/Aaru.Filesystems/AODOS.cs +++ b/Aaru.Filesystems/AODOS.cs @@ -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 + /// /// /// Implements detection of the AO-DOS filesystem /// diff --git a/Aaru.Filesystems/APFS.cs b/Aaru.Filesystems/APFS.cs index 06d906e3a..f714785ca 100644 --- a/Aaru.Filesystems/APFS.cs +++ b/Aaru.Filesystems/APFS.cs @@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the Apple File System (APFS) /// diff --git a/Aaru.Filesystems/Acorn.cs b/Aaru.Filesystems/Acorn.cs index 0c466d197..de633983e 100644 --- a/Aaru.Filesystems/Acorn.cs +++ b/Aaru.Filesystems/Acorn.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of Acorn's Advanced Data Filing System (ADFS) /// diff --git a/Aaru.Filesystems/AmigaDOS.cs b/Aaru.Filesystems/AmigaDOS.cs index d0e8f53a0..65a06437b 100644 --- a/Aaru.Filesystems/AmigaDOS.cs +++ b/Aaru.Filesystems/AmigaDOS.cs @@ -44,6 +44,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of Amiga Fast File System (AFFS) /// diff --git a/Aaru.Filesystems/AppleDOS/AppleDOS.cs b/Aaru.Filesystems/AppleDOS/AppleDOS.cs index fb64ab081..e48d71e69 100644 --- a/Aaru.Filesystems/AppleDOS/AppleDOS.cs +++ b/Aaru.Filesystems/AppleDOS/AppleDOS.cs @@ -38,6 +38,7 @@ using Schemas; namespace Aaru.Filesystems { + /// /// /// Implements the Apple DOS 3 filesystem /// diff --git a/Aaru.Filesystems/AppleHFS/AppleHFS.cs b/Aaru.Filesystems/AppleHFS/AppleHFS.cs index b52b5671d..f817e1ad5 100644 --- a/Aaru.Filesystems/AppleHFS/AppleHFS.cs +++ b/Aaru.Filesystems/AppleHFS/AppleHFS.cs @@ -40,6 +40,7 @@ namespace Aaru.Filesystems { // Information from Inside Macintosh // https://developer.apple.com/legacy/library/documentation/mac/pdf/Files/File_Manager.pdf + /// /// /// Implements detection of the Apple Hierarchical File System (HFS) /// diff --git a/Aaru.Filesystems/AppleHFSPlus.cs b/Aaru.Filesystems/AppleHFSPlus.cs index da5ba135b..b38dca856 100644 --- a/Aaru.Filesystems/AppleHFSPlus.cs +++ b/Aaru.Filesystems/AppleHFSPlus.cs @@ -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 + /// /// /// Implements detection of Apple Hierarchical File System Plus (HFS+) /// diff --git a/Aaru.Filesystems/AtheOS.cs b/Aaru.Filesystems/AtheOS.cs index 942c82b17..37a7ca173 100644 --- a/Aaru.Filesystems/AtheOS.cs +++ b/Aaru.Filesystems/AtheOS.cs @@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection for the AtheOS filesystem /// diff --git a/Aaru.Filesystems/BFS.cs b/Aaru.Filesystems/BFS.cs index 670086b69..9893e6b07 100644 --- a/Aaru.Filesystems/BFS.cs +++ b/Aaru.Filesystems/BFS.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { // Information from Practical Filesystem Design, ISBN 1-55860-497-9 + /// /// /// Implements detection of the Be (new) filesystem /// diff --git a/Aaru.Filesystems/BTRFS.cs b/Aaru.Filesystems/BTRFS.cs index 65dc162ad..8d1aba972 100644 --- a/Aaru.Filesystems/BTRFS.cs +++ b/Aaru.Filesystems/BTRFS.cs @@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the b-tree filesystem (btrfs) /// diff --git a/Aaru.Filesystems/CBM.cs b/Aaru.Filesystems/CBM.cs index 2abf2c342..a29e1c925 100644 --- a/Aaru.Filesystems/CBM.cs +++ b/Aaru.Filesystems/CBM.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the filesystem used in 8-bit Commodore microcomputers /// diff --git a/Aaru.Filesystems/CPM/CPM.cs b/Aaru.Filesystems/CPM/CPM.cs index aca9b866d..1e0642641 100644 --- a/Aaru.Filesystems/CPM/CPM.cs +++ b/Aaru.Filesystems/CPM/CPM.cs @@ -39,6 +39,7 @@ using Schemas; namespace Aaru.Filesystems { + /// /// /// Implements the CP/M filesystem /// diff --git a/Aaru.Filesystems/Cram.cs b/Aaru.Filesystems/Cram.cs index b1fc192cb..9f9df9d35 100644 --- a/Aaru.Filesystems/Cram.cs +++ b/Aaru.Filesystems/Cram.cs @@ -44,6 +44,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the CRAM filesystem /// diff --git a/Aaru.Filesystems/ECMA67.cs b/Aaru.Filesystems/ECMA67.cs index 0f0530a0c..f72a323de 100644 --- a/Aaru.Filesystems/ECMA67.cs +++ b/Aaru.Filesystems/ECMA67.cs @@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the filesystem described in ECMA-67 /// diff --git a/Aaru.Filesystems/EFS.cs b/Aaru.Filesystems/EFS.cs index a7e9ae618..9e3d93c80 100644 --- a/Aaru.Filesystems/EFS.cs +++ b/Aaru.Filesystems/EFS.cs @@ -44,6 +44,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements identification for the SGI Extent FileSystem /// diff --git a/Aaru.Filesystems/F2FS.cs b/Aaru.Filesystems/F2FS.cs index e578e2459..09474263c 100644 --- a/Aaru.Filesystems/F2FS.cs +++ b/Aaru.Filesystems/F2FS.cs @@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the Flash-Friendly File System (F2FS) /// diff --git a/Aaru.Filesystems/FAT/FAT.cs b/Aaru.Filesystems/FAT/FAT.cs index b77da744b..519cf2ea3 100644 --- a/Aaru.Filesystems/FAT/FAT.cs +++ b/Aaru.Filesystems/FAT/FAT.cs @@ -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 + /// /// /// Implements the File Allocation Table, aka FAT, filesystem (FAT12, FAT16 and FAT32 variants). /// diff --git a/Aaru.Filesystems/FATX/FATX.cs b/Aaru.Filesystems/FATX/FATX.cs index 376fccaab..f10cb5267 100644 --- a/Aaru.Filesystems/FATX/FATX.cs +++ b/Aaru.Filesystems/FATX/FATX.cs @@ -40,6 +40,7 @@ using Schemas; namespace Aaru.Filesystems { + /// /// /// Implements the Xbox File Allocation Table (FATX or XTAF) filesystem. /// diff --git a/Aaru.Filesystems/FFS.cs b/Aaru.Filesystems/FFS.cs index f8c1a08fb..e9dd37701 100644 --- a/Aaru.Filesystems/FFS.cs +++ b/Aaru.Filesystems/FFS.cs @@ -47,6 +47,7 @@ using ufs_daddr_t = System.Int32; namespace Aaru.Filesystems { // Using information from Linux kernel headers + /// /// /// Implements detection of BSD Fast File System (FFS, aka UNIX File System) /// diff --git a/Aaru.Filesystems/Fossil.cs b/Aaru.Filesystems/Fossil.cs index 53348f2c3..6a05c1f63 100644 --- a/Aaru.Filesystems/Fossil.cs +++ b/Aaru.Filesystems/Fossil.cs @@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection for the Plan-9 Fossil on-disk filesystem /// diff --git a/Aaru.Filesystems/HAMMER.cs b/Aaru.Filesystems/HAMMER.cs index c307e44a0..1dacdf124 100644 --- a/Aaru.Filesystems/HAMMER.cs +++ b/Aaru.Filesystems/HAMMER.cs @@ -47,6 +47,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection for the HAMMER filesystem /// diff --git a/Aaru.Filesystems/HPFS.cs b/Aaru.Filesystems/HPFS.cs index 44a529f1c..f529fba67 100644 --- a/Aaru.Filesystems/HPFS.cs +++ b/Aaru.Filesystems/HPFS.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { // Information from an old unnamed document + /// /// /// Implements detection of IBM's High Performance File System (HPFS) /// diff --git a/Aaru.Filesystems/HPOFS/HPOFS.cs b/Aaru.Filesystems/HPOFS/HPOFS.cs index fbbd7124d..23a37fce7 100644 --- a/Aaru.Filesystems/HPOFS/HPOFS.cs +++ b/Aaru.Filesystems/HPOFS/HPOFS.cs @@ -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 + /// /// /// Implements identification of IBM's High Performance Optical File System /// diff --git a/Aaru.Filesystems/ISO9660/ISO9660.cs b/Aaru.Filesystems/ISO9660/ISO9660.cs index 29494689f..81790ec8e 100644 --- a/Aaru.Filesystems/ISO9660/ISO9660.cs +++ b/Aaru.Filesystems/ISO9660/ISO9660.cs @@ -42,6 +42,7 @@ using Schemas; namespace Aaru.Filesystems { // This is coded following ECMA-119. + /// /// /// Implements the High Sierra, ISO9660 and CD-i filesystems /// diff --git a/Aaru.Filesystems/JFS.cs b/Aaru.Filesystems/JFS.cs index fb563e368..8d8de2abe 100644 --- a/Aaru.Filesystems/JFS.cs +++ b/Aaru.Filesystems/JFS.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of IBM's Journaled File System /// diff --git a/Aaru.Filesystems/LIF.cs b/Aaru.Filesystems/LIF.cs index c2a57fcf5..3055cc87a 100644 --- a/Aaru.Filesystems/LIF.cs +++ b/Aaru.Filesystems/LIF.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { // Information from http://www.hp9845.net/9845/projects/hpdir/#lif_filesystem + /// /// /// Implements detection of the LIF filesystem /// diff --git a/Aaru.Filesystems/LisaFS/LisaFS.cs b/Aaru.Filesystems/LisaFS/LisaFS.cs index 51b6a66a4..61874bcb9 100644 --- a/Aaru.Filesystems/LisaFS/LisaFS.cs +++ b/Aaru.Filesystems/LisaFS/LisaFS.cs @@ -40,6 +40,7 @@ namespace Aaru.Filesystems.LisaFS { // All information by Natalia Portillo // Variable names from Lisa API + /// /// /// Implements the Apple Lisa File System /// diff --git a/Aaru.Filesystems/Locus.cs b/Aaru.Filesystems/Locus.cs index 416bb8d57..0128c064d 100644 --- a/Aaru.Filesystems/Locus.cs +++ b/Aaru.Filesystems/Locus.cs @@ -67,6 +67,7 @@ using time_t = System.Int32; namespace Aaru.Filesystems { + /// /// /// Implements detection of the Locus filesystem /// diff --git a/Aaru.Filesystems/MicroDOS.cs b/Aaru.Filesystems/MicroDOS.cs index 150429cd7..841eacea5 100644 --- a/Aaru.Filesystems/MicroDOS.cs +++ b/Aaru.Filesystems/MicroDOS.cs @@ -43,12 +43,12 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { - /// - /// Implements detection for the MicroDOS filesystem. - /// - /// Information from http://www.owg.ru/mkt/BK/MKDOS.TXT - /// Thanks to tarlabnor for translating it - /// + /// + /// + /// Implements detection for the MicroDOS filesystem. + /// Information from http://www.owg.ru/mkt/BK/MKDOS.TXT + /// Thanks to tarlabnor for translating it + /// public sealed class MicroDOS : IFilesystem { const ushort MAGIC = 0xA72E; diff --git a/Aaru.Filesystems/MinixFS.cs b/Aaru.Filesystems/MinixFS.cs index d6ccd58b0..408fa831e 100644 --- a/Aaru.Filesystems/MinixFS.cs +++ b/Aaru.Filesystems/MinixFS.cs @@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { // Information from the Linux kernel + /// /// /// Implements detection of the MINIX filesystem /// diff --git a/Aaru.Filesystems/NILFS2.cs b/Aaru.Filesystems/NILFS2.cs index f143c3907..e9056d001 100644 --- a/Aaru.Filesystems/NILFS2.cs +++ b/Aaru.Filesystems/NILFS2.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the New Implementation of a Log-structured File System v2 /// diff --git a/Aaru.Filesystems/NTFS.cs b/Aaru.Filesystems/NTFS.cs index 8e4f6487b..a25c916c4 100644 --- a/Aaru.Filesystems/NTFS.cs +++ b/Aaru.Filesystems/NTFS.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { // Information from Inside Windows NT + /// /// /// Implements detection of the New Technology File System (NTFS) /// diff --git a/Aaru.Filesystems/Nintendo.cs b/Aaru.Filesystems/Nintendo.cs index e6ad57f0d..59eda1489 100644 --- a/Aaru.Filesystems/Nintendo.cs +++ b/Aaru.Filesystems/Nintendo.cs @@ -40,6 +40,7 @@ using Schemas; namespace Aaru.Filesystems { + /// /// /// Implements detection of the filesystem used by Nintendo Gamecube and Wii discs /// diff --git a/Aaru.Filesystems/ODS.cs b/Aaru.Filesystems/ODS.cs index 9382c1b72..d65eb2ab3 100644 --- a/Aaru.Filesystems/ODS.cs +++ b/Aaru.Filesystems/ODS.cs @@ -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 + /// /// /// Implements detection of DEC's On-Disk Structure, aka the ODS filesystem /// diff --git a/Aaru.Filesystems/Opera/Opera.cs b/Aaru.Filesystems/Opera/Opera.cs index 0129f38a8..374af2718 100644 --- a/Aaru.Filesystems/Opera/Opera.cs +++ b/Aaru.Filesystems/Opera/Opera.cs @@ -39,6 +39,7 @@ using Schemas; namespace Aaru.Filesystems { + /// /// /// Implements the 3DO Opera filesystem /// diff --git a/Aaru.Filesystems/PCEngine.cs b/Aaru.Filesystems/PCEngine.cs index e0dbb5864..61bae5c17 100644 --- a/Aaru.Filesystems/PCEngine.cs +++ b/Aaru.Filesystems/PCEngine.cs @@ -38,6 +38,7 @@ using Schemas; namespace Aaru.Filesystems { + /// /// /// Implements detection of the PC-Engine CD file headers /// diff --git a/Aaru.Filesystems/PCFX.cs b/Aaru.Filesystems/PCFX.cs index 6ac57c49b..9d6adca64 100644 --- a/Aaru.Filesystems/PCFX.cs +++ b/Aaru.Filesystems/PCFX.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { // Not a filesystem, more like an executable header + /// /// /// Implements detection of NEC PC-FX headers /// diff --git a/Aaru.Filesystems/PFS.cs b/Aaru.Filesystems/PFS.cs index 27847df57..6fdccdbe1 100644 --- a/Aaru.Filesystems/PFS.cs +++ b/Aaru.Filesystems/PFS.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the Professional File System /// diff --git a/Aaru.Filesystems/ProDOS.cs b/Aaru.Filesystems/ProDOS.cs index 2fd55d08c..d8829e301 100644 --- a/Aaru.Filesystems/ProDOS.cs +++ b/Aaru.Filesystems/ProDOS.cs @@ -46,6 +46,7 @@ using Encoding = System.Text.Encoding; namespace Aaru.Filesystems { // Information from Apple ProDOS 8 Technical Reference + /// /// /// Implements detection of Apple ProDOS filesystem /// diff --git a/Aaru.Filesystems/QNX4.cs b/Aaru.Filesystems/QNX4.cs index 69cb1cccb..17c61d10d 100644 --- a/Aaru.Filesystems/QNX4.cs +++ b/Aaru.Filesystems/QNX4.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of QNX 4 filesystem /// diff --git a/Aaru.Filesystems/QNX6.cs b/Aaru.Filesystems/QNX6.cs index ade2378ae..f9bb026a0 100644 --- a/Aaru.Filesystems/QNX6.cs +++ b/Aaru.Filesystems/QNX6.cs @@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of QNX 6 filesystem /// diff --git a/Aaru.Filesystems/RBF.cs b/Aaru.Filesystems/RBF.cs index 5bc533d87..d4b9ae4b8 100644 --- a/Aaru.Filesystems/RBF.cs +++ b/Aaru.Filesystems/RBF.cs @@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the Locus filesystem /// diff --git a/Aaru.Filesystems/RT11.cs b/Aaru.Filesystems/RT11.cs index 4109ebad8..d972e1050 100644 --- a/Aaru.Filesystems/RT11.cs +++ b/Aaru.Filesystems/RT11.cs @@ -44,6 +44,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { // Information from http://www.trailing-edge.com/~shoppa/rt11fs/ + /// /// /// Implements detection of the DEC RT-11 filesystem /// diff --git a/Aaru.Filesystems/ReFS.cs b/Aaru.Filesystems/ReFS.cs index 2e8d5643e..a60525f6f 100644 --- a/Aaru.Filesystems/ReFS.cs +++ b/Aaru.Filesystems/ReFS.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of Microsoft's Resilient filesystem (ReFS) /// diff --git a/Aaru.Filesystems/Reiser.cs b/Aaru.Filesystems/Reiser.cs index 2b915361a..ed9018bdd 100644 --- a/Aaru.Filesystems/Reiser.cs +++ b/Aaru.Filesystems/Reiser.cs @@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the Reiser v3 filesystem /// diff --git a/Aaru.Filesystems/Reiser4.cs b/Aaru.Filesystems/Reiser4.cs index 8f59778cb..dec5fc87c 100644 --- a/Aaru.Filesystems/Reiser4.cs +++ b/Aaru.Filesystems/Reiser4.cs @@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the Reiser v4 filesystem /// diff --git a/Aaru.Filesystems/SFS.cs b/Aaru.Filesystems/SFS.cs index 1f2192ee2..228935ff1 100644 --- a/Aaru.Filesystems/SFS.cs +++ b/Aaru.Filesystems/SFS.cs @@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the Smart File System /// diff --git a/Aaru.Filesystems/SolarFS.cs b/Aaru.Filesystems/SolarFS.cs index f720805bb..95b0eec4b 100644 --- a/Aaru.Filesystems/SolarFS.cs +++ b/Aaru.Filesystems/SolarFS.cs @@ -41,6 +41,7 @@ using Schemas; namespace Aaru.Filesystems { // Based on FAT's BPB, cannot find a FAT or directory + /// /// /// Implements detection of the Solar OS filesystem /// diff --git a/Aaru.Filesystems/Squash.cs b/Aaru.Filesystems/Squash.cs index fe7e06562..14f1b8023 100644 --- a/Aaru.Filesystems/Squash.cs +++ b/Aaru.Filesystems/Squash.cs @@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the squash filesystem /// diff --git a/Aaru.Filesystems/SysV.cs b/Aaru.Filesystems/SysV.cs index 25b2014b3..b3adf5c7b 100644 --- a/Aaru.Filesystems/SysV.cs +++ b/Aaru.Filesystems/SysV.cs @@ -44,6 +44,7 @@ using Schemas; namespace Aaru.Filesystems { // Information from the Linux kernel + /// /// /// Implements detection of the UNIX System V filesystem /// diff --git a/Aaru.Filesystems/UCSDPascal/UCSDPascal.cs b/Aaru.Filesystems/UCSDPascal/UCSDPascal.cs index c05121f47..a586d2eb3 100644 --- a/Aaru.Filesystems/UCSDPascal/UCSDPascal.cs +++ b/Aaru.Filesystems/UCSDPascal/UCSDPascal.cs @@ -40,6 +40,7 @@ using Schemas; namespace Aaru.Filesystems.UCSDPascal { // Information from Call-A.P.P.L.E. Pascal Disk Directory Structure + /// /// /// Implements the U.C.S.D. Pascal filesystem /// diff --git a/Aaru.Filesystems/UDF.cs b/Aaru.Filesystems/UDF.cs index 1e25dbb98..37457bbcc 100644 --- a/Aaru.Filesystems/UDF.cs +++ b/Aaru.Filesystems/UDF.cs @@ -45,6 +45,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { // TODO: Detect bootable + /// /// /// Implements detection of the Universal Disk Format filesystem /// diff --git a/Aaru.Filesystems/UNICOS.cs b/Aaru.Filesystems/UNICOS.cs index b68196679..7abcc5aa0 100644 --- a/Aaru.Filesystems/UNICOS.cs +++ b/Aaru.Filesystems/UNICOS.cs @@ -51,6 +51,7 @@ using time_t = System.Int64; namespace Aaru.Filesystems { + /// /// /// Implements detection for the Cray UNICOS filesystem /// diff --git a/Aaru.Filesystems/UNIXBFS.cs b/Aaru.Filesystems/UNIXBFS.cs index 86131ac31..abc7aa7fa 100644 --- a/Aaru.Filesystems/UNIXBFS.cs +++ b/Aaru.Filesystems/UNIXBFS.cs @@ -41,6 +41,7 @@ using Schemas; namespace Aaru.Filesystems { // Information from the Linux kernel + /// /// /// Implements detection of the UNIX boot filesystem /// diff --git a/Aaru.Filesystems/VMfs.cs b/Aaru.Filesystems/VMfs.cs index 397e6c434..b73803bbc 100644 --- a/Aaru.Filesystems/VMfs.cs +++ b/Aaru.Filesystems/VMfs.cs @@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the VMware filesystem /// diff --git a/Aaru.Filesystems/VxFS.cs b/Aaru.Filesystems/VxFS.cs index fca45bf20..b9dca37c7 100644 --- a/Aaru.Filesystems/VxFS.cs +++ b/Aaru.Filesystems/VxFS.cs @@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of the Veritas filesystem /// diff --git a/Aaru.Filesystems/XFS.cs b/Aaru.Filesystems/XFS.cs index 36022e37a..40d8ed971 100644 --- a/Aaru.Filesystems/XFS.cs +++ b/Aaru.Filesystems/XFS.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { + /// /// /// Implements detection of SGI's XFS /// diff --git a/Aaru.Filesystems/Xia.cs b/Aaru.Filesystems/Xia.cs index 1d0c2cde4..ddea4463d 100644 --- a/Aaru.Filesystems/Xia.cs +++ b/Aaru.Filesystems/Xia.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { // Information from the Linux kernel + /// /// /// Implements detection for the Xia filesystem /// diff --git a/Aaru.Filesystems/ZFS.cs b/Aaru.Filesystems/ZFS.cs index fce3574a5..5bb15d6b1 100644 --- a/Aaru.Filesystems/ZFS.cs +++ b/Aaru.Filesystems/ZFS.cs @@ -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. */ + /// /// /// Implements detection for the Zettabyte File System (ZFS) /// diff --git a/Aaru.Filesystems/dump.cs b/Aaru.Filesystems/dump.cs index 781216b2e..d341d6dc0 100644 --- a/Aaru.Filesystems/dump.cs +++ b/Aaru.Filesystems/dump.cs @@ -44,6 +44,7 @@ using ufs_daddr_t = System.Int32; namespace Aaru.Filesystems { + /// /// /// Implements identification of a dump(8) image (virtual filesystem on a file) /// diff --git a/Aaru.Filesystems/exFAT.cs b/Aaru.Filesystems/exFAT.cs index b536da063..c4bc12ae0 100644 --- a/Aaru.Filesystems/exFAT.cs +++ b/Aaru.Filesystems/exFAT.cs @@ -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 + /// /// /// Implements detection of the exFAT filesystem /// diff --git a/Aaru.Filesystems/ext2FS.cs b/Aaru.Filesystems/ext2FS.cs index 3002a048e..4b1ebd959 100644 --- a/Aaru.Filesystems/ext2FS.cs +++ b/Aaru.Filesystems/ext2FS.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Filesystems { // Information from the Linux kernel + /// /// /// Implements detection of the Linux extended filesystem v2, v3 and v4 /// diff --git a/Aaru.Filesystems/extFS.cs b/Aaru.Filesystems/extFS.cs index 0518516ec..8e09b0a74 100644 --- a/Aaru.Filesystems/extFS.cs +++ b/Aaru.Filesystems/extFS.cs @@ -40,6 +40,7 @@ using Schemas; namespace Aaru.Filesystems { // Information from the Linux kernel + /// /// /// Implements detection of the Linux extended filesystem /// diff --git a/Aaru.Filters/OffsetStream.cs b/Aaru.Filters/OffsetStream.cs index a9bb2b1bd..6cddb784f 100644 --- a/Aaru.Filters/OffsetStream.cs +++ b/Aaru.Filters/OffsetStream.cs @@ -48,13 +48,14 @@ namespace Aaru.Filters readonly long _streamEnd; readonly long _streamStart; + /// /// - /// Initializes a stream that only allows reading from to of the specified stream, both inclusive. + /// Initializes a stream that only allows reading from to of the specified stream, both inclusive. /// /// Base stream /// Start position /// Last readable position - /// Invalid range + /// Invalid range public OffsetStream(Stream stream, long start, long end) { if(start < 0) @@ -74,18 +75,19 @@ namespace Aaru.Filters _baseStream.Position = start; } + /// /// - /// Initializes a stream that only allows reading from to of the specified file, both inclusive. + /// Initializes a stream that only allows reading from to of the specified file, both inclusive. /// /// A relative or absolute path for the file that the stream will encapsulate. /// One of the enumeration values that determines how to open or create the file. - /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. + /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. /// A bitwise combination of the enumeration values that determines how the file will be shared by processes. /// A positive Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096. /// A bitwise combination of the enumeration values that specifies additional file options. /// Start position /// Last readable position - /// Invalid range + /// Invalid range 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; } + /// /// - /// Initializes a stream that only allows reading from to of the specified file, both inclusive. + /// Initializes a stream that only allows reading from to of the specified file, both inclusive. /// /// A file handle for the file that the stream will encapsulate. - /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. + /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. /// Start position /// Last readable position - /// Invalid range + /// Invalid range public OffsetStream(SafeFileHandle handle, FileAccess access, long start, long end) { if(start < 0) @@ -133,15 +136,16 @@ namespace Aaru.Filters _baseStream.Position = start; } + /// /// - /// Initializes a stream that only allows reading from to of the specified file, both inclusive. + /// Initializes a stream that only allows reading from to of the specified file, both inclusive. /// /// A file handle for the file that the stream will encapsulate. - /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. + /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. /// A positive Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096. /// Start position /// Last readable position - /// Invalid range + /// Invalid range 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; } + /// /// - /// Initializes a stream that only allows reading from to of the specified file, both inclusive. + /// Initializes a stream that only allows reading from to of the specified file, both inclusive. /// /// A file handle for the file that the stream will encapsulate. - /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. + /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. /// A positive Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096. /// Specifies whether to use asynchronous I/O or synchronous I/O. /// Start position /// Last readable position - /// Invalid range + /// Invalid range public OffsetStream(SafeFileHandle handle, FileAccess access, int bufferSize, bool isAsync, long start, long end) { @@ -191,18 +196,19 @@ namespace Aaru.Filters _baseStream.Position = start; } + /// /// - /// Initializes a stream that only allows reading from to of the specified file, both inclusive. + /// Initializes a stream that only allows reading from to of the specified file, both inclusive. /// /// A relative or absolute path for the file that the stream will encapsulate. /// One of the enumeration values that determines how to open or create the file. - /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. + /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. /// A bitwise combination of the enumeration values that determines how the file will be shared by processes. /// A positive Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096. /// Specifies whether to use asynchronous I/O or synchronous I/O. /// Start position /// Last readable position - /// Invalid range + /// Invalid range 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; } + /// /// - /// Initializes a stream that only allows reading from to of the specified file, both inclusive. + /// Initializes a stream that only allows reading from to of the specified file, both inclusive. /// /// A relative or absolute path for the file that the stream will encapsulate. /// One of the enumeration values that determines how to open or create the file. - /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. + /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. /// A bitwise combination of the enumeration values that determines how the file will be shared by processes. /// A positive Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096. /// Start position /// Last readable position - /// Invalid range + /// Invalid range 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; } + /// /// - /// Initializes a stream that only allows reading from to of the specified file, both inclusive. + /// Initializes a stream that only allows reading from to of the specified file, both inclusive. /// /// A relative or absolute path for the file that the stream will encapsulate. /// One of the enumeration values that determines how to open or create the file. - /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. + /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. /// A bitwise combination of the enumeration values that determines how the file will be shared by processes. /// Start position /// Last readable position - /// Invalid range + /// Invalid range 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; } + /// /// - /// Initializes a stream that only allows reading from to of the specified file, both inclusive. + /// Initializes a stream that only allows reading from to of the specified file, both inclusive. /// /// A relative or absolute path for the file that the stream will encapsulate. /// One of the enumeration values that determines how to open or create the file. - /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. + /// A bitwise combination of the enumeration values that determines how the file can be accessed by a object. /// Start position /// Last readable position - /// Invalid range + /// Invalid range 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; } + /// /// - /// Initializes a stream that only allows reading from to of the specified file, both inclusive. + /// Initializes a stream that only allows reading from to of the specified file, both inclusive. /// /// A relative or absolute path for the file that the stream will encapsulate. /// One of the enumeration values that determines how to open or create the file. /// Start position /// Last readable position - /// Invalid range + /// Invalid range public OffsetStream(string path, FileMode mode, long start, long end) { if(start < 0) @@ -338,17 +348,18 @@ namespace Aaru.Filters _baseStream.Position = start; } + /// /// - /// Initializes a stream that only allows reading from to of the specified byte array, both inclusive. + /// Initializes a stream that only allows reading from to of the specified byte array, both inclusive. /// /// The array of unsigned bytes to add at the end of this stream. - /// The index into at which the stream begins. + /// The index into at which the stream begins. /// The length in bytes to add to the end of the current stream. /// The setting of the CanWrite property, currently ignored. /// Currently ignored. /// Start position /// Last readable position - /// Invalid range + /// Invalid range 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; } + /// /// - /// Initializes a stream that only allows reading from to of the specified byte array, both inclusive. + /// Initializes a stream that only allows reading from to of the specified byte array, both inclusive. /// /// The array of unsigned bytes to add at the end of this stream. - /// The index into at which the stream begins. + /// The index into at which the stream begins. /// The length in bytes to add to the end of the current stream. /// The setting of the CanWrite property, currently ignored. /// Start position /// Last readable position - /// Invalid range + /// Invalid range 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; } + /// /// - /// Initializes a stream that only allows reading from to of the specified byte array, both inclusive. + /// Initializes a stream that only allows reading from to of the specified byte array, both inclusive. /// /// The array of unsigned bytes to add at the end of this stream. - /// The index into at which the stream begins. + /// The index into at which the stream begins. /// The length in bytes to add to the end of the current stream. /// Start position /// Last readable position - /// Invalid range + /// Invalid range 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; } + /// /// - /// Initializes a stream that only allows reading from to of the specified byte array, both inclusive. + /// Initializes a stream that only allows reading from to of the specified byte array, both inclusive. /// /// The array of unsigned bytes to add at the end of this stream. /// The setting of the CanWrite property, currently ignored. /// Start position /// Last readable position - /// Invalid range + /// Invalid range public OffsetStream(byte[] buffer, bool writable, long start, long end) { if(start < 0) @@ -453,13 +467,14 @@ namespace Aaru.Filters _baseStream.Position = start; } + /// /// - /// Initializes a stream that only allows reading from to of the specified byte array, both inclusive. + /// Initializes a stream that only allows reading from to of the specified byte array, both inclusive. /// /// The array of unsigned bytes to add at the end of this stream. /// Start position /// Last readable position - /// Invalid range + /// Invalid range public OffsetStream(byte[] buffer, long start, long end) { if(start < 0) diff --git a/Aaru.Filters/SplitJoinStream.cs b/Aaru.Filters/SplitJoinStream.cs index 0a47779f3..6dc8b53e8 100644 --- a/Aaru.Filters/SplitJoinStream.cs +++ b/Aaru.Filters/SplitJoinStream.cs @@ -8,6 +8,7 @@ using Microsoft.Win32.SafeHandles; namespace Aaru.Filters { + /// /// /// Implements a stream that joins two or more files (sequentially) as a single stream /// diff --git a/Aaru.Images/Alcohol120/Alcohol120.cs b/Aaru.Images/Alcohol120/Alcohol120.cs index 3299bab85..612a07320 100644 --- a/Aaru.Images/Alcohol120/Alcohol120.cs +++ b/Aaru.Images/Alcohol120/Alcohol120.cs @@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading and writing Alcohol 120% disk images /// diff --git a/Aaru.Images/Anex86/Anex86.cs b/Aaru.Images/Anex86/Anex86.cs index e6637387f..dc8a50d8b 100644 --- a/Aaru.Images/Anex86/Anex86.cs +++ b/Aaru.Images/Anex86/Anex86.cs @@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading and writing Anex-86 disk images /// diff --git a/Aaru.Images/Apple2MG/Apple2MG.cs b/Aaru.Images/Apple2MG/Apple2MG.cs index 0854819eb..c9a6093e0 100644 --- a/Aaru.Images/Apple2MG/Apple2MG.cs +++ b/Aaru.Images/Apple2MG/Apple2MG.cs @@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading and writing XGD emulator disk images /// diff --git a/Aaru.Images/AppleNIB/AppleNIB.cs b/Aaru.Images/AppleNIB/AppleNIB.cs index 342491fd1..93f964acd 100644 --- a/Aaru.Images/AppleNIB/AppleNIB.cs +++ b/Aaru.Images/AppleNIB/AppleNIB.cs @@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { // TODO: Checksum sectors + /// /// /// Implements reading nibbelized Apple II disk images /// diff --git a/Aaru.Images/Apridisk/Apridisk.cs b/Aaru.Images/Apridisk/Apridisk.cs index 1beb7e0b4..ec3c2e09d 100644 --- a/Aaru.Images/Apridisk/Apridisk.cs +++ b/Aaru.Images/Apridisk/Apridisk.cs @@ -39,6 +39,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { // TODO: Check writing + /// /// /// Implements reading and writing Apridisk disk images /// diff --git a/Aaru.Images/BLU/BLU.cs b/Aaru.Images/BLU/BLU.cs index c5e67705d..0e9ef8b14 100644 --- a/Aaru.Images/BLU/BLU.cs +++ b/Aaru.Images/BLU/BLU.cs @@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading Basic Lisa Utility disk images /// diff --git a/Aaru.Images/BlindWrite4/BlindWrite4.cs b/Aaru.Images/BlindWrite4/BlindWrite4.cs index 7689be7c1..71c4f44b0 100644 --- a/Aaru.Images/BlindWrite4/BlindWrite4.cs +++ b/Aaru.Images/BlindWrite4/BlindWrite4.cs @@ -39,6 +39,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { // TODO: Too many unknowns, plus a completely unknown footer, to make this writable + /// /// /// Implements reading BlindWrite 4 disc images /// diff --git a/Aaru.Images/BlindWrite5/BlindWrite5.cs b/Aaru.Images/BlindWrite5/BlindWrite5.cs index 952004f17..506f40410 100644 --- a/Aaru.Images/BlindWrite5/BlindWrite5.cs +++ b/Aaru.Images/BlindWrite5/BlindWrite5.cs @@ -39,6 +39,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { // TODO: Too many unknowns to make this writable + /// /// /// Implements reading BlindWrite 5/6/7 disc images /// diff --git a/Aaru.Images/CDRDAO/Verify.cs b/Aaru.Images/CDRDAO/Verify.cs index 199580a77..570f27172 100644 --- a/Aaru.Images/CDRDAO/Verify.cs +++ b/Aaru.Images/CDRDAO/Verify.cs @@ -114,7 +114,6 @@ namespace Aaru.DiscImages return failingLbas.Count <= 0; } - /// public bool? VerifySector(ulong sectorAddress, uint track) { byte[] buffer = ReadSectorLong(sectorAddress, track); diff --git a/Aaru.Images/CDRWin/CDRWin.cs b/Aaru.Images/CDRWin/CDRWin.cs index 86f66bc1f..7f37d4aa2 100644 --- a/Aaru.Images/CDRWin/CDRWin.cs +++ b/Aaru.Images/CDRWin/CDRWin.cs @@ -40,6 +40,7 @@ using Aaru.Decoders.CD; namespace Aaru.DiscImages { // TODO: Implement track flags + /// /// /// Implements reading and writing CDRWin cuesheet disc images /// diff --git a/Aaru.Images/CDRWin/Verify.cs b/Aaru.Images/CDRWin/Verify.cs index 1071dc47b..2ba73bd8a 100644 --- a/Aaru.Images/CDRWin/Verify.cs +++ b/Aaru.Images/CDRWin/Verify.cs @@ -225,7 +225,6 @@ namespace Aaru.DiscImages return failingLbas.Count <= 0; } - /// public bool? VerifySector(ulong sectorAddress, uint track) { byte[] buffer = ReadSectorLong(sectorAddress, track); diff --git a/Aaru.Images/CHD/Verify.cs b/Aaru.Images/CHD/Verify.cs index 0bbb707c8..0904d151d 100644 --- a/Aaru.Images/CHD/Verify.cs +++ b/Aaru.Images/CHD/Verify.cs @@ -154,7 +154,6 @@ namespace Aaru.DiscImages return _expectedChecksum.SequenceEqual(calculated); } - /// public bool? VerifySector(ulong sectorAddress, uint track) { if(_isHdd) diff --git a/Aaru.Images/CPCDSK/CPCDSK.cs b/Aaru.Images/CPCDSK/CPCDSK.cs index 9be913dc3..5cbd3c9c7 100644 --- a/Aaru.Images/CPCDSK/CPCDSK.cs +++ b/Aaru.Images/CPCDSK/CPCDSK.cs @@ -37,6 +37,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading CPCDSK disk images /// diff --git a/Aaru.Images/CloneCD/CloneCD.cs b/Aaru.Images/CloneCD/CloneCD.cs index 6b2d849dd..03ba8d7ce 100644 --- a/Aaru.Images/CloneCD/CloneCD.cs +++ b/Aaru.Images/CloneCD/CloneCD.cs @@ -39,6 +39,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { // TODO: CloneCD stores subchannel deinterleaved + /// /// /// Implements reading and writing CloneCD disc images /// diff --git a/Aaru.Images/CloneCD/Verify.cs b/Aaru.Images/CloneCD/Verify.cs index a00b0bc92..04242db95 100644 --- a/Aaru.Images/CloneCD/Verify.cs +++ b/Aaru.Images/CloneCD/Verify.cs @@ -114,7 +114,6 @@ namespace Aaru.DiscImages return failingLbas.Count <= 0; } - /// public bool? VerifySector(ulong sectorAddress, uint track) { byte[] buffer = ReadSectorLong(sectorAddress, track); diff --git a/Aaru.Images/CopyQM/CopyQM.cs b/Aaru.Images/CopyQM/CopyQM.cs index 2dd0c4267..821d7914a 100644 --- a/Aaru.Images/CopyQM/CopyQM.cs +++ b/Aaru.Images/CopyQM/CopyQM.cs @@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading CopyQM disk images /// diff --git a/Aaru.Images/DART/DART.cs b/Aaru.Images/DART/DART.cs index fa19d954c..b369cfaa8 100644 --- a/Aaru.Images/DART/DART.cs +++ b/Aaru.Images/DART/DART.cs @@ -37,6 +37,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading Apple DART disk images /// diff --git a/Aaru.Images/DIM/DIM.cs b/Aaru.Images/DIM/DIM.cs index 1af11f90a..bf7aa05cb 100644 --- a/Aaru.Images/DIM/DIM.cs +++ b/Aaru.Images/DIM/DIM.cs @@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { // TODO: What are the real supported floppies for this image format? + /// /// /// Implements reading DIM disk images /// diff --git a/Aaru.Images/DiskCopy42/DiskCopy42.cs b/Aaru.Images/DiskCopy42/DiskCopy42.cs index 709cd27c2..00ecd944a 100644 --- a/Aaru.Images/DiskCopy42/DiskCopy42.cs +++ b/Aaru.Images/DiskCopy42/DiskCopy42.cs @@ -40,6 +40,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { // Checked using several images and strings inside Apple's DiskImages.framework + /// /// /// Implements reading and writing Apple DiskCopy 4.2 disk images /// diff --git a/Aaru.Images/DiskDupe/DiskDupe.cs b/Aaru.Images/DiskDupe/DiskDupe.cs index 24041f22a..7e19da4fe 100644 --- a/Aaru.Images/DiskDupe/DiskDupe.cs +++ b/Aaru.Images/DiskDupe/DiskDupe.cs @@ -64,6 +64,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading DiskDupe disk images /// diff --git a/Aaru.Images/DriDiskCopy/DriDiskCopy.cs b/Aaru.Images/DriDiskCopy/DriDiskCopy.cs index cee6e739e..46dc61cc8 100644 --- a/Aaru.Images/DriDiskCopy/DriDiskCopy.cs +++ b/Aaru.Images/DriDiskCopy/DriDiskCopy.cs @@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading and writing DR-DOS' DISKCOPY disk images /// diff --git a/Aaru.Images/NDIF/NDIF.cs b/Aaru.Images/NDIF/NDIF.cs index b27b18154..a7e76692e 100644 --- a/Aaru.Images/NDIF/NDIF.cs +++ b/Aaru.Images/NDIF/NDIF.cs @@ -42,6 +42,7 @@ namespace Aaru.DiscImages // TODO: Check checksum // TODO: Implement segments // TODO: Implement compression + /// /// /// Implements reading Apple New Disk Image Format disk images /// diff --git a/Aaru.Images/NHDr0/NHDr0.cs b/Aaru.Images/NHDr0/NHDr0.cs index 9b8803b31..ee442950b 100644 --- a/Aaru.Images/NHDr0/NHDr0.cs +++ b/Aaru.Images/NHDr0/NHDr0.cs @@ -39,6 +39,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { // Info from http://www.geocities.jp/t98next/nhdr0.txt + /// /// /// Implements reading and writing T98-Next disk images /// diff --git a/Aaru.Images/Nero/Nero.cs b/Aaru.Images/Nero/Nero.cs index c43c9b11e..b8d89581d 100644 --- a/Aaru.Images/Nero/Nero.cs +++ b/Aaru.Images/Nero/Nero.cs @@ -44,6 +44,7 @@ using Aaru.Decoders.CD; namespace Aaru.DiscImages { + /// /// /// Implements reading Nero Burning ROM disc images /// diff --git a/Aaru.Images/QCOW/QCOW.cs b/Aaru.Images/QCOW/QCOW.cs index 4aa84851e..1abde7add 100644 --- a/Aaru.Images/QCOW/QCOW.cs +++ b/Aaru.Images/QCOW/QCOW.cs @@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading and writing QEMU's Copy On Write disk images /// diff --git a/Aaru.Images/RayDIM/RayDIM.cs b/Aaru.Images/RayDIM/RayDIM.cs index 4dfddf066..08e439f3d 100644 --- a/Aaru.Images/RayDIM/RayDIM.cs +++ b/Aaru.Images/RayDIM/RayDIM.cs @@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading and writing Ray Arachellian's DIM disk images /// diff --git a/Aaru.Images/RsIde/RsIde.cs b/Aaru.Images/RsIde/RsIde.cs index df2b56543..a1a0872df 100644 --- a/Aaru.Images/RsIde/RsIde.cs +++ b/Aaru.Images/RsIde/RsIde.cs @@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading and writing RS-IDE disk images /// diff --git a/Aaru.Images/SaveDskF/SaveDskF.cs b/Aaru.Images/SaveDskF/SaveDskF.cs index 678fa39a6..9e4e37dd4 100644 --- a/Aaru.Images/SaveDskF/SaveDskF.cs +++ b/Aaru.Images/SaveDskF/SaveDskF.cs @@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading and writing IBM's SaveDskF disk images /// diff --git a/Aaru.Images/UkvFdi/UkvFdi.cs b/Aaru.Images/UkvFdi/UkvFdi.cs index 64e05a453..4ca054bde 100644 --- a/Aaru.Images/UkvFdi/UkvFdi.cs +++ b/Aaru.Images/UkvFdi/UkvFdi.cs @@ -37,6 +37,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading UKV FDI disk images /// diff --git a/Aaru.Images/VDI/VDI.cs b/Aaru.Images/VDI/VDI.cs index e809c4c38..1f6391942 100644 --- a/Aaru.Images/VDI/VDI.cs +++ b/Aaru.Images/VDI/VDI.cs @@ -40,6 +40,7 @@ namespace Aaru.DiscImages { // TODO: Support version 0 // TODO: Support fixed images + /// /// /// Implements reading and writing VirtualBox disk images /// diff --git a/Aaru.Images/VHDX/VHDX.cs b/Aaru.Images/VHDX/VHDX.cs index 0d5eea24f..082dfb622 100644 --- a/Aaru.Images/VHDX/VHDX.cs +++ b/Aaru.Images/VHDX/VHDX.cs @@ -41,6 +41,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading Hyper-V disk images /// diff --git a/Aaru.Images/VMware/VMware.cs b/Aaru.Images/VMware/VMware.cs index 44a9a4530..e556b98fa 100644 --- a/Aaru.Images/VMware/VMware.cs +++ b/Aaru.Images/VMware/VMware.cs @@ -38,6 +38,7 @@ using Aaru.CommonTypes.Structs; namespace Aaru.DiscImages { + /// /// /// Implements reading VMware disk images /// diff --git a/Aaru.Partitions/Acorn.cs b/Aaru.Partitions/Acorn.cs index 58935e9ac..bf1669f69 100644 --- a/Aaru.Partitions/Acorn.cs +++ b/Aaru.Partitions/Acorn.cs @@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { + /// /// /// Implements decoding of Acorn partitions /// diff --git a/Aaru.Partitions/AppleMap.cs b/Aaru.Partitions/AppleMap.cs index f36bf827b..df97aa2fa 100644 --- a/Aaru.Partitions/AppleMap.cs +++ b/Aaru.Partitions/AppleMap.cs @@ -45,6 +45,7 @@ namespace Aaru.Partitions { // Information about structures learnt from Inside Macintosh // Constants from image testing + /// /// /// Implements decoding of the Apple Partition Map /// diff --git a/Aaru.Partitions/Apricot.cs b/Aaru.Partitions/Apricot.cs index b3bf45403..16f827dcc 100644 --- a/Aaru.Partitions/Apricot.cs +++ b/Aaru.Partitions/Apricot.cs @@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { + /// /// /// Implements decoding of Apricot partitions /// diff --git a/Aaru.Partitions/Atari.cs b/Aaru.Partitions/Atari.cs index 4a39284c1..823e1c5b3 100644 --- a/Aaru.Partitions/Atari.cs +++ b/Aaru.Partitions/Atari.cs @@ -41,6 +41,7 @@ using Aaru.Helpers; namespace Aaru.Partitions { + /// /// /// Implements decoding of Atari GEMDOS partitions /// diff --git a/Aaru.Partitions/BSD.cs b/Aaru.Partitions/BSD.cs index ae97d774d..966eb0ddd 100644 --- a/Aaru.Partitions/BSD.cs +++ b/Aaru.Partitions/BSD.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { + /// /// /// Implements decoding of BSD disklabels /// diff --git a/Aaru.Partitions/DEC.cs b/Aaru.Partitions/DEC.cs index a1fe78b25..5dec13d51 100644 --- a/Aaru.Partitions/DEC.cs +++ b/Aaru.Partitions/DEC.cs @@ -39,6 +39,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { + /// /// /// Implements decoding of DEC disklabels /// diff --git a/Aaru.Partitions/DragonFlyBSD.cs b/Aaru.Partitions/DragonFlyBSD.cs index 26d069033..8433f9897 100644 --- a/Aaru.Partitions/DragonFlyBSD.cs +++ b/Aaru.Partitions/DragonFlyBSD.cs @@ -40,6 +40,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { + /// /// /// Implements decoding of DragonFly BSD disklabels /// diff --git a/Aaru.Partitions/GPT.cs b/Aaru.Partitions/GPT.cs index cec176662..cfc1b5990 100644 --- a/Aaru.Partitions/GPT.cs +++ b/Aaru.Partitions/GPT.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { + /// /// /// Implements decoding of the GUID Partition Table /// diff --git a/Aaru.Partitions/Human68k.cs b/Aaru.Partitions/Human68k.cs index 030568b40..8a29f51e0 100644 --- a/Aaru.Partitions/Human68k.cs +++ b/Aaru.Partitions/Human68k.cs @@ -42,6 +42,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { + /// /// /// Implements decoding of Sharp's Human68K partitions /// diff --git a/Aaru.Partitions/MBR.cs b/Aaru.Partitions/MBR.cs index f3e7f6c3a..84b427a6d 100644 --- a/Aaru.Partitions/MBR.cs +++ b/Aaru.Partitions/MBR.cs @@ -44,6 +44,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { // TODO: Support AAP extensions + /// /// /// Implements decoding of Intel/Microsoft Master Boot Record and extensions /// diff --git a/Aaru.Partitions/NeXT.cs b/Aaru.Partitions/NeXT.cs index 6c10123ad..20f2e0b78 100644 --- a/Aaru.Partitions/NeXT.cs +++ b/Aaru.Partitions/NeXT.cs @@ -45,6 +45,7 @@ using Marshal = Aaru.Helpers.Marshal; // Information learnt from XNU source and testing against real disks namespace Aaru.Partitions { + /// /// /// Implements decoding of NeXT disklabels /// diff --git a/Aaru.Partitions/PC98.cs b/Aaru.Partitions/PC98.cs index cd3eb7672..5b5e35ec4 100644 --- a/Aaru.Partitions/PC98.cs +++ b/Aaru.Partitions/PC98.cs @@ -41,6 +41,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { + /// /// /// Implements decoding of NEC PC-9800 partitions /// diff --git a/Aaru.Partitions/Plan9.cs b/Aaru.Partitions/Plan9.cs index 0923ace4f..3ae18dae1 100644 --- a/Aaru.Partitions/Plan9.cs +++ b/Aaru.Partitions/Plan9.cs @@ -44,6 +44,7 @@ namespace Aaru.Partitions // "part type start end\n" // One line per partition, start and end relative to offset // e.g.: "part nvram 10110 10112\npart fossil 10112 3661056\n" + /// /// /// Implements decoding of Plan-9 partitions /// diff --git a/Aaru.Partitions/RDB.cs b/Aaru.Partitions/RDB.cs index 1eabdd183..e6c73b907 100644 --- a/Aaru.Partitions/RDB.cs +++ b/Aaru.Partitions/RDB.cs @@ -45,6 +45,7 @@ using Aaru.Helpers; namespace Aaru.Partitions { + /// /// /// Implements decoding of the Amiga Rigid Disk Block /// diff --git a/Aaru.Partitions/RioKarma.cs b/Aaru.Partitions/RioKarma.cs index 418d9dc19..c98b3cf61 100644 --- a/Aaru.Partitions/RioKarma.cs +++ b/Aaru.Partitions/RioKarma.cs @@ -40,6 +40,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { + /// /// /// Implements decoding of Rio Karma partitions /// diff --git a/Aaru.Partitions/SGI.cs b/Aaru.Partitions/SGI.cs index 48b74f598..9c423790f 100644 --- a/Aaru.Partitions/SGI.cs +++ b/Aaru.Partitions/SGI.cs @@ -44,6 +44,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { + /// /// /// Implements decoding of the SGI Disk Volume Header /// diff --git a/Aaru.Partitions/Sun.cs b/Aaru.Partitions/Sun.cs index 3587854d3..b525b0e95 100644 --- a/Aaru.Partitions/Sun.cs +++ b/Aaru.Partitions/Sun.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { + /// /// /// Implements decoding of Sun disklabels /// diff --git a/Aaru.Partitions/UNIX.cs b/Aaru.Partitions/UNIX.cs index 3105f303e..575b40962 100644 --- a/Aaru.Partitions/UNIX.cs +++ b/Aaru.Partitions/UNIX.cs @@ -41,6 +41,7 @@ namespace Aaru.Partitions // These partitions are hardwired in kernel sources for some UNIX versions predating System V. // They depend on exact device, indeed the kernel chooses what to use depending on the disk driver, so that's what we do. // Currently only DEC devices used in Ultrix are added, probably it's missing a lot of entries. + /// /// /// Implements decoding of historic UNIX static partitions /// diff --git a/Aaru.Partitions/VTOC.cs b/Aaru.Partitions/VTOC.cs index 84a73d81d..07537ff37 100644 --- a/Aaru.Partitions/VTOC.cs +++ b/Aaru.Partitions/VTOC.cs @@ -43,6 +43,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { + /// /// /// Implements decoding of UNIX VTOC partitions /// diff --git a/Aaru.Partitions/XENIX.cs b/Aaru.Partitions/XENIX.cs index c1402a64e..5dba42455 100644 --- a/Aaru.Partitions/XENIX.cs +++ b/Aaru.Partitions/XENIX.cs @@ -40,6 +40,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { // TODO: Find better documentation, this is working for XENIX 2 but not for SCO OpenServer... + /// /// /// Implements decoding of XENIX partitions /// diff --git a/Aaru.Partitions/Xbox.cs b/Aaru.Partitions/Xbox.cs index a3b36a4ca..98499d27d 100644 --- a/Aaru.Partitions/Xbox.cs +++ b/Aaru.Partitions/Xbox.cs @@ -40,6 +40,7 @@ using Marshal = Aaru.Helpers.Marshal; namespace Aaru.Partitions { + /// /// /// Implements decoding of Xbox partitions /// diff --git a/Aaru.Tests/Structs.cs b/Aaru.Tests/Structs.cs index 1eec6a365..d410ce3b4 100644 --- a/Aaru.Tests/Structs.cs +++ b/Aaru.Tests/Structs.cs @@ -20,6 +20,7 @@ namespace Aaru.Tests public override string ToString() => TestFile; } + /// /// Class to define expected data when testing filesystem info public class FileSystemTest : MediaInfoTest { diff --git a/Aaru.sln.DotSettings b/Aaru.sln.DotSettings index 6b9d815e5..c87398c8f 100644 --- a/Aaru.sln.DotSettings +++ b/Aaru.sln.DotSettings @@ -193,6 +193,7 @@ FS HAMMER HPFS + HPOFS ISO JFS LBA