db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dag H. Wanvik (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (DERBY-6552) The public api includes methods inherited from superclasses which aren't in the public api and so have no javadoc comments
Date Thu, 19 Jun 2014 16:52:24 GMT

    [ https://issues.apache.org/jira/browse/DERBY-6552?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14037503#comment-14037503
] 

Dag H. Wanvik edited comment on DERBY-6552 at 6/19/14 4:51 PM:
---------------------------------------------------------------

Uploading patch [^derby-6552-firewall-balm.diff]:

- Use an explicit <get> task to download the required package lists for
  the external Java SE and J2EE Javadocs we want to link to from
  our published API docs.
- Remove the explicit boot classpath set to 16 level lest we get errors generating the docs
for classes which require a higher level. The new  method needs to see all source file to
be able to resolve links and inherit javadocs.

The first time the publishedapi target is built, the package lists will be downloaded and
cached in local directories. Added svn ignore setting for those. On subsequent builds, the
cached values will be used.

If behind a firewall the first time one builds, one needs to let ant know how to bypass the
firewall, e.g. this way in bash:

> export ANT_OPTS="-Dhttp.proxyHost=proxyserver -Dhttp.proxyPort=80"




was (Author: dagw):
Uploading patch [^derby-6552-firewall-balm.diff]:

- Use an explicit <get> task to download the required package lists for
  the external Java SE and J2EE Javadocs we want to link to from
  our published API docs.
- Remove the explicit boot classpath set to 16 level lest we get errors generating the docs
for classes which require a higher level. The new  method needs to see all source file to
be able to resolve links and inherit javadocs.

The first time the publishedapi target is built, the package lists will be downloaded and
cached in local directories. Added svn ignore setting for those. On subsequent builds, the
cached values will be used.

If behind a firewall the first time one build, one needs to let ant know how to bypass the
firewall, e.g. this way in bash:

> export ANT_OPTS="-Dhttp.proxyHost=proxyserver -Dhttp.proxyPort=80"



> The public api includes methods inherited from superclasses which aren't in the public
api and so have no javadoc comments
> --------------------------------------------------------------------------------------------------------------------------
>
>                 Key: DERBY-6552
>                 URL: https://issues.apache.org/jira/browse/DERBY-6552
>             Project: Derby
>          Issue Type: Bug
>          Components: Javadoc, JDBC
>    Affects Versions: 10.11.0.0
>            Reporter: Rick Hillegas
>            Assignee: Dag H. Wanvik
>         Attachments: derby-6552-exp.diff, derby-6552-exp.status, derby-6552-firewall-balm.diff,
derby-6552-link-fixes.diff, derby-6552-only-public-members.diff, derby-6552-restructure-even-more.diff,
derby-6552-restructure-more.diff
>
>
> We simplified and cleaned up the public api in 10.11. Now, however, we've lost the javadoc
for methods which customers may need to use. For instance, ClientDataSource contains a method
called setSsl() which is inherited from ClientBaseDataSourceRoot. But since ClientBaseDataSourceRoot
doesn't appear in the public api, there's no method header comment to consult.



--
This message was sent by Atlassian JIRA
(v6.2#6252)

Mime
View raw message