From 0f02f4c2e553e3370d9ad172094e91a568b69baa Mon Sep 17 00:00:00 2001 From: Richard van den Ham Date: Thu, 7 Sep 2023 00:38:32 +0200 Subject: [PATCH] docs: JavaDoc updates --- src/main/java/module-info.java | 4 ++++ src/main/java/simpletimeapi/Duration.java | 2 +- src/main/java/simpletimeapi/Time.java | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java index 35c4498..dc2c5d8 100644 --- a/src/main/java/module-info.java +++ b/src/main/java/module-info.java @@ -1,3 +1,7 @@ +/** + * JPMS module simpletimeapi. + * Describes API for ALDA Assignment SimpleTime. + */ module simpletimeapi { exports simpletimeapi; } diff --git a/src/main/java/simpletimeapi/Duration.java b/src/main/java/simpletimeapi/Duration.java index ecc8a31..87445b1 100644 --- a/src/main/java/simpletimeapi/Duration.java +++ b/src/main/java/simpletimeapi/Duration.java @@ -55,7 +55,7 @@ public interface Duration extends Comparable { /** * Equals method. * Hint: generate equals method together with hashCode. - * @param other + * @param other object * @return true if the value of this Duration is equal to the value of other Duration. */ @Override diff --git a/src/main/java/simpletimeapi/Time.java b/src/main/java/simpletimeapi/Time.java index 25cd220..9fb2e04 100644 --- a/src/main/java/simpletimeapi/Time.java +++ b/src/main/java/simpletimeapi/Time.java @@ -115,7 +115,7 @@ default int asMinutes() { /** * Equals method. * Hint: generate equals method together with hashCode. - * @param other + * @param other object * @return true if the value of this Time is equal to the value of other Time. */ @Override