db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Daniel John Debrunner (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-2092) Add JDBC classes into Javadoc for Derby's published api
Date Thu, 16 Nov 2006 20:48:37 GMT
    [ http://issues.apache.org/jira/browse/DERBY-2092?page=comments#action_12450520 ] 
            
Daniel John Debrunner commented on DERBY-2092:
----------------------------------------------

Options for a final solution for handling the JDBC files from Harmony files:

1) copy the Harmony files once into Derby's SVN
2) copy (svn co) the Harmony files on demand when running the published api target

Then options for modifying the comments for these files are:

A) Don't modify - run the risk that the defined J2SE behaviour doesn't match Derby.

B) Copy once and modify in Derby's SVN to make the methods match's Derby's implementation.

C) copy from harmony and dynamically annotate with Derby specific information. E.g the simple
case
     Derby does not support this method.
     No idea how easy this would be, could be easier to have a doclet do this instead of modifying
the source code.

> Add JDBC classes into Javadoc for Derby's published api
> -------------------------------------------------------
>
>                 Key: DERBY-2092
>                 URL: http://issues.apache.org/jira/browse/DERBY-2092
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Daniel John Debrunner
>            Priority: Minor
>
> The javadoc for java.sql and javax.sql for JDBC 3 can be added into derby's published
api javadoc fairly easily using the source files from Harmony.
> I created a  folder at the top level called: java/j2se
> I then fetched the JDBC classes from Harmony
> cd java/j2se
> svn co http://svn.apache.org/repos/asf/incubator/harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java
> svn co http://svn.apache.org/repos/asf/incubator/harmony/enhanced/classlib/trunk/modules/sql/src/main/java/javax
> I then added the list of java.sql and javax.sql files to the publishedapi_jdbc3.ant (excluding
RowSet files)
> and added in the published api target this element:
>       <fileset dir="${derby.j2se.src.dir}"
>                  includesfile="${javadoc.inclusions}"/>
> Example of the output at
> http://people.apache.org/~djd/derby/publishedapi/

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message