Commit 820ab246 authored by Greg Messner's avatar Greg Messner
Browse files

Cleaned up Javadocs and renamed getIssues() to getNotes().

parent b2a4fc3c
...@@ -14,13 +14,13 @@ public class NotesApi extends AbstractApi { ...@@ -14,13 +14,13 @@ public class NotesApi extends AbstractApi {
} }
/** /**
* Get a list of issues's notes. Only returns the first page * Get a list of the issues's notes. Only returns the first page
* *
* GET /projects/:id/issues/:issue_iid/notes * GET /projects/:id/issues/:issue_iid/notes
* *
* @param projectId the project ID to get the issues for * @param projectId the project ID to get the issues for
* @param issueIid the issue ID to get the notes for * @param issueIid the issue ID to get the notes for
* @return a list of issues's notes * @return a list of the issues's notes
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
*/ */
public List<Note> getNotes(Integer projectId, Integer issueIid) throws GitLabApiException { public List<Note> getNotes(Integer projectId, Integer issueIid) throws GitLabApiException {
...@@ -29,7 +29,7 @@ public class NotesApi extends AbstractApi { ...@@ -29,7 +29,7 @@ public class NotesApi extends AbstractApi {
} }
/** /**
* Get a list of project's issues using the specified page and per page settings. * Get a list of the issue's notes using the specified page and per page settings.
* *
* GET /projects/:id/issues/:issue_iid/notes * GET /projects/:id/issues/:issue_iid/notes
* *
...@@ -40,7 +40,7 @@ public class NotesApi extends AbstractApi { ...@@ -40,7 +40,7 @@ public class NotesApi extends AbstractApi {
* @return the list of notes in the specified range * @return the list of notes in the specified range
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
*/ */
public List<Note> getIssues(Integer projectId, Integer issueIid, int page, int perPage) throws GitLabApiException { public List<Note> getNotes(Integer projectId, Integer issueIid, int page, int perPage) throws GitLabApiException {
Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "projects", projectId, "issues", issueIid, "notes"); Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "projects", projectId, "issues", issueIid, "notes");
return (response.readEntity(new GenericType<List<Note>>() {})); return (response.readEntity(new GenericType<List<Note>>() {}));
} }
...@@ -53,7 +53,7 @@ public class NotesApi extends AbstractApi { ...@@ -53,7 +53,7 @@ public class NotesApi extends AbstractApi {
* @param projectId the project ID to get the issues for * @param projectId the project ID to get the issues for
* @param issueIid the issue IID to get the notes for * @param issueIid the issue IID to get the notes for
* @param itemsPerPage the number of notes per page * @param itemsPerPage the number of notes per page
* @return the list of issues in the specified range * @return the list of notes in the specified range
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
*/ */
public Pager<Note> getNotes(Integer projectId, Integer issueIid, int itemsPerPage) throws GitLabApiException { public Pager<Note> getNotes(Integer projectId, Integer issueIid, int itemsPerPage) 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