refactor: address IntelliJ QAPlug plugin findings

engine/src/main/java/org/terasology/engine/logic/characters/events/OnScaleEvent.java

@@ -49,7 +49,7 @@ public float getNewValue() {
     /**
      * The scaling factor determined by the quotient of new and old value.
      * <p>
-     * This is guaranteed to be greater zero (> 0).
+     * This is guaranteed to be greater than 0.
      */
     public float getFactor() {
         return newValue / oldValue;

engine/src/main/java/org/terasology/engine/math/Rotation.java

@@ -207,16 +207,16 @@ public int hashCode() {
     }
 
     /**
-     * Returns all possible rotations for each yaw, pitch & roll combination, including duplicates.
+     * Returns all possible rotations for each yaw, pitch & roll combination, including duplicates.
      *
-     * @return All possible rotations for each yaw, pitch & roll combination.
+     * @return All possible rotations for each yaw, pitch & roll combination.
      */
     public static Iterable<Rotation> allValues() {
         return Arrays.asList(ALL_ROTATIONS);
     }
 
     /**
-     * Returns only unique rotations, in respect to transformations, rather than in respect to yaw, pitch & roll.
+     * Returns only unique rotations, in respect to transformations, rather than in respect to yaw, pitch &amp; roll.
      *
      * @return Unique rotations, in respect to transformations.
      */

engine/src/main/java/org/terasology/engine/particles/components/ParticleEmitterComponent.java

@@ -86,12 +86,12 @@ public class ParticleEmitterComponent implements Component<ParticleEmitterCompon
     public transient ParticlePool particlePool;
 
     /**
-     * Maps Generator component -> Function that processes that Generator
+     * Maps Generator component → Function that processes that Generator
      */
     public final Map<Component, GeneratorFunction> generatorFunctionMap = new LinkedHashMap<>();
 
     /**
-     * Maps Affector component -> Function that processes that Affector
+     * Maps Affector component → Function that processes that Affector
      */
     public final Map<Component, AffectorFunction> affectorFunctionMap = new LinkedHashMap<>();
 

engine/src/main/java/org/terasology/engine/rendering/nui/editor/layers/NUIEditorScreen.java

@@ -61,7 +61,7 @@
 
 /**
  * The main NUI editor screen.
- * Contains file selection, editing & preview widgets.
+ * Contains file selection, editing & preview widgets.
  */
 @SuppressWarnings("unchecked")
 public final class NUIEditorScreen extends AbstractEditorScreen {

engine/src/main/java/org/terasology/engine/rendering/nui/layers/mainMenu/savedGames/GameProvider.java

@@ -113,16 +113,16 @@ public static String getNextGameName() {
      * game.
      *
      * <pre>
-     *     1. "Game"    -> "Game"
-     *     2. "Game"    -> "Game 1"
-     *     3. "Game 1"  -> "Game 2"
+     *     1. "Game"    → "Game"
+     *     2. "Game"    → "Game 1"
+     *     3. "Game 1"  → "Game 2"
      * </pre>
      * <p>
      * When incrementing the number the currently highest number is incremented by one (i.e., "gaps" are not filled).
      *
      * <pre>
-     *     1. "Gooey 3"     -> "Gooey 3"
-     *     2. "Gooey"       -> "Gooey 4"
+     *     1. "Gooey 3"     → "Gooey 3"
+     *     2. "Gooey"       → "Gooey 4"
      * </pre>
      *
      * @param gameName will to use as game prefix, if saves contains this game name

engine/src/main/java/org/terasology/engine/rendering/nui/layers/mainMenu/savedGames/NumberedGameName.java

@@ -33,9 +33,9 @@ public NumberedGameName(String namePrefix, Optional<Integer> number) {
      * </pre>
      * These examples will be parsed as follows:
      * <pre>
-     *      "Gooey's 1st Game"  -> ("Gooey's 1st Game", None)
-     *      "Gooey 42"          -> ("Gooey", Optional(42))
-     *      "42"                -> ("42", None)
+     *      "Gooey's 1st Game"  → ("Gooey's 1st Game", None)
+     *      "Gooey 42"          → ("Gooey", Optional(42))
+     *      "42"                → ("42", None)
      * </pre>
      * <p>
      * The input string will be trimmed before matching.
@@ -70,9 +70,9 @@ static NumberedGameName fromString(String fullName) {
      * the name prefix will be returned.
      *
      * <pre>
-     *      ("Gooey's 1st Game", None)  -> "Gooey's 1st Game"
-     *      ("Gooey", Optional(42))     -> "Gooey 42"
-     *      ("42", None)                -> "42"
+     *      ("Gooey's 1st Game", None)  → "Gooey's 1st Game"
+     *      ("Gooey", Optional(42))     → "Gooey 42"
+     *      ("42", None)                → "42"
      * </pre>
      *
      * @return a textual representation of the numbered game version

engine/src/main/java/org/terasology/engine/telemetry/TelemetryField.java

@@ -11,7 +11,7 @@
 
 /**
  * All telemetry fields should have this annotation.
- * {@link org.terasology.engine.telemetry.metrics.Metric} finds all the telemetry fields & values via this annotation.
+ * {@link org.terasology.engine.telemetry.metrics.Metric} finds all telemetry fields and values via this annotation.
  */
 @API
 @Target(ElementType.FIELD)

engine/src/main/java/org/terasology/engine/world/block/BlockAreac.java

@@ -235,8 +235,8 @@ default Vector2i getSize(Vector2i dest) {
     /**
      * Set the size of the block area from the minimum corner.
      *
-     * @param x the x coordinate to set the size; must be > 0
-     * @param y the y coordinate to set the size; must be > 0
+     * @param x the x coordinate to set the size; must be greater than 0
+     * @param y the y coordinate to set the size; must be greater than 0
      * @param dest destination; will hold the result
      * @return {@code dest} (after modification)
      * @throws IllegalArgumentException if the size is smaller than or equal to 0 in any dimension
@@ -246,7 +246,7 @@ default Vector2i getSize(Vector2i dest) {
     /**
      * Set the size of the block area from the minimum corner.
      *
-     * @param size the size to set; all dimensions must be > 0
+     * @param size the size to set; all dimensions must be greater than 0
      * @param dest destination; will hold the result
      * @return {@code dest} (after modification)
      * @throws IllegalArgumentException if the size is smaller than or equal to 0 in any dimension

engine/src/main/java/org/terasology/engine/world/block/BlockRegionc.java

@@ -280,9 +280,9 @@ default Vector3i getSize(Vector3i dest) {
     /**
      * Set the size of the block region from the minimum corner.
      *
-     * @param x the x coordinate to set the size; must be > 0
-     * @param y the y coordinate to set the size; must be > 0
-     * @param z the z coordinate to set the size; must be >
+     * @param x the x coordinate to set the size; must be greater than 0
+     * @param y the y coordinate to set the size; must be greater than 0
+     * @param z the z coordinate to set the size; must be greater than 0
      * @param dest destination; will hold the result
      * @return {@code dest} (after modification)
      * @throws IllegalArgumentException if the size is smaller than or equal to 0 in any dimension
@@ -292,7 +292,7 @@ default Vector3i getSize(Vector3i dest) {
     /**
      * Set the size of the block region from the minimum corner.
      *
-     * @param size the size to set; all dimensions must be > 0
+     * @param size the size to set; all dimensions must be greater than 0
      * @param dest destination; will hold the result
      * @return {@code dest} (after modification)
      * @throws IllegalArgumentException if the size is smaller than or equal to 0 in any dimension