diff options
| author | Simon Brandhof <simon.brandhof@gmail.com> | 2013-06-05 16:46:49 +0200 |
|---|---|---|
| committer | Simon Brandhof <simon.brandhof@gmail.com> | 2013-06-05 16:47:00 +0200 |
| commit | b255c1bfdd0db9fb643bbd2e3cc404bcf2bf66bb (patch) | |
| tree | 3c76a80c1e61701c356629852d409a7f9db85549 | |
| parent | eae9d031f52a7ece4bc6a5a6e554aeb1a6ff1ca3 (diff) | |
| download | sonarqube-b255c1bfdd0db9fb643bbd2e3cc404bcf2bf66bb.tar.gz sonarqube-b255c1bfdd0db9fb643bbd2e3cc404bcf2bf66bb.zip | |
SONAR-3755 add javadoc to issue API
| -rw-r--r-- | sonar-plugin-api/src/main/java/org/sonar/api/issue/Issue.java | 7 |
1 files changed, 7 insertions, 0 deletions
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 |