diff options
| author | JPVenson <github@jpb.email> | 2024-10-09 23:22:21 +0000 |
|---|---|---|
| committer | JPVenson <github@jpb.email> | 2024-10-09 23:22:21 +0000 |
| commit | 4c86642c006d768c672de07f0efb40efb462ea24 (patch) | |
| tree | 64e12b26ed8e2a67ee3771b17963ac7c03d53cc2 | |
| parent | 2955f2f56275fca01cd3f586b3475dcdfbea78ed (diff) | |
Added comments
| -rw-r--r-- | Jellyfin.Data/Entities/AttachmentStreamInfo.cs | 28 |
1 files changed, 27 insertions, 1 deletions
diff --git a/Jellyfin.Data/Entities/AttachmentStreamInfo.cs b/Jellyfin.Data/Entities/AttachmentStreamInfo.cs index 056d5b05e..77b627f37 100644 --- a/Jellyfin.Data/Entities/AttachmentStreamInfo.cs +++ b/Jellyfin.Data/Entities/AttachmentStreamInfo.cs @@ -2,22 +2,48 @@ using System; 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 { + /// <summary> + /// Gets or Sets the <see cref="BaseItemEntity"/> reference. + /// </summary> public required Guid ItemId { get; set; } + /// <summary> + /// Gets or Sets the <see cref="BaseItemEntity"/> reference. + /// </summary> public required BaseItemEntity Item { get; set; } + /// <summary> + /// Gets or Sets The index within the source file. + /// </summary> public required int Index { get; set; } + /// <summary> + /// Gets or Sets the codec of the attachment. + /// </summary> public required string Codec { get; set; } + /// <summary> + /// Gets or Sets the codec tag of the attachment. + /// </summary> public string? CodecTag { get; set; } + /// <summary> + /// Gets or Sets the comment of the attachment. + /// </summary> public string? Comment { get; set; } + /// <summary> + /// Gets or Sets the filename of the attachment. + /// </summary> public string? Filename { get; set; } + /// <summary> + /// Gets or Sets the attachments mimetype. + /// </summary> public string? MimeType { get; set; } } |
