docs(iec62304): [REL-1.0.2] validate and curate XML doc review markers
This commit is contained in:
@@ -174,6 +174,8 @@ public class LdapLoginService : ILoginService
|
||||
/// <returns>A <see cref="Task{User}"/> that represents the asynchronous authentication operation, yielding the authenticated <see cref="User"/> on success.</returns>
|
||||
/// <exception cref="LoginServicesException">Thrown because the authentication operation is not yet implemented.</exception>
|
||||
/// <!-- aidoc:v1 sig=a0b1f46 -->
|
||||
/// <!-- aidoc-review:v1 severity=low kind=wrong_returns
|
||||
/// "The returns description mentions yielding the authenticated User on success, but the method never reaches success since it always throws. Mitigated by the exception tag noting the not-implemented state." -->
|
||||
public Task<User> Authenticate(string username, string password)
|
||||
=> throw new LoginServicesException("Not implemented");
|
||||
|
||||
@@ -194,6 +196,8 @@ public class LdapLoginService : ILoginService
|
||||
/// <returns>A <see cref="Task{T}"/> that resolves to the matching <see cref="User"/>, or <see langword="null"/> if no user exists for the given <paramref name="email"/>.</returns>
|
||||
/// <exception cref="LoginServicesException">Thrown because the operation is not implemented.</exception>
|
||||
/// <!-- aidoc:v1 sig=ba92b09 -->
|
||||
/// <!-- aidoc-review:v1 severity=high kind=wrong_summary
|
||||
/// "The summary and returns describe retrieving a User (or null), but the method body unconditionally throws LoginServicesException and never performs any lookup or returns a User." -->
|
||||
public Task<User?> GetByEmail(string email)
|
||||
=> throw new LoginServicesException("Not implemented");
|
||||
|
||||
|
||||
Reference in New Issue
Block a user