RFR: 8345836: stable annotation documentation is incomplete

[Jorn Vernee]

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 78:

> 76:  * declared as an array potentially defines a tree (of fixed depth
> 77:  * <em>D</em>) containing many stable variables, with each such stable
> 78:  * variable is independently considered for optimization.  In this

Suggestion:

 * variable independently considered for optimization.  In this

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

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