Skip to content

Commit 6c35224

Browse files
committed
Add XML document to data provider and options builder interfaces.
1 parent 7c89b47 commit 6c35224

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

src/Serilog.Ui.Core/IDataProvider.cs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,21 @@
44

55
namespace Serilog.Ui.Core
66
{
7+
/// <summary>
8+
/// Data provider interface
9+
/// </summary>
710
public interface IDataProvider
811
{
12+
/// <summary>
13+
/// Fetches the log data asynchronous.
14+
/// </summary>
15+
/// <param name="page">The page.</param>
16+
/// <param name="count">The count.</param>
17+
/// <param name="level">The log level to filter log.</param>
18+
/// <param name="searchCriteria">The search criteria to filter log.</param>
19+
/// <param name="startDate">The start date to filter log.</param>
20+
/// <param name="endDate">The end date to filter log.</param>
21+
/// <returns>Task&lt;System.ValueTuple&lt;IEnumerable&lt;LogModel&gt;, System.Int32&gt;&gt;.</returns>
922
Task<(IEnumerable<LogModel>, int)> FetchDataAsync(
1023
int page,
1124
int count,

src/Serilog.Ui.Core/OptionsBuilder/ISerilogUiOptionsBuilder.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,15 @@
22

33
namespace Serilog.Ui.Core
44
{
5+
/// <summary>
6+
/// Serilog UI options builder
7+
/// </summary>
58
public interface ISerilogUiOptionsBuilder
69
{
10+
/// <summary>
11+
/// Gets the services collection.
12+
/// </summary>
13+
/// <value>The services.</value>
714
IServiceCollection Services { get; }
815
}
916
}

0 commit comments

Comments
 (0)