浏览代码

Update comments

JPVenson 8 月之前
父节点
当前提交
868bb9ea25
共有 1 个文件被更改,包括 24 次插入4 次删除
  1. 24 4
      Jellyfin.Data/Entities/Chapter.cs

+ 24 - 4
Jellyfin.Data/Entities/Chapter.cs

@@ -1,24 +1,44 @@
 using System;
-using System.Collections.Generic;
-using System.ComponentModel.DataAnnotations;
-using System.ComponentModel.DataAnnotations.Schema;
 
 namespace Jellyfin.Data.Entities;
 
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+/// <summary>
+/// The Chapter entity.
+/// </summary>
 public class Chapter
 {
+    /// <summary>
+    /// Gets or Sets the <see cref="BaseItemEntity"/> reference id.
+    /// </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 chapters index in Item.
+    /// </summary>
     public required int ChapterIndex { get; set; }
 
+    /// <summary>
+    /// Gets or Sets the position within the source file.
+    /// </summary>
     public required long StartPositionTicks { get; set; }
 
+    /// <summary>
+    /// Gets or Sets the common name.
+    /// </summary>
     public string? Name { get; set; }
 
+    /// <summary>
+    /// Gets or Sets the image path.
+    /// </summary>
     public string? ImagePath { get; set; }
 
+    /// <summary>
+    /// Gets or Sets the time the image was last modified.
+    /// </summary>
     public DateTime? ImageDateModified { get; set; }
 }