Added comments

This commit is contained in:
JPVenson 2024-10-09 23:22:21 +00:00
parent 2955f2f562
commit 4c86642c00

View File

@ -2,22 +2,48 @@ using System;
namespace Jellyfin.Data.Entities; namespace Jellyfin.Data.Entities;
#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member /// <summary>
/// Provides informations about an Attachment to an <see cref="BaseItemEntity"/>.
/// </summary>
public class AttachmentStreamInfo public class AttachmentStreamInfo
{ {
/// <summary>
/// Gets or Sets the <see cref="BaseItemEntity"/> reference.
/// </summary>
public required Guid ItemId { get; set; } public required Guid ItemId { get; set; }
/// <summary>
/// Gets or Sets the <see cref="BaseItemEntity"/> reference.
/// </summary>
public required BaseItemEntity Item { get; set; } public required BaseItemEntity Item { get; set; }
/// <summary>
/// Gets or Sets The index within the source file.
/// </summary>
public required int Index { get; set; } public required int Index { get; set; }
/// <summary>
/// Gets or Sets the codec of the attachment.
/// </summary>
public required string Codec { get; set; } public required string Codec { get; set; }
/// <summary>
/// Gets or Sets the codec tag of the attachment.
/// </summary>
public string? CodecTag { get; set; } public string? CodecTag { get; set; }
/// <summary>
/// Gets or Sets the comment of the attachment.
/// </summary>
public string? Comment { get; set; } public string? Comment { get; set; }
/// <summary>
/// Gets or Sets the filename of the attachment.
/// </summary>
public string? Filename { get; set; } public string? Filename { get; set; }
/// <summary>
/// Gets or Sets the attachments mimetype.
/// </summary>
public string? MimeType { get; set; } public string? MimeType { get; set; }
} }