On Fri, 13 Oct 2023 17:27:01 GMT, Maurizio Cimadamore <mcimadam...@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.
>
> Thanks @hns - it looks really polished. I like the new restricted method 
> section. (I will not approve, since I've authored some of the code).

Thanks for providing the major part of it, @mcimadamore. I didn't have to 
change anything on it. I originally used `/author` to add you as co-author, but 
found it replaces instead of adding, so I used `/contributor` instead. Hope 
that's ok :)

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

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

Reply via email to