ljrojas91/adas-core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(iec62304): [REL-1.0.2] apply curated XML doc review updates

Browse Source
This commit is contained in:
n8n IEC 62304 Bot
2026-07-06 19:14:03 +02:00
parent c9446ed5d7
commit 3c2d522c45
2 changed files with 50 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files
adas-core.LdapLogin/LdapLoginService.cs
+10 -13
View File
@@ -167,15 +167,13 @@ public class LdapLoginService : ILoginService
=> throw new LoginServicesException("Not implemented");
/// <summary>
/// Authenticates a user with the provided <paramref name="username"/> and <paramref name="password"/>.
/// Authenticates a user with the specified <paramref name="username"/> and <paramref name="password"/> credentials.
/// </summary>
/// <param name="username">The username of the user attempting to authenticate.</param>
/// <param name="password">The password of the user attempting to authenticate.</param>
/// <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>
/// <param name="username">The username of the user to authenticate.</param>
/// <param name="password">The password of the user to authenticate.</param>
/// <returns>A <see cref="Task{User}"/> that resolves to the authenticated <see cref="User"/>.</returns>
/// <exception cref="LoginServicesException">Thrown when the method is invoked, as authentication is not 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");
@@ -190,14 +188,13 @@ public class LdapLoginService : ILoginService
=> throw new LoginServicesException("Not implemented");
/// <summary>
/// Retrieves a <see cref="User"/> matching the supplied email address, or <see langword="null"/> when no user is found.
/// Retrieves a <see cref="User"/> identified by the supplied email address.
/// The method is not implemented and always throws a <see cref="LoginServicesException"/>.
/// </summary>
/// <param name="email">The email address used to look up the <see cref="User"/>.</param>
/// <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>
/// <param name="email">The email address used to look up the user.</param>
/// <returns>A task that resolves to the matching <see cref="User"/>, or null if no user is found with the given email.</returns>
/// <exception cref="LoginServicesException">Thrown because the method 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");