aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJPVenson <github@jpb.email>2024-10-10 00:01:02 +0000
committerJPVenson <github@jpb.email>2024-10-10 00:01:02 +0000
commit868bb9ea259faa537f44c5c25be823905d4297be (patch)
tree3e1f0cf1807ce7a2cd7b8644de126bf848750254
parent2c2e33dd82de89ce2bc0fe664f5c753e42a716bc (diff)
Update comments
-rw-r--r--Jellyfin.Data/Entities/Chapter.cs28
1 files changed, 24 insertions, 4 deletions
diff --git a/Jellyfin.Data/Entities/Chapter.cs b/Jellyfin.Data/Entities/Chapter.cs
index a55b7fb53..579442cdb 100644
--- a/Jellyfin.Data/Entities/Chapter.cs
+++ b/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; }
}