aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-plugin-api/src/main/java/org/sonar/api/config
diff options
context:
space:
mode:
authorSimon Brandhof <simon.brandhof@sonarsource.com>2018-11-21 11:04:57 +0100
committerSonarTech <sonartech@sonarsource.com>2018-11-21 20:20:57 +0100
commita0ef76c189d7aada77a67ff1517fb672121705f8 (patch)
tree879ddd262167bc2094d8280016d07db3072fab34 /sonar-plugin-api/src/main/java/org/sonar/api/config
parent5788d993b8417cec4f346e728c575341145b20ad (diff)
downloadsonarqube-a0ef76c189d7aada77a67ff1517fb672121705f8.tar.gz
sonarqube-a0ef76c189d7aada77a67ff1517fb672121705f8.zip
Mention ".secured" naming convention in PropertyDefinition Java API
Diffstat (limited to 'sonar-plugin-api/src/main/java/org/sonar/api/config')
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/config/PropertyDefinition.java4
1 files changed, 4 insertions, 0 deletions
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/config/PropertyDefinition.java b/sonar-plugin-api/src/main/java/org/sonar/api/config/PropertyDefinition.java
index 090fbe640d3..87952b5209d 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/config/PropertyDefinition.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/config/PropertyDefinition.java
@@ -136,6 +136,10 @@ public final class PropertyDefinition {
this.index = builder.index;
}
+ /**
+ * @param key the unique property key. If it ends with ".secured" then users need the
+ * administration permission to access the value.
+ */
public static Builder builder(String key) {
return new Builder(key);
}