docs(xml): fill missing XML doc comments + strip task-tracking refs across src (fixdocs)
Add missing <summary>/<param>/<returns>/<typeparam> tags and switch interface implementations to <inheritdoc/> across 106 files; strip project bookkeeping identifiers (Task NN, #05-TNN, PLAN-04, StoreAndForward-0NN) from shipped code comments while preserving the descriptive rationale. Comment-only: zero code-logic lines changed; solution builds 0/0. Claude-Session: https://claude.ai/code/session_01MtdgwpEeCUn6cUA5f1LMPj
This commit is contained in:
@@ -67,6 +67,9 @@ public sealed class LoginThrottle
|
||||
/// currently locked out and a bind must be refused without contacting LDAP. Never mutates
|
||||
/// state (an expired lockout simply reads as unlocked; the entry is cleared on the next write).
|
||||
/// </summary>
|
||||
/// <param name="username">The username being authenticated.</param>
|
||||
/// <param name="ip">The client IP address of the bind attempt.</param>
|
||||
/// <returns><c>true</c> when the key is currently locked out; otherwise <c>false</c>.</returns>
|
||||
public bool IsLockedOut(string username, string ip)
|
||||
{
|
||||
var opts = _options.Value;
|
||||
@@ -82,6 +85,8 @@ public sealed class LoginThrottle
|
||||
/// Opens or advances the fixed window and, on reaching the configured threshold, arms the
|
||||
/// lockout. No-op when throttling is disabled.
|
||||
/// </summary>
|
||||
/// <param name="username">The username that failed authentication.</param>
|
||||
/// <param name="ip">The client IP address of the failed bind attempt.</param>
|
||||
public void RecordFailure(string username, string ip)
|
||||
{
|
||||
var opts = _options.Value;
|
||||
@@ -120,6 +125,8 @@ public sealed class LoginThrottle
|
||||
/// Records a successful bind for the given <paramref name="username"/> +
|
||||
/// <paramref name="ip"/>, clearing any accumulated failure count and lockout for that key.
|
||||
/// </summary>
|
||||
/// <param name="username">The username that authenticated successfully.</param>
|
||||
/// <param name="ip">The client IP address of the successful bind attempt.</param>
|
||||
public void RecordSuccess(string username, string ip)
|
||||
{
|
||||
_entries.TryRemove(Key(username, ip), out _);
|
||||
|
||||
Reference in New Issue
Block a user