improved docs

2004-10-19 21:25:37 +00:00 · 2004-10-19 21:25:37 +00:00 · c0e20524a6
parent a539deb14d
commit c0e20524a6
1 changed files with 8 additions and 1 deletions
--- a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/EmptyStatementCheck.java
+++ b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/EmptyStatementCheck.java
@ -25,8 +25,15 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST;

 /**
 * <p>
- * Check that finds empty statements.
+ * Detects empty statements (standalone ';').
+ * Empty statements often introduce bugs
+ * that are hard to spot, such as in
 * </p>
+ * <pre>
+ * if (someCondition);
+ *   doConditionalStuff();
+ * doUnconditionalStuff();
+ * </pre>
 * <p>
 * An example of how to configure the check is:
 * </p>