[
https://issues.apache.org/jira/browse/ACCUMULO-1031?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13571577#comment-13571577
]
Christopher Tubbs commented on ACCUMULO-1031:
---------------------------------------------
If it helps, the Eclipse settings I use for checking Javadoc formatting are:
{code:java}
Java -> Compiler -> Javadoc
Process Javadoc comments = (checked)
Malformed Javadoc comments = "Warning"
Only consider members as visible as = "Protected"
Validate tag arguments = (checked)
Report nonvisible references = (checked)
Report deprecated references = (checked)
Missing tag descriptions = "Validate all standard tags" (sometimes I just
use "Validate @return tags")
Missing Javadoc tags = "Ignore"
Missing Javadoc comments = "Ignore"
{code}
> Modify Code template to not automatically insert javadocs
> ---------------------------------------------------------
>
> Key: ACCUMULO-1031
> URL: https://issues.apache.org/jira/browse/ACCUMULO-1031
> Project: Accumulo
> Issue Type: Task
> Reporter: Christopher Tubbs
> Assignee: Christopher Tubbs
> Fix For: 1.5.0
>
>
> There are too many javadocs that either provide no value, or are malformed.
> Javadocs should be a conscious thing, where we take care to document what is
> important. Ideally, we could take this care every time we create a method,
> and again every time we update it. However, the reality is, these tend to get
> generated and ignored.
> See conversation on the [dev mailing
> list|http://mail-archives.apache.org/mod_mbox/accumulo-dev/201301.mbox/%3CCAL5zq9YAOdSXABok0RH5Q5h%2BwgJ%3Dp9t2-7Oct%2BDJoSeCXsRFBA%40mail.gmail.com%3E].
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
