Document that multiple @AfterTemplates are a thing.

PiperOrigin-RevId: 632480006
google · May 10, 2024 · 149d0c3 · 149d0c3
1 parent 1225389
commit 149d0c3
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/core/src/main/java/com/google/errorprone/refaster/annotation/AfterTemplate.java b/core/src/main/java/com/google/errorprone/refaster/annotation/AfterTemplate.java
@@ -25,6 +25,9 @@
  * Desired "after" version of a refactoring. Corresponds to a matching method annotated with {@link
  * BeforeTemplate}.
  *
+ * <p>Multiple {@code @AfterTemplate}s can be provided. This is useful in Tricorder findings, where
+ * multiple suggestions can be presented to the user.
+ *
  * @author lowasser@google.com (Louis Wasserman)
  */
 @Target(ElementType.METHOD)

diff --git a/core/src/main/java/com/google/errorprone/refaster/annotation/BeforeTemplate.java b/core/src/main/java/com/google/errorprone/refaster/annotation/BeforeTemplate.java
@@ -22,9 +22,11 @@
 import java.lang.annotation.Target;
 
 /**
- * Desired "before" version of a refactoring. Corresponds to a matching method annotated with {@link
+ * Desired "before" version of a refactoring. Corresponds to matching methods annotated with {@link
  * AfterTemplate}.
  *
+ * <p>Multiple {@code @BeforeTemplate}s can be provided to match multiple patterns.
+ *
  * @author lowasser@google.com (Louis Wasserman)
  */
 @Target(ElementType.METHOD)