aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-plugin-api
diff options
context:
space:
mode:
authorDavid Gageot <david@gageot.net>2012-10-02 08:47:51 +0200
committerDavid Gageot <david@gageot.net>2012-10-02 08:56:30 +0200
commit8d327596480739737e24553a127b7e7cf5346641 (patch)
tree706505f8a7ba93a32c5de3dd009ca3066ed8b6af /sonar-plugin-api
parentd301a6d99a486c8f52f9dfb8e74971b0651775eb (diff)
downloadsonarqube-8d327596480739737e24553a127b7e7cf5346641.tar.gz
sonarqube-8d327596480739737e24553a127b7e7cf5346641.zip
SONAR-3529 Improve code
Diffstat (limited to 'sonar-plugin-api')
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/PropertyField.java3
1 files changed, 3 insertions, 0 deletions
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/PropertyField.java b/sonar-plugin-api/src/main/java/org/sonar/api/PropertyField.java
index c8114b724da..eb50526b67b 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/PropertyField.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/PropertyField.java
@@ -34,6 +34,9 @@ import java.lang.annotation.Target;
public @interface PropertyField {
/**
* Unique key within a property. It shouldn't be prefixed.
+ * Settings for this field are stored into the database with a composite key
+ * <code>{key of parent property}.{key of the set}.{key of this field}</code>
+ * eg. <code>sonar.jira.servers.JIRA1.url</code>
*/
String key();