[jboss-as7-dev] Add checkstyle's JavadocType to root pom?

David M. Lloyd david.lloyd at redhat.com
Fri Dec 9 14:28:49 EST 2011


On 12/09/2011 01:26 PM, Ondřej Žižka wrote:
> Hi,
>
>
> JavadocType checks whether each class/interface has javadoc.
>
> How about enforcing that?

I don't think its check is adequately configurable or robust.  In 
particular, I think it is OK to omit JavaDoc in the following cases:

* The class or member in question is non-public and not a serializable field
* The documentation may be inherited

I don't think the checkstyle check can be configured to handle this.

-- 
- DML


More information about the jboss-as7-dev mailing list