RFR: JDK-8316972: Add javadoc support for restricted methods

[Maurizio Cimadamore]

On Fri, 13 Oct 2023 16:21:48 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

> Please review a change to add support for restricted methods to JavaDoc. The bulk of this patch was contributed by @mcimadamore. It adds a warning note to the summary and details of restricted methods and a superscript to links to restricted methods, similar to what we already do with elements belonging to preview APIs. I added a summary page to list all restricted methods as well as a test.
> 
> To see the wording of this feature in context, the relevant parts of generated documentation can be reviewed here:
> 
> - [Method summary](https://cr.openjdk.org/~hannesw/8316972/api.00/java.base/java/lang/foreign/AddressLayout.html#method-summary)
> - [Method details](https://cr.openjdk.org/~hannesw/8316972/api.00/java.base/java/lang/foreign/AddressLayout.html#withTargetLayout(java.lang.foreign.MemoryLayout))
> - [Restricted Methods list](https://cr.openjdk.org/~hannesw/8316972/api.00/restricted-list.html)
> - [Restricted Methods help section](https://cr.openjdk.org/~hannesw/8316972/api.00/help-doc.html#restricted)
> 
> Since the messages for deprecated, preview, and restricted elements all use the same CSS in our default stylesheet, I decided to combine them into a single CSS rule. It is still possible to define distinct styles for these features in user-provided stylesheets.

Question: we have this section on restricted method in the java/lang/foreign javadoc:
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/foreign/package-summary.html#restricted

Should the text that javadoc generate for restricted method point here? Or should we move this text onto a separate HTML page, and link to that instead? I note that for preview feature we do not link to anywhere else, so maybe what is done in this PR is sufficient.

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

PR Comment: https://git.openjdk.org/jdk/pull/16188#issuecomment-1764484359