Browse Source

Update the XML documentation to use <list type="bullet"> where appropriate

pull/1039/head
Kévin Chalet 6 years ago
parent
commit
e2fe4d9d37
  1. 20
      src/OpenIddict.Server/OpenIddictServerOptions.cs
  2. 10
      src/OpenIddict.Validation/OpenIddictValidationOptions.cs

20
src/OpenIddict.Server/OpenIddictServerOptions.cs

@ -36,10 +36,12 @@ namespace OpenIddict.Server
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Note: OpenIddict automatically sorts the credentials based on the following algorithm: /// Note: OpenIddict automatically sorts the credentials based on the following algorithm:
/// <para>• Symmetric keys are always preferred when they can be used for the operation (e.g token encryption).</para> /// <list type="bullet">
/// <para>• X.509 keys are always preferred to non-X.509 asymmetric keys.</para> /// <item><description>Symmetric keys are always preferred when they can be used for the operation (e.g token encryption).</description></item>
/// <para>• X.509 keys with the furthest expiration date are preferred.</para> /// <item><description>X.509 keys are always preferred to non-X.509 asymmetric keys.</description></item>
/// <para>• X.509 keys whose backing certificate is not yet valid are never preferred.</para> /// <item><description>X.509 keys with the furthest expiration date are preferred.</description></item>
/// <item><description>X.509 keys whose backing certificate is not yet valid are never preferred.</description></item>
/// </list>
/// </remarks> /// </remarks>
public List<EncryptingCredentials> EncryptionCredentials { get; } = new List<EncryptingCredentials>(); public List<EncryptingCredentials> EncryptionCredentials { get; } = new List<EncryptingCredentials>();
@ -52,10 +54,12 @@ namespace OpenIddict.Server
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Note: OpenIddict automatically sorts the credentials based on the following algorithm: /// Note: OpenIddict automatically sorts the credentials based on the following algorithm:
/// <para>• Symmetric keys are always preferred when they can be used for the operation (e.g token signing).</para> /// <list type="bullet">
/// <para>• X.509 keys are always preferred to non-X.509 asymmetric keys.</para> /// <item><description>Symmetric keys are always preferred when they can be used for the operation (e.g token signing).</description></item>
/// <para>• X.509 keys with the furthest expiration date are preferred.</para> /// <item><description>X.509 keys are always preferred to non-X.509 asymmetric keys.</description></item>
/// <para>• X.509 keys whose backing certificate is not yet valid are never preferred.</para> /// <item><description>X.509 keys with the furthest expiration date are preferred.</description></item>
/// <item><description>X.509 keys whose backing certificate is not yet valid are never preferred.</description></item>
/// </list>
/// </remarks> /// </remarks>
public List<SigningCredentials> SigningCredentials { get; } = new List<SigningCredentials>(); public List<SigningCredentials> SigningCredentials { get; } = new List<SigningCredentials>();

10
src/OpenIddict.Validation/OpenIddictValidationOptions.cs

@ -28,10 +28,12 @@ namespace OpenIddict.Validation
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Note: OpenIddict automatically sorts the credentials based on the following algorithm: /// Note: OpenIddict automatically sorts the credentials based on the following algorithm:
/// <para>• Symmetric keys are always preferred when they can be used for the operation (e.g token decryption).</para> /// <list type="bullet">
/// <para>• X.509 keys are always preferred to non-X.509 asymmetric keys.</para> /// <item><description>Symmetric keys are always preferred when they can be used for the operation (e.g token encryption).</description></item>
/// <para>• X.509 keys with the furthest expiration date are preferred.</para> /// <item><description>X.509 keys are always preferred to non-X.509 asymmetric keys.</description></item>
/// <para>• X.509 keys whose backing certificate is not yet valid are never preferred.</para> /// <item><description>X.509 keys with the furthest expiration date are preferred.</description></item>
/// <item><description>X.509 keys whose backing certificate is not yet valid are never preferred.</description></item>
/// </list>
/// </remarks> /// </remarks>
public List<EncryptingCredentials> EncryptionCredentials { get; } = new List<EncryptingCredentials>(); public List<EncryptingCredentials> EncryptionCredentials { get; } = new List<EncryptingCredentials>();

Loading…
Cancel
Save