#378: Added missing JavaDoc.

api/src/main/java/module-info.java

@@ -12,6 +12,8 @@
     exports org.itsallcode.openfasttrace.api.importer.tag.config;
     exports org.itsallcode.openfasttrace.api.exporter;
     exports org.itsallcode.openfasttrace.api.report;
+    // Workaround: Required for the EqualsVerifier
+    opens org.itsallcode.openfasttrace.api.core;
 
     requires java.logging;
 }

importer/lightweightmarkup/src/main/java/org/itsallcode/openfasttrace/importer/lightweightmarkup/LineParserState.java

@@ -1,6 +1,32 @@
 package org.itsallcode.openfasttrace.importer.lightweightmarkup;
 
+/**
+ * This enum defines the state the line parser for lightweight markup languages can be in.
+ */
 public enum LineParserState
 {
-    START, OUTSIDE, SPEC_ITEM, DESCRIPTION, COVERS, DEPENDS, RATIONALE, COMMENT, NEEDS, EOF, TITLE, TAGS
+    /** Parser started (at beginning of the file) */
+    START,
+    /** We are outside any specification item */
+    OUTSIDE,
+    /** Inside a specification item */
+    SPEC_ITEM,
+    /** Inside a description section */
+    DESCRIPTION,
+    /** Inside a provided coverage section */
+    COVERS,
+    /** Inside a section describing dependencies */
+    DEPENDS,
+    /** Inside a rationale section */
+    RATIONALE,
+    /** Inside a comment section */
+    COMMENT,
+    /** Inside a section defining the required coverage */
+    NEEDS,
+    /** Reached the end of the file */
+    EOF,
+    /** Found a title */
+    TITLE,
+    /** Found tags */
+    TAGS
 }

importer/lightweightmarkup/src/main/java/org/itsallcode/openfasttrace/importer/lightweightmarkup/LineParserStateMachine.java

