From b255c1bfdd0db9fb643bbd2e3cc404bcf2bf66bb Mon Sep 17 00:00:00 2001 From: Simon Brandhof Date: Wed, 5 Jun 2013 16:46:49 +0200 Subject: [PATCH] SONAR-3755 add javadoc to issue API --- .../src/main/java/org/sonar/api/issue/Issue.java | 7 +++++++ 1 file changed, 7 insertions(+) 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 -- 2.39.5