diff --git a/DiscImageChef.Filters/AppleDouble.cs b/DiscImageChef.Filters/AppleDouble.cs index afc91a1d9..d0326e4ff 100644 --- a/DiscImageChef.Filters/AppleDouble.cs +++ b/DiscImageChef.Filters/AppleDouble.cs @@ -37,6 +37,9 @@ using System.Runtime.InteropServices; namespace DiscImageChef.Filters { + /// + /// Decodes AppleDouble files + /// public class AppleDouble : Filter { enum AppleDoubleEntryID : uint diff --git a/DiscImageChef.Filters/AppleSingle.cs b/DiscImageChef.Filters/AppleSingle.cs index d7873ef28..c0302b193 100644 --- a/DiscImageChef.Filters/AppleSingle.cs +++ b/DiscImageChef.Filters/AppleSingle.cs @@ -37,6 +37,9 @@ using System.Runtime.InteropServices; namespace DiscImageChef.Filters { + /// + /// Decodes AppleSingle files + /// public class AppleSingle : Filter { enum AppleSingleEntryID : uint diff --git a/DiscImageChef.Filters/BZip2.cs b/DiscImageChef.Filters/BZip2.cs index 5523332b5..f35e23664 100644 --- a/DiscImageChef.Filters/BZip2.cs +++ b/DiscImageChef.Filters/BZip2.cs @@ -37,6 +37,9 @@ using SharpCompress.Compressors.BZip2; namespace DiscImageChef.Filters { + /// + /// Decompress bz2 files while reading + /// public class BZip2 : Filter { Stream dataStream; diff --git a/DiscImageChef.Filters/Filters.cs b/DiscImageChef.Filters/Filters.cs index 24d46d194..08fde704e 100644 --- a/DiscImageChef.Filters/Filters.cs +++ b/DiscImageChef.Filters/Filters.cs @@ -41,6 +41,9 @@ namespace DiscImageChef.Filters { public SortedDictionary Filters; + /// + /// Fills the list of all known filters + /// public FiltersList() { Assembly assembly = Assembly.GetAssembly(typeof(Filter)); @@ -57,6 +60,11 @@ namespace DiscImageChef.Filters catch(Exception exception) { DicConsole.ErrorWriteLine("Exception {0}", exception); } } + /// + /// Gets the filter that allows to read the specified path + /// + /// Path + /// The filter that allows reading the specified path public Filter GetFilter(string path) { Filter noFilter = null; @@ -82,6 +90,10 @@ namespace DiscImageChef.Filters return noFilter; } + /// + /// Gets all known filters + /// + /// Known filters public SortedDictionary GetFiltersList() { return Filters; diff --git a/DiscImageChef.Filters/GZip.cs b/DiscImageChef.Filters/GZip.cs index d489663d3..29c97dbd7 100644 --- a/DiscImageChef.Filters/GZip.cs +++ b/DiscImageChef.Filters/GZip.cs @@ -36,6 +36,9 @@ using System.IO.Compression; namespace DiscImageChef.Filters { + /// + /// Decompress gzip files while reading + /// public class GZip : Filter { Stream dataStream; diff --git a/DiscImageChef.Filters/LZip.cs b/DiscImageChef.Filters/LZip.cs index ff378494a..a8dcf58ff 100644 --- a/DiscImageChef.Filters/LZip.cs +++ b/DiscImageChef.Filters/LZip.cs @@ -37,6 +37,9 @@ using SharpCompress.Compressors.LZMA; namespace DiscImageChef.Filters { + /// + /// Decompress lzip files while reading + /// public class LZip : Filter { Stream dataStream; diff --git a/DiscImageChef.Filters/MacBinary.cs b/DiscImageChef.Filters/MacBinary.cs index 0e20b2e10..cee331e3f 100644 --- a/DiscImageChef.Filters/MacBinary.cs +++ b/DiscImageChef.Filters/MacBinary.cs @@ -38,6 +38,9 @@ using System.Text; namespace DiscImageChef.Filters { // TODO: Interpret fdScript + /// + /// Decodes MacBinary files + /// public class MacBinary : Filter { [StructLayout(LayoutKind.Sequential, Pack = 1)] diff --git a/DiscImageChef.Filters/PCExchange.cs b/DiscImageChef.Filters/PCExchange.cs index a949a49f3..56ede6f05 100644 --- a/DiscImageChef.Filters/PCExchange.cs +++ b/DiscImageChef.Filters/PCExchange.cs @@ -39,6 +39,9 @@ using System.Text; namespace DiscImageChef.Filters { + /// + /// Decodes PCExchange files + /// public class PCExchange : Filter { const string FILE_ID = "FILEID.DAT"; diff --git a/DiscImageChef.Filters/XZ.cs b/DiscImageChef.Filters/XZ.cs index 882d02134..99ab8a559 100644 --- a/DiscImageChef.Filters/XZ.cs +++ b/DiscImageChef.Filters/XZ.cs @@ -36,6 +36,9 @@ using SharpCompress.Compressors.Xz; namespace DiscImageChef.Filters { + /// + /// Decompress xz files while reading + /// public class XZ : Filter { Stream dataStream; diff --git a/DiscImageChef.Filters/ZZZNoFilter.cs b/DiscImageChef.Filters/ZZZNoFilter.cs index 2ecd9349f..983fdd0ad 100644 --- a/DiscImageChef.Filters/ZZZNoFilter.cs +++ b/DiscImageChef.Filters/ZZZNoFilter.cs @@ -35,6 +35,9 @@ using System.IO; namespace DiscImageChef.Filters { + /// + /// No filter for reading files not recognized by any filter + /// public class ZZZNoFilter : Filter { Stream dataStream;