RFR: JDK-8253733: Cleanup internal taglet API

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


On Wed, 30 Sep 2020 09:48:36 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 98:
> 
>> 96:
>> 97:     /**
>> 98:      * Returns the output for a {@code @deprecated ...} tag.
> 
> In this file "ellipsis" is used for inline tags.

OK.

> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletWriter.java line 107:
> 
>> 105:
>> 106:     /**
>> 107:      * Return the output for a {@code {@literal ...}} tag.
> 
> Add "s" to "Return" similarly to how you've done that for the rest of the methods.

Good catch

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

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


More information about the javadoc-dev mailing list