Commit 3fc7ad59 authored by Greg Messner's avatar Greg Messner
Browse files

Javadoc clean-up.

parent 91fbe829
...@@ -181,7 +181,7 @@ public class GitLabApiClient { ...@@ -181,7 +181,7 @@ public class GitLabApiClient {
* *
* @param pathArgs ariable list of arguments used to build the URI * @param pathArgs ariable list of arguments used to build the URI
* @return a REST URL with the specified path arguments * @return a REST URL with the specified path arguments
* @throws IOException * @throws IOException if an error occurs while constructing the URL
*/ */
protected URL getApiUrl(Object... pathArgs) throws IOException { protected URL getApiUrl(Object... pathArgs) throws IOException {
...@@ -223,7 +223,7 @@ public class GitLabApiClient { ...@@ -223,7 +223,7 @@ public class GitLabApiClient {
* @param queryParams multivalue map of request parameters * @param queryParams multivalue map of request parameters
* @param pathArgs variable list of arguments used to build the URI * @param pathArgs variable list of arguments used to build the URI
* @return a ClientResponse instance with the data returned from the endpoint * @return a ClientResponse instance with the data returned from the endpoint
* @throws IOException * @throws IOException if an error occurs while constructing the URL
*/ */
protected Response get(MultivaluedMap<String, String> queryParams, Object... pathArgs) throws IOException { protected Response get(MultivaluedMap<String, String> queryParams, Object... pathArgs) throws IOException {
URL url = getApiUrl(pathArgs); URL url = getApiUrl(pathArgs);
...@@ -249,7 +249,7 @@ public class GitLabApiClient { ...@@ -249,7 +249,7 @@ public class GitLabApiClient {
* @param formData the Form containing the name/value pairs * @param formData the Form containing the name/value pairs
* @param pathArgs variable list of arguments used to build the URI * @param pathArgs variable list of arguments used to build the URI
* @return a ClientResponse instance with the data returned from the endpoint * @return a ClientResponse instance with the data returned from the endpoint
* @throws IOException * @throws IOException if an error occurs while constructing the URL
*/ */
protected Response post(Form formData, Object... pathArgs) throws IOException { protected Response post(Form formData, Object... pathArgs) throws IOException {
URL url = getApiUrl(pathArgs); URL url = getApiUrl(pathArgs);
...@@ -263,7 +263,7 @@ public class GitLabApiClient { ...@@ -263,7 +263,7 @@ public class GitLabApiClient {
* @param queryParams multivalue map of request parameters * @param queryParams multivalue map of request parameters
* @param pathArgs variable list of arguments used to build the URI * @param pathArgs variable list of arguments used to build the URI
* @return a Response instance with the data returned from the endpoint * @return a Response instance with the data returned from the endpoint
* @throws IOException * @throws IOException if an error occurs while constructing the URL
*/ */
protected Response post(MultivaluedMap<String, String> queryParams, Object... pathArgs) throws IOException { protected Response post(MultivaluedMap<String, String> queryParams, Object... pathArgs) throws IOException {
URL url = getApiUrl(pathArgs); URL url = getApiUrl(pathArgs);
...@@ -301,7 +301,7 @@ public class GitLabApiClient { ...@@ -301,7 +301,7 @@ public class GitLabApiClient {
* @param queryParams multivalue map of request parameters * @param queryParams multivalue map of request parameters
* @param pathArgs variable list of arguments used to build the URI * @param pathArgs variable list of arguments used to build the URI
* @return a ClientResponse instance with the data returned from the endpoint * @return a ClientResponse instance with the data returned from the endpoint
* @throws IOException * @throws IOException if an error occurs while constructing the URL
*/ */
protected Response put(MultivaluedMap<String, String> queryParams, Object... pathArgs) throws IOException { protected Response put(MultivaluedMap<String, String> queryParams, Object... pathArgs) throws IOException {
URL url = getApiUrl(pathArgs); URL url = getApiUrl(pathArgs);
...@@ -327,7 +327,7 @@ public class GitLabApiClient { ...@@ -327,7 +327,7 @@ public class GitLabApiClient {
* @param queryParams multivalue map of request parameters * @param queryParams multivalue map of request parameters
* @param pathArgs variable list of arguments used to build the URI * @param pathArgs variable list of arguments used to build the URI
* @return a Response instance with the data returned from the endpoint * @return a Response instance with the data returned from the endpoint
* @throws IOException * @throws IOException if an error occurs while constructing the URL
*/ */
protected Response delete(MultivaluedMap<String, String> queryParams, Object... pathArgs) throws IOException { protected Response delete(MultivaluedMap<String, String> queryParams, Object... pathArgs) throws IOException {
return (delete(queryParams, getApiUrl(pathArgs))); return (delete(queryParams, getApiUrl(pathArgs)));
......
...@@ -19,7 +19,7 @@ public class GitLabApiException extends Exception { ...@@ -19,7 +19,7 @@ public class GitLabApiException extends Exception {
/** /**
* Create a GitLabApiException instance based on the ClientResponse. * Create a GitLabApiException instance based on the ClientResponse.
* *
* @param response * @param response the JAX-RS response that caused the exception
*/ */
public GitLabApiException(Response response) { public GitLabApiException(Response response) {
...@@ -41,7 +41,7 @@ public class GitLabApiException extends Exception { ...@@ -41,7 +41,7 @@ public class GitLabApiException extends Exception {
/** /**
* Create a GitLabApiException instance based on the exception. * Create a GitLabApiException instance based on the exception.
* *
* @param e * @param e the Exception to wrap
*/ */
public GitLabApiException(Exception e) { public GitLabApiException(Exception e) {
super(e); super(e);
......
...@@ -13,7 +13,7 @@ import org.gitlab4j.api.models.MergeRequest; ...@@ -13,7 +13,7 @@ import org.gitlab4j.api.models.MergeRequest;
*/ */
public class MergeRequestApi extends AbstractApi { public class MergeRequestApi extends AbstractApi {
MergeRequestApi(GitLabApi gitLabApi) { public MergeRequestApi(GitLabApi gitLabApi) {
super(gitLabApi); super(gitLabApi);
} }
......
...@@ -12,6 +12,7 @@ import org.gitlab4j.api.models.Project; ...@@ -12,6 +12,7 @@ import org.gitlab4j.api.models.Project;
* It is quite restricted as you may not retrieve the API but only set or delete. * It is quite restricted as you may not retrieve the API but only set or delete.
*/ */
public class ServicesApi extends AbstractApi { public class ServicesApi extends AbstractApi {
public ServicesApi(GitLabApi gitLabApi) { public ServicesApi(GitLabApi gitLabApi) {
super(gitLabApi); super(gitLabApi);
} }
......
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