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] [Commented] (DERBY-6552) The public api includes methods inherited from superclasses which aren't in the public api and so have no javadoc comments
Date Fri, 13 Jun 2014 20:57:02 GMT

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

Dag H. Wanvik commented on DERBY-6552:
--------------------------------------

Thanks, Knut! It sounds like a further good simplification. I was slightly wary of changing
the hierarchy more t this point, but here is a patch that does it anyway [^derby-6552-restructure-more.diff].

Summary:

- adds wrappers so that the exposed classes have the expected methods
  and constants.

- changes the doc build for publishedapi so that we have a
  "sourcepath" for Javadoc which contains all the sources. This is
  necessary to make the wrappers inherit the (common for Basic* and
  regular data sources) javadoc from a class that is otherwise not in
  the API.

- added reference "link"s to official Java Javadocs for ease of
  reading (SE: 8, J2EE: 7)

- removed ClientBaseDataSourceRoot putting its contents into
  BasicClientDataSource40

- removed ClientBaseDataSource moving its contents into ClientDataSource

- added new serialized data source tests for 10.11


> 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
>    Affects Versions: 10.11.0.0
>            Reporter: Rick Hillegas
>            Assignee: Dag H. Wanvik
>         Attachments: derby-6552-exp.diff, derby-6552-exp.status, 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