accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Christopher Tubbs (JIRA)" <j...@apache.org>
Subject [jira] [Created] (ACCUMULO-2089) Remove Javadoc references to package-private classes
Date Tue, 24 Dec 2013 04:40:50 GMT
Christopher Tubbs created ACCUMULO-2089:
-------------------------------------------

             Summary: Remove Javadoc references to package-private classes
                 Key: ACCUMULO-2089
                 URL: https://issues.apache.org/jira/browse/ACCUMULO-2089
             Project: Accumulo
          Issue Type: Sub-task
            Reporter: Christopher Tubbs
             Fix For: 1.6.0


I see that the some of the Javadocs in the o.a.a.core.conf.Property class have references
to default (package-private) scoped annotations (added as part of ACCUMULO-1313).

I'm not sure it makes sense to refer to classes for internal implementation in Javadocs on
public methods.

Since the annotations are for internal use, and not public use, the javadocs that refer to
them should be changed so they describe the API behavior independently of the implementation.



--
This message was sent by Atlassian JIRA
(v6.1.5#6160)

Mime
View raw message