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

Cleaned up Javadocs.

parent a41c2e0d
...@@ -250,8 +250,8 @@ public abstract class AbstractApi { ...@@ -250,8 +250,8 @@ public abstract class AbstractApi {
* Convenience method for adding query and form parameters to a get() or post() call. * Convenience method for adding query and form parameters to a get() or post() call.
* *
* @param formData * @param formData
* @param string * @param name
* @param email * @param value
*/ */
protected void addFormParam(Form formData, String name, Object value) throws IllegalArgumentException { protected void addFormParam(Form formData, String name, Object value) throws IllegalArgumentException {
addFormParam(formData, name, value, false); addFormParam(formData, name, value, false);
......
...@@ -25,7 +25,7 @@ public class CommitsApi extends AbstractApi { ...@@ -25,7 +25,7 @@ public class CommitsApi extends AbstractApi {
* GET /projects/:id/repository/commits * GET /projects/:id/repository/commits
* *
* @param projectId * @param projectId
* @return * @return a List<Commit> containing the commits for the specified project ID
* @throws GitLabApiException * @throws GitLabApiException
*/ */
public List<Commit> getCommits (int projectId) throws GitLabApiException { public List<Commit> getCommits (int projectId) throws GitLabApiException {
...@@ -41,7 +41,7 @@ public class CommitsApi extends AbstractApi { ...@@ -41,7 +41,7 @@ public class CommitsApi extends AbstractApi {
* *
* @param projectId * @param projectId
* @param sha a commit hash or name of a branch or tag * @param sha a commit hash or name of a branch or tag
* @return * @return the Commit instance for the specified project ID/sha pair
* @throws GitLabApiException * @throws GitLabApiException
*/ */
public Commit getCommits (int projectId, String sha) throws GitLabApiException { public Commit getCommits (int projectId, String sha) throws GitLabApiException {
...@@ -57,7 +57,7 @@ public class CommitsApi extends AbstractApi { ...@@ -57,7 +57,7 @@ public class CommitsApi extends AbstractApi {
* *
* @param projectId * @param projectId
* @param sha a commit hash or name of a branch or tag * @param sha a commit hash or name of a branch or tag
* @return * @return the Diff instance for the specified project ID/sha pair
* @throws GitLabApiException * @throws GitLabApiException
*/ */
public Diff getDiff (int projectId, String sha) throws GitLabApiException { public Diff getDiff (int projectId, String sha) throws GitLabApiException {
......
...@@ -109,7 +109,7 @@ public class JacksonJson extends JacksonJaxbJsonProvider implements ContextResol ...@@ -109,7 +109,7 @@ public class JacksonJson extends JacksonJaxbJsonProvider implements ContextResol
* Marshals the supplied object out as a formatted JSON string. * Marshals the supplied object out as a formatted JSON string.
* *
* @param object the object to output as a JSON string * @param object the object to output as a JSON string
* @return * @return a String containing the JSON for the specified object
*/ */
public <T> String marshal (final T object) { public <T> String marshal (final T object) {
......
...@@ -412,11 +412,7 @@ public class ProjectApi extends AbstractApi { ...@@ -412,11 +412,7 @@ public class ProjectApi extends AbstractApi {
* *
* PUT /projects/:id/hooks/:hook_id * PUT /projects/:id/hooks/:hook_id
* *
* @param projectId * @param hook
* @param url
* @param doPushEvents
* @param doIssuesEvents
* @param doMergeRequestsEvents
* @return the modified project hook * @return the modified project hook
* @throws GitLabApiException * @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