From 07cbbb9bb3e8cbd98f9caa08519c2b6259a10083 Mon Sep 17 00:00:00 2001
From: JeremyStarTM <jeremystartm@staropensource.de>
Date: Wed, 4 Sep 2024 17:03:06 +0200
Subject: [PATCH] Fix VersioningSystem and versioning system tests javadoc

---
 .../sosengine/base/implementable/VersioningSystem.java       | 2 +-
 .../versioning/OneNumberVersioningSystemTest.java            | 5 ++---
 .../versioning/StarOpenSourceVersioningSystemTest.java       | 5 ++---
 3 files changed, 5 insertions(+), 7 deletions(-)

diff --git a/base/src/main/java/de/staropensource/sosengine/base/implementable/VersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/implementable/VersioningSystem.java
index 67dc80d..eaf6b45 100644
--- a/base/src/main/java/de/staropensource/sosengine/base/implementable/VersioningSystem.java
+++ b/base/src/main/java/de/staropensource/sosengine/base/implementable/VersioningSystem.java
@@ -41,7 +41,7 @@ public interface VersioningSystem {
      * Compares a {@link VersioningSystem} with another.
      *
      * @param version {@link VersioningSystem} to compare against
-     * @return smaller = {@code 0}, equal = {@code 1}, bigger = {@code 2}
+     * @return {@code 0} if the supplied version is bigger, {@code 1} if equal and {@code 2} if smaller
      * @throws IncompatibleVersioningSystemException incompatible with the supplied versioning system
      * @since v1-alpha1
      */
diff --git a/base/src/test/java/de/staropensource/sosengine/base/srctests/implementation/versioning/OneNumberVersioningSystemTest.java b/base/src/test/java/de/staropensource/sosengine/base/srctests/implementation/versioning/OneNumberVersioningSystemTest.java
index 314394c..0f0628c 100644
--- a/base/src/test/java/de/staropensource/sosengine/base/srctests/implementation/versioning/OneNumberVersioningSystemTest.java
+++ b/base/src/test/java/de/staropensource/sosengine/base/srctests/implementation/versioning/OneNumberVersioningSystemTest.java
@@ -19,9 +19,8 @@
 
 package de.staropensource.sosengine.base.srctests.implementation.versioning;
 
-import de.staropensource.sosengine.base.implementation.versioning.OneNumberVersioningSystem;
-import de.staropensource.sosengine.base.implementation.versioning.TwoNumberVersioningSystem;
 import de.staropensource.sosengine.base.exception.versioning.InvalidVersionStringException;
+import de.staropensource.sosengine.base.implementation.versioning.OneNumberVersioningSystem;
 import de.staropensource.sosengine.base.srctests.TestBase;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -31,7 +30,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.fail;
 
 /**
- * Tests the class {@link TwoNumberVersioningSystem}.
+ * Tests the class {@link OneNumberVersioningSystem}.
  */
 @DisplayName("OneNumberVersioningSystem")
 public class OneNumberVersioningSystemTest extends TestBase {
diff --git a/base/src/test/java/de/staropensource/sosengine/base/srctests/implementation/versioning/StarOpenSourceVersioningSystemTest.java b/base/src/test/java/de/staropensource/sosengine/base/srctests/implementation/versioning/StarOpenSourceVersioningSystemTest.java
index 38050fd..a9cfd69 100644
--- a/base/src/test/java/de/staropensource/sosengine/base/srctests/implementation/versioning/StarOpenSourceVersioningSystemTest.java
+++ b/base/src/test/java/de/staropensource/sosengine/base/srctests/implementation/versioning/StarOpenSourceVersioningSystemTest.java
@@ -19,9 +19,8 @@
 
 package de.staropensource.sosengine.base.srctests.implementation.versioning;
 
-import de.staropensource.sosengine.base.implementation.versioning.SemanticVersioningSystem;
-import de.staropensource.sosengine.base.implementation.versioning.StarOpenSourceVersioningSystem;
 import de.staropensource.sosengine.base.exception.versioning.InvalidVersionStringException;
+import de.staropensource.sosengine.base.implementation.versioning.StarOpenSourceVersioningSystem;
 import de.staropensource.sosengine.base.srctests.TestBase;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -31,7 +30,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.fail;
 
 /**
- * Tests the class {@link SemanticVersioningSystem}.
+ * Tests the class {@link StarOpenSourceVersioningSystem}.
  */
 @DisplayName("StarOpenSourceVersioningSystem")
 public class StarOpenSourceVersioningSystemTest extends TestBase {