accumulo-notifications mailing list archives

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


Christopher Tubbs commented on ACCUMULO-2089:

After a few seconds thinking about this... I'm thinking that the isInterpolated, etc. methods
shouldn't even be public... and they are missing \@since tags. Although, perhaps those are
separate issues.

> Remove Javadoc references to package-private classes
> ----------------------------------------------------
>                 Key: ACCUMULO-2089
>                 URL:
>             Project: Accumulo
>          Issue Type: Sub-task
>          Components: docs
>            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

View raw message