RFR: JDK-8253733: Cleanup internal taglet API

Jonathan Gibbons jjg at openjdk.java.net
Wed Sep 30 16:48:11 UTC 2020


On Wed, 30 Sep 2020 10:02:11 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

>> This is a general cleanup of various classes related to the handling of tags and taglets in the standard doclet.
>> 
>> The initial motivation was to clean up static methods on `TagletWriter` that took a `TagletWriter` as a parameter.
>> These methods are converted into instance methods, and the call sites simplified as well.
>> Another area of cleanup is to make clear which methods are used for inline tags and which are used for block tags.
>> 
>> Some dead code is removed, and the doc comments are generally cleaned up as well.  More details are given in the JBS
>> issue.
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletWriter.java line 282:
> 
>> 280:             } catch (UnsupportedTagletOperationException e) {
>> 281:                 // malformed taglet:
>> 282:                 // claims to support block tags but does not provide the appropriate method.
> 
> This deserves a more detailed explanation: what does this claim look like? (It's not obvious from reading this excerpt.)

Fixed; for reference here, "claims to support" is a reference to `Taglet.isBlockTag` / `Taglet.isInlineTag`

> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletWriter.java line 372:
> 
>> 370:
>> 371:     /**
>> 372:      * Returns  an instance of the configuration used for this doclet.
> 
> Remove extra whitespace in "Returns  an".

��

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

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


More information about the javadoc-dev mailing list