<p>Since Checkstyle 3.0</p><p> Checks the Javadoc of a method or constructor. By default, does not check for unused throws. To allow documented <code>java.lang.RuntimeException</code>s that are not declared, set property allowUndeclaredRTE to true. The scope to verify is specified using the <code>Scope</code> class and defaults to <code>Scope.PRIVATE</code>. To verify another scope, set property scope to a different <a href="property_types.html#scope">scope</a>. </p><p> Error messages about parameters and type parameters for which no param tags are present can be suppressed by defining property <code>allowMissingParamTags</code>. Error messages about exceptions which are declared to be thrown, but for which no throws tag is present can be suppressed by defining property <code>allowMissingThrowsTags</code>. Error messages about methods which return non-void but for which no return tag is present can be suppressed by defining property <code>allowMissingReturnTag</code>. </p><p> Javadoc is not required on a method that is tagged with the <code>@Override</code> 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). Hence Checkstyle supports using the convention of using a single <code>{@inheritDoc}</code> tag instead of all the other tags. </p><p> Note that only inheritable items will allow the <code>{@inheritDoc}</code> tag to be used in place of comments. Static methods at all visibilities, private non-static methods and constructors are not inheritable. </p><p> For example, if the following method is implementing a method required by an interface, then the Javadoc could be done as: </p><pre> /** {@inheritDoc} */ public int checkReturnTag(final int aTagIndex, JavadocTag[] aTags, int aLineNo)</pre><p> The classpath may need to be configured to locate the class information. The classpath configuration is dependent on the mechanism used to invoke Checkstyle. </p>

<p>Since Checkstyle 3.0</p><p> Checks the Javadoc of a method or constructor. By default, does not check for unused throws. To allow documented <code>java.lang.RuntimeException</code>s that are not declared, set property allowUndeclaredRTE to true. The scope to verify is specified using the <code>Scope</code> class and defaults to <code>Scope.PRIVATE</code>. To verify another scope, set property scope to a different <a href="property_types.html#scope">scope</a>. </p><p> Error messages about parameters and type parameters for which no param tags are present can be suppressed by defining property <code>allowMissingParamTags</code>. Error messages about exceptions which are declared to be thrown, but for which no throws tag is present can be suppressed by defining property <code>allowMissingThrowsTags</code>. Error messages about methods which return non-void but for which no return tag is present can be suppressed by defining property <code>allowMissingReturnTag</code>. </p><p> Javadoc is not required on a method that is tagged with the <code>@Override</code> 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). Hence Checkstyle supports using the convention of using a single <code>{@inheritDoc}</code> tag instead of all the other tags. </p><p> Note that only inheritable items will allow the <code>{@inheritDoc}</code> tag to be used in place of comments. Static methods at all visibilities, private non-static methods and constructors are not inheritable. </p><p> For example, if the following method is implementing a method required by an interface, then the Javadoc could be done as: </p><pre> /** {@inheritDoc} */ public int checkReturnTag(final int aTagIndex, JavadocTag[] aTags, int aLineNo)</pre><p> The classpath may need to be configured to locate the class information. The classpath configuration is dependent on the mechanism used to invoke Checkstyle. </p>

<p>Since Checkstyle 3.0</p><p> Checks the Javadoc of a method or constructor. By default, does not check for unused throws. To allow documented <code>java.lang.RuntimeException</code>s that are not declared, set property allowUndeclaredRTE to true. The scope to verify is specified using the <code>Scope</code> class and defaults to <code>Scope.PRIVATE</code>. To verify another scope, set property scope to a different <a href="property_types.html#scope">scope</a>. </p><p> Error messages about parameters and type parameters for which no param tags are present can be suppressed by defining property <code>allowMissingParamTags</code>. Error messages about exceptions which are declared to be thrown, but for which no throws tag is present can be suppressed by defining property <code>allowMissingThrowsTags</code>. Error messages about methods which return non-void but for which no return tag is present can be suppressed by defining property <code>allowMissingReturnTag</code>. </p><p> Javadoc is not required on a method that is tagged with the <code>@Override</code> 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). Hence Checkstyle supports using the convention of using a single <code>{@inheritDoc}</code> tag instead of all the other tags. </p><p> Note that only inheritable items will allow the <code>{@inheritDoc}</code> tag to be used in place of comments. Static methods at all visibilities, private non-static methods and constructors are not inheritable. </p><p> For example, if the following method is implementing a method required by an interface, then the Javadoc could be done as: </p><pre> /** {@inheritDoc} */ public int checkReturnTag(final int aTagIndex, JavadocTag[] aTags, int aLineNo)</pre><p> The classpath may need to be configured to locate the class information. The classpath configuration is dependent on the mechanism used to invoke Checkstyle. </p>