JDK-4172437 : Update the values of @since tags
  • Type: Bug
  • Component: other-libs
  • Sub-Component: other
  • Affected Version: 1.1.6,1.2.0
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • OS: solaris_2.5,windows_95
  • CPU: x86,sparc
  • Submitted: 1998-09-09
  • Updated: 2006-04-14
  • Resolved: 2006-04-14
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 6
6 b81Fixed
Related Reports
Duplicate :  
Relates :  
Relates :  
Description
Verify that the @since tags have the correct values in JDK 1.2.

Also consider changing "JDK" to "Java", such as from "JDK 1.1" to "Java 1.1".
(Check with Doug on this one)

Every 1.0 class should have an @since tag, since that
was easy to to (add the same tag to all classes).

I believe there were no api changes in JDK 1.0.1.

We added 1.0.2 tags to some api changes in JDK 1.0.2,
so that's probably correct, but should be verified.

We added no @since tags to packages in 1.0, since
package.html didn't exist at the time.

We should should add @since tags to all packages.

SIGNATURE FILES

Here are the signature files for determining the values of @since:

FOR JDK 1.0:
There is no signature file for 1.0 or 1.0.2, so use javadoc output instead.

FOR JDK 1.1:
/usr/local/java/jck1.1.6/JCK-116a/tests/api/jdk-1_1.sig
/usr/local/java/jck1.1.6/JCK-116a/tests/api/jdk1_11.sig
/usr/local/java/jck1.1.6/JCK-116a/tests/api/jdk1_16.sig

FOR JDK 1.2:
/usr/local/java/jck1.2/JCK-12beta4/tests/api/SignatureTest/jdk1_2.sig

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

The @since doclet:

% /usr/local/java/jdk1.2/solaris/bin/javadoc -sourcepath /home/atuld/JDK/1.2/src/share/classes/ -doclet Since -docletpath /home/dkramer/javadoc/since/matthew-doar java.applet

This creates a file since.txt in the current directory
which lists the contents of each @since argument:

java.applet:

java.applet.AudioClip: JDK1.0
java.applet.AudioClip.play(): JDK1.0
java.applet.AudioClip.loop(): JDK1.0
java.applet.AudioClip.stop(): JDK1.0

java.applet.AppletStub: JDK1.0
java.applet.AppletStub.isActive(): JDK1.0
java.applet.AppletStub.getDocumentBase(): JDK1.0
java.applet.AppletStub.getCodeBase(): JDK1.0
java.applet.AppletStub.getParameter(String): JDK1.0
java.applet.AppletStub.getAppletContext(): JDK1.0
java.applet.AppletStub.appletResize(int, int): JDK1.0

java.applet.Applet: JDK1.0
java.applet.Applet.accessibleContext: JDK1.0
java.applet.Applet.Applet(): JDK1.0
java.applet.Applet.setStub(AppletStub): JDK1.0

Comments
EVALUATION We're not going to be fixing every single last missing @since in the JDK, but at least we can catch almost all of them for recent releases.
27-03-2006

SUGGESTED FIX I wrote a perl script to help with my own project, that should be able to fill the need of identifying missing @since tags. /home/mb29450/bin/sun/sinceCheck (attached) ###@###.### 2005-06-25 02:53:33 GMT
25-06-2005

EVALUATION Related bugs: 4161260, 4157408 (closed as dupe) doug.kramer@Eng 1998-09-09 Related bug asking for @since 1.4 tags to be updated: 4466493 which is more pressing for authors who need to know the diffs. ###@###.### 2002-03-14
09-09-1998