Skip to content

Commit b91b2fa

Browse files
committed
Enhance documentation for DbContext, DbSet, and IQueryable extensions with detailed remarks on functionality and usage
1 parent 81bdaf1 commit b91b2fa

3 files changed

Lines changed: 21 additions & 0 deletions

File tree

src/EfCoreKit.Core/Context/EfCoreKitDbContext.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@ namespace EfCoreKit.Core.Context;
77
/// Base <see cref="DbContext"/> that provides automatic soft delete, audit trail,
88
/// multi-tenancy, and bulk operation support.
99
/// </summary>
10+
/// <remarks>
11+
/// This class inherits from <see cref="DbContext"/> — all standard EF Core features remain
12+
/// fully available. You can use LINQ queries, raw SQL (<c>Database.ExecuteSqlAsync</c>),
13+
/// change tracking, migrations, <c>DbSet&lt;T&gt;</c>, and any EF Core provider feature
14+
/// exactly as you would with a plain <see cref="DbContext"/>.
15+
///
16+
/// EfCoreKit only adds behaviour in the save pipeline (<c>SaveChangesAsync</c>) and
17+
/// through optional global query filters — it never restricts or hides native APIs.
18+
/// </remarks>
1019
/// <typeparam name="TContext">The derived context type.</typeparam>
1120
public abstract class EfCoreKitDbContext<TContext> : DbContext
1221
where TContext : DbContext

src/EfCoreKit.Core/Extensions/DbSetExtensions.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ namespace EfCoreKit.Core.Extensions;
88
/// <summary>
99
/// Extension methods for <see cref="DbSet{T}"/> providing common query shortcuts.
1010
/// </summary>
11+
/// <remarks>
12+
/// These are additive convenience methods — all standard <see cref="DbSet{T}"/> and
13+
/// EF Core APIs (<c>Add</c>, <c>Attach</c>, <c>Entry</c>, <c>FromSqlRaw</c>,
14+
/// <c>ExecuteDeleteAsync</c>, <c>ExecuteUpdateAsync</c>, etc.) remain fully available
15+
/// and can be used alongside these helpers.
16+
/// </remarks>
1117
public static class DbSetExtensions
1218
{
1319
// ─── Single-entity lookups ────────────────────────────────────────

src/EfCoreKit.Core/Extensions/QueryableExtensions.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ namespace EfCoreKit.Core.Extensions;
99
/// Extension methods for <see cref="IQueryable{T}"/> providing pagination,
1010
/// conditional filtering, and dynamic ordering.
1111
/// </summary>
12+
/// <remarks>
13+
/// These are additive convenience methods — all standard LINQ and EF Core
14+
/// <see cref="IQueryable{T}"/> operators (<c>Where</c>, <c>Select</c>, <c>Include</c>,
15+
/// <c>GroupBy</c>, <c>Join</c>, etc.) continue to work and can be mixed freely
16+
/// with the helpers below.
17+
/// </remarks>
1218
public static class QueryableExtensions
1319
{
1420
/// <summary>

0 commit comments

Comments
 (0)