<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 TRANSITIONAL//EN">

<HTML>

<HEAD>

  <META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=UTF-8">

  <META NAME="GENERATOR" CONTENT="GtkHTML/3.18.3">

</HEAD>

<BODY>

Non-public:<BR>

<BR>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;module name=&quot;JavadocType&quot;&gt;<BR>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;property name=&quot;scope&quot; value=&quot;public&quot;/&gt;<BR>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/module&gt;<BR>

<BR>

Inherited:<BR>

 <BR>

&nbsp;&nbsp;&nbsp; Javadoc is not required on a method that is tagged with the <TT>@Override</TT> annotation. However under Java 5 it is not possible to mark a method required for an interface (this was <I>corrected</I> under Java 6).<BR>

&nbsp;&nbsp;&nbsp; Hence Checkstyle supports using the convention of using a single <TT>{@inheritDoc}</TT> tag instead of all the other tags.<BR>

 <BR>

Classes not mentioned.<BR>

However:&nbsp; Even inherited classes could have javadoc - with a summary of in what way it extends or implements it's base or iface.<BR>

<BR>

Ondra<BR>

<BR>

<BR>

<BR>

<BR>

David M. Lloyd p&#237;&#353;e v P&#225; 09. 12. 2011 v 13:28 -0600:

<BLOCKQUOTE TYPE=CITE>

<PRE>

On 12/09/2011 01:26 PM, Ond&#345;ej &#381;i&#382;ka wrote:

&gt; Hi,

&gt;

&gt;

&gt; JavadocType checks whether each class/interface has javadoc.

&gt;

&gt; 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.

</PRE>

</BLOCKQUOTE>

</BODY>

</HTML>