diff --git a/jabgui/src/main/java/org/jabref/gui/edit/automaticfiededitor/MoveFieldValueAction.java b/jabgui/src/main/java/org/jabref/gui/edit/automaticfiededitor/MoveFieldValueAction.java index 660c2f8454b..4064b1f4c6b 100644 --- a/jabgui/src/main/java/org/jabref/gui/edit/automaticfiededitor/MoveFieldValueAction.java +++ b/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; diff --git a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/FieldRowViewModel.java b/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/FieldRowViewModel.java index 2cd50b5ffa6..8c81fc77b05 100644 --- a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/FieldRowViewModel.java +++ b/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 } diff --git a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/cell/HeaderCell.java b/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/cell/HeaderCell.java index 56dd1de1178..e1f49cd5c6f 100644 --- a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/cell/HeaderCell.java +++ b/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(); diff --git a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/cell/sidebuttons/ToggleMergeUnmergeButton.java b/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/cell/sidebuttons/ToggleMergeUnmergeButton.java index 5b1122c999a..6476b44f2eb 100644 --- a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/cell/sidebuttons/ToggleMergeUnmergeButton.java +++ b/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); } diff --git a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/CommentMerger.java b/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/CommentMerger.java index cccb75db27f..d7703943dce 100644 --- a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/CommentMerger.java +++ b/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) { diff --git a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/FieldMerger.java b/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/FieldMerger.java index 7dfdb077341..ccb3286384d 100644 --- a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/FieldMerger.java +++ b/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); diff --git a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/FileMerger.java b/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/FileMerger.java index 7e5f075f6cb..edef3b2834f 100644 --- a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/FileMerger.java +++ b/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) { diff --git a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/GroupMerger.java b/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/GroupMerger.java index 2aa182c286a..d457916b40d 100644 --- a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/GroupMerger.java +++ b/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; diff --git a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/KeywordMerger.java b/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/KeywordMerger.java index f47190ef1b5..6fe139cd879 100644 --- a/jabgui/src/main/java/org/jabref/gui/mergeentries/threewaymerge/fieldsmerger/KeywordMerger.java +++ b/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; diff --git a/jablib/src/main/java/org/jabref/logic/layout/format/HTMLChars.java b/jablib/src/main/java/org/jabref/logic/layout/format/HTMLChars.java index 9776f49a504..346ffd637c6 100644 --- a/jablib/src/main/java/org/jabref/logic/layout/format/HTMLChars.java +++ b/jablib/src/main/java/org/jabref/logic/layout/format/HTMLChars.java @@ -14,13 +14,12 @@ public class HTMLChars implements ParamLayoutFormatter { private static final Map HTML_CHARS = HTMLUnicodeConversionMaps.LATEX_HTML_CONVERSION_MAP; - /** - * This regex matches '&' that DO NOT BEGIN an HTML entity. - *

- * &{@literal amp;} Not Matched
- * &{@literal #34;} Not Matched
- * &Hey Matched - * */ + + /// This regex matches `&` that **do not begin** an HTML entity. + /// + /// - `&` **Not Matched** + /// - `"` **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; diff --git a/jablib/src/main/java/org/jabref/model/entry/identifier/ArXivIdentifier.java b/jablib/src/main/java/org/jabref/model/entry/identifier/ArXivIdentifier.java index 78f43ccb6a4..39a8f80e0e6 100644 --- a/jablib/src/main/java/org/jabref/model/entry/identifier/ArXivIdentifier.java +++ b/jablib/src/main/java/org/jabref/model/entry/identifier/ArXivIdentifier.java @@ -75,14 +75,11 @@ public Optional getClassification() { } } - /** - * ArXiV articles are assigned DOIs automatically, which starts with a DOI prefix '10.48550/' followed by the ArXiV - * ID (replacing the colon with a period). - *

- * For more information: - * - * new-arxiv-articles-are-now-automatically-assigned-dois - * */ + /// ArXiv articles are automatically assigned DOIs starting with the prefix + /// `10.48550/`, followed by the ArXiv ID (with the colon replaced by a period). + /// + /// More information: + /// [new-arxiv-articles-are-now-automatically-assigned-dois](https://blog.arxiv.org/2022/02/17/new-arxiv-articles-are-now-automatically-assigned-dois/) public Optional inferDOI() { if (StringUtil.isBlank(identifier)) { return Optional.empty(); diff --git a/jablib/src/main/java/org/jabref/model/entry/identifier/EprintIdentifier.java b/jablib/src/main/java/org/jabref/model/entry/identifier/EprintIdentifier.java index 994af79115c..2d373f0b84f 100644 --- a/jablib/src/main/java/org/jabref/model/entry/identifier/EprintIdentifier.java +++ b/jablib/src/main/java/org/jabref/model/entry/identifier/EprintIdentifier.java @@ -3,9 +3,7 @@ import org.jabref.model.entry.field.Field; import org.jabref.model.entry.field.StandardField; -/** - * NOTE: This class is mainly used to keep track of eprint parsers, and make it easier to navigate the code. - * */ +/// NOTE: This class is mainly used to keep track of eprint parsers and make it easier to navigate the code. public abstract class EprintIdentifier implements Identifier { @Override diff --git a/jablib/src/main/java/org/jabref/model/strings/StringUtil.java b/jablib/src/main/java/org/jabref/model/strings/StringUtil.java index 54cc25da703..0b75385d9d6 100644 --- a/jablib/src/main/java/org/jabref/model/strings/StringUtil.java +++ b/jablib/src/main/java/org/jabref/model/strings/StringUtil.java @@ -778,7 +778,7 @@ public static String quoteStringIfSpaceIsContained(String string) { * * @param s The string to check * @return {@code True} if the given string does contain at least one whitespace character, {@code False} otherwise - * */ + */ public static boolean containsWhitespace(String s) { return s.chars().anyMatch(Character::isWhitespace); } diff --git a/jablib/src/test/java/org/jabref/logic/importer/fetcher/CiteSeerTest.java b/jablib/src/test/java/org/jabref/logic/importer/fetcher/CiteSeerTest.java index 3e18df3bdc7..92e59439f4c 100644 --- a/jablib/src/test/java/org/jabref/logic/importer/fetcher/CiteSeerTest.java +++ b/jablib/src/test/java/org/jabref/logic/importer/fetcher/CiteSeerTest.java @@ -63,10 +63,10 @@ void searchByQueryFindsEntryCopingTheoryAndResearch() throws FetcherException { assertEquals(List.of(expected), fetchedEntries); } - /* - * CiteSeer seems to only apply year ranges effectively when we search for entries - * with associated pdfs, year values do not accurately reflect realistic values - * */ + /** + * CiteSeer seems to only apply year ranges effectively when we search for entries + * with associated pdfs, year values do not accurately reflect realistic values + */ @Disabled @Test void searchWithSortingByYear() throws FetcherException {