RFR of JDK-8176563: @since value errors in apis of java.base/java.logging module

Martin Buchholz martinrb at google.com
Tue Mar 14 16:06:39 UTC 2017


On Tue, Mar 14, 2017 at 12:46 AM, Hamlin Li <huaming.li at oracle.com> wrote:

>
> @since *since-text*
>
> Introduced in JDK 1.1
>
> Adds a *Since* heading with the specified since-text value to the
> generated documentation. The text has no special internal structure. This
> tag is valid in any documentation comment: overview, package, class,
> interface, constructor, method, or field. *This tag means that this
> change or feature has existed since the software release specified by the*
>  *since-text* *value*, for example: @since 1.5.
>
> For Java platform source code, the @since tag indicates the version of
> the Java platform API specification, which is not necessarily when the
> source code was added to the reference implementation. Multiple @since tags
> are allowed and are treated like multiple @author tags. You could use
> multiple tags when the program element is used by more than one API.
>
Instead of focusing on the *red text*, I read


"""For Java platform source code, the @since tag indicates the version of
the Java platform API specification"""


as being all about API, not implementation.  There is no @modifiedIn or
@optimizedIn tag


More information about the core-libs-dev mailing list