Add internal package verbiage to ExceptionEventData interface

open-telemetry · Feb 28, 2022 · a1d2057 · a1d2057
1 parent 69c570d
commit a1d2057
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/data/EventData.java b/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/data/EventData.java
@@ -9,7 +9,7 @@
 import io.opentelemetry.sdk.trace.SpanLimits;
 import javax.annotation.concurrent.Immutable;
 
-/** Data representation of a event. */
+/** Data representation of an event. */
 @Immutable
 public interface EventData {
 

diff --git a/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/internal/data/ExceptionEventData.java b/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/internal/data/ExceptionEventData.java
@@ -8,6 +8,12 @@
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.sdk.trace.data.EventData;
 
+/**
+ * Data representation of an event for a recorded exception.
+ *
+ * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
+ * at any time.
+ */
 public interface ExceptionEventData extends EventData {
 
   /**