Added some missed doc comments

This commit is contained in:
Ajay Bhargav Baaskaran 2017-06-27 15:02:17 -07:00
parent 3280ebd84b
commit 379d6d8dcd
5 changed files with 14 additions and 1 deletions

View File

@ -11,6 +11,10 @@ using Microsoft.Extensions.Logging;
namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption
{ {
/// <summary>
/// An <see cref="IAuthenticatedEncryptorFactory"/> to create an <see cref="IAuthenticatedEncryptor"/>
/// based on the <see cref="AuthenticatedEncryptorConfiguration"/>.
/// </summary>
public sealed class AuthenticatedEncryptorFactory : IAuthenticatedEncryptorFactory public sealed class AuthenticatedEncryptorFactory : IAuthenticatedEncryptorFactory
{ {
private readonly ILoggerFactory _loggerFactory; private readonly ILoggerFactory _loggerFactory;

View File

@ -12,6 +12,9 @@ using Microsoft.Extensions.Logging;
namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption
{ {
/// <summary>
/// An <see cref="IAuthenticatedEncryptorFactory"/> for <see cref="CbcAuthenticatedEncryptor"/>.
/// </summary>
public sealed class CngCbcAuthenticatedEncryptorFactory : IAuthenticatedEncryptorFactory public sealed class CngCbcAuthenticatedEncryptorFactory : IAuthenticatedEncryptorFactory
{ {
private readonly ILogger _logger; private readonly ILogger _logger;

View File

@ -12,6 +12,9 @@ using Microsoft.Extensions.Logging;
namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption
{ {
/// <summary>
/// An <see cref="IAuthenticatedEncryptorFactory"/> for <see cref="GcmAuthenticatedEncryptor"/>.
/// </summary>
public sealed class CngGcmAuthenticatedEncryptorFactory : IAuthenticatedEncryptorFactory public sealed class CngGcmAuthenticatedEncryptorFactory : IAuthenticatedEncryptorFactory
{ {
private readonly ILogger _logger; private readonly ILogger _logger;

View File

@ -11,6 +11,9 @@ using Microsoft.Extensions.Logging;
namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption
{ {
/// <summary>
/// An <see cref="IAuthenticatedEncryptorFactory"/> for <see cref="ManagedAuthenticatedEncryptor"/>.
/// </summary>
public sealed class ManagedAuthenticatedEncryptorFactory : IAuthenticatedEncryptorFactory public sealed class ManagedAuthenticatedEncryptorFactory : IAuthenticatedEncryptorFactory
{ {
private readonly ILogger _logger; private readonly ILogger _logger;

View File

@ -145,7 +145,7 @@ namespace Microsoft.AspNetCore.DataProtection
/// Configures the key management options for the data protection system. /// Configures the key management options for the data protection system.
/// </summary> /// </summary>
/// <param name="builder">The <see cref="IDataProtectionBuilder"/>.</param> /// <param name="builder">The <see cref="IDataProtectionBuilder"/>.</param>
/// <param name="setupAction">An <see cref="Action{KeyManagementOptions}"/> to configure the provided<see cref="KeyManagementOptions"/>.</param> /// <param name="setupAction">An <see cref="Action{KeyManagementOptions}"/> to configure the provided <see cref="KeyManagementOptions"/>.</param>
/// <returns>A reference to the <see cref="IDataProtectionBuilder" /> after this operation has completed.</returns> /// <returns>A reference to the <see cref="IDataProtectionBuilder" /> after this operation has completed.</returns>
public static IDataProtectionBuilder AddKeyManagementOptions(this IDataProtectionBuilder builder, Action<KeyManagementOptions> setupAction) public static IDataProtectionBuilder AddKeyManagementOptions(this IDataProtectionBuilder builder, Action<KeyManagementOptions> setupAction)
{ {