浏览代码

Document HomeSection.cs

Patrick Barron 5 年之前
父节点
当前提交
3c7eb6b324
共有 1 个文件被更改,包括 19 次插入2 次删除
  1. 19 2
      Jellyfin.Data/Entities/HomeSection.cs

+ 19 - 2
Jellyfin.Data/Entities/HomeSection.cs

@@ -1,21 +1,38 @@
-using System;
-using System.ComponentModel.DataAnnotations;
+using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
 using Jellyfin.Data.Enums;
 
 namespace Jellyfin.Data.Entities
 {
+    /// <summary>
+    /// An entity representing a section on the user's home page.
+    /// </summary>
     public class HomeSection
     {
+        /// <summary>
+        /// Gets or sets the id.
+        /// </summary>
+        /// <remarks>
+        /// Identity. Required.
+        /// </remarks>
         [Key]
         [Required]
         [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
         public int Id { get; protected set; }
 
+        /// <summary>
+        /// Gets or sets the Id of the associated display preferences.
+        /// </summary>
         public int DisplayPreferencesId { get; set; }
 
+        /// <summary>
+        /// Gets or sets the order.
+        /// </summary>
         public int Order { get; set; }
 
+        /// <summary>
+        /// Gets or sets the type.
+        /// </summary>
         public HomeSectionType Type { get; set; }
     }
 }