add a note about exception handling (#5870)

apollographql · Apr 30, 2024 · 4e70750 · 4e70750
1 parent c63ee72
commit 4e70750
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/...pollo-compiler/src/main/kotlin/com/apollographql/apollo3/compiler/ApolloCompilerPlugin.kt b/...pollo-compiler/src/main/kotlin/com/apollographql/apollo3/compiler/ApolloCompilerPlugin.kt
@@ -19,8 +19,11 @@ import com.apollographql.apollo3.compiler.operationoutput.OperationId
 typealias Plugin = ApolloCompilerPlugin
 
 /**
- * Entry point for customizing the behaviour of the Apollo Compiler besides the
- * already existing options
+ * [ApolloCompilerPlugin] allows to customize the behaviour of the Apollo Compiler.
+ *
+ * [ApolloCompilerPlugin] is run in an isolated classloader. You may throw from [ApolloCompilerPlugin] methods to fail the build
+ * but custom exception classes are not accessible from the calling environment like Gradle for an example.
+ * Prefer throwing regular Java exception classes.
  */
 interface ApolloCompilerPlugin {
   /**