Minor JavaDoc updates (#13483)

* Minor JavaDoc updates

* Fix checkstyle

* Update jabgui/src/main/java/org/jabref/gui/externalfiles/AutoSetFileLinksUtil.java

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

---------

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

Author: koppor

jabgui/src/main/java/org/jabref/gui/externalfiles/AutoSetFileLinksUtil.java

@@ -90,6 +90,11 @@ public LinkFilesResult linkAssociatedFiles(List<BibEntry> entries, BiConsumer<Li
         return result;
     }
 
+    /// Scans for missing files which should be linked to the given entry.
+    ///
+    /// Related: {@link org.jabref.gui.externalfiles.UnlinkedFilesCrawler} for scanning files missing at all entries
+    ///
+    /// NOTE: This method does not check if the file is already linked to another entry.
     public List<LinkedFile> findAssociatedNotLinkedFiles(BibEntry entry) throws IOException {
         List<LinkedFile> linkedFiles = new ArrayList<>();
 

jabgui/src/main/java/org/jabref/gui/externalfiles/UnlinkedFilesCrawler.java

@@ -19,15 +19,16 @@
 import org.jabref.logic.externalfiles.DateRange;
 import org.jabref.logic.externalfiles.ExternalFileSorter;
 import org.jabref.logic.util.BackgroundTask;
-import org.jabref.model.database.BibDatabase;
 import org.jabref.model.database.BibDatabaseContext;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/**
- * Util class for searching files on the file system which are not linked to a provided {@link BibDatabase}.
- */
+/// Util class for searching files on the file system which are not linked to a provided {@link org.jabref.model.database.BibDatabase}.
+///
+/// The result is used to create *new* entries. The user has then to use the duplicate check to merge the entries.
+///
+/// Related: {@link org.jabref.gui.externalfiles.AutoSetFileLinksUtil#findAssociatedNotLinkedFiles}
 public class UnlinkedFilesCrawler extends BackgroundTask<FileNodeViewModel> {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(UnlinkedFilesCrawler.class);