Add tip for parsing KeyValueFormat format from ruby code

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/utils/KeyValueFormat.java b/sonar-plugin-api/src/main/java/org/sonar/api/utils/KeyValueFormat.java
index 6f004c963bafe5424a5420d6519047c520c9eeab..0f6ebd7103c2a13b17907ffcf8a74ad25cc77882 100644 (file)
--- a/sonar-plugin-api/src/main/java/org/sonar/api/utils/KeyValueFormat.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/utils/KeyValueFormat.java
@@ -34,8 +34,10 @@ import java.text.SimpleDateFormat;
 import java.util.*;
 
 /**
- * Formats and parses key/value pairs with the string representation : "key1=value1;key2=value2". Conversion
- * of fields is supported and can be extended.
+ * <p>Formats and parses key/value pairs with the string representation : "key1=value1;key2=value2". Conversion
+ * of fields is supported and can be extended.</p>
+ *
+ * <p>This format can easily be parsed with Ruby code: <code>hash=Hash[*(my_string.split(';').map { |elt| elt.split('=') }.flatten)]</code></p>
  *
  * @since 1.10
  */