diff --git a/DiscImageChef.Server/App_Start/Ata.cs b/DiscImageChef.Server/App_Start/Ata.cs index e0dcc9334..4f1f9feef 100644 --- a/DiscImageChef.Server/App_Start/Ata.cs +++ b/DiscImageChef.Server/App_Start/Ata.cs @@ -39,6 +39,16 @@ namespace DiscImageChef.Server.App_Start { public static class Ata { + /// + /// Takes the ATA part of a device report and prints it as a list of values and another list of key=value pairs to be sequenced by ASP.NET in the rendering + /// + /// ATA part of a device report + /// true if compact flash device + /// true if atapi device + /// true if removabledevice + /// List to put values on + /// List to put key=value pairs on + /// List of tested media public static void Report(ataType ataReport, bool cfa, bool atapi, ref bool removable, ref List ataOneValue, ref Dictionary ataTwoValue, ref testedMediaType[] testedMedia) diff --git a/DiscImageChef.Server/App_Start/ScsiEvpd.cs b/DiscImageChef.Server/App_Start/ScsiEvpd.cs index 24d924e95..49d16dc01 100644 --- a/DiscImageChef.Server/App_Start/ScsiEvpd.cs +++ b/DiscImageChef.Server/App_Start/ScsiEvpd.cs @@ -38,6 +38,12 @@ namespace DiscImageChef.Server.App_Start { public static class ScsiEvpd { + /// + /// Takes the SCSI EVPD part of a device report and prints it as a list key=value pairs to be sequenced by ASP.NET in the rendering + /// + /// EVPD pages + /// SCSI vendor string + /// List to put the key=value pairs on public static void Report(pageType[] pages, string vendor, ref Dictionary evpdPages) { foreach(pageType evpd in pages) diff --git a/DiscImageChef.Server/App_Start/ScsiInquiry.cs b/DiscImageChef.Server/App_Start/ScsiInquiry.cs index 6099b4d72..28e11fa84 100644 --- a/DiscImageChef.Server/App_Start/ScsiInquiry.cs +++ b/DiscImageChef.Server/App_Start/ScsiInquiry.cs @@ -38,6 +38,11 @@ namespace DiscImageChef.Server.App_Start { static class ScsiInquiry { + /// + /// Takes the SCSI INQUIRY part of a device report and prints it as a list of values to be sequenced by ASP.NET in the rendering + /// + /// INQUIRY part of the report + /// List of values internal static List Report(scsiInquiryType inquiry) { List scsiOneValue = new List(); diff --git a/DiscImageChef.Server/App_Start/ScsiMmcFeatures.cs b/DiscImageChef.Server/App_Start/ScsiMmcFeatures.cs index 9dba7c9ca..379907454 100644 --- a/DiscImageChef.Server/App_Start/ScsiMmcFeatures.cs +++ b/DiscImageChef.Server/App_Start/ScsiMmcFeatures.cs @@ -38,6 +38,11 @@ namespace DiscImageChef.Server.App_Start { public static class ScsiMmcFeatures { + /// + /// Takes the MMC FEATURES part of a device report and prints it as a list of values to be sequenced by ASP.NET in the rendering + /// + /// FEATURES part of the report + /// List to put the values on public static void Report(mmcFeaturesType ftr, ref List mmcOneValue) { if(ftr.SupportsAACS && ftr.AACSVersionSpecified) diff --git a/DiscImageChef.Server/App_Start/ScsiMmcMode.cs b/DiscImageChef.Server/App_Start/ScsiMmcMode.cs index 77094a023..1fd659ca1 100644 --- a/DiscImageChef.Server/App_Start/ScsiMmcMode.cs +++ b/DiscImageChef.Server/App_Start/ScsiMmcMode.cs @@ -39,6 +39,11 @@ namespace DiscImageChef.Server.App_Start { public static class ScsiMmcMode { + /// + /// Takes the MODE PAGE 2Ah part of a device report and prints it as a list of values to be sequenced by ASP.NET in the rendering + /// + /// MODE PAGE 2Ah part of the report + /// List to put the values on public static void Report(mmcModeType mode, ref List mmcOneValue) { if(mode.PlaysAudio) mmcOneValue.Add("Drive can play audio"); diff --git a/DiscImageChef.Server/App_Start/ScsiModeSense.cs b/DiscImageChef.Server/App_Start/ScsiModeSense.cs index 267d1437e..27b80a4c1 100644 --- a/DiscImageChef.Server/App_Start/ScsiModeSense.cs +++ b/DiscImageChef.Server/App_Start/ScsiModeSense.cs @@ -38,6 +38,14 @@ namespace DiscImageChef.Server.App_Start { public static class ScsiModeSense { + /// + /// Takes the MODE PAGEs part of a device report and prints it as a list of values and another list of key=value pairs to be sequenced by ASP.NET in the rendering + /// + /// MODE PAGEs part of a device report + /// SCSI vendor string + /// SCSI peripheral device type + /// List to put values on + /// List to put key=value pairs on public static void Report(modeType modeSense, string vendor, PeripheralDeviceTypes deviceType, ref List scsiOneValue, ref Dictionary modePages) { diff --git a/DiscImageChef.Server/App_Start/SscTestedMedia.cs b/DiscImageChef.Server/App_Start/SscTestedMedia.cs index b694c9d75..0b8699f15 100644 --- a/DiscImageChef.Server/App_Start/SscTestedMedia.cs +++ b/DiscImageChef.Server/App_Start/SscTestedMedia.cs @@ -37,6 +37,11 @@ namespace DiscImageChef.Server.App_Start { public static class SscTestedMedia { + /// + /// Takes the tested media from SCSI Streaming devices of a device report and prints it as a list of values + /// + /// List to put values on + /// List of tested media public static void Report(IEnumerable testedMedia, ref List mediaOneValue) { foreach(SequentialMedia media in testedMedia) diff --git a/DiscImageChef.Server/App_Start/TestedMedia.cs b/DiscImageChef.Server/App_Start/TestedMedia.cs index 5743dd46e..fb6e428da 100644 --- a/DiscImageChef.Server/App_Start/TestedMedia.cs +++ b/DiscImageChef.Server/App_Start/TestedMedia.cs @@ -37,6 +37,12 @@ namespace DiscImageChef.Server.App_Start { public static class TestedMedia { + /// + /// Takes the tested media from a device report and prints it as a list of values + /// + /// true if device report is from an ATA device + /// List to put values on + /// List of tested media public static void Report(IEnumerable testedMedias, bool ata, ref List mediaOneValue) { foreach(testedMediaType testedMedia in testedMedias) diff --git a/DiscImageChef.Server/Controllers/UploadReportController.cs b/DiscImageChef.Server/Controllers/UploadReportController.cs index 0939744f8..ac844b591 100644 --- a/DiscImageChef.Server/Controllers/UploadReportController.cs +++ b/DiscImageChef.Server/Controllers/UploadReportController.cs @@ -45,6 +45,10 @@ namespace DiscImageChef.Server.Controllers { public class UploadReportController : ApiController { + /// + /// Receives a report from DiscImageChef.Core, verifies it's in the correct format and stores it on the server + /// + /// HTTP response [Route("api/uploadreport")] [HttpPost] public HttpResponseMessage UploadReport() diff --git a/DiscImageChef.Server/Controllers/UploadStatsController.cs b/DiscImageChef.Server/Controllers/UploadStatsController.cs index 1a7c7d137..0ce736b81 100644 --- a/DiscImageChef.Server/Controllers/UploadStatsController.cs +++ b/DiscImageChef.Server/Controllers/UploadStatsController.cs @@ -48,6 +48,10 @@ namespace DiscImageChef.Server.Controllers { public class UploadStatsController : ApiController { + /// + /// Receives statistics from DiscImageChef.Core, processes them and adds them to a server-side global statistics XML + /// + /// HTTP response [Route("api/uploadstats")] [HttpPost] public HttpResponseMessage UploadStats() diff --git a/DiscImageChef.Server/Default.aspx.cs b/DiscImageChef.Server/Default.aspx.cs index ebf7f2895..9941aed78 100644 --- a/DiscImageChef.Server/Default.aspx.cs +++ b/DiscImageChef.Server/Default.aspx.cs @@ -39,6 +39,9 @@ using Velyo.AspNet.Markdown; namespace DiscImageChef.Server { + /// + /// Renders the README.md file + /// public partial class Default : Page { protected void Page_Load(object sender, EventArgs e) diff --git a/DiscImageChef.Server/Statistics.aspx.cs b/DiscImageChef.Server/Statistics.aspx.cs index 3a03d4e4f..4fe595e8e 100644 --- a/DiscImageChef.Server/Statistics.aspx.cs +++ b/DiscImageChef.Server/Statistics.aspx.cs @@ -46,6 +46,9 @@ using PlatformID = DiscImageChef.Interop.PlatformID; namespace DiscImageChef.Server { + /// + /// Renders a page with statistics, list of media type, devices, etc + /// public partial class Statistics : Page { class MediaItem diff --git a/DiscImageChef.Server/ViewReport.aspx.cs b/DiscImageChef.Server/ViewReport.aspx.cs index 7d32e0c22..9b7abb99b 100644 --- a/DiscImageChef.Server/ViewReport.aspx.cs +++ b/DiscImageChef.Server/ViewReport.aspx.cs @@ -46,6 +46,9 @@ using Tuple = DiscImageChef.Decoders.PCMCIA.Tuple; namespace DiscImageChef.Server { + /// + /// Renders the specified report from the server + /// public partial class ViewReport : Page { protected void Page_Load(object sender, EventArgs e)