diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 89f8d3adafd..d057c72964d 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -38,6 +38,7 @@ jobs: with: reporter: github-pr-check checkstyle_config: 'config/checkstyle/checkstyle_reviewdog.xml' + checkstyle_version: '10.1' - name: Run checkstyle gradle run: ./gradlew checkstyleMain checkstyleTest checkstyleJmh - name: Run markdown-lint diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml index 5d75c732bed..25fe5b033d9 100644 --- a/config/checkstyle/checkstyle.xml +++ b/config/checkstyle/checkstyle.xml @@ -32,6 +32,8 @@ + + @@ -67,6 +69,7 @@ + @@ -83,6 +86,8 @@ + + @@ -137,5 +142,9 @@ + + + + diff --git a/config/checkstyle/checkstyle_reviewdog.xml b/config/checkstyle/checkstyle_reviewdog.xml index 23d41f035e1..0fe1f7b221b 100644 --- a/config/checkstyle/checkstyle_reviewdog.xml +++ b/config/checkstyle/checkstyle_reviewdog.xml @@ -32,6 +32,8 @@ + + @@ -67,6 +69,7 @@ + @@ -83,6 +86,8 @@ + + @@ -137,5 +142,9 @@ + + + + diff --git a/src/main/java/org/jabref/gui/actions/ActionHelper.java b/src/main/java/org/jabref/gui/actions/ActionHelper.java index 0c34735f12d..2e23cc54c4e 100644 --- a/src/main/java/org/jabref/gui/actions/ActionHelper.java +++ b/src/main/java/org/jabref/gui/actions/ActionHelper.java @@ -85,6 +85,7 @@ public static BooleanExpression isFilePresentForSelectedEntry(StateManager state * Check if at least one of the selected entries has linked files *
* Used in {@link org.jabref.gui.maintable.OpenExternalFileAction} when multiple entries selected + * * @param stateManager manager for the state of the GUI * @return a boolean binding */ diff --git a/src/main/java/org/jabref/gui/autocompleter/AutoCompletionTextInputBinding.java b/src/main/java/org/jabref/gui/autocompleter/AutoCompletionTextInputBinding.java index 7f0f10b160e..a294c91df91 100644 --- a/src/main/java/org/jabref/gui/autocompleter/AutoCompletionTextInputBinding.java +++ b/src/main/java/org/jabref/gui/autocompleter/AutoCompletionTextInputBinding.java @@ -41,8 +41,6 @@ * Represents a binding between a text input control and a auto-completion popup * This class is a slightly modified version of {@link impl.org.controlsfx.autocompletion.AutoCompletionTextFieldBinding} * that works with general text input controls instead of just text fields. - * @param - * */ public class AutoCompletionTextInputBinding extends AutoCompletionBinding { diff --git a/src/main/java/org/jabref/gui/groups/GroupDialogViewModel.java b/src/main/java/org/jabref/gui/groups/GroupDialogViewModel.java index 522d129bb08..1d4d7d97804 100644 --- a/src/main/java/org/jabref/gui/groups/GroupDialogViewModel.java +++ b/src/main/java/org/jabref/gui/groups/GroupDialogViewModel.java @@ -269,6 +269,7 @@ private void setupValidation() { /** * Gets the absolute path relative to the LatexFileDirectory, if given a relative path + * * @param input the user input path * @return an absolute path if LatexFileDirectory exists; otherwise, returns input */ diff --git a/src/main/java/org/jabref/gui/importer/GrobidOptInDialogHelper.java b/src/main/java/org/jabref/gui/importer/GrobidOptInDialogHelper.java index 4809acfc5a2..d58d6c8d5d4 100644 --- a/src/main/java/org/jabref/gui/importer/GrobidOptInDialogHelper.java +++ b/src/main/java/org/jabref/gui/importer/GrobidOptInDialogHelper.java @@ -7,13 +7,14 @@ /** * Metadata extraction from PDFs and plaintext works very well using Grobid, but we do not want to enable it by default * due to data privacy concerns. - * To make users aware of the feature, we ask each time before querrying Grobid, giving the option to opt-out. + * To make users aware of the feature, we ask each time before querying Grobid, giving the option to opt-out. */ public class GrobidOptInDialogHelper { /** - * If Grobid is not enabled but the user has not expicitly opted-out of Grobid, we ask for permission to send data + * If Grobid is not enabled but the user has not explicitly opted-out of Grobid, we ask for permission to send data * to Grobid using a dialog and giving an opt-out option. + * * @param dialogService the DialogService to use * @return if the user enabled Grobid, either in the past or after being asked by the dialog. */ diff --git a/src/main/java/org/jabref/gui/importer/actions/GUIPostOpenAction.java b/src/main/java/org/jabref/gui/importer/actions/GUIPostOpenAction.java index acdbd8726a7..cc943956861 100644 --- a/src/main/java/org/jabref/gui/importer/actions/GUIPostOpenAction.java +++ b/src/main/java/org/jabref/gui/importer/actions/GUIPostOpenAction.java @@ -17,6 +17,7 @@ public interface GUIPostOpenAction { /** * This method is queried in order to find out whether the action needs to be * performed or not. + * * @param pr The result of the BIB parse operation. * @return true if the action should be called, false otherwise. */ diff --git a/src/main/java/org/jabref/gui/menus/FileHistoryMenu.java b/src/main/java/org/jabref/gui/menus/FileHistoryMenu.java index da640b11016..7a748f6d838 100644 --- a/src/main/java/org/jabref/gui/menus/FileHistoryMenu.java +++ b/src/main/java/org/jabref/gui/menus/FileHistoryMenu.java @@ -36,6 +36,7 @@ public FileHistoryMenu(PreferencesService preferences, DialogService dialogServi /** * This method is to use typed letters to access recent libraries in menu. + * * @param keyEvent a KeyEvent. * @return false if typed char is invalid or not a number. */ diff --git a/src/main/java/org/jabref/gui/openoffice/Bootstrap.java b/src/main/java/org/jabref/gui/openoffice/Bootstrap.java index 87e242be781..54cacab3162 100644 --- a/src/main/java/org/jabref/gui/openoffice/Bootstrap.java +++ b/src/main/java/org/jabref/gui/openoffice/Bootstrap.java @@ -49,24 +49,24 @@ import com.sun.star.uno.XComponentContext; /** Bootstrap offers functionality to obtain a context or simply - a service manager. - The service manager can create a few basic services, whose implementations are: -
    -
  • com.sun.star.comp.loader.JavaLoader
    • -
  • com.sun.star.comp.urlresolver.UrlResolver
    • -
  • com.sun.star.comp.bridgefactory.BridgeFactory
    • -
  • com.sun.star.comp.connections.Connector
    • -
  • com.sun.star.comp.connections.Acceptor
    • -
  • com.sun.star.comp.servicemanager.ServiceManager
    • -
- - Other services can be inserted into the service manager by - using its XSet interface: - 
-        XSet xSet = UnoRuntime.queryInterface( XSet.class, aMultiComponentFactory );
-        // insert the service manager
-        xSet.insert( aSingleComponentFactory );
-
+ * a service manager. + * The service manager can create a few basic services, whose implementations are: + *
    + *
  • com.sun.star.comp.loader.JavaLoader
    • + *
  • com.sun.star.comp.urlresolver.UrlResolver
    • + *
  • com.sun.star.comp.bridgefactory.BridgeFactory
    • + *
  • com.sun.star.comp.connections.Connector
    • + *
  • com.sun.star.comp.connections.Acceptor
    • + *
  • com.sun.star.comp.servicemanager.ServiceManager
    • + *
+ * + * Other services can be inserted into the service manager by + * using its XSet interface: + * 
+  *     XSet xSet = UnoRuntime.queryInterface( XSet.class, aMultiComponentFactory );
+  *     // insert the service manager
+  *     xSet.insert( aSingleComponentFactory );
+  *
*/ public class Bootstrap { diff --git a/src/main/java/org/jabref/gui/preferences/preview/PreviewTabViewModel.java b/src/main/java/org/jabref/gui/preferences/preview/PreviewTabViewModel.java index 256bb7ebd52..e31faa4d2d8 100644 --- a/src/main/java/org/jabref/gui/preferences/preview/PreviewTabViewModel.java +++ b/src/main/java/org/jabref/gui/preferences/preview/PreviewTabViewModel.java @@ -54,6 +54,7 @@ *

* {@link PreviewTab} is the controller of Entry Preview tab *

+ * * @see PreviewTab * */ public class PreviewTabViewModel implements PreferenceTabViewModel { diff --git a/src/main/java/org/jabref/logic/bibtex/FileFieldWriter.java b/src/main/java/org/jabref/logic/bibtex/FileFieldWriter.java index 68f59c1e403..237e160dfb9 100644 --- a/src/main/java/org/jabref/logic/bibtex/FileFieldWriter.java +++ b/src/main/java/org/jabref/logic/bibtex/FileFieldWriter.java @@ -29,6 +29,7 @@ public static String getStringRepresentation(LinkedFile field) { /** * Encodes a two-dimensional String array into a single string, using ':' and * ';' as separators. The characters ':' and ';' are escaped with '\'. + * * @param values The String array. * @return The encoded String. */ @@ -41,6 +42,7 @@ public static String encodeStringArray(String[][] values) { /** * Encodes a String array into a single string, using ':' as separator. * The characters ':' and ';' are escaped with '\'. + * * @param entry The String array. * @return The encoded String. */ diff --git a/src/main/java/org/jabref/logic/bst/TextPrefixFunction.java b/src/main/java/org/jabref/logic/bst/TextPrefixFunction.java index 983792ad833..415ee97498b 100644 --- a/src/main/java/org/jabref/logic/bst/TextPrefixFunction.java +++ b/src/main/java/org/jabref/logic/bst/TextPrefixFunction.java @@ -6,19 +6,18 @@ import org.jabref.logic.bst.VM.BstFunction; /** - The |built_in| function {\.{text.prefix\$}} pops the top two literals - (the integer literal |pop_lit1| and a string literal, in that order). - It pushes the substring of the (at most) |pop_lit1| consecutive text - characters starting from the beginning of the string. This function - is similar to {\.{substring\$}}, but this one considers an accented - character (or more precisely, a ``special character''$\!$, even if - it's missing its matching |right_brace|) to be a single text character - (rather than however many |ASCII_code| characters it actually - comprises), and this function doesn't consider braces to be text - characters; furthermore, this function appends any needed matching - |right_brace|s. If any of the types is incorrect, it complains and - pushes the null string. - * + * The |built_in| function {\.{text.prefix\$}} pops the top two literals + * (the integer literal |pop_lit1| and a string literal, in that order). + * It pushes the substring of the (at most) |pop_lit1| consecutive text + * characters starting from the beginning of the string. This function + * is similar to {\.{substring\$}}, but this one considers an accented + * character (or more precisely, a ``special character''$\!$, even if + * it's missing its matching |right_brace|) to be a single text character + * (rather than however many |ASCII_code| characters it actually + * comprises), and this function doesn't consider braces to be text + * characters; furthermore, this function appends any needed matching + * |right_brace|s. If any of the types is incorrect, it complains and + * pushes the null string. */ public class TextPrefixFunction implements BstFunction { diff --git a/src/main/java/org/jabref/logic/bst/VM.java b/src/main/java/org/jabref/logic/bst/VM.java index eab8f4003a2..c4b6a08d6ba 100644 --- a/src/main/java/org/jabref/logic/bst/VM.java +++ b/src/main/java/org/jabref/logic/bst/VM.java @@ -925,7 +925,6 @@ public String run(Collection bibEntries, BibDatabase bibDatabase) { * field variable is marked as missing for the entry. *

* We use null for the missing entry designator. - * @param bibDatabase */ private void read(BibDatabase bibDatabase) { FieldWriter fieldWriter = new FieldWriter(new FieldWriterPreferences(true, List.of(StandardField.MONTH), new FieldContentFormatterPreferences())); diff --git a/src/main/java/org/jabref/logic/citationstyle/CSLAdapter.java b/src/main/java/org/jabref/logic/citationstyle/CSLAdapter.java index 88467782466..cf5c9874c70 100644 --- a/src/main/java/org/jabref/logic/citationstyle/CSLAdapter.java +++ b/src/main/java/org/jabref/logic/citationstyle/CSLAdapter.java @@ -54,6 +54,7 @@ public class CSLAdapter { /** * Creates the bibliography of the provided items. This method needs to run synchronized because the underlying * CSL engine is not thread-safe. + * * @param databaseContext {@link BibDatabaseContext} is used to be able to resolve fields and their aliases */ public synchronized List makeBibliography(List bibEntries, String style, CitationStyleOutputFormat outputFormat, BibDatabaseContext databaseContext, BibEntryTypesManager entryTypesManager) throws IOException, IllegalArgumentException { diff --git a/src/main/java/org/jabref/logic/exporter/Exporter.java b/src/main/java/org/jabref/logic/exporter/Exporter.java index 58a649a5d14..fb2f1267b3f 100644 --- a/src/main/java/org/jabref/logic/exporter/Exporter.java +++ b/src/main/java/org/jabref/logic/exporter/Exporter.java @@ -62,6 +62,7 @@ public String toString() { /** * Exports to all files linked to a given entry + * * @param databaseContext the database to export from * @param filePreferences the filePreferences to use for resolving paths * @param entryToWriteOn the entry for which we want to write on all linked pdfs @@ -90,6 +91,7 @@ public boolean exportToAllFilesOfEntry(BibDatabaseContext databaseContext, FileP * Behaviour in case the file is linked to different bib-entries depends on the implementation of {@link #export}. * If it overwrites any existing information, only the last found bib-entry will be exported (as the previous exports are overwritten). * If it extends existing information, all found bib-entries will be exported. + * * @param databaseContext the database-context to export from * @param dataBase the database to export from * @param filePreferences the filePreferences to use for resolving paths diff --git a/src/main/java/org/jabref/logic/git/GitHandler.java b/src/main/java/org/jabref/logic/git/GitHandler.java index f486ae52878..7ad89689672 100644 --- a/src/main/java/org/jabref/logic/git/GitHandler.java +++ b/src/main/java/org/jabref/logic/git/GitHandler.java @@ -110,6 +110,7 @@ Optional getRefForBranch(String branchName) throws GitAPIException, IOExcep /** * Creates a commit on the currently checked out branch + * * @param amend Whether to amend to the last commit (true), or not (false) * @return Returns true if a new commit was created. This is the case if the repository was not clean on method invocation */ diff --git a/src/main/java/org/jabref/logic/importer/PagedSearchBasedParserFetcher.java b/src/main/java/org/jabref/logic/importer/PagedSearchBasedParserFetcher.java index bbbc848cc99..9f08d042c69 100644 --- a/src/main/java/org/jabref/logic/importer/PagedSearchBasedParserFetcher.java +++ b/src/main/java/org/jabref/logic/importer/PagedSearchBasedParserFetcher.java @@ -40,8 +40,9 @@ private List getBibEntries(URL urlForQuery) throws FetcherException { /** * Constructs a URL based on the query, size and page number. - * @param luceneQuery the search query - * @param pageNumber the number of the page indexed from 0 + * + * @param luceneQuery the search query + * @param pageNumber the number of the page indexed from 0 */ URL getURLForQuery(QueryNode luceneQuery, int pageNumber) throws URISyntaxException, MalformedURLException, FetcherException; diff --git a/src/main/java/org/jabref/logic/importer/fileformat/EndnoteImporter.java b/src/main/java/org/jabref/logic/importer/fileformat/EndnoteImporter.java index 00ae5eec79f..3c23f90258f 100644 --- a/src/main/java/org/jabref/logic/importer/fileformat/EndnoteImporter.java +++ b/src/main/java/org/jabref/logic/importer/fileformat/EndnoteImporter.java @@ -271,6 +271,7 @@ public ParserResult importDatabase(BufferedReader reader) throws IOException { * separated by " and ". This is the correct behaviour. * One source lists the names separated by comma, with a comma at the end. We can detect * this format and fix it. + * * @param s The author string * @return The fixed author string */ diff --git a/src/main/java/org/jabref/logic/importer/fileformat/EndnoteXmlImporter.java b/src/main/java/org/jabref/logic/importer/fileformat/EndnoteXmlImporter.java index 168fc291bbc..57d6eb6787a 100644 --- a/src/main/java/org/jabref/logic/importer/fileformat/EndnoteXmlImporter.java +++ b/src/main/java/org/jabref/logic/importer/fileformat/EndnoteXmlImporter.java @@ -173,64 +173,64 @@ private static EntryType convertRefNameToType(String refName) { }; } - private BibEntry parseRecord(Record record) { + private BibEntry parseRecord(Record endNoteRecord) { BibEntry entry = new BibEntry(); - entry.setType(getType(record)); - Optional.ofNullable(getAuthors(record)) + entry.setType(getType(endNoteRecord)); + Optional.ofNullable(getAuthors(endNoteRecord)) .ifPresent(value -> entry.setField(StandardField.AUTHOR, value)); - Optional.ofNullable(record.getTitles()) + Optional.ofNullable(endNoteRecord.getTitles()) .map(Titles::getTitle) .map(Title::getStyle) .map(this::mergeStyleContents) .ifPresent(value -> entry.setField(StandardField.TITLE, clean(value))); - Optional.ofNullable(record.getTitles()) + Optional.ofNullable(endNoteRecord.getTitles()) .map(Titles::getSecondaryTitle) .map(SecondaryTitle::getStyle) .map(Style::getContent) .ifPresent(value -> entry.setField(StandardField.JOURNAL, clean(value))); - Optional.ofNullable(record.getPages()) + Optional.ofNullable(endNoteRecord.getPages()) .map(Pages::getStyle) .map(Style::getContent) .ifPresent(value -> entry.setField(StandardField.PAGES, value)); - Optional.ofNullable(record.getNumber()) + Optional.ofNullable(endNoteRecord.getNumber()) .map(Number::getStyle) .map(Style::getContent) .ifPresent(value -> entry.setField(StandardField.NUMBER, value)); - Optional.ofNullable(record.getVolume()) + Optional.ofNullable(endNoteRecord.getVolume()) .map(Volume::getStyle) .map(Style::getContent) .ifPresent(value -> entry.setField(StandardField.VOLUME, value)); - Optional.ofNullable(record.getDates()) + Optional.ofNullable(endNoteRecord.getDates()) .map(Dates::getYear) .map(Year::getStyle) .map(Style::getContent) .ifPresent(value -> entry.setField(StandardField.YEAR, value)); - Optional.ofNullable(record.getNotes()) + Optional.ofNullable(endNoteRecord.getNotes()) .map(Notes::getStyle) .map(Style::getContent) .ifPresent(value -> entry.setField(StandardField.NOTE, value.trim())); - getUrl(record) + getUrl(endNoteRecord) .ifPresent(value -> entry.setField(StandardField.URL, value)); - entry.putKeywords(getKeywords(record), preferences.getKeywordSeparator()); - Optional.ofNullable(record.getAbstract()) + entry.putKeywords(getKeywords(endNoteRecord), preferences.getKeywordSeparator()); + Optional.ofNullable(endNoteRecord.getAbstract()) .map(Abstract::getStyle) .map(Style::getContent) .ifPresent(value -> entry.setField(StandardField.ABSTRACT, value.trim())); - entry.setFiles(getLinkedFiles(record)); - Optional.ofNullable(record.getIsbn()) + entry.setFiles(getLinkedFiles(endNoteRecord)); + Optional.ofNullable(endNoteRecord.getIsbn()) .map(Isbn::getStyle) .map(Style::getContent) .ifPresent(value -> entry.setField(StandardField.ISBN, clean(value))); - Optional.ofNullable(record.getElectronicResourceNum()) + Optional.ofNullable(endNoteRecord.getElectronicResourceNum()) .map(ElectronicResourceNum::getStyle) .map(Style::getContent) .ifPresent(doi -> entry.setField(StandardField.DOI, doi.trim())); - Optional.ofNullable(record.getPublisher()) + Optional.ofNullable(endNoteRecord.getPublisher()) .map(Publisher::getStyle) .map(Style::getContent) .ifPresent(value -> entry.setField(StandardField.PUBLISHER, value)); - Optional.ofNullable(record.getLabel()) + Optional.ofNullable(endNoteRecord.getLabel()) .map(Label::getStyle) .map(Style::getContent) .ifPresent(value -> entry.setField(new UnknownField("endnote-label"), value)); @@ -238,15 +238,15 @@ private BibEntry parseRecord(Record record) { return entry; } - private EntryType getType(Record record) { - return Optional.ofNullable(record.getRefType()) + private EntryType getType(Record endNoteRecord) { + return Optional.ofNullable(endNoteRecord.getRefType()) .map(RefType::getName) .map(EndnoteXmlImporter::convertRefNameToType) .orElse(StandardEntryType.Article); } - private List getLinkedFiles(Record record) { - Optional urls = Optional.ofNullable(record.getUrls()) + private List getLinkedFiles(Record endNoteRecord) { + Optional urls = Optional.ofNullable(endNoteRecord.getUrls()) .map(Urls::getPdfUrls); return OptionalUtil.toStream(urls) .flatMap(pdfUrls -> pdfUrls.getUrl().stream()) @@ -262,8 +262,8 @@ private List getLinkedFiles(Record record) { .collect(Collectors.toList()); } - private Optional getUrl(Record record) { - Optional urls = Optional.ofNullable(record.getUrls()) + private Optional getUrl(Record endNoteRecord) { + Optional urls = Optional.ofNullable(endNoteRecord.getUrls()) .map(Urls::getRelatedUrls); return OptionalUtil.toStream(urls) .flatMap(url -> url.getUrl().stream()) @@ -302,8 +302,8 @@ private Optional getUrlValue(Url url) { return ret; } - private List getKeywords(Record record) { - Keywords keywords = record.getKeywords(); + private List getKeywords(Record endNoteRecord) { + Keywords keywords = endNoteRecord.getKeywords(); if (keywords != null) { return keywords.getKeyword() @@ -317,8 +317,8 @@ private List getKeywords(Record record) { } } - private String getAuthors(Record record) { - Optional authors = Optional.ofNullable(record.getContributors()) + private String getAuthors(Record endNoteRecord) { + Optional authors = Optional.ofNullable(endNoteRecord.getContributors()) .map(Contributors::getAuthors); return OptionalUtil.toStream(authors) .flatMap(value -> value.getAuthor().stream()) diff --git a/src/main/java/org/jabref/logic/importer/fileformat/GvkParser.java b/src/main/java/org/jabref/logic/importer/fileformat/GvkParser.java index 6dc44d0ed67..5837bdf0e34 100644 --- a/src/main/java/org/jabref/logic/importer/fileformat/GvkParser.java +++ b/src/main/java/org/jabref/logic/importer/fileformat/GvkParser.java @@ -57,8 +57,8 @@ private List parseEntries(Document content) { return result; } List records = getChildren("zs:record", srwrecords); - for (Element record : records) { - Element e = getChild("zs:recordData", record); + for (Element gvkRecord : records) { + Element e = getChild("zs:recordData", gvkRecord); if (e != null) { e = getChild("record", e); if (e != null) { diff --git a/src/main/java/org/jabref/logic/importer/fileformat/MrDLibImporter.java b/src/main/java/org/jabref/logic/importer/fileformat/MrDLibImporter.java index 413964a567a..5e331ca0716 100644 --- a/src/main/java/org/jabref/logic/importer/fileformat/MrDLibImporter.java +++ b/src/main/java/org/jabref/logic/importer/fileformat/MrDLibImporter.java @@ -71,6 +71,7 @@ public String getDescription() { /** * Convert Buffered Reader response to string for JSON parsing. + * * @param input Takes a BufferedReader with a reference to the JSON document delivered by mdl server. * @return Returns an String containing the JSON document. * @throws IOException @@ -104,8 +105,8 @@ public RankedBibEntry(BibEntry entry, Integer rank) { /** * Parses the input from the server to a ParserResult + * * @param input A BufferedReader with a reference to a string with the server's response - * @throws IOException */ private void parse(BufferedReader input) throws IOException { // The Bibdatabase that gets returned in the ParserResult. @@ -141,6 +142,7 @@ private void parse(BufferedReader input) throws IOException { /** * Parses the JSON recommendations into bib entries + * * @param recommendation JSON object of a single recommendation returned by Mr. DLib * @return A ranked bib entry created from the recommendation input */ diff --git a/src/main/java/org/jabref/logic/importer/fileformat/MsBibImporter.java b/src/main/java/org/jabref/logic/importer/fileformat/MsBibImporter.java index 11e39b19f88..0834bcd12e7 100644 --- a/src/main/java/org/jabref/logic/importer/fileformat/MsBibImporter.java +++ b/src/main/java/org/jabref/logic/importer/fileformat/MsBibImporter.java @@ -93,6 +93,7 @@ public String getDescription() { /** * DocumentBuilderFactory makes a XXE safe Builder factory from dBuild. If not supported by current * XML then returns original builder given and logs error. + * * @param dBuild | DocumentBuilderFactory to be made XXE safe. * @return If supported, XXE safe DocumentBuilderFactory. Else, returns original builder given */ diff --git a/src/main/java/org/jabref/logic/importer/util/MetaDataParser.java b/src/main/java/org/jabref/logic/importer/util/MetaDataParser.java index e6ac1eb1da1..eb1e905adca 100644 --- a/src/main/java/org/jabref/logic/importer/util/MetaDataParser.java +++ b/src/main/java/org/jabref/logic/importer/util/MetaDataParser.java @@ -110,6 +110,7 @@ private static Comparator> groupsLast() { /** * Returns the first item in the list. * If the specified list does not contain exactly one item, then a {@link ParseException} will be thrown. + * * @param value * @return */ diff --git a/src/main/java/org/jabref/logic/integrity/UTF8Checker.java b/src/main/java/org/jabref/logic/integrity/UTF8Checker.java index a5474dd0f46..534b99cd47f 100644 --- a/src/main/java/org/jabref/logic/integrity/UTF8Checker.java +++ b/src/main/java/org/jabref/logic/integrity/UTF8Checker.java @@ -52,6 +52,7 @@ public List check(BibEntry entry) { * Check whether a byte array is encoded in UTF-8 charset * * Use java api decoder and try&catch block to check the charset. + * * @param data the byte array used to check the encoding charset * @return true if is encoded in UTF-8 & false is not encoded in UTF-8 */ diff --git a/src/main/java/org/jabref/logic/layout/AbstractParamLayoutFormatter.java b/src/main/java/org/jabref/logic/layout/AbstractParamLayoutFormatter.java index 44e67a312f7..bbd1344ddf9 100644 --- a/src/main/java/org/jabref/logic/layout/AbstractParamLayoutFormatter.java +++ b/src/main/java/org/jabref/logic/layout/AbstractParamLayoutFormatter.java @@ -17,6 +17,7 @@ protected AbstractParamLayoutFormatter() { /** * Parse an argument string and return the parts of the argument. The parts are * separated by commas, and escaped commas are reduced to literal commas. + * * @param arg The argument string. * @return A list of strings representing the parts of the argument. */ diff --git a/src/main/java/org/jabref/logic/layout/ParamLayoutFormatter.java b/src/main/java/org/jabref/logic/layout/ParamLayoutFormatter.java index 946e7f6af81..bdbda3040b3 100644 --- a/src/main/java/org/jabref/logic/layout/ParamLayoutFormatter.java +++ b/src/main/java/org/jabref/logic/layout/ParamLayoutFormatter.java @@ -13,6 +13,7 @@ public interface ParamLayoutFormatter extends LayoutFormatter { /** * Method for setting the argument of this formatter. + * * @param arg A String argument. */ void setArgument(String arg); diff --git a/src/main/java/org/jabref/logic/layout/format/Authors.java b/src/main/java/org/jabref/logic/layout/format/Authors.java index 3a7a9860ab7..5692470fac3 100644 --- a/src/main/java/org/jabref/logic/layout/format/Authors.java +++ b/src/main/java/org/jabref/logic/layout/format/Authors.java @@ -209,6 +209,7 @@ private void handleArgument(String key, String value) { /** * Check for case-insensitive equality between two strings after removing * white space at the beginning and end of the first string. + * * @param one The first string - whitespace is trimmed * @param two The second string * @return true if the strings are deemed equal diff --git a/src/main/java/org/jabref/logic/layout/format/FileLink.java b/src/main/java/org/jabref/logic/layout/format/FileLink.java index ba784043224..79a5b4b31fc 100644 --- a/src/main/java/org/jabref/logic/layout/format/FileLink.java +++ b/src/main/java/org/jabref/logic/layout/format/FileLink.java @@ -68,6 +68,7 @@ public String format(String field) { /** * This method is called if the layout file specifies an argument for this * formatter. We use it as an indicator of which file type we should look for. + * * @param arg The file type. */ @Override diff --git a/src/main/java/org/jabref/logic/net/URLDownload.java b/src/main/java/org/jabref/logic/net/URLDownload.java index 7646048d7ba..3f9c3a5311c 100644 --- a/src/main/java/org/jabref/logic/net/URLDownload.java +++ b/src/main/java/org/jabref/logic/net/URLDownload.java @@ -98,6 +98,7 @@ public URLDownload(URL source) { * security-relevant information this is kind of OK (no, actually it is not...). *

* Taken from http://stackoverflow.com/a/6055903/873661 and https://stackoverflow.com/a/19542614/873661 + * * @deprecated */ @Deprecated diff --git a/src/main/java/org/jabref/logic/pdf/search/indexing/PdfIndexer.java b/src/main/java/org/jabref/logic/pdf/search/indexing/PdfIndexer.java index c750de78b21..3b91be44f71 100644 --- a/src/main/java/org/jabref/logic/pdf/search/indexing/PdfIndexer.java +++ b/src/main/java/org/jabref/logic/pdf/search/indexing/PdfIndexer.java @@ -111,6 +111,7 @@ public void addToIndex(BibEntry entry, LinkedFile linkedFile, BibDatabaseContext /** * Removes a pdf file linked to one entry in the database from the index + * * @param entry the entry the file is linked to * @param linkedFile the link to the file to be removed */ @@ -130,6 +131,7 @@ public void removeFromIndex(BibEntry entry, LinkedFile linkedFile) { /** * Removes all files linked to a bib-entry from the index + * * @param entry the entry documents are linked to */ public void removeFromIndex(BibEntry entry) { @@ -138,6 +140,7 @@ public void removeFromIndex(BibEntry entry) { /** * Removes a list of files linked to a bib-entry from the index + * * @param entry the entry documents are linked to */ public void removeFromIndex(BibEntry entry, List linkedFiles) { @@ -162,6 +165,7 @@ public void flushIndex() { /** * Writes all files linked to an entry to the index if the files are not yet in the index or the files on the fs are * newer than the one in the index. + * * @param entry the entry associated with the file */ private void writeToIndex(BibEntry entry) { @@ -173,6 +177,7 @@ private void writeToIndex(BibEntry entry) { /** * Writes the file to the index if the file is not yet in the index or the file on the fs is newer than the one in * the index. + * * @param entry the entry associated with the file * @param linkedFile the file to write to the index */ diff --git a/src/main/java/org/jabref/logic/util/DelayTaskThrottler.java b/src/main/java/org/jabref/logic/util/DelayTaskThrottler.java index 6ce6c35094a..17fe4770937 100644 --- a/src/main/java/org/jabref/logic/util/DelayTaskThrottler.java +++ b/src/main/java/org/jabref/logic/util/DelayTaskThrottler.java @@ -15,7 +15,6 @@ * This class allows to throttle a list of tasks. * Use case: you have an event that occurs often, and every time you want to invoke the same task. * However, if a lot of events happen in a relatively short time span, then only one task should be invoked. - * @param * * @implNote Once {@link #schedule(Runnable)} is called, the task is delayed for a given time span. * If during this time, {@link #schedule(Runnable)} is called again, then the original task is canceled and the new one scheduled. diff --git a/src/main/java/org/jabref/logic/util/strings/StringManipulator.java b/src/main/java/org/jabref/logic/util/strings/StringManipulator.java index cb1972de5e1..bdde7c1fd49 100644 --- a/src/main/java/org/jabref/logic/util/strings/StringManipulator.java +++ b/src/main/java/org/jabref/logic/util/strings/StringManipulator.java @@ -78,7 +78,8 @@ static ResultingStringState deleteUntilWordBoundary(int caretPosition, String te /** * Utility method to find the next whitespace position in string after text - * @param caretPosition The current caret Position + * + * @param caretPosition The current caret position * @param text The string to search in * @param direction The direction to move through string * diff --git a/src/main/java/org/jabref/model/TreeNode.java b/src/main/java/org/jabref/model/TreeNode.java index 5491a53c3ad..634882d0f73 100644 --- a/src/main/java/org/jabref/model/TreeNode.java +++ b/src/main/java/org/jabref/model/TreeNode.java @@ -590,6 +590,7 @@ public T copySubtree() { * - addChild (new parent) * - removeChild (old parent) * - move (old parent and new parent) + * * @param subscriber function to be invoked upon a change */ public void subscribeToDescendantChanged(Consumer subscriber) { diff --git a/src/main/java/org/jabref/model/database/BibDatabase.java b/src/main/java/org/jabref/model/database/BibDatabase.java index 14193a0d14e..4d01284d1e0 100644 --- a/src/main/java/org/jabref/model/database/BibDatabase.java +++ b/src/main/java/org/jabref/model/database/BibDatabase.java @@ -293,6 +293,7 @@ public synchronized void addString(BibtexString string) throws KeyCollisionExcep /** * Replaces the existing lists of BibTexString with the given one * Duplicates throw KeyCollisionException + * * @param stringsToAdd The collection of strings to set */ public void setStrings(List stringsToAdd) { @@ -634,6 +635,7 @@ public boolean isDuplicateCitationKeyExisting(String key) { /** * Set the newline separator. + * * @param newLineSeparator */ public void setNewLineSeparator(String newLineSeparator) { diff --git a/src/main/java/org/jabref/model/database/BibDatabaseContext.java b/src/main/java/org/jabref/model/database/BibDatabaseContext.java index 3fb270f0645..e5824aecc61 100644 --- a/src/main/java/org/jabref/model/database/BibDatabaseContext.java +++ b/src/main/java/org/jabref/model/database/BibDatabaseContext.java @@ -215,6 +215,7 @@ public List getEntries() { /** * check if the database has any empty entries + * * @return true if the database has any empty entries; otherwise false */ public boolean hasEmptyEntries() { diff --git a/src/main/java/org/jabref/model/strings/StringUtil.java b/src/main/java/org/jabref/model/strings/StringUtil.java index c3f9e53a0fc..e10b8ce5796 100644 --- a/src/main/java/org/jabref/model/strings/StringUtil.java +++ b/src/main/java/org/jabref/model/strings/StringUtil.java @@ -258,6 +258,7 @@ public static String quoteForHTML(String toQuote) { * Decodes an encoded double String array back into array form. The array * is assumed to be square, and delimited by the characters ';' (first dim) and * ':' (second dim). + * * @param value The encoded String to be decoded. * @return The decoded String array. */ @@ -413,6 +414,7 @@ public static String unifyLineBreaks(String s, String newline) { /** * Checks if the given String has exactly one pair of surrounding curly braces
* Strings with escaped characters in curly braces at the beginning and end are respected, too + * * @param toCheck The string to check * @return True, if the check was succesful. False otherwise. */ diff --git a/src/main/java/org/jabref/model/util/FileUpdateMonitor.java b/src/main/java/org/jabref/model/util/FileUpdateMonitor.java index 7404b13d6f0..9575bf3a8d5 100644 --- a/src/main/java/org/jabref/model/util/FileUpdateMonitor.java +++ b/src/main/java/org/jabref/model/util/FileUpdateMonitor.java @@ -21,6 +21,7 @@ public interface FileUpdateMonitor { /** * Indicates whether the native system's file monitor has successfully started. + * * @return true is process is running; false otherwise. */ boolean isActive(); diff --git a/src/test/java/org/jabref/logic/integrity/UTF8CheckerTest.java b/src/test/java/org/jabref/logic/integrity/UTF8CheckerTest.java index aac597ee93e..2151776af09 100644 --- a/src/test/java/org/jabref/logic/integrity/UTF8CheckerTest.java +++ b/src/test/java/org/jabref/logic/integrity/UTF8CheckerTest.java @@ -34,7 +34,8 @@ void fieldAcceptsUTF8() { * fieldDoesNotAcceptUmlauts to check UTF8Checker's result set * when the entry is encoded in Non-Utf-8 charset and the Library * environment is Non UTF-8. - * Finally we need to reset the environment charset. + * Finally, we need to reset the environment charset. + * * @throws UnsupportedEncodingException initial a String in charset GBK * Demo: new String(StringDemo.getBytes(), "GBK"); */