From e96a36512a542168e3d50609b1c4058e965a9791 Mon Sep 17 00:00:00 2001
From: Patrick Barron <barronpm@gmail.com>
Date: Thu, 9 Jul 2020 22:00:34 -0400
Subject: [PATCH] Document DisplayPreferences.cs

---
 Jellyfin.Data/Entities/DisplayPreferences.cs | 77 ++++++++++++++++++++
 1 file changed, 77 insertions(+)

diff --git a/Jellyfin.Data/Entities/DisplayPreferences.cs b/Jellyfin.Data/Entities/DisplayPreferences.cs
index 668030149b..928407e7a0 100644
--- a/Jellyfin.Data/Entities/DisplayPreferences.cs
+++ b/Jellyfin.Data/Entities/DisplayPreferences.cs
@@ -6,8 +6,16 @@ using Jellyfin.Data.Enums;
 
 namespace Jellyfin.Data.Entities
 {
+    /// <summary>
+    /// An entity representing a user's display preferences.
+    /// </summary>
     public class DisplayPreferences
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DisplayPreferences"/> class.
+        /// </summary>
+        /// <param name="client">The client string.</param>
+        /// <param name="userId">The user's id.</param>
         public DisplayPreferences(string client, Guid userId)
         {
             RememberIndexing = false;
@@ -18,14 +26,29 @@ namespace Jellyfin.Data.Entities
             HomeSections = new HashSet<HomeSection>();
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DisplayPreferences"/> class.
+        /// </summary>
         protected DisplayPreferences()
         {
         }
 
+        /// <summary>
+        /// Gets or sets the Id.
+        /// </summary>
+        /// <remarks>
+        /// Required.
+        /// </remarks>
         [Required]
         [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
         public int Id { get; protected set; }
 
+        /// <summary>
+        /// Gets or sets the user Id.
+        /// </summary>
+        /// <remarks>
+        /// Required.
+        /// </remarks>
         [Required]
         public Guid UserId { get; set; }
 
@@ -38,35 +61,89 @@ namespace Jellyfin.Data.Entities
         /// </remarks>
         public Guid? ItemId { get; set; }
 
+        /// <summary>
+        /// Gets or sets the client string.
+        /// </summary>
+        /// <remarks>
+        /// Required. Max Length = 64.
+        /// </remarks>
         [Required]
         [MaxLength(64)]
         [StringLength(64)]
         public string Client { get; set; }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether the indexing should be remembered.
+        /// </summary>
+        /// <remarks>
+        /// Required.
+        /// </remarks>
         [Required]
         public bool RememberIndexing { get; set; }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether the sorting type should be remembered.
+        /// </summary>
+        /// <remarks>
+        /// Required.
+        /// </remarks>
         [Required]
         public bool RememberSorting { get; set; }
 
+        /// <summary>
+        /// Gets or sets the sort order.
+        /// </summary>
+        /// <remarks>
+        /// Required.
+        /// </remarks>
         [Required]
         public SortOrder SortOrder { get; set; }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether to show the sidebar.
+        /// </summary>
+        /// <remarks>
+        /// Required.
+        /// </remarks>
         [Required]
         public bool ShowSidebar { get; set; }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether to show the backdrop.
+        /// </summary>
+        /// <remarks>
+        /// Required.
+        /// </remarks>
         [Required]
         public bool ShowBackdrop { get; set; }
 
+        /// <summary>
+        /// Gets or sets what the view should be sorted by.
+        /// </summary>
         public string SortBy { get; set; }
 
+        /// <summary>
+        /// Gets or sets the view type.
+        /// </summary>
         public ViewType? ViewType { get; set; }
 
+        /// <summary>
+        /// Gets or sets the scroll direction.
+        /// </summary>
+        /// <remarks>
+        /// Required.
+        /// </remarks>
         [Required]
         public ScrollDirection ScrollDirection { get; set; }
 
+        /// <summary>
+        /// Gets or sets what the view should be indexed by.
+        /// </summary>
         public IndexingKind? IndexBy { get; set; }
 
+        /// <summary>
+        /// Gets or sets the home sections.
+        /// </summary>
         public virtual ICollection<HomeSection> HomeSections { get; protected set; }
     }
 }