Fix JavaDoc (#13888)

* Fix JavaDoc

* Update jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/KeywordMerger.java

Co-authored-by: Subhramit Basu <[email protected]>

---------

Co-authored-by: Subhramit Basu <[email protected]>

Author: koppor

jabgui/src/main/java/org/jabref/gui/edit/automaticfiededitor/MoveFieldValueAction.java

@@ -53,9 +53,7 @@ public void execute() {
         edits.end();
     }
 
-    /**
-     * @return the number of affected entries
-     * */
+    /// @return the number of affected entries
     public int executeAndGetAffectedEntriesCount() {
         execute();
         return affectedEntriesCount;

jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/FieldRowViewModel.java

@@ -37,7 +37,7 @@ public enum Selection {
         /**
          * When the user types something into the merged field value and neither the left nor
          * right values match it, NONE is selected
-         * */
+         */
         NONE
     }
 

jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/cell/HeaderCell.java

@@ -3,9 +3,7 @@
 import javafx.geometry.Insets;
 import javafx.scene.control.Label;
 
-/**
- * A readonly cell used to display the header of the ThreeWayMerge UI at the top of the layout.
- * */
+/// A readonly cell used to display the header of the ThreeWayMerge UI at the top of the layout.
 public class HeaderCell extends ThreeWayMergeCell {
     public static final String DEFAULT_STYLE_CLASS = "merge-header-cell";
     private final Label label = new Label();

jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/cell/sidebuttons/ToggleMergeUnmergeButton.java

@@ -63,9 +63,7 @@ public boolean canMerge() {
         return canMerge.get();
     }
 
-    /**
-     * Setting {@code canMerge} to {@code false} will disable the merge/unmerge button
-     * */
+    /// Setting `canMerge` to `false` will disable the merge/unmerge button
     public void setCanMerge(boolean value) {
         canMergeProperty().set(value);
     }

jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/CommentMerger.java

@@ -1,11 +1,8 @@
 package org.jabref.gui.mergeentries.threewaymerge.fieldsmerger;
 
 import org.jabref.logic.os.OS;
-import org.jabref.model.entry.field.StandardField;
 
-/**
- * A merger for the {@link StandardField#COMMENT} field
- * */
+/// A merger for the {@link org.jabref.model.entry.field.StandardField#COMMENT} field
 public class CommentMerger implements FieldMerger {
     @Override
     public String merge(String fieldValueA, String fieldValueB) {

jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/FieldMerger.java

@@ -1,8 +1,6 @@
 package org.jabref.gui.mergeentries.threewaymerge.fieldsmerger;
 
-/**
- * This class is responsible for taking two values for some field and merging them to into one value
- * */
+/// This class is responsible for taking two values for some field and merging them into one value
 @FunctionalInterface
 public interface FieldMerger {
     String merge(String fieldValueA, String fieldValueB);

jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/FileMerger.java

@@ -5,12 +5,9 @@
 import org.jabref.logic.bibtex.FileFieldWriter;
 import org.jabref.logic.importer.util.FileFieldParser;
 import org.jabref.model.entry.LinkedFile;
-import org.jabref.model.entry.field.StandardField;
 import org.jabref.model.strings.StringUtil;
 
-/**
- * A merger for the {@link StandardField#FILE} field
- * */
+/// A merger for the {@link org.jabref.model.entry.field.StandardField#FILE} field
 public class FileMerger implements FieldMerger {
     @Override
     public String merge(String filesA, String filesB) {

jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/GroupMerger.java

@@ -4,14 +4,11 @@
 
 import org.jabref.model.entry.BibEntryPreferences;
 import org.jabref.model.entry.KeywordList;
-import org.jabref.model.entry.field.StandardField;
 import org.jabref.model.strings.StringUtil;
 
 import org.jspecify.annotations.NonNull;
 
-/**
- * A merger for the {@link StandardField#GROUPS} field
- * */
+/// A merger for the {@link org.jabref.model.entry.field.StandardField#GROUPS} field
 public class GroupMerger implements FieldMerger {
 
     private final @NonNull BibEntryPreferences bibEntryPreferences;

jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/KeywordMerger.java

@@ -4,11 +4,8 @@
 
 import org.jabref.model.entry.BibEntryPreferences;
 import org.jabref.model.entry.KeywordList;
-import org.jabref.model.entry.field.StandardField;
 
-/**
- * A merger for the {@link StandardField#KEYWORDS} field
- * */
+/// A merger for the {@link org.jabref.model.entry.field.StandardField#KEYWORDS} field
 public class KeywordMerger implements FieldMerger {
     private final BibEntryPreferences bibEntryPreferences;
 

jablib/src/main/java/org/jabref/logic/layout/format/HTMLChars.java

@@ -14,13 +14,12 @@
 public class HTMLChars implements ParamLayoutFormatter {
 
     private static final Map<String, String> HTML_CHARS = HTMLUnicodeConversionMaps.LATEX_HTML_CONVERSION_MAP;
-    /**
-     * This regex matches '<b>&</b>' that DO NOT BEGIN an HTML entity.
-     * <p>
-     * <b>&</b>{@literal amp;} <b>Not Matched</b><br>
-     * <b>&</b>{@literal #34;} <b>Not Matched</b><br>
-     * <b>&</b>Hey <b>Matched</b>
-     * */
+
+    /// This regex matches `&` that **do not begin** an HTML entity.
+    ///
+    /// - `&amp;` **Not Matched**
+    /// - `&#34;` **Not Matched**
+    /// - `&Hey` **Matched**
     private static final Pattern HTML_ENTITY_PATTERN = Pattern.compile("&(?!(?:[a-z0-9]+|#[0-9]{1,6}|#x[0-9a-fA-F]{1,6});)");
 
     private boolean keepCurlyBraces = false;