DOCUMENTATION: Added XML documentation to DiscImageChef.Core.

DiscImageChef.Core/Sidecar/AudioMedia.cs

@@ -41,6 +41,16 @@ namespace DiscImageChef.Core
     public static partial class Sidecar
     {
         // TODO: Complete it
+        /// <summary>
+        /// Creates a metadata sidecar for an audio media (e.g. cassette) 
+        /// </summary>
+        /// <param name="image">Image</param>
+        /// <param name="filterId">Filter uuid</param>
+        /// <param name="imagePath">Image path</param>
+        /// <param name="fi">Image file information</param>
+        /// <param name="plugins">Image plugins</param>
+        /// <param name="imgChecksums">List of image checksums</param>
+        /// <param name="sidecar">Metadata sidecar</param>
         static void AudioMedia(ImagePlugin image, Guid filterId, string imagePath, FileInfo fi,
                                PluginBase plugins, List<ChecksumType> imgChecksums, ref CICMMetadataType sidecar)
         {

DiscImageChef.Core/Sidecar/BlockMedia.cs

@@ -50,6 +50,16 @@ namespace DiscImageChef.Core
 {
     public static partial class Sidecar
     {
+        /// <summary>
+        /// Creates a metadata sidecar for a block media (e.g. floppy, hard disk, flash card, usb stick) 
+        /// </summary>
+        /// <param name="image">Image</param>
+        /// <param name="filterId">Filter uuid</param>
+        /// <param name="imagePath">Image path</param>
+        /// <param name="fi">Image file information</param>
+        /// <param name="plugins">Image plugins</param>
+        /// <param name="imgChecksums">List of image checksums</param>
+        /// <param name="sidecar">Metadata sidecar</param>
         static void BlockMedia(ImagePlugin image, Guid filterId, string imagePath, FileInfo fi,
                                PluginBase plugins, List<ChecksumType> imgChecksums, ref CICMMetadataType sidecar)
         {

DiscImageChef.Core/Sidecar/BlockTape.cs

@@ -38,6 +38,12 @@ namespace DiscImageChef.Core
 {
     public static partial class Sidecar
     {
+        /// <summary>
+        /// Creates a metadata sidecar for a block tape (e.g. scsi streaming) 
+        /// </summary>
+        /// <param name="files">List of files</param>
+        /// <param name="folderName">Dump path</param>
+        /// <param name="blockSize">Expected block size in bytes</param>
         public static CICMMetadataType Create(string folderName, List<string> files, int blockSize)
         {
             CICMMetadataType sidecar = new CICMMetadataType

DiscImageChef.Core/Sidecar/Helpers.cs

@@ -34,6 +34,11 @@ namespace DiscImageChef.Core
 {
     public static partial class Sidecar
     {
+        /// <summary>
+        /// Converts a LBA to MM:SS:FF string for CDs
+        /// </summary>
+        /// <param name="lba">LBA</param>
+        /// <returns>MM:SS:FF</returns>
         static string LbaToMsf(long lba)
         {
             long m, s, f;
@@ -57,6 +62,11 @@ namespace DiscImageChef.Core
             return $"{m}:{s:D2}:{f:D2}";
         }
 
+        /// <summary>
+        /// Converts a LBA to MM:SS:FF string for DDCDs
+        /// </summary>
+        /// <param name="lba">LBA</param>
+        /// <returns>MM:SS:FF</returns>
         static string DdcdLbaToMsf(long lba)
         {
             long h, m, s, f;

DiscImageChef.Core/Sidecar/LinearMedia.cs

@@ -41,6 +41,16 @@ namespace DiscImageChef.Core
     public static partial class Sidecar
     {
         // TODO: Complete it
+        /// <summary>
+        /// Creates a metadata sidecar for linear media (e.g. ROM chip) 
+        /// </summary>
+        /// <param name="image">Image</param>
+        /// <param name="filterId">Filter uuid</param>
+        /// <param name="imagePath">Image path</param>
+        /// <param name="fi">Image file information</param>
+        /// <param name="plugins">Image plugins</param>
+        /// <param name="imgChecksums">List of image checksums</param>
+        /// <param name="sidecar">Metadata sidecar</param>
         static void LinearMedia(ImagePlugin image, Guid filterId, string imagePath, FileInfo fi,
                                 PluginBase plugins, List<ChecksumType> imgChecksums, ref CICMMetadataType sidecar)
         {

DiscImageChef.Core/Sidecar/OpticalDisc.cs

@@ -47,6 +47,16 @@ namespace DiscImageChef.Core
 {
     public static partial class Sidecar
     {
+        /// <summary>
+        /// Creates a metadata sidecar for an optical disc (e.g. CD, DVD, GD, BD, XGD, GOD) 
+        /// </summary>
+        /// <param name="image">Image</param>
+        /// <param name="filterId">Filter uuid</param>
+        /// <param name="imagePath">Image path</param>
+        /// <param name="fi">Image file information</param>
+        /// <param name="plugins">Image plugins</param>
+        /// <param name="imgChecksums">List of image checksums</param>
+        /// <param name="sidecar">Metadata sidecar</param>
         static void OpticalDisc(ImagePlugin image, Guid filterId, string imagePath, FileInfo fi,
                                 PluginBase plugins, List<ChecksumType> imgChecksums, ref CICMMetadataType sidecar)
         {

DiscImageChef.Core/Sidecar/Sidecar.cs

@@ -41,6 +41,14 @@ namespace DiscImageChef.Core
 {
     public static partial class Sidecar
     {
+        /// <summary>
+        /// Implements creating a metadata sidecar
+        /// </summary>
+        /// <param name="image">Image</param>
+        /// <param name="imagePath">Path to image</param>
+        /// <param name="filterId">Filter uuid</param>
+        /// <param name="encoding">Encoding for analysis</param>
+        /// <returns>The metadata sidecar</returns>
         public static CICMMetadataType Create(ImagePlugin image, string imagePath, Guid filterId,
                                               Encoding encoding)
         {