RFR : 8008632 : Additional JavaDoc tags @apiNote, @implSpec and @implNote for JDK API Docs
mike.duigou at oracle.com
Fri Apr 19 15:18:50 UTC 2013
On Apr 19 2013, at 08:15 , Alan Bateman wrote:
> On 19/04/2013 16:13, Mike Duigou wrote:
>> Not as currently used, no. The @implSpec is being used to describe required behaviour of the implementation, usually defaults. ie. Conforming defaults implementations must throw ISE (or UOE, etc.).
> Sorry, I meant @implNote where it may not always be desirable to have that show up in the generated javadoc.
Unsure. I haven't looked at how the @implNote tag has been used. According to the definition it certainly could be. Both the @apiNote and @implNote are non-normative and could technically be removed from the spec.
I have a task today of generate samples with the @implSpec and @implNote tags moved to the end of the docs rather than before @param. That thread would be a good place to have the discussion about inclusion (along with placement).
More information about the core-libs-dev