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] [Updated] (DERBY-6552) The public api includes methods inherited from superclasses which aren't in the public api and so have no javadoc comments
Date Tue, 17 Jun 2014 22:41:07 GMT

     [ https://issues.apache.org/jira/browse/DERBY-6552?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Dag H. Wanvik updated DERBY-6552:
---------------------------------

    Attachment: derby-6552-only-public-members.diff

Uploading a patch [^derby-6552-only-public-members.diff]. Details:

- Changes the way we generate public API Javadocs by restricting it to
public class members.

- Adds back Javadocs for private, class private and protected members
removed before.

- Added some missing Javadocs.

- Moved the top level class javadocs that were not visible (root
classes) down to the first level visible data sources, so we can get
the data source properties documented for embedded. Added details for
client.  Cf. BasicEmbeddedDataSource40 and BasicClientDataSource40
respectively.

- Added missing @serial tags


> 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-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