Skip to content
This repository was archived by the owner on Mar 29, 2019. It is now read-only.

Commit 207a5a2

Browse files
committed
Updated javadoc to pass doclint
JDK 1.8 turned on doclint, validating javadoc and subsequently failing builds when generating javadoc with invalid markup. This commit addresses the javadoc errors in this project that cause javadoc generation to fail. There are still warnings that need to be addressed, but this project should now build with JDK 1.8 when generating javadoc. BATCHADM-216
1 parent c67639f commit 207a5a2

File tree

6 files changed

+18
-1
lines changed

6 files changed

+18
-1
lines changed

spring-batch-admin-domain/src/main/java/org/springframework/batch/admin/domain/StepExecutionInfoResource.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ public class StepExecutionInfoResource extends ResourceSupport {
9393

9494
/**
9595
* @param stepExecution Must not be null
96+
* @param timeZone timeZone dates are represented in.
9697
*/
9798
public StepExecutionInfoResource(StepExecution stepExecution, TimeZone timeZone) {
9899
Assert.notNull(stepExecution, "stepExecution must not be null.");

spring-batch-admin-domain/src/main/java/org/springframework/batch/admin/domain/StepExecutionProgressInfoResource.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ public StepExecutionProgressInfoResource() {
4949
*
5050
* @param stepExecution Must not be null
5151
* @param stepExecutionHistory Must not be null
52+
* @param percentageComplete percentage of the step that is complete (1.0 = 100%)
53+
* @param isFinished true if the step is finished
54+
* @param duration duration of the step
55+
* @param timeZone time zone dates/times are expressed in
5256
*/
5357
public StepExecutionProgressInfoResource(StepExecution stepExecution, StepExecutionHistory stepExecutionHistory,
5458
double percentageComplete, boolean isFinished, double duration, TimeZone timeZone) {

spring-batch-admin-domain/src/main/java/org/springframework/batch/admin/domain/support/StepExecutionHistoryJacksonMixIn.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import com.fasterxml.jackson.annotation.JsonProperty;
2222

2323
/**
24-
* Jackson MixIn for {@link org.springframework.batch.admin.history.StepExecutionHistory} de-serialization.
24+
* Jackson MixIn for org.springframework.batch.admin.history.StepExecutionHistory de-serialization.
2525
*
2626
* @author Ilayaperumal Gopinathan
2727
* @since 2.0

spring-batch-admin-manager/src/main/java/org/springframework/batch/admin/web/BatchJobInstancesController.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ public JobInstanceInfoResource getJobInstance(@PathVariable long instanceId) {
8787
/**
8888
* Return a paged collection of job instances for a given job.
8989
*
90+
* @param pageable page request
91+
* @param assembler used to construct resources
9092
* @param jobName name of the batch job
9193
* @return collection of JobInstances by job name
9294
*/

spring-batch-admin-manager/src/main/java/org/springframework/batch/admin/web/BatchJobsController.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ public class BatchJobsController extends AbstractBatchJobsController {
5858
*
5959
* @param pageable the paging metadata
6060
* @param assembler the paged resource assembler of type {@link org.springframework.batch.admin.domain.DetailedJobInfo}
61+
*
62+
* @return a page of {@link DetailedJobInfoResource}
6163
*/
6264
@RequestMapping(value = "", method = RequestMethod.GET)
6365
@ResponseStatus(HttpStatus.OK)

spring-batch-admin-manager/src/main/java/org/springframework/batch/admin/web/RestControllerAdvice.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ public class RestControllerAdvice {
5858

5959
/**
6060
* Handles the case where client submitted an ill valued request (missing parameter).
61+
*
62+
* @param e exception to be handled
63+
*
64+
* @return VndErrors see {@link VndErrors}
6165
*/
6266
@ExceptionHandler
6367
@ResponseStatus(HttpStatus.BAD_REQUEST)
@@ -69,6 +73,10 @@ public VndErrors onMissingServletRequestParameterException(MissingServletRequest
6973

7074
/**
7175
* Handles the general error case. Report server-side error.
76+
*
77+
* @param e the exception to be handled
78+
*
79+
* @return VndErrors see {@link VndErrors}
7280
*/
7381
@ExceptionHandler(Exception.class)
7482
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)

0 commit comments

Comments
 (0)