Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
Expand Down
Original file line number Diff line number Diff line change
@@ -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) {
Expand Down
Original file line number Diff line number Diff line change
@@ -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);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,11 @@ public Optional<String> 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).
*<p>
* For more information:
* <a href="https://blog.arxiv.org/2022/02/17/new-arxiv-articles-are-now-automatically-assigned-dois/">
* new-arxiv-articles-are-now-automatically-assigned-dois</a>
* */
/// 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<DOI> inferDOI() {
if (StringUtil.isBlank(identifier)) {
return Optional.empty();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Loading