Skip to content

Commit 2530997

Browse files
committed
Added some JavaDoc.
1 parent 0fb41b7 commit 2530997

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

  • jenkins-client/src/main/java/com/offbytwo/jenkins/model

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

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,22 @@ public BuildWithDetails details() throws IOException {
105105
return client.get(url, BuildWithDetails.class);
106106
}
107107

108+
/**
109+
* This is to get the information about {@link TestReport}
110+
* for a Maven Job type.
111+
* @return {@link TestReport}
112+
* @throws IOException in casae of an error.
113+
*/
108114
public TestReport getTestReport() throws IOException {
109115
return client.get(this.getUrl() + "/testReport/?depth=1", TestReport.class);
110116
}
111117

112-
//Only for non Maven Jobs..
118+
/**
119+
* This is to get the information about run tests for a
120+
* non Maven job type.
121+
* @return {@link TestResult}
122+
* @throws IOException in case of an error.
123+
*/
113124
public TestResult getTestResult() throws IOException {
114125
return client.get(this.getUrl() + "/testReport/?depth=1", TestResult.class);
115126
}

0 commit comments

Comments
 (0)