@@ -185,11 +185,11 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen
185185 * assignee,components and summary.
186186 * The created issue ID is saved to the file at "filename".
187187 *
188- * @param build
189- * @param filename
188+ * @param build build
189+ * @param filename filename
190190 * @return issue id
191- * @throws IOException
192- * @throws InterruptedException
191+ * @throws IOException if IO fails
192+ * @throws InterruptedException if thread is interrupted
193193 */
194194 private Issue createJiraIssue (AbstractBuild <?, ?> build , String filename ) throws IOException , InterruptedException {
195195
@@ -227,10 +227,10 @@ private Issue createJiraIssue(AbstractBuild<?, ?> build, String filename) throws
227227 /**
228228 * Returns the status of the issue.
229229 *
230- * @param build
231- * @param id
230+ * @param build build
231+ * @param id issue key
232232 * @return Status of the issue
233- * @throws IOException
233+ * @throws IOException if IO fails
234234 */
235235 private Status getStatus (AbstractBuild <?, ?> build , String id ) throws IOException {
236236
@@ -242,11 +242,11 @@ private Status getStatus(AbstractBuild<?, ?> build, String id) throws IOExceptio
242242 /**
243243 * Adds a comment to the existing issue.
244244 *
245- * @param build
246- * @param listener
247- * @param id
248- * @param comment
249- * @throws IOException
245+ * @param build build
246+ * @param listener listener
247+ * @param id issue key
248+ * @param comment comment text
249+ * @throws IOException if IO fails
250250 */
251251 private void addComment (AbstractBuild <?, ?> build , BuildListener listener , String id , String comment )
252252 throws IOException {
@@ -258,10 +258,10 @@ private void addComment(AbstractBuild<?, ?> build, BuildListener listener, Strin
258258 /**
259259 * Returns the issue id
260260 *
261- * @param filename
262- * @return
263- * @throws IOException
264- * @throws InterruptedException
261+ * @param filename file from which to read the issue name
262+ * @return issue ID
263+ * @throws IOException if IO fails
264+ * @throws InterruptedException if thread is interrupted
265265 */
266266 private String getIssue (String filename ) throws IOException , InterruptedException {
267267 String issueId = "" ;
@@ -288,9 +288,9 @@ JiraSite getSiteForProject(AbstractProject<?, ?> project) {
288288 /**
289289 * Returns the jira session.
290290 *
291- * @param build
291+ * @param build build
292292 * @return JiraSession
293- * @throws IOException
293+ * @throws IOException if IO fails
294294 */
295295 private JiraSession getJiraSession (AbstractBuild <?, ?> build ) throws IOException {
296296
@@ -310,7 +310,7 @@ private JiraSession getJiraSession(AbstractBuild<?, ?> build) throws IOException
310310 }
311311
312312 /**
313- * @param filename
313+ * @param filename filename
314314 */
315315 private void deleteFile (String filename ) {
316316 File file = new File (filename );
@@ -320,11 +320,11 @@ private void deleteFile(String filename) {
320320 }
321321
322322 /**
323- * write's the issue id in the file, which is stored in the Job's directory
323+ * Writes the issue id in the file, which is stored in the Job's directory.
324324 *
325- * @param filename
326- * @param issue
327- * @throws FileNotFoundException
325+ * @param filename filenam
326+ * @param issue issue
327+ * @throws FileNotFoundException if file not found
328328 */
329329 private void writeInFile (String filename , Issue issue ) throws IOException {
330330 // olamy really weird to write an empty file especially with null
@@ -394,12 +394,12 @@ private void currentBuildResultFailure(
394394 * it checks for the previous build's result and adds comment until the
395395 * previously created issue is closed.
396396 *
397- * @param build
398- * @param previousBuildResult
399- * @param filename
400- * @param vars
401- * @throws InterruptedException
402- * @throws IOException
397+ * @param build build
398+ * @param previousBuildResult previous build result
399+ * @param filename filename
400+ * @param vars variables
401+ * @throws InterruptedException if thread isinterrupted
402+ * @throws IOException if IO fails
403403 */
404404 private void currentBuildResultSuccess (
405405 AbstractBuild <?, ?> build ,
@@ -463,8 +463,8 @@ private void progressWorkflowAction(AbstractBuild<?, ?> build, String issueId, I
463463 /**
464464 * Returns build details string in wiki format, with hyperlinks.
465465 *
466- * @param vars
467- * @return
466+ * @param vars environment variables
467+ * @return build details string
468468 */
469469 private String getBuildDetailsString (EnvVars vars ) {
470470 final String buildURL = vars .get ("BUILD_URL" );
@@ -474,8 +474,8 @@ private String getBuildDetailsString(EnvVars vars) {
474474 /**
475475 * Returns build name in format BUILD#10
476476 *
477- * @param vars
478- * @return String
477+ * @param vars environment variables
478+ * @return String build name
479479 */
480480 private String getBuildName (EnvVars vars ) {
481481 final String jobName = vars .get ("JOB_NAME" );
0 commit comments