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

[Jonathan Gibbons]

On 02/07/2020 05:20 AM, Pavel Rappo wrote:
> 1. The change removes full stops from some places (e.g. @param and @return) and
> adds them to others

Thanks for pointing this out; I agree with the general guideline that 
@param and @return should generally use phrases and not end with a period.
>
> 2. "taglet-writer" hyphenated spelling is used inconsistently across
> getTagletOutput methods in Taglet.java

Fixed to be taglet-writer.

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

Oops. Fixed.

>
> 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.
Since you mention it, I fixed it, to be consistent with Start:384 :-)

>
> 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/
>>