Skip to content

Commit ddc98a7

Browse files
committed
Javadoc fixes (#122).
1 parent 69ce360 commit ddc98a7

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

src/main/java/org/gitlab4j/api/CommitsApi.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ public Comment addComment(int projectId, String sha, String note) throws GitLabA
299299
* @param authorName the commit author's name
300300
* @param actions the array of CommitAction to commit as a batch
301301
* @return the create Commit instance
302-
* @throws GitLabApiException
302+
* @throws GitLabApiException if any exception occurs during execution
303303
*/
304304
public Commit createCommit(int projectId, String branch, String commitMessage, String startBranch,
305305
String authorEmail, String authorName, List<CommitAction> actions) throws GitLabApiException {
@@ -329,7 +329,7 @@ public Commit createCommit(int projectId, String branch, String commitMessage, S
329329
* @param authorName the commit author's name
330330
* @param actions the array of CommitAction to commit as a batch
331331
* @return the create Commit instance
332-
* @throws GitLabApiException
332+
* @throws GitLabApiException if any exception occurs during execution
333333
*/
334334
public Commit createCommit(String project, String branch, String commitMessage, String startBranch,
335335
String authorEmail, String authorName, List<CommitAction> actions) throws GitLabApiException {

src/main/java/org/gitlab4j/api/GitLabApiClient.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418,8 +418,9 @@ protected Response post(MultivaluedMap<String, String> queryParams, URL url) {
418418
* a ClientResponse instance with the data returned from the endpoint.
419419
*
420420
* @param payload the object instance that will be serialized to JSON and used as the POST data
421-
* @param url the fully formed path to the GitLab API endpoint
421+
* @param pathArgs variable list of arguments used to build the URI
422422
* @return a ClientResponse instance with the data returned from the endpoint
423+
* @throws IOException if an error occurs while constructing the URL
423424
*/
424425
protected Response post(Object payload, Object... pathArgs) throws IOException {
425426
URL url = getApiUrl(pathArgs);

0 commit comments

Comments
 (0)