On Thu, 8 Jun 2023 09:55:27 GMT, Pavel Rappo <pra...@openjdk.org> wrote:

>> Please review this long-awaited change to documentation inheritance.
>> 
>> This change improves "methods comment algorithm" and introduces directed 
>> documentation inheritance. While "methods comment algorithm" -- automatic 
>> search for inheritable documentation -- has been improved, it still cannot 
>> read an author's mind so as to always find the documentation they intended. 
>> From now on, an author can state their intention, by providing an FQN of the 
>> superclass or superinterface from which to inherit documentation:
>> 
>> ​{@inheritDoc S}
>> 
>> Which is exactly what I did to counterbalance some of the JDK API 
>> Documentation changes caused by the change to "methods comment algorithm".
>
> Pavel Rappo has updated the pull request incrementally with one additional 
> commit since the last revision:
> 
>   feedback: remove unduly restrictive warning

src/java.base/share/classes/java/util/concurrent/LinkedBlockingDeque.java line 
635:

> 633:      * @return {@inheritDoc BlockingDeque}
> 634:      */
> 635:     public boolean offer(E e) {

Does this work for @param tags too? Just curious.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/14357#discussion_r1222860792

Reply via email to