RFR: JDK-8238506 fix obsolete comments and inconsistent exceptions in BaseTaglet

Pavel Rappo pavel.rappo at oracle.com
Fri Feb 7 13:20:48 UTC 2020


1. The change removes full stops from some places (e.g. @param and @return) and
adds them to others

2. "taglet-writer" hyphenated spelling is used inconsistently across
getTagletOutput methods in Taglet.java

3. 2-parameter getTagletOutput method specifies
    @throws UnsupportedOperationException (not Unsupported*Taglet*OperationException)

4. Thanks for removing

    (element == null) ? null : element;

   It could only compete with

    if (v)
        return true;
    else
        return false;

5. Thanks for changing variables' names to less cryptic ones.
One of these days I will change the name of the variable in
jdk/javadoc/internal/tool/Start.java:402, I'm "stubbing on it" constantly.

Otherwise, looks good. No need to update the webrev.

-Pavel

> On 6 Feb 2020, at 22:56, Jonathan Gibbons <jonathan.gibbons at oracle.com> wrote:
> 
> Please review a small cleanup of internal doc comments, and nearby code, triggered by other recent review comments.
> 
> The focus of the change was the obsolete references  to '<code>Tag</code>' where 'Tag' was the JDK8 predecessor to using DocTree in javadoc.  The comments are updated. The other changes in these files were IDE cleanup suggestions.
> 
> -- Jon
> 
> JBS: https://bugs.openjdk.java.net/browse/JDK-8238506
> Webrev: http://cr.openjdk.java.net/~jjg/8238506/webrev/
> 



More information about the javadoc-dev mailing list