maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Chris Hennick (JIRA)" <>
Subject [jira] [Commented] (MJAVADOC-496) javadoc:fix creates invalid @param tags for "this"
Date Sat, 09 Sep 2017 05:13:00 GMT


Chris Hennick commented on MJAVADOC-496:

It does indeed compile on Java 8; in fact, the Checker Framework relies on
it to know when an instance method (at least a non-final one) is safe to
call from the constructor. "this" isn't an actual parameter, just a place
to attach annotations.

> javadoc:fix creates invalid @param tags for "this"
> --------------------------------------------------
>                 Key: MJAVADOC-496
>                 URL:
>             Project: Maven Javadoc Plugin
>          Issue Type: Bug
>    Affects Versions: 2.9.1
>         Environment: Ubuntu 14.04.3 LTS
>            Reporter: Chris Hennick
> I'm using the Checker Framework on Java 8, so I sometimes need to write method declarations
in a form like
> {code:java}
>   protected void initTransientFields(
>       @UnknownInitialization AesCounterRandom this) {/*...*/}
> {code}
> When I run mvn javadoc:fix on a code base where I'm doing that, the javadocs of such
methods gain tags beginning with {code:java}@param this{code}, which raise an error when mvn
javadoc:javadoc tries to process them.

This message was sent by Atlassian JIRA

View raw message