From c9060fef45d353fba05c35178ba6e5e0aaf2fb50 Mon Sep 17 00:00:00 2001
From: Peter Palaga <ppalaga@redhat.com>
Date: Tue, 9 Jul 2024 16:08:24 +0200
Subject: [PATCH] Add class level JavaDoc to BytecodeTransformerBuildItem

---
 .../builditem/BytecodeTransformerBuildItem.java          | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/BytecodeTransformerBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/BytecodeTransformerBuildItem.java
index ec968f494b8b0..ea79ca227b8bf 100644
--- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/BytecodeTransformerBuildItem.java
+++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/BytecodeTransformerBuildItem.java
@@ -8,6 +8,15 @@
 
 import io.quarkus.builder.item.MultiBuildItem;
 
+/**
+ * Transform a class using ASM {@link ClassVisitor}. Note that the transformation is performed after assembling the
+ * index and thus the changes won't be visible to any processor steps relying on the index.
+ * <p>
+ * You may consider using {@code io.quarkus.arc.deployment.AnnotationsTransformerBuildItem} if your transformation
+ * should be visible for Arc. See also
+ * <a href="https://quarkus.io/version/main/guides/cdi-integration#annotations_transformer_build_item">I Need To
+ * Transform Annotation Metadata</a> section of Quarkus CDI integration guide.
+ */
 public final class BytecodeTransformerBuildItem extends MultiBuildItem {
 
     final String classToTransform;