chore: Correct Javadoc for @Pact annotation #1739

pact-foundation · Dec 18, 2023 · fe8e0cc · fe8e0cc
1 parent 2a641c4
commit fe8e0cc
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/core/model/src/main/kotlin/au/com/dius/pact/core/model/annotations/Pact.kt b/core/model/src/main/kotlin/au/com/dius/pact/core/model/annotations/Pact.kt
@@ -2,10 +2,17 @@ package au.com.dius.pact.core.model.annotations
 
 /**
  * describes the interactions between a provider and a consumer used in JUnit tests.
- * The annotated method has to be of following signature:
+ * The annotated method has to be one of following signatures:
  *
+ * For legacy DSL classes and request/response interactions:
  * public RequestResponsePact providerDef1(PactDslWithProvider builder) {...}
  *
+ * For message interactions:
+ * public MessagePact providerDef1(MessagePactBuilder builder)
+ *
+ * For V4 DSL classes and any interaction type:
+ * public V4Pact providerDef1(PactBuilder builder) {...}
+ *
  * @author pmucha
  */
 @Retention(AnnotationRetention.RUNTIME)