Skip to content

Commit 4a892aa

Browse files
kopporsubhramit
andauthored
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 <subhramit.bb@live.in> --------- Co-authored-by: Subhramit Basu <subhramit.bb@live.in>
1 parent b20e9fe commit 4a892aa

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,11 @@ public LinkFilesResult linkAssociatedFiles(List<BibEntry> entries, BiConsumer<Li
9090
return result;
9191
}
9292

93+
/// Scans for missing files which should be linked to the given entry.
94+
///
95+
/// Related: {@link org.jabref.gui.externalfiles.UnlinkedFilesCrawler} for scanning files missing at all entries
96+
///
97+
/// NOTE: This method does not check if the file is already linked to another entry.
9398
public List<LinkedFile> findAssociatedNotLinkedFiles(BibEntry entry) throws IOException {
9499
List<LinkedFile> linkedFiles = new ArrayList<>();
95100

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,16 @@
1919
import org.jabref.logic.externalfiles.DateRange;
2020
import org.jabref.logic.externalfiles.ExternalFileSorter;
2121
import org.jabref.logic.util.BackgroundTask;
22-
import org.jabref.model.database.BibDatabase;
2322
import org.jabref.model.database.BibDatabaseContext;
2423

2524
import org.slf4j.Logger;
2625
import org.slf4j.LoggerFactory;
2726

28-
/**
29-
* Util class for searching files on the file system which are not linked to a provided {@link BibDatabase}.
30-
*/
27+
/// Util class for searching files on the file system which are not linked to a provided {@link org.jabref.model.database.BibDatabase}.
28+
///
29+
/// The result is used to create *new* entries. The user has then to use the duplicate check to merge the entries.
30+
///
31+
/// Related: {@link org.jabref.gui.externalfiles.AutoSetFileLinksUtil#findAssociatedNotLinkedFiles}
3132
public class UnlinkedFilesCrawler extends BackgroundTask<FileNodeViewModel> {
3233

3334
private static final Logger LOGGER = LoggerFactory.getLogger(UnlinkedFilesCrawler.class);

0 commit comments

Comments
 (0)