DOCUMENTATION: Added XML documentation to DiscImageChef.Filters.

DiscImageChef.Filters/AppleDouble.cs

@@ -37,6 +37,9 @@ using System.Runtime.InteropServices;
 
 namespace DiscImageChef.Filters
 {
+    /// <summary>
+    /// Decodes AppleDouble files
+    /// </summary>
     public class AppleDouble : Filter
     {
         enum AppleDoubleEntryID : uint

DiscImageChef.Filters/AppleSingle.cs

@@ -37,6 +37,9 @@ using System.Runtime.InteropServices;
 
 namespace DiscImageChef.Filters
 {
+    /// <summary>
+    /// Decodes AppleSingle files
+    /// </summary>
     public class AppleSingle : Filter
     {
         enum AppleSingleEntryID : uint

DiscImageChef.Filters/BZip2.cs

@@ -37,6 +37,9 @@ using SharpCompress.Compressors.BZip2;
 
 namespace DiscImageChef.Filters
 {
+    /// <summary>
+    /// Decompress bz2 files while reading
+    /// </summary>
     public class BZip2 : Filter
     {
         Stream dataStream;

DiscImageChef.Filters/Filters.cs

@@ -41,6 +41,9 @@ namespace DiscImageChef.Filters
     {
         public SortedDictionary<string, Filter> Filters;
 
+        /// <summary>
+        /// Fills the list of all known filters
+        /// </summary>
         public FiltersList()
         {
             Assembly assembly = Assembly.GetAssembly(typeof(Filter));
@@ -57,6 +60,11 @@ namespace DiscImageChef.Filters
                 catch(Exception exception) { DicConsole.ErrorWriteLine("Exception {0}", exception); }
         }
 
+        /// <summary>
+        /// Gets the filter that allows to read the specified path
+        /// </summary>
+        /// <param name="path">Path</param>
+        /// <returns>The filter that allows reading the specified path</returns>
         public Filter GetFilter(string path)
         {
             Filter noFilter = null;
@@ -82,6 +90,10 @@ namespace DiscImageChef.Filters
             return noFilter;
         }
 
+        /// <summary>
+        /// Gets all known filters
+        /// </summary>
+        /// <returns>Known filters</returns>
         public SortedDictionary<string, Filter> GetFiltersList()
         {
             return Filters;

DiscImageChef.Filters/GZip.cs

@@ -36,6 +36,9 @@ using System.IO.Compression;
 
 namespace DiscImageChef.Filters
 {
+    /// <summary>
+    /// Decompress gzip files while reading
+    /// </summary>
     public class GZip : Filter
     {
         Stream dataStream;

DiscImageChef.Filters/LZip.cs

@@ -37,6 +37,9 @@ using SharpCompress.Compressors.LZMA;
 
 namespace DiscImageChef.Filters
 {
+    /// <summary>
+    /// Decompress lzip files while reading
+    /// </summary>
     public class LZip : Filter
     {
         Stream dataStream;

DiscImageChef.Filters/MacBinary.cs

@@ -38,6 +38,9 @@ using System.Text;
 namespace DiscImageChef.Filters
 {
     // TODO: Interpret fdScript
+    /// <summary>
+    /// Decodes MacBinary files
+    /// </summary>
     public class MacBinary : Filter
     {
         [StructLayout(LayoutKind.Sequential, Pack = 1)]

DiscImageChef.Filters/PCExchange.cs

@@ -39,6 +39,9 @@ using System.Text;
 
 namespace DiscImageChef.Filters
 {
+    /// <summary>
+    /// Decodes PCExchange files
+    /// </summary>
     public class PCExchange : Filter
     {
         const string FILE_ID = "FILEID.DAT";

DiscImageChef.Filters/XZ.cs

@@ -36,6 +36,9 @@ using SharpCompress.Compressors.Xz;
 
 namespace DiscImageChef.Filters
 {
+    /// <summary>
+    /// Decompress xz files while reading
+    /// </summary>
     public class XZ : Filter
     {
         Stream dataStream;

DiscImageChef.Filters/ZZZNoFilter.cs

@@ -35,6 +35,9 @@ using System.IO;
 
 namespace DiscImageChef.Filters
 {
+    /// <summary>
+    /// No filter for reading files not recognized by any filter
+    /// </summary>
     public class ZZZNoFilter : Filter
     {
         Stream dataStream;