Commit f5dd4855 authored by Greg Messner's avatar Greg Messner
Browse files

Updated Javadocs for getUser(String username).

parent 5efacf72
...@@ -282,14 +282,14 @@ public class UserApi extends AbstractApi { ...@@ -282,14 +282,14 @@ public class UserApi extends AbstractApi {
} }
/** /**
* Lookup a user by username. * Lookup a user by username. Returns null if not found.
* *
* <p>NOTE: This is for admin users only.</p> * <p>NOTE: This is for admin users only.</p>
* *
* <pre><code>GitLab Endpoint: GET /users?username=:username</code></pre> * <pre><code>GitLab Endpoint: GET /users?username=:username</code></pre>
* *
* @param username the username of the user to get * @param username the username of the user to get
* @return the User instance for the specified username * @return the User instance for the specified username, or null if not found
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
*/ */
public User getUser(String username) throws GitLabApiException { public User getUser(String username) throws GitLabApiException {
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment