Refactor (#47)

* docs: clean up javadoc

* perf: use lombok for enum getters

common/src/main/java/io/github/jy95/fds/common/types/DisplayOrder.java

@@ -1,12 +1,15 @@
 package io.github.jy95.fds.common.types;
 
+import lombok.Getter;
+
 import java.util.List;
 
 /**
  * Represents the available display orders
  *
  * @author jy95
  */
+@Getter
 public enum DisplayOrder {
     /**
      * Display "method"
@@ -141,18 +144,13 @@ public enum DisplayOrder {
      */
     TIMING_MODIFIER_EXTENSION(List.of("timing.modifierExtension"));
 
+    /**
+     *  Getter for the <code>field</code>(s) covered by the display order
+     */
     private final List<String> fields;
 
     DisplayOrder(List<String> fields) {
         this.fields = fields;
     }
 
-    /**
-     * <p>Getter for the field <code>fields</code>.</p>
-     *
-     * @return a {@link java.util.List} object
-     */
-    public List<String> getFields() {
-        return fields;
-    }
 }

common/src/main/java/io/github/jy95/fds/common/types/LinkWord.java

@@ -1,10 +1,13 @@
 package io.github.jy95.fds.common.types;
 
+import lombok.Getter;
+
 /**
  * Enum representing the link words used to combine list elements.
  *
  * @author jy95
  */
+@Getter
 public enum LinkWord {
     /**
      * Represents the "and" link word.
@@ -15,18 +18,13 @@ public enum LinkWord {
      */
     THEN("then");
 
+    /**
+     *  Retrieves the value of the link word.
+     */
     private final String value;
 
     LinkWord(String value) {
         this.value = value;
     }
 
-    /**
-     * Retrieves the value of the link word.
-     *
-     * @return The string value of the link word.
-     */
-    public String getValue() {
-        return value;
-    }
 }

r4/src/main/java/io/github/jy95/fds/r4/functions/RatioToStringR4.java

@@ -13,8 +13,6 @@
  * R4 class for converting ratio objects to human-readable strings.
  * Implements the Bill Pugh Singleton pattern for thread-safe lazy initialization.
  *
- * Author: jy95
- *
  * @author jy95
  */
 public class RatioToStringR4 implements RatioToString<FDSConfigR4, Ratio> {

r5/src/main/java/io/github/jy95/fds/r5/functions/RatioToStringR5.java

@@ -13,8 +13,6 @@
  * R5 class for converting ratio objects to human-readable strings.
  * Implements the Bill Pugh Singleton pattern for thread-safe lazy initialization.
  *
- * Author: jy95
- *
  * @author jy95
  */
 public class RatioToStringR5 implements RatioToString<FDSConfigR5, Ratio> {