Skip to content

Commit a13e952

Browse files
committed
Add documentation
1 parent 890616d commit a13e952

1 file changed

Lines changed: 17 additions & 4 deletions

File tree

src/QueryFilterExtensions.cs

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,20 @@
88
namespace EntityFramework.Extensions.AddQueryFilter;
99

1010
/// <summary>
11-
/// Dark magic, refer to https://gist.github.com/haacked/febe9e88354fb2f4a4eb11ba88d64c24
11+
/// Dark magic, refer to https://gist.github.com/haacked/febe9e88354fb2f4a4eb11ba88d64c24
1212
/// </summary>
1313
public static class ModelBuilderExtensions
1414
{
1515
private static readonly MethodInfo _convertAndAppendQueryFilterMethod = typeof(ModelBuilderExtensions)
1616
.GetMethod(nameof(ConvertAndAppendQueryFilter), BindingFlags.NonPublic | BindingFlags.Static)!;
1717

18+
/// <summary>
19+
/// Adds a query filter on all entities assignable to <see cref="TBaseEntity"/>.
20+
/// <remarks>Query filters are joined using a && expression.</remarks>
21+
/// </summary>
22+
/// <param name="builder">The model builder to apply the query filters on</param>
23+
/// <param name="filterExpression">The filter expression</param>
24+
/// <typeparam name="TBaseEntity">The entity type used to select the entities to apply the filter on</typeparam>
1825
[PublicAPI]
1926
public static void AddQueryFilterOnAllEntities<TBaseEntity>(
2027
this ModelBuilder builder,
@@ -31,13 +38,19 @@ public static void AddQueryFilterOnAllEntities<TBaseEntity>(
3138
}
3239
}
3340

41+
/// <summary>
42+
/// Adds a query filter on <see cref="TEntity"/>.
43+
/// <remarks>Query filters are joined using a && expression.</remarks>
44+
/// </summary>
45+
/// <param name="builder">The model builder to apply the query filters on</param>
46+
/// <param name="filterExpression">The filter expression</param>
3447
[PublicAPI]
3548
public static void AddQueryFilter<TEntity>(
36-
this EntityTypeBuilder<TEntity> entityTypeBuilder,
37-
Expression<Func<TEntity, bool>> expression)
49+
this EntityTypeBuilder<TEntity> builder,
50+
Expression<Func<TEntity, bool>> filterExpression)
3851
where TEntity : class
3952
{
40-
entityTypeBuilder.AppendQueryFilter(expression);
53+
builder.AppendQueryFilter(filterExpression);
4154
}
4255

4356
private static void AppendQueryFilter<TBaseEntity>(

0 commit comments

Comments
 (0)