diff --git a/server/application-server/pom.xml b/server/application-server/pom.xml index 32187537..2c9023dc 100644 --- a/server/application-server/pom.xml +++ b/server/application-server/pom.xml @@ -105,6 +105,11 @@ 2.5.1 test + + com.github.therapi + therapi-runtime-javadoc + 0.15.0 + @@ -148,6 +153,19 @@ . + + org.apache.maven.plugins + maven-compiler-plugin + + + + com.github.therapi + therapi-runtime-javadoc-scribe + 0.15.0 + + + + diff --git a/server/application-server/src/main/java/de/tum/in/www1/hephaestus/hello/Hello.java b/server/application-server/src/main/java/de/tum/in/www1/hephaestus/hello/Hello.java index e7926145..36b83b24 100644 --- a/server/application-server/src/main/java/de/tum/in/www1/hephaestus/hello/Hello.java +++ b/server/application-server/src/main/java/de/tum/in/www1/hephaestus/hello/Hello.java @@ -25,7 +25,8 @@ public class Hello { private Long id; /** - * The timestamp indicating when the Hello entity was created. + * The timestamp of when the Hello entity was created. + * This field is mandatory. */ @Column(nullable = false) private Instant timestamp; diff --git a/server/application-server/src/main/java/de/tum/in/www1/hephaestus/hello/HelloController.java b/server/application-server/src/main/java/de/tum/in/www1/hephaestus/hello/HelloController.java index e531d1e3..10032ef8 100644 --- a/server/application-server/src/main/java/de/tum/in/www1/hephaestus/hello/HelloController.java +++ b/server/application-server/src/main/java/de/tum/in/www1/hephaestus/hello/HelloController.java @@ -18,9 +18,9 @@ public HelloController(HelloService helloService) { } /** - * Handles GET requests for retrieving all Hello entities. + * Retrieves all {@link Hello} entities. * - * @return a list of all Hello entities + * @return A list of all Hello entities */ @GetMapping public List getAllHellos() { @@ -28,9 +28,9 @@ public List getAllHellos() { } /** - * Handles POST requests for creating a new Hello entity. + * Creates a new {@link Hello} entity with the current timestamp. * - * @return the newly created Hello entity + * @return The created Hello entity */ @PostMapping public Hello addHello() { diff --git a/server/application-server/src/main/java/de/tum/in/www1/hephaestus/hello/HelloService.java b/server/application-server/src/main/java/de/tum/in/www1/hephaestus/hello/HelloService.java index fdfe60b2..b8d394b4 100644 --- a/server/application-server/src/main/java/de/tum/in/www1/hephaestus/hello/HelloService.java +++ b/server/application-server/src/main/java/de/tum/in/www1/hephaestus/hello/HelloService.java @@ -19,9 +19,9 @@ public HelloService(HelloRepository helloRepository) { } /** - * Retrieves all Hello entities from the repository. + * Retrieves all {@link Hello} entities from the repository. * - * @return a list of all Hello entities + * @return A list of all Hello entities */ public List getAllHellos() { var hellos = helloRepository.findAll(); @@ -30,9 +30,9 @@ public List getAllHellos() { } /** - * Creates and saves a new Hello entity with the current timestamp. + * Creates a new {@link Hello} entity with the current timestamp and saves it to the repository. * - * @return the newly created Hello entity + * @return The created Hello entity */ public Hello addHello() { Hello hello = new Hello();