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

[Ondřej Žižka]

Non-public:

        <module name="JavadocType">
                      <property name="scope" value="public"/>
        </module>

Inherited:
 
    Javadoc is not required on a method that is tagged with the
@Override annotation. However under Java 5 it is not possible to mark a
method required for an interface (this was corrected under Java 6).
    Hence Checkstyle supports using the convention of using a single
{@inheritDoc} tag instead of all the other tags.
 
Classes not mentioned.
However:  Even inherited classes could have javadoc - with a summary of
in what way it extends or implements it's base or iface.

Ondra




David M. Lloyd píše v Pá 09. 12. 2011 v 13:28 -0600:

> 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.
> 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/jboss-as7-dev/attachments/20111209/10491318/attachment.html