SONAR-75 Document i18n API as experimental (postponed to v2.10)

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/i18n/I18n.java b/sonar-plugin-api/src/main/java/org/sonar/api/i18n/I18n.java
index 13c989fa043da4aca8b122444a43ff2415882b3f..cef7a86fe114b60ef8c9420eb433db452a308e44 100644 (file)
--- a/sonar-plugin-api/src/main/java/org/sonar/api/i18n/I18n.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/i18n/I18n.java
@@ -25,116 +25,18 @@ import org.sonar.api.ServerComponent;
 import java.util.Locale;
 
 /**
+ *
+ *
+ *
+ * EXPERIMENTAL - this feature will be fully implemented in version 2.10
+ *
  * 
- * The <code>I18n</code> Interface is the entry point for the internationalization of the Sonar application and plugins.<br>The corresponding implementation is located in the core I18n plugin. 
+ *
+ * The <code>I18n</code> Interface is the entry point for the internationalization of the Sonar application and plugins.<br>The corresponding implementation is located in the core plugin.
  * <p/>
  * I18n is managed in Sonar through the use of key-based resource bundles.
  * <br>
  * Though any key can be used, the following key-naming conventions, which are applied in the Sonar application and core plugins, are given as guidelines:
- * <ul>
- * <li>
- * Title of <code>View</code> extensions (pages, tabs, widgets): 
- * <blockquote><code>view.<i>view_id</i>.title</code></blockquote>
- * where <i>view_id</i> is the value returned by the <code>View.getId()</code> method
- * </li>
- * <br>
- * <li>
- * Free text translation in <code>View</code> extensions (pages, tabs, widgets):
- * <blockquote><code>view.<i>view_id</i>.<i>key</i></code></blockquote>
- * where:
- *  <ul>
- *    <li>
- *      <code><i>view_id</i></code> is the value returned by the <code>View.getId()</code> method
- *    </li>
- *    <li>
- *      <code><i>key</i></code> is the key of the text in the code of this view (rails page resource for a widget)
- *    </li>  
- *  </ul>
- * </li>
- * <br>
- * <li>
- * Free text translation in the files of the Rails web application:
- * <blockquote><code>app.<i>type</i>.<i>path</i>.<i>key</i></code></blockquote>
- * where:
- *  <ul>
- *    <li>
- *      <code><i>type</i></code> is the type of rails application file ('controller', 'helper', 'model', 'view').
- *    </li>
- *    <li>
- *      <code><i>path</i></code> is the path of the rails page related to the rails component type subdirectory ('controllers', 'views', etc ...).
- *    </li>
- *    <li>
- *      <code><i>key</i></code> is the key of the text in the code of this file
- *    </li>  
- *  </ul><br>
- *  For example, searching for the <code>login</code> key in the rails file <code>views/layouts/_layout.html.erb</code> gives the following full i18n key:
- *  <blockquote><code>app.view.layouts.layout.login</code></blockquote>
- * </li>
- * <br>
- * <li>
- * Metric name or description:
- * <blockquote><code>metric.<i>metric_key</i>.<i>field</i></code></blockquote>
- * where:
- *  <ul>
- *    <li>
- *      <code><i>metric_key</i></code> is the key of the metric ('ncloc', etc ...),
- *    </li>
- *    <li>
- *      <code><i>field</i></code> is the field to translate on the metric ('name' or 'description').
- *    </li>
- *  </ul>
- * </li>
- * <br>
- * <li>
- * Metric domain:
- * <blockquote><code>domain.<i>domain_text</i></code></blockquote>
- * where:
- *  <ul>
- *    <li>
- *      <code><i>domain_text</i></code> is the default (english) text of the domain as defined in the Metric object.
- *    </li>
- *  </ul>
- * </li>
- * <br>
- * <li>
- * General columns which are not metrics (key, build date, etc ...):
- * <blockquote><code>general_columns.<i>column_key</i></code></blockquote>
- * where:
- *  <ul>
- *    <li>
- *      <code><i>column_key</i></code> is the key of the column ('key', 'date', 'links', etc ...).
- *    </li>
- *  </ul>
- * </li>
- * <br>
- * <li>
- * Rules:
- * <blockquote><code>rule.<i>repository_key</i>.<i>rule_key</i>.<i>field</i></code></blockquote>
- * where:
- *  <ul>
- *    <li>
- *      <code><i>repository_key</i></code> is the key of the rule repository,
- *    </li>
- *    <li>
- *      <code><i>rule_key</i></code> is the key of the rule in the repository,
- *    </li>
- *    <li>
- *      <code><i>field</i></code> is the field to translate on the rule ('name' or 'description').
- *    </li>
- *  </ul>
- * </li>
- * <br>
- * <li>
- * Rule severities:
- * <blockquote><code>severity.<i>severity_text</i></code></blockquote>
- * where:
- *  <ul>
- *    <li>
- *      <code><i>severity_text</i></code> is the upper_case text of the RulePriority enum value ('MAJOR', 'MINOR', etc ...).
- *    </li>
- *  </ul>
- * </li>
- * </ul>
  *
  * @since 2.9
  */

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/i18n/LanguagePack.java b/sonar-plugin-api/src/main/java/org/sonar/api/i18n/LanguagePack.java
index 719a493547d0fd8e43f4cad9f5ca86335ac66f67..5b167fd6cadff0c97b4d5493bcbc26a2afd6e632 100644 (file)
--- a/sonar-plugin-api/src/main/java/org/sonar/api/i18n/LanguagePack.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/i18n/LanguagePack.java
@@ -26,6 +26,10 @@ import java.util.Collection;
 import java.util.Locale;
 
 /**
+ *
+ * EXPERIMENTAL - this feature will be fully implemented in version 2.10
+ *
+ *
  * @since 2.9
  */
 public abstract class LanguagePack implements ServerExtension, BatchExtension {