docs: clarify comments in versioncompare

milkdrinkers · Dec 22, 2024 · 7a3b3e8 · 7a3b3e8
1 parent 01763eb
commit 7a3b3e8
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/common/src/main/java/io/github/milkdrinkers/javasemver/VersionCompare.java b/common/src/main/java/io/github/milkdrinkers/javasemver/VersionCompare.java
@@ -130,7 +130,7 @@ private static boolean isNumber(final @NotNull String identifier) {
      *
      * @param current the current version
      * @param other the other version
-     * @return if currentVersion is same as otherVersion
+     * @return true if current version is same as other version
      */
     @SuppressWarnings("unused")
     public static boolean isEqual(@NotNull Version current, @NotNull Version other) {
@@ -142,7 +142,7 @@ public static boolean isEqual(@NotNull Version current, @NotNull Version other)
      *
      * @param current the current version
      * @param other the other version
-     * @return if currentVersion is newer
+     * @return true if current version is newer than other version
      */
     @SuppressWarnings("unused")
     public static boolean isNewer(@NotNull Version current, @NotNull Version other) {
@@ -154,7 +154,7 @@ public static boolean isNewer(@NotNull Version current, @NotNull Version other)
      *
      * @param current the current version
      * @param other the other version
-     * @return if currentVersion is older
+     * @return true if current version is older than other version
      */
     @SuppressWarnings("unused")
     public static boolean isOlder(@NotNull Version current, @NotNull Version other) {
@@ -166,7 +166,7 @@ public static boolean isOlder(@NotNull Version current, @NotNull Version other)
      *
      * @param current the current version
      * @param other the other version
-     * @return if currentVersion is newer or equal to
+     * @return true if current version is newer or equal to other version
      */
     @SuppressWarnings("unused")
     public static boolean isNewerOrEqual(@NotNull Version current, @NotNull Version other) {
@@ -178,7 +178,7 @@ public static boolean isNewerOrEqual(@NotNull Version current, @NotNull Version
      *
      * @param current the current version
      * @param other the other version
-     * @return if currentVersion is older or equal to
+     * @return true if current version is older or equal to other version
      */
     @SuppressWarnings("unused")
     public static boolean isOlderOrEqual(@NotNull Version current, @NotNull Version other) {