From: simonbrandhof <simon.brandhof@gmail.com>
Date: Thu, 23 Sep 2010 14:33:58 +0000 (+0000)
Subject: depreciate the methods Plugin.getKey(), getName() and getDescription()
X-Git-Tag: 2.6~967
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=edbb6d604fd2484ecf0a243463bbc3f60afb5898;p=sonarqube.git

depreciate the methods Plugin.getKey(), getName() and getDescription()
---

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/Plugin.java b/sonar-plugin-api/src/main/java/org/sonar/api/Plugin.java
index a0a953fbde9..5038b9a714d 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/Plugin.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/Plugin.java
@@ -34,17 +34,23 @@ public interface Plugin {
 
   /**
    * Unique key within sonar plugins
+   * @deprecated since 2.2. The key must be set in the manifest.
    */
+  @Deprecated
   String getKey();
 
   /**
    * Descriptive name
+   * @deprecated since 2.2. The name must be set in the manifest.
    */
+  @Deprecated
   String getName();
 
   /**
    * description of the plugin, can contains html or ruby code
+   * @deprecated since 2.2. The description must be set in the manifest.
    */
+  @Deprecated
   String getDescription();
 
   /**
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/rules/AnnotationRuleRepository.java b/sonar-plugin-api/src/main/java/org/sonar/api/rules/AnnotationRuleRepository.java
index c19878dd800..984f710b944 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/rules/AnnotationRuleRepository.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/rules/AnnotationRuleRepository.java
@@ -17,7 +17,6 @@
  * License along with Sonar; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
  */
-
 package org.sonar.api.rules;
 
 import com.google.common.collect.Lists;
@@ -41,7 +40,7 @@ public final class AnnotationRuleRepository extends RuleRepository {
   private Collection<Class> annotatedClasses;
 
   /**
-   * Use the factory method()
+   * Use the factory method create()
    */
   private AnnotationRuleRepository(String key, String language, Collection<Class> annotatedClasses) {
     super(key, language);