added basic xml comments to all Oqtane.Services interfaces

This commit is contained in:
Marc Drexel
2021-09-17 10:13:26 +02:00
parent 423a42d25b
commit 267ca178ed
20 changed files with 700 additions and 13 deletions

View File

@ -4,10 +4,22 @@ using System.Threading.Tasks;
namespace Oqtane.Services
{
/// <summary>
/// Service to read the job schedule log
/// </summary>
public interface IJobLogService
{
/// <summary>
/// Return a list of all <see cref="JobLog"/> entries
/// </summary>
/// <returns></returns>
Task<List<JobLog>> GetJobLogsAsync();
/// <summary>
/// Return a <see cref="JobLog"/> entry for the given Id
/// </summary>
/// <param name="jobLogId"></param>
/// <returns></returns>
Task<JobLog> GetJobLogAsync(int jobLogId);
}
}