RFR: 8256917: Use combo @returns tag in java.compiler javadoc

Joe Darcy darcy at openjdk.java.net
Wed Dec 9 02:27:34 UTC 2020


On Wed, 9 Dec 2020 02:11:45 GMT, Iris Clark <iris at openjdk.org> wrote:

>> Take advantage of upgraded dual-use @return tag.
>
> Straightforward.  I see a few minor differences (e.g. "otherwise returns X" -> "otherwise X"), but nothing significant.  
> 
> Fantastic use of the new @returns tag.  I look forward to seeing it used across the JDK.

> 
> 
> Pleasantly boring. Nice to see the duplication going away.
> 
> In places, I would have tweaked the phrasing or the layout, but I accept that would be out of scope for the intent of this otherwise simple change.



> 
> 
> Pleasantly boring. Nice to see the duplication going away.

The feature is working as intended :-)
 
> In places, I would have tweaked the phrasing or the layout, but I accept that would be out of scope for the intent of this otherwise simple change.

Right; this was a first pass over the JSR 269 API to apply new upgraded @return tag. Fuller use could be made to DRY-out the API on subsequent passes. If I was writing the spec for this API from scratch, I'd incorporate the new facility to being with.

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

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


More information about the compiler-dev mailing list