Add XML comments to public entities.

This commit is contained in:
2021-08-17 13:56:05 +01:00
parent 0d18153610
commit 00f605b0ca
542 changed files with 6029 additions and 104 deletions

View File

@@ -36,10 +36,20 @@ using Aaru.CommonTypes.Metadata;
namespace Aaru.Database.Models
{
/// <summary>
/// Known device
/// </summary>
public class Device : DeviceReportV2
{
/// <summary>
/// Builds an empty device
/// </summary>
public Device() => LastSynchronized = DateTime.UtcNow;
/// <summary>
/// Builds a device from a device report
/// </summary>
/// <param name="report">Device report</param>
public Device(DeviceReportV2 report)
{
ATA = report.ATA;
@@ -59,11 +69,20 @@ namespace Aaru.Database.Models
GdRomSwapDiscCapabilities = report.GdRomSwapDiscCapabilities;
}
/// <summary>
/// When this known device was last synchronized with the server
/// </summary>
public DateTime LastSynchronized { get; set; }
/// <summary>
/// Optimal number of blocks to read at once
/// </summary>
[DefaultValue(0)]
public int OptimalMultipleSectorsRead { get; set; }
/// <summary>
/// Can read GD-ROM using swap trick?
/// </summary>
[DefaultValue(null)]
public bool? CanReadGdRomUsingSwapDisc { get; set; }
}