From 90ffe6950eea3a0f3d88b2fab644b07485e44b67 Mon Sep 17 00:00:00 2001 From: Natalia Portillo Date: Wed, 11 Mar 2020 21:56:46 +0000 Subject: [PATCH] Complete file headers. --- Enums/DeviceType.cs | 2 +- Interfaces/IArchive.cs | 2 +- Interfaces/IFloppyImage.cs | 2 +- Interfaces/IOpticalMediaImage.cs | 2 +- Interfaces/IPartitionableMediaImage.cs | 4 +-- Interfaces/ITapeImage.cs | 4 +-- Interfaces/IWritableFloppyImage.cs | 2 +- Interfaces/IWritableImage.cs | 2 +- Interfaces/IWritableOpticalImage.cs | 2 +- Interfaces/IWritableTapeImage.cs | 2 +- MediaTypeFromDevice.cs | 4 +-- Structs/Devices/ATA/Identify.cs | 38 ++++++++++++++++++++++++++ Structs/Devices/SCSI/Enums.cs | 2 +- Structs/Devices/SCSI/Inquiry.cs | 38 ++++++++++++++++++++++++++ Structs/Devices/SCSI/Modes/2A.cs | 2 +- Structs/Filesystems.cs | 2 +- Structs/Images.cs | 4 +-- Structs/TapeFile.cs | 2 +- Structs/TapePartition.cs | 2 +- 19 files changed, 97 insertions(+), 21 deletions(-) diff --git a/Enums/DeviceType.cs b/Enums/DeviceType.cs index ce22c292f..0f3dbb123 100644 --- a/Enums/DeviceType.cs +++ b/Enums/DeviceType.cs @@ -9,7 +9,7 @@ // // --[ Description ] ---------------------------------------------------------- // -// Defines enumerations of devce types. +// Defines enumerations of device types. // // --[ License ] -------------------------------------------------------------- // diff --git a/Interfaces/IArchive.cs b/Interfaces/IArchive.cs index 6366db317..a5ffbbd2e 100644 --- a/Interfaces/IArchive.cs +++ b/Interfaces/IArchive.cs @@ -9,7 +9,7 @@ // // --[ Description ] ---------------------------------------------------------- // -// Defines the interface for an Archive. +// Defines the interface for implementing archive plugins. // // --[ License ] -------------------------------------------------------------- // diff --git a/Interfaces/IFloppyImage.cs b/Interfaces/IFloppyImage.cs index 8a5c2563e..998148ba9 100644 --- a/Interfaces/IFloppyImage.cs +++ b/Interfaces/IFloppyImage.cs @@ -9,7 +9,7 @@ // // --[ Description ] ---------------------------------------------------------- // -// Defines interface to be implemented by floppy image plugins. +// Defines the interface to be implemented by floppy image plugins. // // --[ License ] -------------------------------------------------------------- // diff --git a/Interfaces/IOpticalMediaImage.cs b/Interfaces/IOpticalMediaImage.cs index b040b213f..026aae7e6 100644 --- a/Interfaces/IOpticalMediaImage.cs +++ b/Interfaces/IOpticalMediaImage.cs @@ -9,7 +9,7 @@ // // --[ Description ] ---------------------------------------------------------- // -// Defines interface to be implemented by optical disc image plugins. +// Defines the interface to be implemented by optical disc image plugins. // // --[ License ] -------------------------------------------------------------- // diff --git a/Interfaces/IPartitionableMediaImage.cs b/Interfaces/IPartitionableMediaImage.cs index 432c263df..9bfd83b2b 100644 --- a/Interfaces/IPartitionableMediaImage.cs +++ b/Interfaces/IPartitionableMediaImage.cs @@ -9,8 +9,8 @@ // // --[ Description ] ---------------------------------------------------------- // -// Defines interface to be implemented by image plugins that can contain -// partitioned medias, usually optical discs and some newer tapes. +// Defines the interface to be implemented by image plugins that can +// contain partitioned medias, usually optical discs and some newer tapes. // // --[ License ] -------------------------------------------------------------- // diff --git a/Interfaces/ITapeImage.cs b/Interfaces/ITapeImage.cs index 9f458f8f9..fe37e632b 100644 --- a/Interfaces/ITapeImage.cs +++ b/Interfaces/ITapeImage.cs @@ -9,8 +9,8 @@ // // --[ Description ] ---------------------------------------------------------- // -// Defines interface to be implemented by block addressable sequential tape -// image plugins. +// Defines the interface to be implemented by block addressable sequential +// tape image plugins. // // --[ License ] -------------------------------------------------------------- // diff --git a/Interfaces/IWritableFloppyImage.cs b/Interfaces/IWritableFloppyImage.cs index c313e3cf0..2f093a534 100644 --- a/Interfaces/IWritableFloppyImage.cs +++ b/Interfaces/IWritableFloppyImage.cs @@ -9,7 +9,7 @@ // // --[ Description ] ---------------------------------------------------------- // -// Defines interface to be implemented by floppy image plugins. +// Defines the interface to be implemented by floppy image plugins. // // --[ License ] -------------------------------------------------------------- // diff --git a/Interfaces/IWritableImage.cs b/Interfaces/IWritableImage.cs index 3448639b4..a30f5398a 100644 --- a/Interfaces/IWritableImage.cs +++ b/Interfaces/IWritableImage.cs @@ -9,7 +9,7 @@ // // --[ Description ] ---------------------------------------------------------- // -// Defines interface to be implemented by writable image plugins. +// Defines the interface to be implemented by writable image plugins. // // --[ License ] -------------------------------------------------------------- // diff --git a/Interfaces/IWritableOpticalImage.cs b/Interfaces/IWritableOpticalImage.cs index bd4dd2037..fbf7d6b11 100644 --- a/Interfaces/IWritableOpticalImage.cs +++ b/Interfaces/IWritableOpticalImage.cs @@ -9,7 +9,7 @@ // // --[ Description ] ---------------------------------------------------------- // -// Defines interface to be implemented by writable image plugins. +// Defines the interface to be implemented by writable image plugins. // // --[ License ] -------------------------------------------------------------- // diff --git a/Interfaces/IWritableTapeImage.cs b/Interfaces/IWritableTapeImage.cs index 8771710d8..d0459153d 100644 --- a/Interfaces/IWritableTapeImage.cs +++ b/Interfaces/IWritableTapeImage.cs @@ -9,7 +9,7 @@ // // --[ Description ] ---------------------------------------------------------- // -// Defines interface to be implemented by writable block addressable +// Defines the interface to be implemented by writable block addressable // sequential tape image plugins. // // --[ License ] -------------------------------------------------------------- diff --git a/MediaTypeFromDevice.cs b/MediaTypeFromDevice.cs index 29d5aa708..69f88ee53 100644 --- a/MediaTypeFromDevice.cs +++ b/MediaTypeFromDevice.cs @@ -2,14 +2,14 @@ // Aaru Data Preservation Suite // ---------------------------------------------------------------------------- // -// Filename : MediaTypeFromSCSI.cs +// Filename : MediaTypeFromDevice.cs // Author(s) : Natalia Portillo // // Component : Aaru common types. // // --[ Description ] ---------------------------------------------------------- // -// Lookups media type from SCSI informative values. +// Lookups media type from SCSI and ATA informative values. // // --[ License ] -------------------------------------------------------------- // diff --git a/Structs/Devices/ATA/Identify.cs b/Structs/Devices/ATA/Identify.cs index d35d0d76c..c07c2dca1 100644 --- a/Structs/Devices/ATA/Identify.cs +++ b/Structs/Devices/ATA/Identify.cs @@ -1,3 +1,41 @@ +// /*************************************************************************** +// Aaru Data Preservation Suite +// ---------------------------------------------------------------------------- +// +// Filename : Identify.cs +// Author(s) : Natalia Portillo +// +// Component : Common structures for ATA devices. +// +// --[ Description ] ---------------------------------------------------------- +// +// Defines a high level interpretation of the ATA IDENTIFY response. +// +// --[ License ] -------------------------------------------------------------- +// +// Permission is hereby granted, free of charge, to any person obtaining a +// copy of this software and associated documentation files (the +// "Software"), to deal in the Software without restriction, including +// without limitation the rights to use, copy, modify, merge, publish, +// distribute, sublicense, and/or sell copies of the Software, and to +// permit persons to whom the Software is furnished to do so, subject to +// the following conditions: +// +// The above copyright notice and this permission notice shall be included +// in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +// +// ---------------------------------------------------------------------------- +// Copyright © 2011-2020 Natalia Portillo +// ****************************************************************************/ + using System; using System.Collections.Generic; using System.Diagnostics.CodeAnalysis; diff --git a/Structs/Devices/SCSI/Enums.cs b/Structs/Devices/SCSI/Enums.cs index 2ebc10316..017b184fb 100644 --- a/Structs/Devices/SCSI/Enums.cs +++ b/Structs/Devices/SCSI/Enums.cs @@ -5,7 +5,7 @@ // Filename : Enums.cs // Author(s) : Natalia Portillo // -// Component : Device structures decoders. +// Component : Common structures for SCSI devices. // // --[ Description ] ---------------------------------------------------------- // diff --git a/Structs/Devices/SCSI/Inquiry.cs b/Structs/Devices/SCSI/Inquiry.cs index 022ce9e57..508cdde79 100644 --- a/Structs/Devices/SCSI/Inquiry.cs +++ b/Structs/Devices/SCSI/Inquiry.cs @@ -1,3 +1,41 @@ +// /*************************************************************************** +// Aaru Data Preservation Suite +// ---------------------------------------------------------------------------- +// +// Filename : Inquiry.cs +// Author(s) : Natalia Portillo +// +// Component : Common structures for SCSI devices. +// +// --[ Description ] ---------------------------------------------------------- +// +// Defines a high level interpretation of the SCSI INQUIRY response. +// +// --[ License ] -------------------------------------------------------------- +// +// Permission is hereby granted, free of charge, to any person obtaining a +// copy of this software and associated documentation files (the +// "Software"), to deal in the Software without restriction, including +// without limitation the rights to use, copy, modify, merge, publish, +// distribute, sublicense, and/or sell copies of the Software, and to +// permit persons to whom the Software is furnished to do so, subject to +// the following conditions: +// +// The above copyright notice and this permission notice shall be included +// in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +// +// ---------------------------------------------------------------------------- +// Copyright © 2011-2020 Natalia Portillo +// ****************************************************************************/ + using System; using System.Diagnostics.CodeAnalysis; using System.Linq; diff --git a/Structs/Devices/SCSI/Modes/2A.cs b/Structs/Devices/SCSI/Modes/2A.cs index b81be5225..01e63e33b 100644 --- a/Structs/Devices/SCSI/Modes/2A.cs +++ b/Structs/Devices/SCSI/Modes/2A.cs @@ -5,7 +5,7 @@ // Filename : 2A.cs // Author(s) : Natalia Portillo // -// Component : Device structures decoders. +// Component : Common structures for SCSI devices. // // --[ Description ] ---------------------------------------------------------- // diff --git a/Structs/Filesystems.cs b/Structs/Filesystems.cs index 7d862af25..ad26d5dd7 100644 --- a/Structs/Filesystems.cs +++ b/Structs/Filesystems.cs @@ -5,7 +5,7 @@ // Filename : Structs.cs // Author(s) : Natalia Portillo // -// Component : Aaru filesystem plugins. +// Component : Common structures. // // --[ Description ] ---------------------------------------------------------- // diff --git a/Structs/Images.cs b/Structs/Images.cs index 0e9d8e2a9..464d1da50 100644 --- a/Structs/Images.cs +++ b/Structs/Images.cs @@ -5,11 +5,11 @@ // Filename : IMediaImage.cs // Author(s) : Natalia Portillo // -// Component : Disc image plugins. +// Component : Common structures. // // --[ Description ] ---------------------------------------------------------- // -// Defines structures to be used by disc image plugins. +// Defines structures to be used by media image plugins. // // --[ License ] -------------------------------------------------------------- // diff --git a/Structs/TapeFile.cs b/Structs/TapeFile.cs index c70c2a267..dc17c1a89 100644 --- a/Structs/TapeFile.cs +++ b/Structs/TapeFile.cs @@ -5,7 +5,7 @@ // Filename : TapeFile.cs // Author(s) : Natalia Portillo // -// Component : Disc image plugins. +// Component : Common structures. // // --[ Description ] ---------------------------------------------------------- // diff --git a/Structs/TapePartition.cs b/Structs/TapePartition.cs index a79c325c6..3bad6e2ee 100644 --- a/Structs/TapePartition.cs +++ b/Structs/TapePartition.cs @@ -5,7 +5,7 @@ // Filename : TapeFile.cs // Author(s) : Natalia Portillo // -// Component : Disc image plugins. +// Component : Common structures. // // --[ Description ] ---------------------------------------------------------- //