Skip to content

Commit

Permalink
documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
ByteDecoder committed Oct 23, 2023
1 parent a2b972c commit e6a93b1
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
1 change: 0 additions & 1 deletion src/Queryology.Abstractions/IQuery.cs
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,3 @@ public interface IQuery<T>
/// </summary>
void Execute();
}

20 changes: 11 additions & 9 deletions src/Queryology/QueryologyEngine.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ public class QueryologyEngine<T> : IQueryologyEngine<T>
private bool _ignoreExcludedQueries;

/// <summary>
///
/// Initializes a new instance of the <see cref="QueryologyEngine{T}"/> class.
/// </summary>
/// <param name="queryologyOptions"></param>
/// <param name="queryologyOptions">Expect and instance of instance of
/// the <see cref="QueryologyEngineOptions{T}"/> class.</param>
public QueryologyEngine(QueryologyEngineOptions<T> queryologyOptions)
: this(
queryologyOptions.DataContextProvider,
Expand All @@ -45,20 +46,21 @@ public QueryologyEngine(
}

/// <summary>
///
/// LINQ deferred query operator to filter the query execution if queries are
/// Executable or ignore that object state.
/// </summary>
/// <param name="ignoreQueries">The default is true, otherwise all queries will executed even if they are mark as not executable</param>
/// <returns></returns>
/// <returns>returns the IQueryologyEngine of type T instance.</returns>
public IQueryologyEngine<T> IgnoreExcludedQueries(bool ignoreQueries)
{
_ignoreExcludedQueries = ignoreQueries;
return this;
}

/// <summary>
/// Execute each query object IQuery, loaded in the Current AppDomain
/// Execute each query object IQuery, loaded in the Current AppDomain.
/// </summary>
/// <returns>Total executed queries</returns>
/// <returns>Total executed queries.</returns>
public int Execute()
{
var totalExecQueries = 0;
Expand All @@ -71,16 +73,16 @@ public int Execute()
query.Execute();
checked
{ totalExecQueries++; }
};
}

_ignoreExcludedQueries = true;
return totalExecQueries;
}

/// <summary>
///
/// Scan the assembly for all types assignable to IQuery and create an instance of each.
/// </summary>
/// <returns>An enumerator for each of the Query Types registered in the loaded assemblies</returns>
/// <returns>An enumerator for each of the Query Types registered in the loaded assemblies.</returns>
private IEnumerable<IQuery<T>> RegisteredQueries()
{
var loadedTypes = GetLoadedTypes(typeof(IQuery<T>));
Expand Down

0 comments on commit e6a93b1

Please sign in to comment.