From ac4076d96db0d67906a2f947418b7120aba8b436 Mon Sep 17 00:00:00 2001 From: Oliver Burn Date: Tue, 26 Nov 2002 22:56:37 +0000 Subject: [PATCH] Fix the Javadoc --- .../tools/checkstyle/checks/BlockOption.java | 31 ++++++++++++++----- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/BlockOption.java b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/BlockOption.java index db9a8a107..6e68e1c63 100644 --- a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/BlockOption.java +++ b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/BlockOption.java @@ -22,8 +22,7 @@ import java.util.HashMap; import java.util.Map; /** - * Represents the options for blocks. - * + * Represents the policy for checking block statements. * @author Rick Giles */ public final class BlockOption @@ -31,12 +30,30 @@ public final class BlockOption { /** maps from a string representation to an option */ private static final Map STR_TO_OPT = new HashMap(); - - /** require that there is some text in the block **/ + + /** + * Represents the policy that there is some text in the block. For example: + * + *
+     * catch (Exception ex) {
+     *     // This is a bad coding practice
+     * }
+     * 
+ */ public static final BlockOption TEXT = new BlockOption("text"); - /** require that there is a statement in the block **/ + + /** + * Represents the policy that there is a statement in the block. For + * example: + * + *
+     * finally {
+     *     lock.release();
+     * }
+     * 
+ */ public static final BlockOption STMT = new BlockOption("statement"); - + /** * Creates a new BlockOption instance. * @@ -46,7 +63,7 @@ public final class BlockOption { super(aStrRep); } - + /** @see com.puppycrawl.tools.checkstyle.checks.AbstractOption */ protected Map getStrToOpt() {