summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJean-Baptiste Lievremont <jean-baptiste.lievremont@sonarsource.com>2015-02-19 16:06:11 +0100
committerJean-Baptiste Lievremont <jean-baptiste.lievremont@sonarsource.com>2015-02-19 16:06:24 +0100
commitdddd9fda7f80181eb335ea79b152acd10bd473a7 (patch)
tree94e011f7489d306d39fdae758ea5b2efbab3a658
parent9f2fe650aa141d333ffe07f4d0f6d24fe22a414b (diff)
downloadsonarqube-dddd9fda7f80181eb335ea79b152acd10bd473a7.tar.gz
sonarqube-dddd9fda7f80181eb335ea79b152acd10bd473a7.zip
SONAR-6199 Update rule activation parameter descriptions
-rw-r--r--server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/RuleActivationActions.java8
1 files changed, 4 insertions, 4 deletions
diff --git a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/RuleActivationActions.java b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/RuleActivationActions.java
index f5488b20206..a2c7758cdb1 100644
--- a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/RuleActivationActions.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/RuleActivationActions.java
@@ -74,7 +74,7 @@ public class RuleActivationActions implements ServerComponent {
activate.createParam(PARAMS)
.setDescription(String.format("Parameters as semi-colon list of <key>=<value>, for example " +
- "'params=key1=v1;key2=v2'. Ignored if parameter %s is true.", RESET));
+ "'<code>params=key1=v1;key2=v2</code>'. Ignored if parameter %s is true.", RESET));
activate.createParam(RESET)
.setDescription("Reset severity and parameters of activated rule. Set the values defined on parent profile " +
@@ -99,12 +99,12 @@ public class RuleActivationActions implements ServerComponent {
private void defineActiveRuleKeyParameters(WebService.NewAction action) {
action.createParam(PROFILE_KEY)
- .setDescription("Key of Quality profile")
+ .setDescription("Key of Quality profile, can be obtained through <code>api/profiles/list</code>")
.setRequired(true)
- .setExampleValue("Sonar way:java");
+ .setExampleValue("java-sonar-way-80423");
action.createParam(RULE_KEY)
- .setDescription("Key of the rule to activate")
+ .setDescription("Key of the rule")
.setRequired(true)
.setExampleValue("squid:AvoidCycles");
}