Skip to content

Commit f2d46b6

Browse files
docs: add docstring for AnnotationParser
1 parent f91123b commit f2d46b6

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

src/main/java/org/variantsync/diffdetective/feature/AnnotationParser.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
import org.prop4j.Node;
44
import org.variantsync.diffdetective.error.UnparseableFormulaException;
55

6+
/**
7+
* Interface for a parser that analyzes annotations in parsed text. The parser is responsible for determining the type
8+
* of the annotation (see {@link AnnotationType}), and parsing the annotation into a {@link Node}.
9+
* <p>
10+
* See {@link PreprocessorAnnotationParser} for an example of how an implementation of AnnotationParser could look like.
11+
* </p>
12+
*/
613
public interface AnnotationParser {
714
/**
815
* Determine the annotation type for the given piece of text (typically a line of source code).

0 commit comments

Comments
 (0)