Add XML comments to public entities.

Interfaces/IArchive.cs

@@ -39,6 +39,9 @@ using System.IO;
 
 namespace Aaru.CommonTypes.Interfaces
 {
+    /// <summary>
+    /// Supported archive features
+    /// </summary>
     [Flags]
     public enum ArchiveSupportedFeature : uint
     {
@@ -68,6 +71,9 @@ namespace Aaru.CommonTypes.Interfaces
         SupportsXAttrs = 1 << 6
     }
 
+    /// <summary>
+    /// Defines the interface to handle an archive (e.g. ZIP, WAD, etc)
+    /// </summary>
     public interface IArchive
     {
         /// <summary>Descriptive name of the plugin</summary>

Interfaces/IChecksum.cs

@@ -38,6 +38,9 @@
 
 namespace Aaru.CommonTypes.Interfaces
 {
+    /// <summary>
+    /// Defines the interface to implement a checksum or hashing algorithm
+    /// </summary>
     public interface IChecksum
     {
         /// <summary>Updates the hash with data.</summary>

Interfaces/IFilesystem.cs

@@ -45,6 +45,9 @@ namespace Aaru.CommonTypes.Interfaces
     /// <summary>Interface to implement filesystem plugins.</summary>
     public interface IFilesystem
     {
+        /// <summary>
+        /// Defines the encoding used to interpret strings in the filesystem
+        /// </summary>
         Encoding Encoding { get; }
         /// <summary>Plugin name.</summary>
         string Name { get; }

Interfaces/IFilter.cs

@@ -41,6 +41,10 @@ using System.IO;
 
 namespace Aaru.CommonTypes.Interfaces
 {
+    /// <summary>
+    /// Defines a filter, that is, a transformation of the data from a file, like, for example, a compressor (e.g. GZIP),
+    /// or a container (e.g. AppleDouble)
+    /// </summary>
     public interface IFilter
     {
         /// <summary>Descriptive name of the plugin</summary>

Interfaces/IPartitionableMediaImage.cs

@@ -41,6 +41,9 @@ using System.Collections.Generic;
 
 namespace Aaru.CommonTypes.Interfaces
 {
+    /// <summary>
+    /// Defines an image that can contain partitions
+    /// </summary>
     public interface IPartitionableMediaImage
     {
         /// <summary>

Interfaces/IPluginRegister.cs

@@ -41,6 +41,9 @@ using System.Collections.Generic;
 
 namespace Aaru.CommonTypes.Interfaces
 {
+    /// <summary>
+    /// Defines a register of all known plugins
+    /// </summary>
     public interface IPluginRegister
     {
         /// <summary>Gets all checksum plugins</summary>

Interfaces/IReadOnlyFilesystem.cs

@@ -45,12 +45,17 @@ using Aaru.CommonTypes.Structs;
 namespace Aaru.CommonTypes.Interfaces
 {
     /// <inheritdoc />
-    /// <summary>Interface to implement filesystem plugins.</summary>
+    /// <summary>
+    /// Defines the interface to implement reading the contents of a filesystem
+    /// </summary>
     public interface IReadOnlyFilesystem : IFilesystem
     {
         /// <summary>Retrieves a list of options supported by the filesystem, with name, type and description</summary>
         IEnumerable<(string name, Type type, string description)> SupportedOptions { get; }
 
+        /// <summary>
+        /// Supported namespaces
+        /// </summary>
         Dictionary<string, string> Namespaces { get; }
 
         /// <summary>
@@ -90,7 +95,7 @@ namespace Aaru.CommonTypes.Interfaces
         /// <summary>Reads an extended attribute, alternate data stream or fork from the given file.</summary>
         /// <returns>Error number.</returns>
         /// <param name="path">File path.</param>
-        /// <param name="xattr">Extendad attribute, alternate data stream or fork name.</param>
+        /// <param name="xattr">Extended attribute, alternate data stream or fork name.</param>
         /// <param name="buf">Buffer.</param>
         Errno GetXattr(string path, string xattr, ref byte[] buf);
 

Interfaces/ITapeImage.cs

@@ -42,6 +42,9 @@ using Aaru.CommonTypes.Structs;
 
 namespace Aaru.CommonTypes.Interfaces
 {
+    /// <summary>
+    /// Defines an image that can store the information from streaming, digital, tapes
+    /// </summary>
     public interface ITapeImage : IMediaImage
     {
         /// <summary>Gets a list of all the files registered in the image</summary>

Interfaces/IVerifiableImage.cs

@@ -39,6 +39,9 @@
 
 namespace Aaru.CommonTypes.Interfaces
 {
+    /// <summary>
+    /// Defines an image that can verify the integrity of the image itself, but not its contents
+    /// </summary>
     public interface IVerifiableImage
     {
         /// <summary>Verifies media image internal checksum.</summary>

Interfaces/IVerifiableSectorsImage.cs

@@ -41,6 +41,9 @@ using System.Collections.Generic;
 
 namespace Aaru.CommonTypes.Interfaces
 {
+    /// <summary>
+    /// Defines an image that can verify the integrity of the sectors it contains
+    /// </summary>
     public interface IVerifiableSectorsImage
     {
         /// <summary>Verifies a sector.</summary>

Interfaces/IWritableImage.cs

@@ -62,7 +62,13 @@ namespace Aaru.CommonTypes.Interfaces
         /// <summary>Gets a list of known extensions for format auto-choosing</summary>
         IEnumerable<string> KnownExtensions { get; }
 
+        /// <summary>
+        /// If set to <c>true</c> means the image is opened for writing
+        /// </summary>
         bool   IsWriting    { get; }
+        /// <summary>
+        /// Contains a description of the last error
+        /// </summary>
         string ErrorMessage { get; }
 
         /// <summary>

Interfaces/IWritableOpticalImage.cs

@@ -42,8 +42,14 @@ using Aaru.CommonTypes.Structs;
 
 namespace Aaru.CommonTypes.Interfaces
 {
+    /// <summary>
+    /// Defines an image that is writable and can store an optical disc (CD, DVD, etc)
+    /// </summary>
     public interface IWritableOpticalImage : IWritableImage, IOpticalMediaImage
     {
+        /// <summary>
+        /// Image format capabilities
+        /// </summary>
         OpticalImageCapabilities OpticalCapabilities { get; }
 
         /// <summary>Sets tracks for optical media</summary>

Interfaces/IWritableTapeImage.cs

@@ -41,6 +41,9 @@ using Aaru.CommonTypes.Structs;
 
 namespace Aaru.CommonTypes.Interfaces
 {
+    /// <summary>
+    /// Defines an image that is writable and can store information about a streaming, digital, tape
+    /// </summary>
     public interface IWritableTapeImage : ITapeImage, IWritableImage
     {
         /// <summary>Registers a new file in the image</summary>