* 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. + *
+ *+ * An example of how to configure the check is: + *
+ * TODO: re-visit after configuration format settled. + *+ * <check + * classname="com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck"/> + *+ *
An example of how to configure the check to check for unused imports + * and for the {@link Scope#PUBLIC} scope is: + *
+ *+ * <check + * classname="com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck"> + * <property name="scope" value="public"/> + * <property name="checkUnusedThrows" value="true"/> + * </check> + ** * @author Oliver Burn * @author Rick Giles