Skip to content

Commit 8fd7b3e

Browse files
committed
Fixed JavaDoc issues.
1 parent 0af41dc commit 8fd7b3e

File tree

5 files changed

+7
-5
lines changed

5 files changed

+7
-5
lines changed

jenkins-client/src/main/java/com/offbytwo/jenkins/client/JenkinsHttpConnection.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ public interface JenkinsHttpConnection extends Closeable {
170170
* @param data data to post
171171
* @param crumbFlag true / false.
172172
* @return resulting response
173-
* @throws IOException, HttpResponseException
173+
* @throws IOException in case of an error.
174174
*/
175175
HttpResponse post_form_with_result(String path, List<NameValuePair> data, boolean crumbFlag) throws IOException;
176176

jenkins-client/src/main/java/com/offbytwo/jenkins/model/BaseModel.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public JenkinsHttpConnection getClient() {
4141

4242
/**
4343
* Set the HTTP client.
44-
* @param client
44+
* @param client {@link JenkinsHttpConnection}.
4545
*/
4646
public void setClient(final JenkinsHttpConnection client) {
4747
this.client = client;

jenkins-client/src/main/java/com/offbytwo/jenkins/model/Build.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,8 @@ public String Stop() throws HttpResponseException, IOException {
156156
*
157157
* @param crumbFlag flag used to specify if a crumb is passed into for the request
158158
* @return the client url
159-
* @throws HttpResponseException
160-
* @throws IOException
159+
* @throws HttpResponseException in case of an error.
160+
* @throws IOException in case of an error.
161161
*/
162162
public String Stop(boolean crumbFlag) throws HttpResponseException, IOException {
163163
try {

jenkins-client/src/main/java/com/offbytwo/jenkins/model/BuildChangeSetPath.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public String getEditType() {
2424

2525
/**
2626
* Sets the SCM operation.
27-
* @param the SCM operation, <code>add</code> or <code>edit</code> or <code>delete</code>
27+
* @param editType the SCM operation, <code>add</code> or <code>edit</code> or <code>delete</code>
2828
* @see <a href="http://javadoc.jenkins.io/hudson/scm/EditType.html">EditType</a>
2929
*/
3030
public void setEditType(String editType) {

jenkins-client/src/main/java/com/offbytwo/jenkins/model/BuildWithDetails.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,8 @@ public String getConsoleOutputHtml() throws IOException {
403403
* @param listener interface used to asynchronously obtain logs
404404
* @param poolingInterval interval (seconds) used to pool jenkins for logs
405405
* @param poolingTimeout pooling timeout (seconds) used to break pooling in case build stuck
406+
* @throws InterruptedException in case of an error.
407+
* @throws IOException in case of an error.
406408
*
407409
*/
408410
public void streamConsoleOutput(final BuildConsoleStreamListener listener, final int poolingInterval, final int poolingTimeout) throws InterruptedException, IOException {

0 commit comments

Comments
 (0)