aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-plugin-api/src
diff options
context:
space:
mode:
authorSimon Brandhof <simon.brandhof@gmail.com>2013-06-06 16:20:18 +0200
committerSimon Brandhof <simon.brandhof@gmail.com>2013-06-06 16:20:18 +0200
commitf1c7b9f5601d77f9ffa35c4f61129c898292299b (patch)
treeed1b7531fcc74199fc37fcc4f60e7edce81fa8c2 /sonar-plugin-api/src
parent1b47644db7d409deb5840072eabf1cd0d08d934e (diff)
downloadsonarqube-f1c7b9f5601d77f9ffa35c4f61129c898292299b.tar.gz
sonarqube-f1c7b9f5601d77f9ffa35c4f61129c898292299b.zip
Add some javadoc to org.sonar.api.config.PropertyDefinition
Diffstat (limited to 'sonar-plugin-api/src')
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/config/PropertyDefinition.java27
1 files changed, 22 insertions, 5 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 f77e9609a12..c2f87e7232b 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
@@ -164,6 +164,13 @@ public final class PropertyDefinition implements BatchExtension, ServerExtension
/**
* Unique key within all plugins. It's recommended to prefix the key by 'sonar.' and the plugin name. Examples :
* 'sonar.cobertura.reportPath' and 'sonar.cpd.minimumTokens'.
+ * <p/>
+ * Keys in l10n bundles:
+ * <ul>
+ * <li>"property.<key>.name" is the label</li>
+ * <li>"property.<key>.description" is the description</li>
+ * <li></li>
+ * </ul>
*/
public String key() {
return key;
@@ -323,8 +330,14 @@ public final class PropertyDefinition implements BatchExtension, ServerExtension
}
/**
- * Category where properties will appear. By default equal to plugin name.
- * @param category Name/key of the category. Could be internationalized.
+ * Category where the property appears in settings pages. By default equal to plugin name.
+ * <p/>
+ * Keys in l10n bundles are:
+ * <ul>
+ * <li>"property.category.<category>" is the label to display</li>
+ * <li>"property.category.<category>.description" is the description</li>
+ *
+ * </ul>
*/
public Builder category(String category) {
this.category = category;
@@ -332,9 +345,13 @@ public final class PropertyDefinition implements BatchExtension, ServerExtension
}
/**
- * Sub category where properties will appear. By default sub category will have
- * same name as parent category.
- * @param subCategory Name/key of the sub category. Could be internationalized.
+ * Sub-category where property will appear. By default sub category is the category.
+ * <p/>
+ * Keys in l10n bundles:
+ * <ul>
+ * <li>"property.category.<category>.<subcategory>" is the sub-category label</li>
+ * <li>"property.category.<category>.<subcategory>.description" is the description</li>
+ * </ul>
*/
public Builder subCategory(String subCategory) {
this.subCategory = subCategory;