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

beef up Javadoc

This commit is contained in:
Rick Giles 2002-12-09 09:42:05 +00:00
parent 294e959728
commit f1c2e34d74
2 changed files with 48 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/JavadocVariableCheck.java
View File

@ -26,8 +26,23 @@ import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Checks that a variable has Javadoc comment
*
* Checks that a variable has Javadoc comment.
* 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.
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="JavadocVariableCheck"/&gt;
* </pre>
* <p> An example of how to configure the check for the
* {@link Scope#PUBLIC} scope is:
*</p>
* <pre>
* &lt;config name="JavadocVariableCheck"&gt;
* &lt;property name="scope" value="public"/&gt;
* &lt;/config&gt;
* </pre>
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
* @version 1.0
*/

32
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/LineLengthCheck.java
View File

@ -39,7 +39,37 @@ import org.apache.commons.beanutils.ConversionException;
* has been dropped as it is a special case of regexp: The user can set
* the ignorePattern to "^import" and achieve the same effect.
* </p>
*
* <p>
* The default maximum allowable line length is 80 characters. To change the
* maximum, set property max.
* </p>
* <p>
* To ignore lines in the check, set property ignorePattern to a regular
* expression for the lines to ignore.
* </p>
* <p>
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="LineLengthCheck"/&gt;
* </pre>
* <p> An example of how to configure the check to accept lines up to 120
* characters long is:
*</p>
* <pre>
* &lt;config name="LineLengthCheck"&gt;
* &lt;property name="max" value="120"/&gt;
* &lt;/config&gt;
* </pre>
* <p> An example of how to configure the check to ignore lines that begin with
* &quot; * &quot;, such as within a Javadoc comment, is:
* </p>
* <pre>
* &lt;config name="LineLengthCheck"&gt;
* &lt;property name="ignorePattern" value="^ *\* *[^ ]+$"/&gt;
* &lt;/config&gt;
* </pre>
*
* @author Lars Kühne
*/
public class LineLengthCheck extends Check