Skip to content

Commit 75a8b10

Browse files
jstedfastjstedfast
committed
Fixed up API summary docs for SecureMimeContext and WindowsSecureMimeContext
1 parent f003b95 commit 75a8b10

2 files changed

Lines changed: 22 additions & 22 deletions

File tree

‎MimeKit/Cryptography/SecureMimeContext.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -923,7 +923,7 @@ internal SmimeCapabilitiesAttribute GetSecureMimeCapabilitiesAttribute (bool inc
923923
public abstract Stream Verify (Stream signedData, out DigitalSignatureCollection signatures, CancellationToken cancellationToken = default);
924924

925925
/// <summary>
926-
/// Encrypts the specified content for the specified recipients.
926+
/// Encrypt the specified content for the specified recipients.
927927
/// </summary>
928928
/// <remarks>
929929
/// Encrypts the specified content for the specified recipients.
@@ -944,7 +944,7 @@ internal SmimeCapabilitiesAttribute GetSecureMimeCapabilitiesAttribute (bool inc
944944
public abstract ApplicationPkcs7Mime Encrypt (CmsRecipientCollection recipients, Stream content, CancellationToken cancellationToken = default);
945945

946946
/// <summary>
947-
/// Asynchronously encrypts the specified content for the specified recipients.
947+
/// Asynchronously encrypt the specified content for the specified recipients.
948948
/// </summary>
949949
/// <remarks>
950950
/// Asynchronously encrypts the specified content for the specified recipients.
@@ -965,7 +965,7 @@ internal SmimeCapabilitiesAttribute GetSecureMimeCapabilitiesAttribute (bool inc
965965
public abstract Task<ApplicationPkcs7Mime> EncryptAsync (CmsRecipientCollection recipients, Stream content, CancellationToken cancellationToken = default);
966966

967967
/// <summary>
968-
/// Decrypts the specified encryptedData to an output stream.
968+
/// Decrypt the specified encryptedData to an output stream.
969969
/// </summary>
970970
/// <remarks>
971971
/// Decrypts the specified encryptedData to an output stream.
@@ -984,7 +984,7 @@ internal SmimeCapabilitiesAttribute GetSecureMimeCapabilitiesAttribute (bool inc
984984
public abstract void DecryptTo (Stream encryptedData, Stream decryptedData, CancellationToken cancellationToken = default);
985985

986986
/// <summary>
987-
/// Asynchronously decrypts the specified encryptedData to an output stream.
987+
/// Asynchronously decrypt the specified encryptedData to an output stream.
988988
/// </summary>
989989
/// <remarks>
990990
/// Asynchronously decrypts the specified encryptedData to an output stream.
@@ -1004,7 +1004,7 @@ internal SmimeCapabilitiesAttribute GetSecureMimeCapabilitiesAttribute (bool inc
10041004
public abstract Task DecryptToAsync (Stream encryptedData, Stream decryptedData, CancellationToken cancellationToken = default);
10051005

10061006
/// <summary>
1007-
/// Imports certificates and keys from a pkcs12-encoded stream.
1007+
/// Import certificates and keys from a pkcs12-encoded stream.
10081008
/// </summary>
10091009
/// <remarks>
10101010
/// Imports certificates and keys from a pkcs12-encoded stream.
@@ -1026,7 +1026,7 @@ internal SmimeCapabilitiesAttribute GetSecureMimeCapabilitiesAttribute (bool inc
10261026
public abstract void Import (Stream stream, string password, CancellationToken cancellationToken = default);
10271027

10281028
/// <summary>
1029-
/// Asynchronously imports certificates and keys from a pkcs12-encoded stream.
1029+
/// Asynchronously import certificates and keys from a pkcs12-encoded stream.
10301030
/// </summary>
10311031
/// <remarks>
10321032
/// Asynchronously imports certificates and keys from a pkcs12-encoded stream.
@@ -1049,7 +1049,7 @@ internal SmimeCapabilitiesAttribute GetSecureMimeCapabilitiesAttribute (bool inc
10491049
public abstract Task ImportAsync (Stream stream, string password, CancellationToken cancellationToken = default);
10501050

10511051
/// <summary>
1052-
/// Imports certificates and keys from a pkcs12 file.
1052+
/// Import certificates and keys from a pkcs12 file.
10531053
/// </summary>
10541054
/// <remarks>
10551055
/// Imports certificates and keys from a pkcs12 file.
@@ -1103,7 +1103,7 @@ public virtual void Import (string fileName, string password, CancellationToken
11031103
}
11041104

11051105
/// <summary>
1106-
/// Asynchronously imports certificates and keys from a pkcs12 file.
1106+
/// Asynchronously import certificates and keys from a pkcs12 file.
11071107
/// </summary>
11081108
/// <remarks>
11091109
/// Asynchronously imports certificates and keys from a pkcs12 file.

‎MimeKit/Cryptography/WindowsSecureMimeContext.cs‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -882,7 +882,7 @@ public override async Task<MimePart> SignAsync (MailboxAddress signer, DigestAlg
882882
}
883883

884884
/// <summary>
885-
/// Attempts to map a <see cref="System.Security.Cryptography.Oid"/>
885+
/// Attempt to map a <see cref="System.Security.Cryptography.Oid"/>
886886
/// to a <see cref="DigestAlgorithm"/>.
887887
/// </summary>
888888
/// <remarks>
@@ -1080,7 +1080,7 @@ public override Stream Verify (Stream signedData, out DigitalSignatureCollection
10801080
}
10811081

10821082
/// <summary>
1083-
/// Gets the preferred encryption algorithm to use for encrypting to the specified recipients.
1083+
/// Get the preferred encryption algorithm to use for encrypting to the specified recipients.
10841084
/// </summary>
10851085
/// <remarks>
10861086
/// <para>Gets the preferred encryption algorithm to use for encrypting to the specified recipients
@@ -1209,7 +1209,7 @@ Task<Stream> EnvelopeAsync (CmsRecipientCollection recipients, Stream content, C
12091209
}
12101210

12111211
/// <summary>
1212-
/// Encrypts the specified content for the specified recipients.
1212+
/// Encrypt the specified content for the specified recipients.
12131213
/// </summary>
12141214
/// <remarks>
12151215
/// Encrypts the specified content for the specified recipients.
@@ -1250,7 +1250,7 @@ public override ApplicationPkcs7Mime Encrypt (CmsRecipientCollection recipients,
12501250
}
12511251

12521252
/// <summary>
1253-
/// Asynchronously encrypts the specified content for the specified recipients.
1253+
/// Asynchronously encrypt the specified content for the specified recipients.
12541254
/// </summary>
12551255
/// <remarks>
12561256
/// Asynchronously encrypts the specified content for the specified recipients.
@@ -1291,7 +1291,7 @@ public override async Task<ApplicationPkcs7Mime> EncryptAsync (CmsRecipientColle
12911291
}
12921292

12931293
/// <summary>
1294-
/// Encrypts the specified content for the specified recipients.
1294+
/// Encrypt the specified content for the specified recipients.
12951295
/// </summary>
12961296
/// <remarks>
12971297
/// Encrypts the specified content for the specified recipients.
@@ -1335,7 +1335,7 @@ public override MimePart Encrypt (IEnumerable<MailboxAddress> recipients, Stream
13351335
}
13361336

13371337
/// <summary>
1338-
/// Asynchronously encrypts the specified content for the specified recipients.
1338+
/// Asynchronously encrypt the specified content for the specified recipients.
13391339
/// </summary>
13401340
/// <remarks>
13411341
/// Asynchronously encrypts the specified content for the specified recipients.
@@ -1391,7 +1391,7 @@ static byte[] Decrypt (byte[] content)
13911391
/// Decrypt the encrypted data.
13921392
/// </summary>
13931393
/// <remarks>
1394-
/// Decrypt the encrypted data.
1394+
/// Decrypts the encrypted data.
13951395
/// </remarks>
13961396
/// <returns>The decrypted <see cref="MimeEntity"/>.</returns>
13971397
/// <param name="encryptedData">The encrypted data.</param>
@@ -1422,7 +1422,7 @@ public override MimeEntity Decrypt (Stream encryptedData, CancellationToken canc
14221422
/// Asynchronously decrypt the encrypted data.
14231423
/// </summary>
14241424
/// <remarks>
1425-
/// Asynchronously decrypt the encrypted data.
1425+
/// Asynchronously decrypts the encrypted data.
14261426
/// </remarks>
14271427
/// <returns>The decrypted <see cref="MimeEntity"/>.</returns>
14281428
/// <param name="encryptedData">The encrypted data.</param>
@@ -1450,7 +1450,7 @@ public override async Task<MimeEntity> DecryptAsync (Stream encryptedData, Cance
14501450
}
14511451

14521452
/// <summary>
1453-
/// Decrypts the specified encryptedData to an output stream.
1453+
/// Decrypt the specified encryptedData to an output stream.
14541454
/// </summary>
14551455
/// <remarks>
14561456
/// Decrypts the specified encryptedData to an output stream.
@@ -1484,7 +1484,7 @@ public override void DecryptTo (Stream encryptedData, Stream decryptedData, Canc
14841484
}
14851485

14861486
/// <summary>
1487-
/// Asynchronously decrypts the specified encryptedData to an output stream.
1487+
/// Asynchronously decrypt the specified encryptedData to an output stream.
14881488
/// </summary>
14891489
/// <remarks>
14901490
/// Asynchronously decrypts the specified encryptedData to an output stream.
@@ -1522,7 +1522,7 @@ public override async Task DecryptToAsync (Stream encryptedData, Stream decrypte
15221522
/// Import the specified certificate.
15231523
/// </summary>
15241524
/// <remarks>
1525-
/// Import the specified certificate.
1525+
/// Imports the specified certificate.
15261526
/// </remarks>
15271527
/// <param name="storeName">The store to import the certificate into.</param>
15281528
/// <param name="certificate">The certificate.</param>
@@ -1570,7 +1570,7 @@ public override void Import (X509Certificate2 certificate, CancellationToken can
15701570
/// Import the specified certificate.
15711571
/// </summary>
15721572
/// <remarks>
1573-
/// Import the specified certificate.
1573+
/// Imports the specified certificate.
15741574
/// </remarks>
15751575
/// <param name="storeName">The store to import the certificate into.</param>
15761576
/// <param name="certificate">The certificate.</param>
@@ -1811,7 +1811,7 @@ public override Task ImportAsync (Stream stream, string password, CancellationTo
18111811
}
18121812

18131813
/// <summary>
1814-
/// Exports the certificates for the specified mailboxes.
1814+
/// Export certificates for the specified mailboxes.
18151815
/// </summary>
18161816
/// <remarks>
18171817
/// Exports the certificates for the specified mailboxes.
@@ -1868,7 +1868,7 @@ public override MimePart Export (IEnumerable<MailboxAddress> mailboxes, Cancella
18681868
}
18691869

18701870
/// <summary>
1871-
/// Asynchronously export the certificates for the specified mailboxes.
1871+
/// Asynchronously export certificates for the specified mailboxes.
18721872
/// </summary>
18731873
/// <remarks>
18741874
/// Asynchronously exports the certificates for the specified mailboxes.

0 commit comments

Comments
 (0)