@@ -5,15 +5,16 @@
 import java.util.regex.Matcher;
 
 /**
- * This machine implements the core of a state based parser
- *
+ * This machine implements the core of a state based parser.
+ * <p>
  * Before the state machine is run, it needs to be configured with a transition
  * table in the constructor.
- *
+ * </p><p>
  * Each step of the state machine gets a portion of the text to be imported as
  * input. The machine checks the current state and the input on each step and
  * decides on resulting state and action depending on the configuration provided
  * in the transition table.
+ * </p>
  */
 public class LineParserStateMachine
 {
@@ -50,7 +51,7 @@ public void step(final String line)
             if ((this.state == entry.getFrom()) && matchToken(line, entry))
             {
                 LOG.finest(() -> entry + " : '" + line + "'");
-                entry.getTransition().transit();
+                entry.getTransitionAction().transit();
                 this.state = entry.getTo();
                 break;
             }
@@ -60,7 +61,7 @@ public void step(final String line)
     private boolean matchToken(final String line, final Transition entry)
     {
         boolean matches = false;
-        final Matcher matcher = entry.getMarkdownPattern().getPattern().matcher(line);
+        final Matcher matcher = entry.getLinePattern().getPattern().matcher(line);
         if (matcher.matches())
         {
             this.lastToken = (matcher.groupCount() == 0) ? "" : matcher.group(1);

importer/lightweightmarkup/src/main/java/org/itsallcode/openfasttrace/importer/lightweightmarkup/Transition.java

@@ -1,37 +1,68 @@
 package org.itsallcode.openfasttrace.importer.lightweightmarkup;
 
+/**
+ * Transition in the line parser statemachine.
+ */
 public class Transition
 {
     private final LineParserState from;
     private final LineParserState to;
-    private final LinePattern markdownPattern;
+    private final LinePattern linePattern;
     private final TransitionAction transitionAction;
 
-    public Transition(final LineParserState from, final LineParserState to, final LinePattern markdownPattern,
+    /**
+     * Create a new instance of a {@link Transition}.
+     *
+     * @param from state the statemachine comes from
+     * @param to state the machine will switch to if the pattern matches
+     * @param linePattern pattern the line must match for the transition to happen
+     * @param transitionAction action that will be executed as result of the transition
+     */
+    public Transition(final LineParserState from, final LineParserState to, final LinePattern linePattern,
                       final TransitionAction transitionAction)
     {
         this.from = from;
         this.to = to;
-        this.markdownPattern = markdownPattern;
+        this.linePattern = linePattern;
         this.transitionAction = transitionAction;
     }
 
+    /**
+     * Get the origin state of this transition.
+     *
+     * @return origin state
+     */
     public LineParserState getFrom()
     {
         return this.from;
     }
 
+    /**
+     * Get the target state of this transition.
+     *
+     * @return target state
+     */
     public LineParserState getTo()
     {
         return this.to;
     }
 
-    public LinePattern getMarkdownPattern()
+    /**
+     * Get the regular expression pattern that needs to be matched in order for the transition to happen.
+     *
+     * @return line pattern to be matched
+     */
+    public LinePattern getLinePattern()
     {
-        return this.markdownPattern;
+        return this.linePattern;
     }
 
-    public TransitionAction getTransition()
+    /**
+     * Get the action that is executed when the transition happens.
+     *
+     * @return action that is executed as result of the transition
+     */
+    public TransitionAction getTransitionAction()
     {
         return this.transitionAction;
     }
@@ -40,6 +71,6 @@ public TransitionAction getTransition()
     public String toString()
     {
         return "Transition [from=" + this.from + ", to=" + this.to + ", markdownPattern="
-                + this.markdownPattern + "]";
+                + this.linePattern + "]";
     }
 }

importer/lightweightmarkup/src/main/java/org/itsallcode/openfasttrace/importer/lightweightmarkup/TransitionAction.java

@@ -1,7 +1,13 @@
 package org.itsallcode.openfasttrace.importer.lightweightmarkup;
 
+/**
+ * Action that is executed as a result of a state transition in the line parser.
+ */
 @FunctionalInterface
 public interface TransitionAction
 {
+    /**
+     * Execute the transition action.
+     */
     void transit();
 }

parent/pom.xml

@@ -375,14 +375,9 @@
                     <useModulePath>true</useModulePath>
                     <argLine>
                         <!-- Required for Jacoco coverage -->
-                        @{argLine}
+                        <!-- @{argLine} -->
                         <!-- Required for Java 18 -->
                         ${test.args}
-                        <!-- Required to fix failing EqualsVerifier test:
-                            TestTracedLink.testEqualsAndHashContract:22 EqualsVerifier found a problem in class org.itsallcode.openfasttrace.api.core.TracedLink.
-                            -> Unable to make field private final org.itsallcode.openfasttrace.api.core.LinkedSpecificationItem org.itsallcode.openfasttrace.api.core.TracedLink.otherLinkEnd accessible:
-                            module org.itsallcode.openfasttrace.api does not "opens org.itsallcode.openfasttrace.api.core" to unnamed module @48ae9b55 -->
-                        --add-opens org.itsallcode.openfasttrace.api/org.itsallcode.openfasttrace.api.core=ALL-UNNAMED
                     </argLine>
                 </configuration>
             </plugin>
@@ -398,14 +393,9 @@
                     <useModulePath>true</useModulePath>
                     <argLine>
                         <!-- Required for Jacoco coverage -->
-                        @{argLine}
+                        <!-- @{argLine} -->
                         <!-- Required for Java 18 -->
                         ${test.args}
-                        <!-- Required to fix failing EqualsVerifier test:
-                            TestTracedLink.testEqualsAndHashContract:22 EqualsVerifier found a problem in class org.itsallcode.openfasttrace.api.core.TracedLink.
-                            -> Unable to make field private final org.itsallcode.openfasttrace.api.core.LinkedSpecificationItem org.itsallcode.openfasttrace.api.core.TracedLink.otherLinkEnd accessible:
-                            module org.itsallcode.openfasttrace.api does not "opens org.itsallcode.openfasttrace.api.core" to unnamed module @48ae9b55 -->
-                        --add-opens org.itsallcode.openfasttrace.api/org.itsallcode.openfasttrace.api.core=ALL-UNNAMED
                     </argLine>
                 </configuration>
                 <executions>