Improved the Javadoc
This commit is contained in:
parent
2b36d7dec1
commit
01c1609cff
|
|
@ -25,8 +25,9 @@ import org.apache.regexp.RE;
|
|||
import org.apache.commons.beanutils.ConversionException;
|
||||
|
||||
/**
|
||||
* Abstract class for checks that verify a name matches a specified regular
|
||||
* expression. Provides support for setting the format of the name.
|
||||
* Abstract class for checks that verify strings using a regular
|
||||
* expression. It provides support for setting the regular expression using
|
||||
* the property name <code>format</code>.
|
||||
*
|
||||
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
|
||||
* @version 1.0
|
||||
|
|
@ -50,7 +51,7 @@ public abstract class AbstractFormatCheck
|
|||
}
|
||||
|
||||
/**
|
||||
* Set the format.
|
||||
* Set the format to the specified regular expression.
|
||||
* @param aFormat a <code>String</code> value
|
||||
* @throws ConversionException unable to parse aFormat
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -16,7 +16,6 @@
|
|||
// License along with this library; if not, write to the Free Software
|
||||
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
package com.puppycrawl.tools.checkstyle.checks;
|
||||
|
||||
import com.puppycrawl.tools.checkstyle.api.Check;
|
||||
|
|
@ -24,8 +23,10 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST;
|
|||
import com.puppycrawl.tools.checkstyle.api.FullIdent;
|
||||
|
||||
/**
|
||||
* Abstract base class that provides functionality that is used in import
|
||||
* checks.
|
||||
* Abstract class that provides helper functionality for determining an import
|
||||
* name. It caches the import name in the token context to improve
|
||||
* performance.
|
||||
*
|
||||
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
|
||||
* @version 1.0
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue