Skip to content
Snippets Groups Projects
Commit 26defbdc authored by brinn's avatar brinn
Browse files

doc: improve authenticate()

SVN: 257
parent b0ce0f32
No related branches found
No related tags found
No related merge requests found
...@@ -33,7 +33,9 @@ public interface IAuthenticationService ...@@ -33,7 +33,9 @@ public interface IAuthenticationService
public void checkAvailability(); public void checkAvailability();
/** /**
* Returns <code>true</code> if the specified user is authenticated with the specified password. * Attempts authentication for the given user credentials.
*
* @return <code>true</code> if the <var>user</var> has been successfully authenticated.
*/ */
public boolean authenticate(String user, String password); public boolean authenticate(String user, String password);
} }
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment