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] [Commented] (ACCUMULO-1917) ClientConfiguration needs javadocs
Date Fri, 31 Jan 2014 18:32:10 GMT

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

Christopher Tubbs commented on ACCUMULO-1917:
---------------------------------------------

Also, I would say that if a class "needs javadocs", then those javadocs should add value...
@param and @return and @throws statements that don't actually have a description are completely
worthless and serve no purpose but to add lines to the code, hurting readability. The javadoc
tool already knows that the method has those params, exceptions, and that it will return.

> ClientConfiguration needs javadocs
> ----------------------------------
>
>                 Key: ACCUMULO-1917
>                 URL: https://issues.apache.org/jira/browse/ACCUMULO-1917
>             Project: Accumulo
>          Issue Type: Bug
>            Reporter: Keith Turner
>            Assignee: John Vines
>              Labels: Documentation
>             Fix For: 1.6.0
>
>
> The new ClientConfiguration class needs javadocs.  Especially the methods related to
loading it from files like {{loadDefaults()}}.



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

Mime
View raw message