Added some inheritdocs to some DTOs to make it more clear how they function.

API/DTOs/UserPreferencesDto.cs

@@ -9,102 +9,59 @@ namespace API.DTOs;
 
 public sealed record UserPreferencesDto
 {
-    /// <summary>
-    /// Manga Reader Option: What direction should the next/prev page buttons go
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.ReadingDirection"/>
     [Required]
     public ReadingDirection ReadingDirection { get; set; }
-    /// <summary>
-    /// Manga Reader Option: How should the image be scaled to screen
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.ScalingOption"/>
     [Required]
     public ScalingOption ScalingOption { get; set; }
-    /// <summary>
-    /// Manga Reader Option: Which side of a split image should we show first
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.PageSplitOption"/>
     [Required]
     public PageSplitOption PageSplitOption { get; set; }
-    /// <summary>
-    /// Manga Reader Option: How the manga reader should perform paging or reading of the file
-    /// <example>
-    /// Webtoon uses scrolling to page, LeftRight uses paging by clicking left/right side of reader, UpDown uses paging
-    /// by clicking top/bottom sides of reader.
-    /// </example>
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.ReaderMode"/>
     [Required]
     public ReaderMode ReaderMode { get; set; }
-    /// <summary>
-    /// Manga Reader Option: How many pages to display in the reader at once
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.LayoutMode"/>
     [Required]
     public LayoutMode LayoutMode { get; set; }
-    /// <summary>
-    /// Manga Reader Option: Emulate a book by applying a shadow effect on the pages
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.EmulateBook"/>
     [Required]
     public bool EmulateBook { get; set; }
-    /// <summary>
-    /// Manga Reader Option: Background color of the reader
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.BackgroundColor"/>
     [Required]
     public string BackgroundColor { get; set; } = "#000000";
-    /// <summary>
-    /// Manga Reader Option: Should swiping trigger pagination
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.SwipeToPaginate"/>
     [Required]
     public bool SwipeToPaginate { get; set; }
-    /// <summary>
-    /// Manga Reader Option: Allow the menu to close after 6 seconds without interaction
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.AutoCloseMenu"/>
     [Required]
     public bool AutoCloseMenu { get; set; }
-    /// <summary>
-    /// Manga Reader Option: Show screen hints to the user on some actions, ie) pagination direction change
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.ShowScreenHints"/>
     [Required]
     public bool ShowScreenHints { get; set; } = true;
-    /// <summary>
-    /// Manga Reader Option: Allow Automatic Webtoon detection
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.AllowAutomaticWebtoonReaderDetection"/>
     [Required]
     public bool AllowAutomaticWebtoonReaderDetection { get; set; }
 
-
-    /// <summary>
-    /// Book Reader Option: Override extra Margin
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.BookReaderMargin"/>
     [Required]
     public int BookReaderMargin { get; set; }
-    /// <summary>
-    /// Book Reader Option: Override line-height
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.BookReaderLineSpacing"/>
     [Required]
     public int BookReaderLineSpacing { get; set; }
-    /// <summary>
-    /// Book Reader Option: Override font size
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.BookReaderFontSize"/>
     [Required]
     public int BookReaderFontSize { get; set; }
-    /// <summary>
-    /// Book Reader Option: Maps to the default Kavita font-family (inherit) or an override
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.BookReaderFontFamily"/>
     [Required]
     public string BookReaderFontFamily { get; set; } = null!;
-
-    /// <summary>
-    /// Book Reader Option: Allows tapping on side of screens to paginate
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.BookReaderTapToPaginate"/>
     [Required]
     public bool BookReaderTapToPaginate { get; set; }
-    /// <summary>
-    /// Book Reader Option: What direction should the next/prev page buttons go
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.BookReaderReadingDirection"/>
     [Required]
     public ReadingDirection BookReaderReadingDirection { get; set; }
-
-    /// <summary>
-    /// Book Reader Option: What writing style should be used, horizontal or vertical.
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.BookReaderWritingStyle"/>
     [Required]
     public WritingStyle BookReaderWritingStyle { get; set; }
 
@@ -116,79 +73,46 @@ public sealed record UserPreferencesDto
     public SiteThemeDto? Theme { get; set; }
 
     [Required] public string BookReaderThemeName { get; set; } = null!;
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.BookReaderLayoutMode"/>
     [Required]
     public BookPageLayoutMode BookReaderLayoutMode { get; set; }
-    /// <summary>
-    /// Book Reader Option: A flag that hides the menu-ing system behind a click on the screen. This should be used with tap to paginate, but the app doesn't enforce this.
-    /// </summary>
-    /// <remarks>Defaults to false</remarks>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.BookReaderImmersiveMode"/>
     [Required]
     public bool BookReaderImmersiveMode { get; set; } = false;
-    /// <summary>
-    /// Global Site Option: If the UI should layout items as Cards or List items
-    /// </summary>
-    /// <remarks>Defaults to Cards</remarks>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.GlobalPageLayoutMode"/>
     [Required]
     public PageLayoutMode GlobalPageLayoutMode { get; set; } = PageLayoutMode.Cards;
-    /// <summary>
-    /// UI Site Global Setting: If unread summaries should be blurred until expanded or unless user has read it already
-    /// </summary>
-    /// <remarks>Defaults to false</remarks>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.BlurUnreadSummaries"/>
     [Required]
     public bool BlurUnreadSummaries { get; set; } = false;
-    /// <summary>
-    /// UI Site Global Setting: Should Kavita prompt user to confirm downloads that are greater than 100 MB.
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.PromptForDownloadSize"/>
     [Required]
     public bool PromptForDownloadSize { get; set; } = true;
-    /// <summary>
-    /// UI Site Global Setting: Should Kavita disable CSS transitions
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.NoTransitions"/>
     [Required]
     public bool NoTransitions { get; set; } = false;
-    /// <summary>
-    /// When showing series, only parent series or series with no relationships will be returned
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.CollapseSeriesRelationships"/>
     [Required]
     public bool CollapseSeriesRelationships { get; set; } = false;
-    /// <summary>
-    /// UI Site Global Setting: Should series reviews be shared with all users in the server
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.ShareReviews"/>
     [Required]
     public bool ShareReviews { get; set; } = false;
-    /// <summary>
-    /// UI Site Global Setting: The language locale that should be used for the user
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.Locale"/>
     [Required]
     public string Locale { get; set; }
 
-    /// <summary>
-    /// PDF Reader: Theme of the Reader
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.PdfTheme"/>
     [Required]
     public PdfTheme PdfTheme { get; set; } = PdfTheme.Dark;
-    /// <summary>
-    /// PDF Reader: Scroll mode of the reader
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.PdfScrollMode"/>
     [Required]
     public PdfScrollMode PdfScrollMode { get; set; } = PdfScrollMode.Vertical;
-    /// <summary>
-    /// PDF Reader: Layout Mode of the reader
-    /// </summary>
-    [Required]
-    public PdfLayoutMode PdfLayoutMode { get; set; } = PdfLayoutMode.Multiple;
-    /// <summary>
-    /// PDF Reader: Spread Mode of the reader
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.PdfSpreadMode"/>
     [Required]
     public PdfSpreadMode PdfSpreadMode { get; set; } = PdfSpreadMode.None;
 
-    /// <summary>
-    /// Kavita+: Should this account have Scrobbling enabled for AniList
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.AniListScrobblingEnabled"/>
     public bool AniListScrobblingEnabled { get; set; }
-    /// <summary>
-    /// Kavita+: Should this account have Want to Read Sync enabled
-    /// </summary>
+    /// <inheritdoc cref="API.Entities.AppUserPreferences.WantToReadSync"/>
     public bool WantToReadSync { get; set; }
 }