From 969cfa0ad87805e336a758454fe9200167da1c10 Mon Sep 17 00:00:00 2001 From: David Gageot Date: Fri, 27 Apr 2012 14:48:34 +0200 Subject: [PATCH] Added comments on code --- .../src/main/java/org/sonar/api/batch/DependedUpon.java | 5 +++-- .../src/main/java/org/sonar/api/resources/Resource.java | 5 +++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/DependedUpon.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/DependedUpon.java index aa4104b6d3d..fb299ea9482 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/DependedUpon.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/DependedUpon.java @@ -19,7 +19,6 @@ */ package org.sonar.api.batch; - import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @@ -34,7 +33,9 @@ public @interface DependedUpon { /** * Used only on classes. Must be keep empty on methods. + * + * @see org.sonar.api.batch.DecoratorBarriers for a list of possible values. */ String[] value() default {}; -} \ No newline at end of file +} diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/resources/Resource.java b/sonar-plugin-api/src/main/java/org/sonar/api/resources/Resource.java index a96368bd111..39e49e546da 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/resources/Resource.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/resources/Resource.java @@ -161,7 +161,12 @@ public abstract class Resource { public abstract String getScope(); /** + * The qualifier tells the type of the resource. For example, it can be a File, a Class, a Project, a Unit Test... + * * @return the qualifier + * + * @see org.sonar.api.resources.Qualifiers for the list of qualifiers + * @see org.sonar.api.resources.ResourceUtils to find out if a resource if a class, a unit test,... from its qualifier */ public abstract String getQualifier(); -- 2.39.5