TouchInstinct
/
checkstyle
311
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Beef up Javadoc.

This commit is contained in:
Rick Giles 2002-12-03 18:53:56 +00:00
parent 19368509da
commit e52c0ac541
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/JavadocMethodCheck.java
View File

@ -36,7 +36,32 @@ import java.util.Set;
import org.apache.regexp.RE;
/**
* <p>
* Checks the Javadoc of a method or constructor.
* By default, does not check for unused throws.
* To check for unused throws, set property checkUnusedThrows to true.
* The scope to verify is specified using the {@link Scope} class and
* defaults to {@link Scope#PRIVATE}. To verify another scope,
* set property scope to one of the {@link Scope#} constants.
* </p>
* <p>
* An example of how to configure the check is:
* </p>
* TODO: re-visit after configuration format settled.
* <pre>
* &lt;check
* classname="com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck"/&gt;
* </pre>
* <p> An example of how to configure the check to check for unused imports
* and for the {@link Scope#PUBLIC} scope is:
*</p>
* <pre>
* &lt;check
* classname="com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck"&gt;
* &lt;property name="scope" value="public"/&gt;
* &lt;property name="checkUnusedThrows" value="true"/&gt;
* &lt;/check&gt;
* </pre>
*
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
* @author Rick Giles