AZEN-SGG/Kavita
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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

Browse source
This commit is contained in:
Joseph Milazzo 2025-05-04 09:04:07 -05:00
parent ae57267e5b
commit 2a528fdb45
7 changed files with 132 additions and 223 deletions
Download patch file Download diff file Expand all files Collapse all files

22
API/DTOs/VolumeDto.cs
View file

@ -1,5 +1,4 @@

using System;
using System;
using System.Collections.Generic;
using API.Entities;
using API.Entities.Interfaces;
@ -10,12 +9,13 @@ namespace API.DTOs;
public sealed record VolumeDto : IHasReadTimeEstimate, IHasCoverImage
{
/// <inheritdoc cref="API.Entities.Volume.Id"/>
public int Id { get; set; }
/// <inheritdoc cref="Volume.MinNumber"/>
/// <inheritdoc cref="API.Entities.Volume.MinNumber"/>
public float MinNumber { get; set; }
/// <inheritdoc cref="Volume.MaxNumber"/>
/// <inheritdoc cref="API.Entities.Volume.MaxNumber"/>
public float MaxNumber { get; set; }
/// <inheritdoc cref="Volume.Name"/>
/// <inheritdoc cref="API.Entities.Volume.Name"/>
public string Name { get; set; } = default!;
/// <summary>
/// This will map to MinNumber. Number was removed in v0.7.13.8/v0.7.14
@ -24,17 +24,21 @@ public sealed record VolumeDto : IHasReadTimeEstimate, IHasCoverImage
public int Number { get; set; }
public int Pages { get; set; }
public int PagesRead { get; set; }
/// <inheritdoc cref="API.Entities.Volume.LastModifiedUtc"/>
public DateTime LastModifiedUtc { get; set; }
/// <inheritdoc cref="API.Entities.Volume.CreatedUtc"/>
public DateTime CreatedUtc { get; set; }
/// <summary>
/// When chapter was created in local server time
/// </summary>
/// <remarks>This is required for Tachiyomi Extension</remarks>
/// <inheritdoc cref="API.Entities.Volume.Created"/>
public DateTime Created { get; set; }
/// <summary>
/// When chapter was last modified in local server time
/// </summary>
/// <remarks>This is required for Tachiyomi Extension</remarks>
/// <inheritdoc cref="API.Entities.Volume.LastModified"/>
public DateTime LastModified { get; set; }
public int SeriesId { get; set; }
public ICollection<ChapterDto> Chapters { get; set; } = new List<ChapterDto>();
@ -64,10 +68,14 @@ public sealed record VolumeDto : IHasReadTimeEstimate, IHasCoverImage
return MinNumber.Is(Parser.SpecialVolumeNumber);
}
/// <inheritdoc cref="API.Entities.Volume.CoverImage"/>
public string CoverImage { get; set; }
/// <inheritdoc cref="API.Entities.Volume.CoverImageLocked"/>
private bool CoverImageLocked { get; set; }
public string PrimaryColor { get; set; } = string.Empty;
public string SecondaryColor { get; set; } = string.Empty;
/// <inheritdoc cref="API.Entities.Volume.PrimaryColor"/>
public string? PrimaryColor { get; set; } = string.Empty;
/// <inheritdoc cref="API.Entities.Volume.SecondaryColor"/>
public string? SecondaryColor { get; set; } = string.Empty;
public void ResetColorScape()
{