Document that "internalCompilerData" field is not meant for public co…

…nsumption
oshai · Oct 31, 2024 · c0735bb · c0735bb
1 parent c7047dc
commit c0735bb
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/commonMain/kotlin/io/github/oshai/kotlinlogging/KLoggingEventBuilder.kt b/src/commonMain/kotlin/io/github/oshai/kotlinlogging/KLoggingEventBuilder.kt
@@ -4,6 +4,11 @@ public class KLoggingEventBuilder {
   public var message: String? = null
   public var cause: Throwable? = null
   public var payload: Map<String, Any?>? = null
+
+  /**
+   * Internal data that is used by compiler plugin to provide additional information about the log site.
+   * Not intended for use by user code, API stability is not guaranteed.
+   */
   public var internalCompilerData: InternalCompilerData? = null
 
   public class InternalCompilerData(