From c526865f398d7fcbbc71812d524ef5ea08815fb7 Mon Sep 17 00:00:00 2001 From: Greg Messner Date: Mon, 30 Jan 2017 17:40:23 -0800 Subject: [PATCH] Fixed javadoc issues. --- .../com/messners/gitlab/api/AbstractApi.java | 71 +++++++++---------- .../com/messners/gitlab/api/CommitsApi.java | 8 +-- .../com/messners/gitlab/api/GitLabApi.java | 2 - .../messners/gitlab/api/GitLabApiClient.java | 2 - .../gitlab/api/GitLabApiException.java | 3 - .../com/messners/gitlab/api/GroupApi.java | 2 - .../java/com/messners/gitlab/api/ISO8601.java | 2 - .../com/messners/gitlab/api/JacksonJson.java | 3 - .../messners/gitlab/api/MergeRequestApi.java | 2 - .../com/messners/gitlab/api/ProjectApi.java | 3 + .../messners/gitlab/api/RepositoryApi.java | 3 - .../gitlab/api/RepositoryFileApi.java | 2 - .../com/messners/gitlab/api/SessionApi.java | 3 - 13 files changed, 40 insertions(+), 66 deletions(-) diff --git a/src/main/java/com/messners/gitlab/api/AbstractApi.java b/src/main/java/com/messners/gitlab/api/AbstractApi.java index 8d4ca3c7..90cdd6b9 100644 --- a/src/main/java/com/messners/gitlab/api/AbstractApi.java +++ b/src/main/java/com/messners/gitlab/api/AbstractApi.java @@ -8,9 +8,6 @@ import java.net.URL; /** * This class is the base class for all the sub API classes. It provides implementations of * delete(), get(), post() and put() that are re-used by all the sub-classes. - * - * @author Greg Messner - * */ public abstract class AbstractApi { @@ -29,10 +26,10 @@ public abstract class AbstractApi { * a ClientResponse instance with the data returned from the endpoint. * * @param expectedStatus the HTTP status that should be returned from the server - * @param queryParams - * @param pathArgs + * @param queryParams multivalue map of request parameters + * @param pathArgs variable list of arguments used to build the URI * @return a ClientResponse instance with the data returned from the endpoint - * @throws GitLabApiException + * @throws GitLabApiException if any exception occurs during execution */ protected Response get(Response.Status expectedStatus, MultivaluedMap queryParams, Object... pathArgs) throws GitLabApiException { try { @@ -47,10 +44,10 @@ public abstract class AbstractApi { * a ClientResponse instance with the data returned from the endpoint. * * @param expectedStatus the HTTP status that should be returned from the server - * @param queryParams - * @param url + * @param queryParams multivalue map of request parameters + * @param url the fully formed path to the GitLab API endpoint * @return a ClientResponse instance with the data returned from the endpoint - * @throws GitLabApiException + * @throws GitLabApiException if any exception occurs during execution */ protected Response get(Response.Status expectedStatus, MultivaluedMap queryParams, URL url) throws GitLabApiException { try { @@ -65,10 +62,10 @@ public abstract class AbstractApi { * a ClientResponse instance with the data returned from the endpoint. * * @param expectedStatus the HTTP status that should be returned from the server - * @param formData - * @param pathArgs + * @param formData the Form containing the name/value pairs for the POST data + * @param pathArgs variable list of arguments used to build the URI * @return a ClientResponse instance with the data returned from the endpoint - * @throws GitLabApiException + * @throws GitLabApiException if any exception occurs during execution */ protected Response post(Response.Status expectedStatus, Form formData, Object... pathArgs) throws GitLabApiException { try { @@ -83,10 +80,10 @@ public abstract class AbstractApi { * a ClientResponse instance with the data returned from the endpoint. * * @param expectedStatus the HTTP status that should be returned from the server - * @param queryParams - * @param pathArgs + * @param queryParams multivalue map of request parameters + * @param pathArgs variable list of arguments used to build the URI * @return a ClientResponse instance with the data returned from the endpoint - * @throws GitLabApiException + * @throws GitLabApiException if any exception occurs during execution */ protected Response post(Response.Status expectedStatus, MultivaluedMap queryParams, Object... pathArgs) throws GitLabApiException { try { @@ -101,10 +98,10 @@ public abstract class AbstractApi { * a ClientResponse instance with the data returned from the endpoint. * * @param expectedStatus the HTTP status that should be returned from the server - * @param formData - * @param url + * @param formData the Form containing the name/value pairs for the POST data + * @param url the fully formed path to the GitLab API endpoint * @return a ClientResponse instance with the data returned from the endpoint - * @throws GitLabApiException + * @throws GitLabApiException if any exception occurs during execution */ protected Response post(Response.Status expectedStatus, Form formData, URL url) throws GitLabApiException { try { @@ -119,10 +116,10 @@ public abstract class AbstractApi { * a ClientResponse instance with the data returned from the endpoint. * * @param expectedStatus the HTTP status that should be returned from the server - * @param queryParams - * @param pathArgs + * @param queryParams multivalue map of request parameters + * @param pathArgs variable list of arguments used to build the URI * @return a ClientResponse instance with the data returned from the endpoint - * @throws GitLabApiException + * @throws GitLabApiException if any exception occurs during execution */ protected Response put(Response.Status expectedStatus, MultivaluedMap queryParams, Object... pathArgs) throws GitLabApiException { try { @@ -137,10 +134,10 @@ public abstract class AbstractApi { * a ClientResponse instance with the data returned from the endpoint. * * @param expectedStatus the HTTP status that should be returned from the server - * @param queryParams - * @param url + * @param queryParams multivalue map of request parameters + * @param url the fully formed path to the GitLab API endpoint * @return a ClientResponse instance with the data returned from the endpoint - * @throws GitLabApiException + * @throws GitLabApiException if any exception occurs during execution */ protected Response put(Response.Status expectedStatus, MultivaluedMap queryParams, URL url) throws GitLabApiException { try { @@ -155,10 +152,10 @@ public abstract class AbstractApi { * a ClientResponse instance with the data returned from the endpoint. * * @param expectedStatus the HTTP status that should be returned from the server - * @param queryParams - * @param pathArgs + * @param queryParams multivalue map of request parameters + * @param pathArgs variable list of arguments used to build the URI * @return a ClientResponse instance with the data returned from the endpoint - * @throws GitLabApiException + * @throws GitLabApiException if any exception occurs during execution */ protected Response delete(Response.Status expectedStatus, MultivaluedMap queryParams, Object... pathArgs) throws GitLabApiException { try { @@ -173,10 +170,10 @@ public abstract class AbstractApi { * a ClientResponse instance with the data returned from the endpoint. * * @param expectedStatus the HTTP status that should be returned from the server - * @param queryParams - * @param url + * @param queryParams multivalue map of request parameters + * @param url the fully formed path to the GitLab API endpoint * @return a ClientResponse instance with the data returned from the endpoint - * @throws GitLabApiException + * @throws GitLabApiException if any exception occurs during execution */ protected Response delete(Response.Status expectedStatus, MultivaluedMap queryParams, URL url) throws GitLabApiException { try { @@ -189,9 +186,9 @@ public abstract class AbstractApi { /** * Convenience method for adding query and form parameters to a get() or post() call. * - * @param formData - * @param name - * @param value + * @param formData the Form containing the name/value pairs + * @param name the name of the field/attribute to add + * @param value the value of the field/attribute to add */ protected void addFormParam(Form formData, String name, Object value) throws IllegalArgumentException { addFormParam(formData, name, value, false); @@ -201,10 +198,10 @@ public abstract class AbstractApi { * Convenience method for adding query and form parameters to a get() or post() call. * If required is true and value is null, will throw an IllegalArgumentException. * - * @param formData - * @param name - * @param value - * @param required + * @param formData the Form containing the name/value pairs + * @param name the name of the field/attribute to add + * @param value the value of the field/attribute to add + * @param required the field is required flag * @throws IllegalArgumentException if a required parameter is null or empty */ protected void addFormParam(Form formData, String name, Object value, boolean required) throws IllegalArgumentException { diff --git a/src/main/java/com/messners/gitlab/api/CommitsApi.java b/src/main/java/com/messners/gitlab/api/CommitsApi.java index 78e51ada..f72d1ff3 100644 --- a/src/main/java/com/messners/gitlab/api/CommitsApi.java +++ b/src/main/java/com/messners/gitlab/api/CommitsApi.java @@ -9,8 +9,6 @@ import java.util.List; /** * This class implements the client side API for the GitLab commits calls. - * - * @author Greg Messner */ public class CommitsApi extends AbstractApi { @@ -23,7 +21,7 @@ public class CommitsApi extends AbstractApi { * * GET /projects/:id/repository/commits * - * @param projectId + * @param projectId the project ID to get the list of commits for * @return a List containing the commits for the specified project ID * @throws GitLabApiException */ @@ -38,7 +36,7 @@ public class CommitsApi extends AbstractApi { * * GET /projects/:id/repository/commits/:sha * - * @param projectId + * @param projectId the project ID that the commit belongs to * @param sha a commit hash or name of a branch or tag * @return the Commit instance for the specified project ID/sha pair * @throws GitLabApiException @@ -53,7 +51,7 @@ public class CommitsApi extends AbstractApi { * * GET /projects/:id/repository/commits/:sha/diff * - * @param projectId + * @param projectId the project ID that the commit belongs to * @param sha a commit hash or name of a branch or tag * @return the Diff instance for the specified project ID/sha pair * @throws GitLabApiException diff --git a/src/main/java/com/messners/gitlab/api/GitLabApi.java b/src/main/java/com/messners/gitlab/api/GitLabApi.java index 602678af..ad124a48 100644 --- a/src/main/java/com/messners/gitlab/api/GitLabApi.java +++ b/src/main/java/com/messners/gitlab/api/GitLabApi.java @@ -3,8 +3,6 @@ package com.messners.gitlab.api; /** * This class is provides a simplified interface to a GitLab API server, and divides the API up into * a separate API class for each concern. - * - * @author Greg Messner */ public class GitLabApi { diff --git a/src/main/java/com/messners/gitlab/api/GitLabApiClient.java b/src/main/java/com/messners/gitlab/api/GitLabApiClient.java index 3df8e0fd..050de34f 100644 --- a/src/main/java/com/messners/gitlab/api/GitLabApiClient.java +++ b/src/main/java/com/messners/gitlab/api/GitLabApiClient.java @@ -31,8 +31,6 @@ import java.util.Map; /** * This class utilizes the Jersey client package to communicate with a GitLab API endpoint. - * - * @author Greg Messner */ public class GitLabApiClient { diff --git a/src/main/java/com/messners/gitlab/api/GitLabApiException.java b/src/main/java/com/messners/gitlab/api/GitLabApiException.java index 9a8e0f93..b154663e 100755 --- a/src/main/java/com/messners/gitlab/api/GitLabApiException.java +++ b/src/main/java/com/messners/gitlab/api/GitLabApiException.java @@ -8,9 +8,6 @@ import javax.ws.rs.core.Response.StatusType; /** * This is the exception that will be thrown if any exception occurs while communicating * with a GitLab API endpoint. - * - * @author Greg Messner - * */ public class GitLabApiException extends Exception { diff --git a/src/main/java/com/messners/gitlab/api/GroupApi.java b/src/main/java/com/messners/gitlab/api/GroupApi.java index 3094afd3..f76be775 100644 --- a/src/main/java/com/messners/gitlab/api/GroupApi.java +++ b/src/main/java/com/messners/gitlab/api/GroupApi.java @@ -10,8 +10,6 @@ import java.util.List; /** * This class implements the client side API for the GitLab groups calls. - * - * @author Greg Messner */ public class GroupApi extends AbstractApi { diff --git a/src/main/java/com/messners/gitlab/api/ISO8601.java b/src/main/java/com/messners/gitlab/api/ISO8601.java index 1ee83ec9..538c4026 100644 --- a/src/main/java/com/messners/gitlab/api/ISO8601.java +++ b/src/main/java/com/messners/gitlab/api/ISO8601.java @@ -8,8 +8,6 @@ import java.util.TimeZone; /** * This class provides utility methods for parsing and formatting ISO8601 formatted dates. - * - * @author Greg Messner */ public class ISO8601 { public static final String PATTERN = "yyyy-MM-dd'T'HH:mm:ssZ"; diff --git a/src/main/java/com/messners/gitlab/api/JacksonJson.java b/src/main/java/com/messners/gitlab/api/JacksonJson.java index 507d3703..37e2765f 100644 --- a/src/main/java/com/messners/gitlab/api/JacksonJson.java +++ b/src/main/java/com/messners/gitlab/api/JacksonJson.java @@ -29,9 +29,6 @@ import org.codehaus.jackson.map.module.SimpleModule; /** * Jackson JSON Configuration and utility class. - * - * @author Greg Messner - * */ @Provider @Produces(MediaType.APPLICATION_JSON) diff --git a/src/main/java/com/messners/gitlab/api/MergeRequestApi.java b/src/main/java/com/messners/gitlab/api/MergeRequestApi.java index 3b58381f..05776fe6 100644 --- a/src/main/java/com/messners/gitlab/api/MergeRequestApi.java +++ b/src/main/java/com/messners/gitlab/api/MergeRequestApi.java @@ -10,8 +10,6 @@ import java.util.List; /** * This class implements the client side API for the GitLab merge request calls. - * - * @author Greg Messner */ public class MergeRequestApi extends AbstractApi { diff --git a/src/main/java/com/messners/gitlab/api/ProjectApi.java b/src/main/java/com/messners/gitlab/api/ProjectApi.java index a6181b4d..182347c8 100644 --- a/src/main/java/com/messners/gitlab/api/ProjectApi.java +++ b/src/main/java/com/messners/gitlab/api/ProjectApi.java @@ -13,6 +13,9 @@ import java.io.UnsupportedEncodingException; import java.net.URLEncoder; import java.util.List; +/** + * This class provides an entry point to all the GitLab API project calls. + */ public class ProjectApi extends AbstractApi { ProjectApi(GitLabApi gitLabApi) { diff --git a/src/main/java/com/messners/gitlab/api/RepositoryApi.java b/src/main/java/com/messners/gitlab/api/RepositoryApi.java index 4c0be3a9..4d79561c 100644 --- a/src/main/java/com/messners/gitlab/api/RepositoryApi.java +++ b/src/main/java/com/messners/gitlab/api/RepositoryApi.java @@ -12,8 +12,6 @@ import com.messners.gitlab.api.models.TreeItem; /** * This class provides an entry point to all the GitLab API repository calls. - * - * @author Greg Messner */ public class RepositoryApi extends AbstractApi { @@ -78,7 +76,6 @@ public class RepositoryApi extends AbstractApi { * * @param projectId * @param branchName - * @return the branch info for the protected branch * @throws GitLabApiException */ public void deleteBranch(Integer projectId, String branchName) throws GitLabApiException { diff --git a/src/main/java/com/messners/gitlab/api/RepositoryFileApi.java b/src/main/java/com/messners/gitlab/api/RepositoryFileApi.java index f8170b6b..d7b50821 100644 --- a/src/main/java/com/messners/gitlab/api/RepositoryFileApi.java +++ b/src/main/java/com/messners/gitlab/api/RepositoryFileApi.java @@ -7,8 +7,6 @@ import com.messners.gitlab.api.models.RepositoryFile; /** * This class provides an entry point to all the GitLab API repository files calls. - * - * @author lonfee88 */ public class RepositoryFileApi extends AbstractApi { diff --git a/src/main/java/com/messners/gitlab/api/SessionApi.java b/src/main/java/com/messners/gitlab/api/SessionApi.java index a34c4c48..07080fa2 100644 --- a/src/main/java/com/messners/gitlab/api/SessionApi.java +++ b/src/main/java/com/messners/gitlab/api/SessionApi.java @@ -7,9 +7,6 @@ import javax.ws.rs.core.Response; /** * This class implements the client side API for the GitLab login call. - * - * @author Greg Messner - * */ public class SessionApi extends AbstractApi { -- GitLab