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

Javadoc fixes (#122).

parent 69ce3604
...@@ -299,7 +299,7 @@ public class CommitsApi extends AbstractApi { ...@@ -299,7 +299,7 @@ public class CommitsApi extends AbstractApi {
* @param authorName the commit author's name * @param authorName the commit author's name
* @param actions the array of CommitAction to commit as a batch * @param actions the array of CommitAction to commit as a batch
* @return the create Commit instance * @return the create Commit instance
* @throws GitLabApiException * @throws GitLabApiException if any exception occurs during execution
*/ */
public Commit createCommit(int projectId, String branch, String commitMessage, String startBranch, public Commit createCommit(int projectId, String branch, String commitMessage, String startBranch,
String authorEmail, String authorName, List<CommitAction> actions) throws GitLabApiException { String authorEmail, String authorName, List<CommitAction> actions) throws GitLabApiException {
...@@ -329,7 +329,7 @@ public class CommitsApi extends AbstractApi { ...@@ -329,7 +329,7 @@ public class CommitsApi extends AbstractApi {
* @param authorName the commit author's name * @param authorName the commit author's name
* @param actions the array of CommitAction to commit as a batch * @param actions the array of CommitAction to commit as a batch
* @return the create Commit instance * @return the create Commit instance
* @throws GitLabApiException * @throws GitLabApiException if any exception occurs during execution
*/ */
public Commit createCommit(String project, String branch, String commitMessage, String startBranch, public Commit createCommit(String project, String branch, String commitMessage, String startBranch,
String authorEmail, String authorName, List<CommitAction> actions) throws GitLabApiException { String authorEmail, String authorName, List<CommitAction> actions) throws GitLabApiException {
......
...@@ -418,8 +418,9 @@ public class GitLabApiClient { ...@@ -418,8 +418,9 @@ public class GitLabApiClient {
* a ClientResponse instance with the data returned from the endpoint. * a ClientResponse instance with the data returned from the endpoint.
* *
* @param payload the object instance that will be serialized to JSON and used as the POST data * @param payload the object instance that will be serialized to JSON and used as the POST data
* @param url the fully formed path to the GitLab API endpoint * @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 if an error occurs while constructing the URL
*/ */
protected Response post(Object payload, Object... pathArgs) throws IOException { protected Response post(Object payload, Object... pathArgs) throws IOException {
URL url = getApiUrl(pathArgs); URL url = getApiUrl(pathArgs);
......
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