RFR: 8285470: Improve handling of @inheritDoc [v3]

Jonathan Gibbons jjg at openjdk.java.net
Mon Apr 25 22:51:53 UTC 2022


On Fri, 22 Apr 2022 17:32:22 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

>> The only taglet that along with its own tag needs to know the immediately enclosing tag is `InheritDocTaglet`:
>> 
>>     @return {@inheritDoc}
>>     @throws NullPointerException {@inheritDoc}
>>     @param p {@inheritDoc}
>> 
>> However, the immediately enclosing tag is unconditionally passed to all taglets. If we stop passing it and make `InheritDocTaglet` compute it instead, the code becomes cleaner.
>> 
>> While reviewing, particularly note these benefits of the proposed change:
>> 
>>  * taglet-handling code knows less about `@inheritDoc`, and
>>  * `InheritDocTaglet` receives its own tag, not the tag that encloses it
>
> Pavel Rappo has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Update src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/InheritDocTaglet.java
>   
>   Co-authored-by: ExE Boss <3889017+ExE-Boss at users.noreply.github.com>

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java line 1428:

> 1426: 
> 1427:     /**
> 1428:      * Converts inline tags and text to Content, expanding the

either `content` or `{@code Content}`

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

PR: https://git.openjdk.java.net/jdk/pull/8361


More information about the javadoc-dev mailing list