fix: code smells

Health-Education-England · Nov 20, 2024 · e081b45 · e081b45
1 parent 0095aca
commit e081b45
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/src/main/java/uk/nhs/hee/trainee/details/api/CctResource.java b/src/main/java/uk/nhs/hee/trainee/details/api/CctResource.java
@@ -103,6 +103,14 @@ public ResponseEntity<CctCalculationDetailDto> createCalculation(
         .body(savedCalculation);
   }
 
+  /**
+   * Set the CCT end date in a CCT calculation DTO.
+   *
+   * @param calculation The CCT calculation details.
+   *
+   * @return The CCT calculation with the CCT end date, or Bad Request if the CCT date could not
+   *         be calculated.
+   */
   @PostMapping("/calculate")
   public ResponseEntity<CctCalculationDetailDto> calculateCctDate(
       @RequestBody CctCalculationDetailDto calculation) {

diff --git a/src/main/java/uk/nhs/hee/trainee/details/service/CctService.java b/src/main/java/uk/nhs/hee/trainee/details/service/CctService.java
@@ -122,7 +122,7 @@ public CctCalculationDetailDto createCalculation(CctCalculationDetailDto dto) {
    *
    * @param dto The CctCalculationDetailDto to use to calculate the CCT end date.
    * @return A copy of the DTO with the CCT end date set, or Optional.empty if the calculation was
-   * not possible due to invalid data.
+   *         not possible due to invalid data.
    */
   public Optional<CctCalculationDetailDto> calculateCctDate(CctCalculationDetailDto dto) {
     LocalDate cctDate = LocalDate.MAX; //placeholder