RFR : 8008632 : Additional JavaDoc tags @apiNote, @implSpec and @implNote for JDK API Docs
Alan.Bateman at oracle.com
Fri Apr 19 10:40:17 UTC 2013
On 18/04/2013 16:12, Mike Duigou wrote:
>> @implSpec is very welcome, more reasons now with the addition of default methods.
>> Clearly distinguishing normative from non-normative text is also been a long standing problem so having a tag to identify the non-normative text is very useful. I had to look at a few examples in the lambda/jdk repo to convince myself that both @apiNote and @implNote are needed. One thing that isn't clear to me is whether the "official" Java SE documentation should include the text tagged @implNote or not.
> Once we got going we decided to fill out the matrix. There's no obligation to use all of the tags.
Where @implSpec is used, then do you have a view on whether this should
be filtered out of the Java SE specs?
More information about the core-libs-dev