Adding @since tags

Pavel Safrata pavel.safrata at oracle.com
Tue May 28 05:43:13 PDT 2013


Hello,
I'm almost ready with a tool that generates @since tags to JavaFX API. 
My question is what should I generate. Essentially, there are three 
releases with added API: 2.0, 2.2 and 8.0.

Question 1:
Should we generate @since for the initial stuff that appeared in 2.0?

Question 2:
There are classes and methods marked as "@since JavaFX 1.3" (comments 
survived porting to Java). Should I keep it? Or remove/replace by 2.0 
based on Q1? Note that I'm not able to compare Java 2.0 API to previous 
fx-script API so I cannot make sure everything that existed before 2.0 
is marked properly as 1.x.

Question 3:
What should be the format?

(a) - full FX version
2.0: @since JavaFX 2.0
2.2: @since JavaFX 2.2
8.0: @since JavaFX 8.0

(b) - major FX version
2.0: @since JavaFX 2
2.2: @since JavaFX 2
8.0: @since JavaFX 8

(c) - JDK version
2.0: @since 1.7
2.2: @since 1.7
8.0: @since 1.8

Or something else?

As we are going to fully integrate with JDK, I guess I'd go with 3c - 
JDK version numbers, marking 8.0 features as "@since 1.8" and everything 
else as "@since 1.7". But I'd be fine with any other option as well. 
Please let me know what do you think.

Thanks,
Pavel


More information about the openjfx-dev mailing list