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-1031) Modify Code template to not automatically insert javadocs
Date Mon, 04 Feb 2013 01:27:11 GMT

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

Christopher Tubbs commented on ACCUMULO-1031:
---------------------------------------------

I looked for an option on maven-javadoc-plugin, or in the javadoc tool's arguments to fail
if it discovers a malformed javadoc tag, but I couldn't find one. Eclipse is pretty good about
having a lot of options for this, though... many of them are disabled by default, but I turn
some of them on in my workspace. I'd rather do it in the build, though.
                
> 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

Mime
View raw message