Add comments

JabRef · Oct 6, 2024 · 76c7b8a · 76c7b8a
1 parent e55f8d4
commit 76c7b8a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/src/main/java/org/jabref/logic/importer/fileformat/BibliographyFromPdfImporter.java b/src/main/java/org/jabref/logic/importer/fileformat/BibliographyFromPdfImporter.java
@@ -39,11 +39,13 @@
 import org.slf4j.LoggerFactory;
 
 /**
- * Parses the references from the "References" section from a PDF
+ * Parses the references from the "References" section from a PDF.
  * <p>
  * Currently, IEEE two column format is supported.
  * <p>
  * To extract a {@link BibEntry} matching the PDF, see {@link PdfContentImporter}.
+ * <p>
+ * TODO: This class is similar to {@link org.jabref.logic.importer.plaincitation.RuleBasedPlainCitationParser}, we need to unify them.
  */
 @AllowedToUseApacheCommonsLang3("Fastest method to count spaces in a string")
 public class BibliographyFromPdfImporter extends Importer {

diff --git a/src/main/java/org/jabref/logic/importer/plaincitation/RuleBasedPlainCitationParser.java b/src/main/java/org/jabref/logic/importer/plaincitation/RuleBasedPlainCitationParser.java
@@ -14,6 +14,11 @@
 import org.jabref.model.entry.types.EntryType;
 import org.jabref.model.entry.types.StandardEntryType;
 
+/**
+ * Parse a plain citation using regex rules.
+ * <p>
+ * TODO: This class is similar to {@link org.jabref.logic.importer.fileformat.BibliographyFromPdfImporter}, we need to unify them.
+ */
 public class RuleBasedPlainCitationParser implements PlainCitationParser {
     private static final String AUTHOR_TAG = "[author_tag]";
     private static final String URL_TAG = "[url_tag]";