Cleaned up Javadocs.

chrisoberle · Dec 4, 2014 · a5ab678 · a5ab678
1 parent a41c2e0
commit a5ab678
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 11 deletions.
diff --git a/src/main/java/com/messners/gitlab/api/AbstractApi.java b/src/main/java/com/messners/gitlab/api/AbstractApi.java
@@ -250,8 +250,8 @@ protected ClientResponse delete (ClientResponse.Status expectedStatus, Multivalu
 	 * Convenience method for adding query and form parameters to a get() or post() call.
 	 * 
 	 * @param formData
-	 * @param string
-	 * @param email
+	 * @param name
+	 * @param value
 	 */
 	protected void addFormParam(Form formData, String name, Object value) throws IllegalArgumentException {
 		addFormParam(formData, name, value, false);

diff --git a/src/main/java/com/messners/gitlab/api/CommitsApi.java b/src/main/java/com/messners/gitlab/api/CommitsApi.java
@@ -25,7 +25,7 @@ public CommitsApi (GitLabApi gitLabApi) {
 	 * GET /projects/:id/repository/commits
 	 * 
 	 * @param projectId
-	 * @return
+	 * @return a List<Commit> containing the commits for the specified project ID
 	 * @throws GitLabApiException 
 	 */
 	public List<Commit> getCommits (int projectId) throws GitLabApiException {		
@@ -41,7 +41,7 @@ public List<Commit> getCommits (int projectId) throws GitLabApiException {
 	 * 
 	 * @param projectId
 	 * @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 
 	 */
 	public Commit getCommits (int projectId, String sha) throws GitLabApiException {		
@@ -57,7 +57,7 @@ public Commit getCommits (int projectId, String sha) throws GitLabApiException {
 	 * 
 	 * @param projectId
 	 * @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 
 	 */
 	public Diff getDiff (int projectId, String sha) throws GitLabApiException {		

diff --git a/src/main/java/com/messners/gitlab/api/JacksonJson.java b/src/main/java/com/messners/gitlab/api/JacksonJson.java
@@ -109,7 +109,7 @@ public <T> T unmarshal (Class<T> returnType, String postData)
 	 * Marshals the supplied object out as a formatted 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) {
 

diff --git a/src/main/java/com/messners/gitlab/api/ProjectApi.java b/src/main/java/com/messners/gitlab/api/ProjectApi.java
@@ -412,11 +412,7 @@ public void deleteHook (ProjectHook hook) throws GitLabApiException {
 	 * 
 	 * PUT /projects/:id/hooks/:hook_id
 	 * 
-	 * @param projectId
-	 * @param url
-	 * @param doPushEvents
-	 * @param doIssuesEvents
-	 * @param doMergeRequestsEvents
+	 * @param hook
 	 * @return the modified project hook
 	 * @throws GitLabApiException 
 	 */