[
https://issues.apache.org/jira/browse/ZOOKEEPER-2829?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16100797#comment-16100797
]
ASF GitHub Bot commented on ZOOKEEPER-2829:
-------------------------------------------
Github user afine commented on the issue:
https://github.com/apache/zookeeper/pull/316
@hanm I am happy to split it up if you insist. My concern is that just
adding the annotations to our "normal" java classes does not actually do much
since it is technically incomplete.
I thought it would be a good idea to do the javadoc generation change here
because it provides us a reasonably full proof way of verifying that every
class that should be labeled public has been labeled public. Otherwise it would
be rather tedious to make sure that we have labeled all of our classes
appropriately.
> Interface usability / compatibility improvements through Java annotation.
> -------------------------------------------------------------------------
>
> Key: ZOOKEEPER-2829
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-2829
> Project: ZooKeeper
> Issue Type: Improvement
> Components: java client, server
> Affects Versions: 3.4.10, 3.5.3
> Reporter: Michael Han
> Assignee: Abraham Fine
> Labels: annotation
>
> Hadoop has interface classification regarding the interfaces' scope and
> stability. ZK should do something similar, which not only provides additional
> benefits of making API compatibility easier between releases (or even
> commits, by automating the checks via some tooling), but also consistent with
> rest of Hadoop ecosystem.
> See HADOOP-5073 for more context.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
