SONAR-5460 Add long Markdown description to Xoo rule parameter

diff --git a/plugins/sonar-xoo-plugin/src/main/java/org/sonar/xoo/rule/XooRulesDefinition.java b/plugins/sonar-xoo-plugin/src/main/java/org/sonar/xoo/rule/XooRulesDefinition.java
index 1b7ff74e0e7ea0f4740102659179037c3d45afb5..c05fe0e09768760c720c3289bbf7ad86b3ceff9a 100644 (file)
--- a/plugins/sonar-xoo-plugin/src/main/java/org/sonar/xoo/rule/XooRulesDefinition.java
+++ b/plugins/sonar-xoo-plugin/src/main/java/org/sonar/xoo/rule/XooRulesDefinition.java
@@ -60,7 +60,9 @@ public class XooRulesDefinition implements RulesDefinition {
     x1Rule.createParam("acceptWhitespace")
       .setDefaultValue("false")
       .setType(RuleParamType.BOOLEAN)
-      .setDescription("Accept whitespaces (``\\s|\\t``) on the line");
+      .setDescription("= Accept whitespace (``\\s|\\t``) on the line\nThis property is available so that a line containing only whitespace is not considered empty.\n"
+        + "== Example with property set to ``false``\n``xoo\n   <- One issue here\n<- And one here\n``\n\n"
+        + "== Example with property set to ``true``\n``xoo\n   <- No issue here\n<- But one here\n``\n");
 
     // don't forget to call done() to finalize the definition
     repository.done();