improved javadoc

asotona · Dec 9, 2024 · 6fdc3c4 · 6fdc3c4
1 parent 7c48105
commit 6fdc3c4
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/java.base/share/classes/java/lang/classfile/CompoundElement.java b/src/java.base/share/classes/java/lang/classfile/CompoundElement.java
@@ -95,7 +95,9 @@ public void accept(E e) {
     }
 
     /**
-     * {@return a debug printout of the compound element}
+     * {@return a text representation of the compound element and its contents for debugging purposes}
+     *
+     * The format, structure and exact content are not specified and may change at any time in the future.
      */
     default String toDebugString() {
         StringBuilder text = new StringBuilder();