Add comments for tests helpers (JabRef#11189)

alexandre-cremieux · Feb 7, 2025 · 14ab672 · 14ab672
1 parent eb3dfd8
commit 14ab672
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/.../java/org/jabref/logic/citation/repository/BibEntryRelationsRepositoryHelpersForTest.java b/.../java/org/jabref/logic/citation/repository/BibEntryRelationsRepositoryHelpersForTest.java
@@ -7,7 +7,17 @@
 
 import org.jabref.model.entry.BibEntry;
 
+/**
+ * Provide helpers methods and classes for tests to manage {@link BibEntryRelationsRepository} mocks.
+ */
 public class BibEntryRelationsRepositoryHelpersForTest {
+
+    /**
+     * Provide mocks factories for {@link BibEntryRelationsRepository} mocks.
+     * <br>
+     * Those implementations should help to test the values passed to an injected repository instance
+     * when it is called from {@link org.jabref.logic.citation.SearchCitationsRelationsService}.
+     */
     public static class Mocks {
         public static BibEntryRelationsRepository from(
             Function<BibEntry, List<BibEntry>> retrieveCitations,