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,21 @@ using System.ComponentModel.DataAnnotations;
namespace Aaru.Database.Models
{
/// <summary>
/// USB vendor
/// </summary>
public class UsbVendor
{
/// <summary>
/// Builds an empty USB vendor
/// </summary>
public UsbVendor() {}
/// <summary>
/// Builds a USB vendor with the specified parameters
/// </summary>
/// <param name="id">Vendor ID</param>
/// <param name="vendor">Vendor name</param>
public UsbVendor(ushort id, string vendor)
{
Id = id;
@@ -47,12 +58,27 @@ namespace Aaru.Database.Models
AddedWhen = ModifiedWhen = DateTime.UtcNow;
}
/// <summary>
/// Database ID
/// </summary>
[Key]
public ushort Id { get; set; }
/// <summary>
/// Vendor name
/// </summary>
public string Vendor { get; set; }
/// <summary>
/// Date when model has been added to the database
/// </summary>
public DateTime AddedWhen { get; set; }
/// <summary>
/// Date when model was last modified
/// </summary>
public DateTime ModifiedWhen { get; set; }
/// <summary>
/// List of products from this vendor
/// </summary>
public virtual ICollection<UsbProduct> Products { get; set; }
}
}