ADBA javadoc issues

Lance Andersen lance.andersen at oracle.com
Mon May 7 16:08:39 UTC 2018


Yes, the javadocs are a work in progress and will continue to get cleaned  up and updated…  This is a early draft 


> On May 7, 2018, at 12:04 PM, Mark Rotteveel <mark at lawinegevaar.nl> wrote:
> 
> I notice that in the ADBA javadoc, a lot of @link and @see links are syntactically invalid.
> 
> For example in DataSource, the {@link getConnection} should be {@link #getConnection()}, and there are a lot of example.
> 
> I notice these problems in:
> 
> - AdbaConnectionProperty
> - AdbaType
> - Connection
> - ConnectionProperty
> - DataSource
> - Result
> - SqlBlob
> - SqlClob
> - Submission
> - Transaction
> 
> The following classes have sparse javadoc and may need more:
> 
> - Connection.LifeCycle (especially the boolean getters)
> - SqlException (especially the constructors)
> - SqlSkippedException
> 
> Need documentation
> 
> - DataSource.close()
> 
> I notice that occasionally covariant overrides get documented, and some times not, while the override is not really adding new information (eg DynamicMultiOperation.onError(Consumer<Throwable> handler) vs other overrides in the same class).
> 
> Mark
> -- 
> Mark Rotteveel

 <http://oracle.com/us/design/oracle-email-sig-198324.gif>
 <http://oracle.com/us/design/oracle-email-sig-198324.gif> <http://oracle.com/us/design/oracle-email-sig-198324.gif>
 <http://oracle.com/us/design/oracle-email-sig-198324.gif>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 <mailto:Lance.Andersen at oracle.com>





More information about the jdbc-spec-discuss mailing list