diff options
| author | Jean-Baptiste Lievremont <jean-baptiste.lievremont@sonarsource.com> | 2014-07-18 11:59:25 +0200 |
|---|---|---|
| committer | Jean-Baptiste Lievremont <jean-baptiste.lievremont@sonarsource.com> | 2014-07-18 12:26:20 +0200 |
| commit | 4232affa985c379616b2a6ae52fdfabe753d48b2 (patch) | |
| tree | f8b8b2fe17819dbb99098f27c956a9b051a75337 | |
| parent | 2cc04077c80f684fc3860b1b622accf4eb0af08d (diff) | |
| download | sonarqube-4232affa985c379616b2a6ae52fdfabe753d48b2.tar.gz sonarqube-4232affa985c379616b2a6ae52fdfabe753d48b2.zip | |
SONAR-5460 Add long Markdown description to Xoo rule parameter
| -rw-r--r-- | plugins/sonar-xoo-plugin/src/main/java/org/sonar/xoo/rule/XooRulesDefinition.java | 4 |
1 files changed, 3 insertions, 1 deletions
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 1b7ff74e0e7..c05fe0e0976 100644 --- 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(); |