Fix XML documentation syntax errors in templates

This commit is contained in:
Maarten Balliauw 2025-01-26 13:52:27 +01:00
parent 62e333ae75
commit 577e54a641
No known key found for this signature in database
3 changed files with 18 additions and 9 deletions

View file

@ -75,6 +75,7 @@ public static class Telemetry
/// </summary>
/// <param name="clientId">Client id</param>
/// <param name="scopes">Scope names. Each element is added on it's own to the counter</param>
/// <param name="remember">Remember consent granted</param>
public static void ConsentGranted(string clientId, IEnumerable<string> scopes, bool remember)
{
ArgumentNullException.ThrowIfNull(scopes);
@ -90,7 +91,7 @@ public static class Telemetry
}
/// <summary>
/// Helper method to increase <see cref="Counters.ConsentDenied"/> counter. The scopes
/// Helper method to increase <see cref="Counters.Consent"/> counter. The scopes
/// are expanded and called one by one to not cause a combinatory explosion of scopes.
/// </summary>
/// <param name="clientId">Client id</param>
@ -119,13 +120,15 @@ public static class Telemetry
/// Helper method to increase <see cref="Counters.UserLogin"/> counter.
/// </summary>
/// <param name="clientId">Client Id, if available</param>
/// <param name="idp">Identity provider</param>
public static void UserLogin(string? clientId, string idp)
=> UserLoginCounter.Add(1, new(Tags.Client, clientId), new(Tags.Idp, idp));
/// <summary>
/// Helper method to increase <see cref="Counters.UserLogin" counter on failure.
/// Helper method to increase <see cref="Counters.UserLogin"/> counter on failure.
/// </summary>
/// <param name="clientId">Client Id, if available</param>
/// <param name="idp">Identity provider</param>
/// <param name="error">Error message</param>
public static void UserLoginFailure(string? clientId, string idp, string error)
=> UserLoginCounter.Add(1, new(Tags.Client, clientId), new(Tags.Idp, idp), new(Tags.Error, error));
@ -139,4 +142,4 @@ public static class Telemetry
public static void UserLogout(string? idp)
=> UserLogoutCounter.Add(1, tag: new(Tags.Idp, idp));
}
}
}

View file

@ -75,6 +75,7 @@ public static class Telemetry
/// </summary>
/// <param name="clientId">Client id</param>
/// <param name="scopes">Scope names. Each element is added on it's own to the counter</param>
/// <param name="remember">Remember consent granted</param>
public static void ConsentGranted(string clientId, IEnumerable<string> scopes, bool remember)
{
ArgumentNullException.ThrowIfNull(scopes);
@ -90,7 +91,7 @@ public static class Telemetry
}
/// <summary>
/// Helper method to increase <see cref="Counters.ConsentDenied"/> counter. The scopes
/// Helper method to increase <see cref="Counters.Consent"/> counter. The scopes
/// are expanded and called one by one to not cause a combinatory explosion of scopes.
/// </summary>
/// <param name="clientId">Client id</param>
@ -119,13 +120,15 @@ public static class Telemetry
/// Helper method to increase <see cref="Counters.UserLogin"/> counter.
/// </summary>
/// <param name="clientId">Client Id, if available</param>
/// <param name="idp">Identity provider</param>
public static void UserLogin(string? clientId, string idp)
=> UserLoginCounter.Add(1, new(Tags.Client, clientId), new(Tags.Idp, idp));
/// <summary>
/// Helper method to increase <see cref="Counters.UserLogin" counter on failure.
/// Helper method to increase <see cref="Counters.UserLogin"/> counter on failure.
/// </summary>
/// <param name="clientId">Client Id, if available</param>
/// <param name="idp">Identity provider</param>
/// <param name="error">Error message</param>
public static void UserLoginFailure(string? clientId, string idp, string error)
=> UserLoginCounter.Add(1, new(Tags.Client, clientId), new(Tags.Idp, idp), new(Tags.Error, error));
@ -139,4 +142,4 @@ public static class Telemetry
public static void UserLogout(string? idp)
=> UserLogoutCounter.Add(1, tag: new(Tags.Idp, idp));
}
}
}

View file

@ -75,6 +75,7 @@ public static class Telemetry
/// </summary>
/// <param name="clientId">Client id</param>
/// <param name="scopes">Scope names. Each element is added on it's own to the counter</param>
/// <param name="remember">Remember consent granted</param>
public static void ConsentGranted(string clientId, IEnumerable<string> scopes, bool remember)
{
ArgumentNullException.ThrowIfNull(scopes);
@ -90,7 +91,7 @@ public static class Telemetry
}
/// <summary>
/// Helper method to increase <see cref="Counters.ConsentDenied"/> counter. The scopes
/// Helper method to increase <see cref="Counters.Consent"/> counter. The scopes
/// are expanded and called one by one to not cause a combinatory explosion of scopes.
/// </summary>
/// <param name="clientId">Client id</param>
@ -119,13 +120,15 @@ public static class Telemetry
/// Helper method to increase <see cref="Counters.UserLogin"/> counter.
/// </summary>
/// <param name="clientId">Client Id, if available</param>
/// <param name="idp">Identity provider</param>
public static void UserLogin(string? clientId, string idp)
=> UserLoginCounter.Add(1, new(Tags.Client, clientId), new(Tags.Idp, idp));
/// <summary>
/// Helper method to increase <see cref="Counters.UserLogin" counter on failure.
/// Helper method to increase <see cref="Counters.UserLogin"/> counter on failure.
/// </summary>
/// <param name="clientId">Client Id, if available</param>
/// <param name="idp">Identity provider</param>
/// <param name="error">Error message</param>
public static void UserLoginFailure(string? clientId, string idp, string error)
=> UserLoginCounter.Add(1, new(Tags.Client, clientId), new(Tags.Idp, idp), new(Tags.Error, error));
@ -139,4 +142,4 @@ public static class Telemetry
public static void UserLogout(string? idp)
=> UserLogoutCounter.Add(1, tag: new(Tags.Idp, idp));
}
}
}