Fix the Javadoc errors introduced by thesis_bm

Author: ibbem

src/main/java/org/variantsync/diffdetective/variation/diff/DiffNode.java

@@ -286,7 +286,6 @@ public int getChangeAmount(Time time) {
      * Inverse of drop.
      * @param newBeforeParent Node that should be this node's before parent. May be null.
      * @param newAfterParent Node that should be this node's after parent. May be null.
-     * @return True iff this node could be added as child to at least one of the given non-null parents.
      */
     public void addBelow(final DiffNode newBeforeParent, final DiffNode newAfterParent) {
         if (getDiffType().existsAtTime(BEFORE) && newBeforeParent != null) {
@@ -367,7 +366,6 @@ public void addChildren(final Collection<DiffNode> children, Time time) {
      * The node might still remain a child after or before the edit.
      * @param child the child to remove
      * @param time whether {@code child} should be removed before or after the edit
-     * @return True iff the child was removed, false iff it's not a child at {@code time}.
      */
     public void removeChild(final DiffNode child, Time time) {
         Assert.assertTrue(isChild(child, time));

src/main/java/org/variantsync/diffdetective/variation/diff/DiffTree.java

@@ -494,7 +494,7 @@ public String toString() {
      * Create a {@link DiffTree} by matching nodes between {@code before} and {@code after} with the
      * default GumTree matcher.
      *
-     * @see compareUsingMatching(VariationTree, VariationTree, Matcher)
+     * @see compareUsingMatching(VariationNode, VariationNode, Matcher)
      */
     public static DiffTree compareUsingMatching(VariationTree before, VariationTree after) {
         DiffNode root = compareUsingMatching(
@@ -507,13 +507,14 @@ public static DiffTree compareUsingMatching(VariationTree before, VariationTree
     }
 
     /**
-     * Create a {@link DiffTree} by matching nodes between {@code before} and {@code after} with
-     * {@code matcher}.
+     * Create a {@link DiffNode} by matching nodes between {@code before} and {@code after} with
+     * {@code matcher}. The arguments of this function aren't modified (note the
+     * {@link compareUsingMatching(DiffNode, VariationNode, Matcher) overload} which modifies
+     * {@code before} in-place.
      *
-     * Note: There are currently no guarantees about the line numbers. But it is guaranteed that
-     * {@link DiffNode#getID} is unique.
-     *
-     * @param TODO
+     * @param before the variation tree before an edit
+     * @param after the variation tree after an edit
+     * @see compareUsingMatching(DiffNode, VariationNode, Matcher)
      */
     public static <A extends VariationNode<A>, B extends VariationNode<B>> DiffNode compareUsingMatching(
         VariationNode<A> before,
@@ -523,6 +524,17 @@ public static <A extends VariationNode<A>, B extends VariationNode<B>> DiffNode
         return compareUsingMatching(DiffNode.unchanged(before), after, matcher);
     }
 
+    /**
+     * Create a {@link DiffNode} by matching nodes between {@code before} and {@code after} with
+     * {@code matcher}. The result of this function is {@code before} which is modified in-place. In
+     * contrast, {@code after} is kept in tact.
+     *
+     * Note: There are currently no guarantees about the line numbers. But it is guaranteed that
+     * {@link DiffNode#getID} is unique.
+     *
+     * @param before the variation tree before an edit
+     * @param after the variation tree after an edit
+     */
     public static <B extends VariationNode<B>> DiffNode compareUsingMatching(
         DiffNode before,
         VariationNode<B> after,
@@ -591,10 +603,18 @@ private static void addUnmapped(MappingStore mappings, DiffNode parent, WrappedV
         }
     }
 
+    /**
+     * Run {@code matcher} on the implicit matching of this variation diff and update this variation
+     * tree in-place to reflect the new matching.
+     */
     public void improveMatching(Matcher matcher) {
         improveMatching(getRoot(), matcher);
     }
 
+    /**
+     * Run {@code matcher} on the matching extracted from {@code tree} and modify {@code tree}
+     * in-place to reflect the new matching.
+     */
     public static DiffNode improveMatching(DiffNode tree, Matcher matcher) {
         var src = new WrappedDiffTree(tree, BEFORE);
         var dst = new WrappedDiffTree(tree, AFTER);

src/main/java/org/variantsync/diffdetective/variation/diff/source/VariationTreeDiffSource.java

@@ -1,9 +1,11 @@
 package org.variantsync.diffdetective.variation.diff.source;
 
+import org.variantsync.diffdetective.variation.diff.DiffTree; // For Javadoc
+import org.variantsync.diffdetective.variation.tree.VariationTree; // For Javadoc
 import org.variantsync.diffdetective.variation.tree.source.VariationTreeSource;
 
 /**
- * Describes that a {@link DiffTree} was created from two {@link VarationTree}s.
+ * Describes that a {@link DiffTree} was created from two {@link VariationTree}s.
  */
 public record VariationTreeDiffSource(
     VariationTreeSource before,

src/main/java/org/variantsync/diffdetective/variation/tree/VariationNode.java

@@ -238,8 +238,6 @@ public void addChildren(final Collection<T> children) {
      * Removes the given node from this node's children list and sets the parent of {@code child}
      * to {@code null}.
      *
-     * @return {@code true} iff the child was removed, {@code false} iff {@code child} is not a
-     * child of this node
      * @throws IllegalArgumentException if {@code childe} is not a child of this node
      * @see removeChildren
      * @see getChildren