Skip to content

Commit a2099a8

Browse files
committed
fixed XML related warnings
1 parent 083107e commit a2099a8

File tree

8 files changed

+35
-12
lines changed

8 files changed

+35
-12
lines changed

src/DependencyInjection/Email.NET.DependencyInjection/Configurations.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
namespace Microsoft.Extensions.DependencyInjection
22
{
33
using Email.NET;
4-
using Email.NET.EDP;
4+
using Email.NET.EDP;
55
using Email.NET.EDP.Smtp;
66
using System;
77

@@ -11,7 +11,7 @@
1111
public static class Configurations
1212
{
1313
/// <summary>
14-
/// add the Email.NET services & configuration.
14+
/// add the Email.NET services and configuration.
1515
/// </summary>
1616
/// <param name="serviceCollection">the service collection instant</param>
1717
/// <param name="config">the configuration initializer.</param>

src/EmailDeliveryProviders/Email.NET.AmazonSES/AmazonSESEmailDeliveryProvider.cs

+6-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public async Task<EmailSendingResult> SendAsync(NET.Message message)
3636
.AddMetaData("message_id", response.MessageId)
3737
.AddMetaData("request_id", response.ResponseMetadata?.RequestId);
3838

39-
if (!(response.ResponseMetadata is null) && response.ResponseMetadata.Metadata.Any())
39+
if (response.ResponseMetadata is not null && response.ResponseMetadata.Metadata.Any())
4040
{
4141
foreach (var metaData in response.ResponseMetadata.Metadata)
4242
result.AddMetaData(metaData.Key, metaData.Value);
@@ -67,6 +67,11 @@ public partial class AmazonSESEmailDeliveryProvider
6767

6868
private readonly AmazonSESEmailDeliveryProviderOptions _options;
6969

70+
/// <summary>
71+
/// create an instance of <see cref="AmazonSESEmailDeliveryProvider"/>
72+
/// </summary>
73+
/// <param name="options">the options instance</param>
74+
/// <exception cref="ArgumentNullException">the given options instance is null</exception>
7075
public AmazonSESEmailDeliveryProvider(AmazonSESEmailDeliveryProviderOptions options)
7176
{
7277
if (options is null)

src/EmailDeliveryProviders/Email.NET.AmazonSES/Options/AmazonSESEmailDeliveryProviderOptions.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public class AmazonSESEmailDeliveryProviderOptions
2121
public string AwsSecretAccessKey { get; set; }
2222

2323
/// <summary>
24-
/// Get or set the AWS session token. this property will be used only if you specified the <seealso cref="AwsSecretAccessKey"/> & <seealso cref="AwsAccessKeyId"/>.
24+
/// Get or set the AWS session token. this property will be used only if you specified the <seealso cref="AwsSecretAccessKey"/> and <seealso cref="AwsAccessKeyId"/>.
2525
/// </summary>
2626
public string AwsSessionToken { get; set; }
2727

src/EmailDeliveryProviders/Email.NET.MailKit/MailKitEmailDeliveryProvider.cs

+7-2
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,11 @@ public partial class MailKitEmailDeliveryProvider
136136

137137
private readonly MailKitEmailDeliveryProviderOptions _options;
138138

139+
/// <summary>
140+
/// create an instance of <see cref="MailKitEmailDeliveryProvider"/>
141+
/// </summary>
142+
/// <param name="options">the edp options instance</param>
143+
/// <exception cref="ArgumentNullException">if the given provider options is null</exception>
139144
public MailKitEmailDeliveryProvider(MailKitEmailDeliveryProviderOptions options)
140145
{
141146
if (options is null)
@@ -239,9 +244,9 @@ public MimeMessage CreateMessage(Message message)
239244
}
240245

241246
/// <summary>
242-
/// add the given list of attachments to the <see cref="MailMessage"/> instance
247+
/// add the given list of attachments to the <see cref="BodyBuilder"/> instance
243248
/// </summary>
244-
/// <param name="message">the <see cref="MailMessage"/> instance</param>
249+
/// <param name="message">the <see cref="BodyBuilder"/> instance</param>
245250
/// <param name="attachments">the list of attachments to add</param>
246251
public void SetAttachments(BodyBuilder message, IEnumerable<NET.Attachment> attachments)
247252
{

src/EmailDeliveryProviders/Email.NET.Mailgun/MailgunEmailDeliveryProvider.cs

+7-3
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,11 @@ public partial class MailgunEmailDeliveryProvider
6666

6767
private readonly MailgunEmailDeliveryProviderOptions _options;
6868

69+
/// <summary>
70+
/// create an instance of <see cref="MailgunEmailDeliveryProvider"/>
71+
/// </summary>
72+
/// <param name="options">the edp options instance</param>
73+
/// <exception cref="ArgumentNullException">if the given provider options is null</exception>
6974
public MailgunEmailDeliveryProvider(MailgunEmailDeliveryProviderOptions options)
7075
{
7176
if (options is null)
@@ -77,11 +82,10 @@ public MailgunEmailDeliveryProvider(MailgunEmailDeliveryProviderOptions options)
7782
}
7883

7984
/// <summary>
80-
/// create an instance of <see cref="BasicMessage"/> from the given <see cref="Message"/>.
85+
/// create an instance of <see cref="HttpClient"/> from the given <see cref="HttpClient"/>.
8186
/// </summary>
8287
/// <param name="message">the message instance</param>
83-
/// <param name="data">the edp data instance</param>
84-
/// <returns>instance of <see cref="BasicMessage"/></returns>
88+
/// <returns>instance of <see cref="HttpClient"/></returns>
8589
public HttpContent CreateMessage(Message message)
8690
{
8791
var content = new MultipartFormDataContent();

src/EmailDeliveryProviders/Email.NET.SendGrid/SendGridEmailDeliveryProvider.cs

+6-1
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,11 @@ public partial class SendgridEmailDeliveryProvider
5454

5555
private readonly SendgridEmailDeliveryProviderOptions _options;
5656

57+
/// <summary>
58+
/// create an instance of <see cref="SendgridEmailDeliveryProvider"/>
59+
/// </summary>
60+
/// <param name="options">the edp options instance</param>
61+
/// <exception cref="ArgumentNullException">if the given provider options is null</exception>
5762
public SendgridEmailDeliveryProvider(SendgridEmailDeliveryProviderOptions options)
5863
{
5964
if (options is null)
@@ -104,7 +109,7 @@ private static async Task<EmailSendingResult> BuildResultObjectAsync(Response re
104109
}
105110

106111
/// <summary>
107-
/// create an instance of <see cref="BasicMessage"/> from the given <see cref="Message"/>.
112+
/// create an instance of <see cref="SendGridMessage"/> from the given <see cref="Message"/>.
108113
/// </summary>
109114
/// <param name="message">the message instance</param>
110115
/// <returns>instance of <see cref="SendGridMessage"/></returns>

src/EmailDeliveryProviders/Email.NET.Socketlabs/Extensions/SocketLabsEmailServiceFactoryExtensions.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public static EmailServiceFactory UseSocketlabs(this EmailServiceFactory builder
2424
/// </summary>
2525
/// <param name="builder">the <see cref="EmailServiceFactory"/> instance.</param>
2626
/// <param name="config">the configuration builder instance.</param>
27-
/// <returns>instance of <see cref="EmailNetBuilder"/> to enable methods chaining.</returns>
27+
/// <returns>instance of <see cref="EmailServiceFactory"/> to enable methods chaining.</returns>
2828
public static EmailServiceFactory UseSocketlabs(this EmailServiceFactory builder, Action<SocketLabsEmailDeliveryProviderOptions> config)
2929
{
3030
// load the configuration

src/EmailDeliveryProviders/Email.NET.Socketlabs/SocketLabsEmailDeliveryProvider.cs

+5-1
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,11 @@ public partial class SocketLabsEmailDeliveryProvider
7676

7777
private readonly SocketLabsEmailDeliveryProviderOptions _options;
7878

79+
/// <summary>
80+
/// create an instance of <see cref="SocketLabsEmailDeliveryProvider"/>
81+
/// </summary>
82+
/// <param name="options">the edp options instance</param>
83+
/// <exception cref="ArgumentNullException">if the given provider options is null</exception>
7984
public SocketLabsEmailDeliveryProvider(SocketLabsEmailDeliveryProviderOptions options)
8085
{
8186
if (options is null)
@@ -127,7 +132,6 @@ private static EmailSendingResult BuildResultObject(SendResponse result)
127132
/// create an instance of <see cref="BasicMessage"/> from the given <see cref="Message"/>.
128133
/// </summary>
129134
/// <param name="message">the message instance</param>
130-
/// <param name="data">the edp data instance</param>
131135
/// <returns>instance of <see cref="BasicMessage"/></returns>
132136
public BasicMessage CreateMessage(Message message)
133137
{

0 commit comments

Comments
 (0)