Revised javadocs

[Lance Andersen - Oracle]

Updated version is at http://cr.openjdk.java.net/~lancea/8005080/specdiffs.02/
On Jan 3, 2013, at 2:39 PM, Mark Rotteveel wrote:

> On 3-1-2013 19:43, Lance Andersen - Oracle wrote:
>> I pushed a revised version of the javadocs to http://cr.openjdk.java.net/~lancea/8005080/specdiffs.01.
> 
> Good to see that JDBCType.valueOf(int) got included, thanks! The javadoc[1] is refering to Types.java instead of simply Types (or java.sql.Types), which is probably why the "See Also:" isn't hyperlinked.
> 
> PreparedStatement.setObject(int, Object, int) [2] and CallableStatement.setObject(int, Object, int) [3] "This method is similar setObject([..]) parameter, except [..]" => ".. is similar _to_ ..". The addition of "parameter" after the link to setObject seems out of place.
> 
> The CallableStatement version of the javadoc links to PreparedStatement.setObject(int parameterIndex, Object x, int targetSqlType, int scaleOrLength), while CallableStatement has its own Javadoc for that method.
This was actually correct as this method is inherited from PreparedStatement.

However, I changed it parameterIndex->parameterName so it pulls the CallableStatement method to be clearer
> 
> For PreparedStatement the text "; if a database access error occurs or this method is called on a closed PreparedStatement" has been removed from the throws SQLException documentation while it remains in place in all other similar methods. I think these are still the valid conditions for throwing SQLException here and should remain documented as such (as it remains on the CallableStatement version).

> 
> Similar comments apply to the equivalent javadocs for the methods accepting java.sql.SQLType instead of the int parameter [4],[5]
> 
> Mark
> 
> [1] : http://cr.openjdk.java.net/~lancea/8005080/specdiffs.01/java/sql/JDBCType-report.html#method:valueOf(int)
> [2] : http://cr.openjdk.java.net/~lancea/8005080/specdiffs.01/java/sql/PreparedStatement-report.html#method:setObject(int,%20java.lang.Object,%20int)
> [3] : http://cr.openjdk.java.net/~lancea/8005080/specdiffs.01/java/sql/CallableStatement-report.html#method:setObject(java.lang.String,%20java.lang.Object,%20int)
> [4] : http://cr.openjdk.java.net/~lancea/8005080/specdiffs.01/java/sql/CallableStatement-report.html#method:setObject(java.lang.String,%20java.lang.Object,%20java.sql.SQLType)
> [5] : http://cr.openjdk.java.net/~lancea/8005080/specdiffs.01/java/sql/PreparedStatement-report.html#method:setObject(int,%20java.lang.Object,%20java.sql.SQLType)
> 
> -- 
> Mark Rotteveel

-------------- next part --------------

Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037
Oracle Java Engineering 
1 Network Drive 
Burlington, MA 01803
Lance.Andersen at oracle.com