From: Simon Brandhof <simon.brandhof@gmail.com>
Date: Wed, 5 Jun 2013 14:46:49 +0000 (+0200)
Subject: SONAR-3755 add javadoc to issue API
X-Git-Tag: 3.6~67
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=b255c1bfdd0db9fb643bbd2e3cc404bcf2bf66bb;p=sonarqube.git

SONAR-3755 add javadoc to issue API
---

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issue.java b/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issue.java
index 527fccd84bf..982ed14ff94 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issue.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issue.java
@@ -67,10 +67,17 @@ public interface Issue extends Serializable {
    */
   String key();
 
+  /**
+   * Components are modules ("my_project"), directories ("my_project:my/dir") or files ("my_project:my/file.c").
+   * Keys of Java packages and classes are currently in a special format: "my_project:com.company" and "my_project:com.company.Foo".
+   */
   String componentKey();
 
   RuleKey ruleKey();
 
+  /**
+   * See constants in {@link org.sonar.api.rule.Severity}.
+   */
   String severity();
 
   @CheckForNull