JDK-4466493 : All new methods should use the "@since 1.4" javadoc tag
  • Type: Bug
  • Component: other-libs
  • Sub-Component: other
  • Affected Version: 1.3.1,1.4.0,1.4.1,1.4.2,5.0
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • OS:
    generic,linux,windows_98,windows_2000,windows_xp generic,linux,windows_98,windows_2000,windows_xp
  • CPU: generic,x86
  • Submitted: 2001-06-05
  • 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 :  
Duplicate :  
Duplicate :  
Duplicate :  
Relates :  
Relates :  
Description
Name: bsC130419			Date: 06/05/2001


java version "1.4.0-beta"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.0-beta-b65)
Java HotSpot(TM) Client VM (build 1.4.0-beta-b65, mixed mode)

Some of the new methods in JDK1.4 are not marked as such using the "@since"
javadoc tag. For example, Runtime.availableProcessors() and Runtime.maxMemory().

There are so many changes in 1.4 that it is very difficult to track them all
down and we need the javadoc to help in this department. Please ensure that
everyone marks new methods as being new using @since. And while they are at it,
ensure that any methods whose contracts have changed significantly are also
clearly documented as such.

Thanks - the Java authors of the world will greatly appreciate this.
(Review ID: 125799) 
======================================================================

Name: rmT116609			Date: 11/02/2001


Current docs for JDK 1.4 beta3 is missing Since1.4 keyword in get/setSurrendersFocusOnKeystroke

http://java.sun.com/j2se/1.4/docs/api/javax/swing/JTable.html#setSurrendersFocusOnKeystroke(boolean)

http://java.sun.com/j2se/1.4/docs/api/javax/swing/JTable.html#getSurrendersFocusOnKeystroke()
(Review ID: 134904)
======================================================================

Name: rmT116609			Date: 11/17/2001



The new constants in java.awt.Color, like BLACK, RED, etc. are not marked as being new in the 1.4 JDK. Maybe this is true for fields/methods in
other classes as well throughout the JDK. This can become very anoying because it means that I either have to work with older documentation, if 
I want to be 1.2 conform or I have to run every little piece of my applications under 1.2 just to find out whether it is compatible.
(Review ID: 135859)
======================================================================

Name: rmT116609			Date: 01/04/2002



http://java.sun.com/j2se/1.4/docs/api/java/net/ServerSocket.html#ServerSocket()

The no parameter constructor for java.net.ServerSocket is
new "Since: JDK1.4".

Bug: Please say so via javadoc @since.




(Review ID: 137854)
======================================================================

Name: rmT116609			Date: 02/21/2002


DESCRIPTION OF THE PROBLEM :

http://java.sun.com/j2se/1.4/docs/api/java/net/URLEncoder.html#encode(java.lang.String, java.lang.String)

The documentation for java.net.URLEncoder.encode(String s, String enc) lacks the "@since 1.4.0" keyword.  This is a new method and the previous method
java.net.URLEncoder.encode(String s) was deprecated, causing
deprecation errors on code that compiled fine in 1.3.1.

For developers to find out what the impact of changing to the new method would be, they need to know the version in which the new function was added.
(Review ID: 143169)
======================================================================

Name: rmT116609			Date: 03/10/2002


URLEncoder/Decoder since jdk 1.4 is  missing

Documentation of URLEncoder.encode(String, String) and URLDecoder.decode(String, String)should contain a @since tag;
(Review ID: 143972)
======================================================================

Name: rmT116609			Date: 03/21/2002


 DESCRIPTION OF THE PROBLEM :
Since section is missing from the online documentation for the java.net.URISyntaxException class

The page in question is:

http://java.sun.com/j2se/1.4/docs/api/java/net/URISyntaxException.html

EXPECTED VERSUS ACTUAL BEHAVIOR :

Expected:

   Since:
      1.4

Actual:

There is no 'Since' section included in the documentation. It is probabily just an ommision.  But it is an inconsistency and it is useful information.

(Review ID: 144445)
======================================================================

Name: rmT116609			Date: 05/23/2002



http://java.sun.com/j2se/1.4/docs/api/javax/swing/JOptionPane.html#showInputDialog(java.awt.Component, java.lang.Object, java.lang.Object)

Expected : since 1.4


(Review ID: 144705)
======================================================================

Name: rmT116609			Date: 06/23/2002


 DESCRIPTION OF THE PROBLEM :
Apparently the VolatileImage has been introduced in the 1.4 version of J2SE.

STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
1. Open VolatileImage api documentation:
jdk/docs/api/java/awt/image/VolatileImage.html

/*
http://java.sun.com/j2se/1.4/docs/api/java/awt/image/VolatileImage.html
http://java.sun.com/j2se/1.4.1/docs/api/java/awt/image/VolatileImage.html

*/


2. Notice that there's no information as to when the class VolatileImage was first introduced.

EXPECTED VERSUS ACTUAL BEHAVIOR :
An information about the version of J2SE where VolatileImage was introduced should be present in the form of a @since tag in the java doc comments in the source code.

(Review ID: 158306)
======================================================================

Comments
EVALUATION Will be fixed as part of work on 6367207. Therefore, I am taking ownership of this bug.
27-03-2006

WORK AROUND Name: bsC130419 Date: 06/05/2001 n/a ======================================================================
11-08-2004

EVALUATION Correction to my earlier evaluation. Reflection would only give us information about the Sun implementation. We would actually need to look at TCK signature files to obtain this kind of information. It should be possible for us to address this issue with a program that reflects on 2 different SDK versions, and builds a list of all new methods that are missing @since tags. With this list in hand, our documentation team could make sure that all new methods have the @since tags. scott.hommel@eng 2001-07-30 This bug stresses that 1.4 is more important to mark than previous versions. Am leaving this open as a near-duplicate of 4172437: update values of @since tags ###@###.### 2002-03-14 ###@###.### 2005-05-10 22:41:18 GMT
14-03-2002