Achieves 100% XML doc coverage on non-trivial types with CS1591 enforcement via Directory.Build.props. Coverage by project: - Butter: from 6.5% to 100% (DTOs, enums, MIME types) - Lactose: from ~28% to 100% (controllers, services, repos, jobs, models) - MilkStream.Client: from ~29% to 100% (all frontend services) Uses <inheritdoc /> on repository implementations (interfaces already documented) and full <summary>/<param>/<returns> tags elsewhere. Enums include member-level docs.
45 lines
1.2 KiB
C#
45 lines
1.2 KiB
C#
using Lactose.Models;
|
|
|
|
namespace Lactose.Repositories;
|
|
|
|
/// <summary>
|
|
/// Interface for folder repository operations.
|
|
/// </summary>
|
|
public interface IFolderRepository : IDisposable {
|
|
/// <summary>
|
|
/// Creates a new folder.
|
|
/// </summary>
|
|
/// <param name="folder">The folder to create.</param>
|
|
void Create(Folder folder);
|
|
|
|
/// <summary>
|
|
/// Updates an existing folder.
|
|
/// </summary>
|
|
/// <param name="id">The ID of the folder to update.</param>
|
|
/// <param name="folder">The updated folder data.</param>
|
|
void Update(Guid id, Folder folder);
|
|
|
|
/// <summary>
|
|
/// Deletes a folder by ID.
|
|
/// </summary>
|
|
/// <param name="id">The ID of the folder to delete.</param>
|
|
void Delete(Guid id);
|
|
|
|
/// <summary>
|
|
/// Retrieves a folder by ID.
|
|
/// </summary>
|
|
/// <param name="id">The ID of the folder to retrieve.</param>
|
|
/// <returns>The folder with the specified ID.</returns>
|
|
Folder? Get(Guid id);
|
|
|
|
/// <summary>
|
|
/// Retrieves all folders.
|
|
/// </summary>
|
|
IEnumerable<Folder> GetAll();
|
|
|
|
/// <summary>
|
|
/// Retrieves all folders without tracking them in the change tracker.
|
|
/// </summary>
|
|
IEnumerable<Folder> GetAllUntracked();
|
|
}
|