Skip to content

Commit 5f4e93d

Browse files
Merge pull request #6 from NielsPilgaard/a-bit-more-docs
added a bit more summary docs
2 parents 27c88f1 + 671a00e commit 5f4e93d

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/Pilgaard.CronJobs/ICronJob.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
using Cronos;
2+
using Microsoft.Extensions.DependencyInjection;
3+
using Pilgaard.CronJobs.Extensions;
24

35
namespace Pilgaard.CronJobs;
46

7+
/// <summary>
8+
/// Implementing this interface and registering it in your <see cref="IServiceCollection"/> will give you a functional CronJob.
9+
/// <para>
10+
/// Use <see cref="ServiceCollectionExtensions.AddCronJobs(IServiceCollection, Type[])"/> or one of it's overloads to register the <see cref="ICronJob"/> correctly.
11+
/// </para>
12+
/// </summary>
513
public interface ICronJob
614
{
715
/// <summary>

0 commit comments

Comments
 (0)