Parcourir la source

Added comments

JPVenson il y a 8 mois
Parent
commit
4c86642c00
1 fichiers modifiés avec 27 ajouts et 1 suppressions
  1. 27 1
      Jellyfin.Data/Entities/AttachmentStreamInfo.cs

+ 27 - 1
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; }
 }