RFR: 8345836: stable annotation documentation is incomplete

[Dan Heidinga]

On Mon, 9 Dec 2024 23:53:31 GMT, John R Rose <jrose at openjdk.org> wrote:

> The javadoc for jdk.internal.vm.annotation.Stable is incomplete.
> 
> The existing documentation gives an over-simple user model,
> and does not explain how it is implemented.
> Proposed new documentation will detail how the annotation
> is implemented, and how it may be used correctly.
> 
> The improved documentation will makes it easier for JDK programmers
> to use the annotation more aggressively, and more confidently.
> 
> This is a first cut.  Please comment…

src/java.base/share/classes/jdk/internal/vm/annotation/Stable.java line 111:

> 109:  * treated in this way during AOT cache assembly, that fact must be
> 110:  * clearly stated as a warning on the field declaration.  If there is
> 111:  * no such warning, maintainers can ignore this edge case.

The warning on the field declaration is a comment?  As a follow on to this, should we define an additional annotation to carry that warning ie `@AssemblyTimeChangable`?  (better naming to be bike shed)

-------------

PR Review Comment: https://git.openjdk.org/leyden/pull/26#discussion_r1878433056