diff options
| author | Evgeny Mandrikov <mandrikov@gmail.com> | 2012-03-16 17:09:32 +0400 |
|---|---|---|
| committer | Evgeny Mandrikov <mandrikov@gmail.com> | 2012-03-20 09:59:33 +0400 |
| commit | a9f1cd33f9c640f78ea7aa464a7e3b7cab30dbfd (patch) | |
| tree | 4487fefe1a9739d87a23fa72f45eb4f039893429 /sonar-plugin-api | |
| parent | 5d55f72823ad1fac99682c4f9bd2aa91e0ad776a (diff) | |
| download | sonarqube-a9f1cd33f9c640f78ea7aa464a7e3b7cab30dbfd.tar.gz sonarqube-a9f1cd33f9c640f78ea7aa464a7e3b7cab30dbfd.zip | |
Add some Javadocs
Diffstat (limited to 'sonar-plugin-api')
| -rw-r--r-- | sonar-plugin-api/src/main/java/org/sonar/api/batch/Decorator.java | 3 | ||||
| -rw-r--r-- | sonar-plugin-api/src/main/java/org/sonar/api/batch/SonarIndex.java | 5 |
2 files changed, 6 insertions, 2 deletions
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/Decorator.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/Decorator.java index 68ff6fb30ac..f0dc71cec27 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/Decorator.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/Decorator.java @@ -27,6 +27,9 @@ import org.sonar.api.resources.Resource; */ public interface Decorator extends BatchExtension, CheckProject { + /** + * @param resource resource that is currently decorated, equivalent of <code>context.getResource()</code> + */ void decorate(Resource resource, DecoratorContext context); } diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/SonarIndex.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/SonarIndex.java index 4d8c0335041..44cf1a1d901 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/SonarIndex.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/SonarIndex.java @@ -100,6 +100,7 @@ public abstract class SonarIndex implements DirectedGraphAccessor<Resource, Depe public abstract void setSource(Resource reference, String source) throws DuplicatedSourceException; /** + * @return source code associated with a specified resource, <code>null</code> if not available * @since 2.9 */ public abstract String getSource(Resource resource); @@ -124,7 +125,7 @@ public abstract class SonarIndex implements DirectedGraphAccessor<Resource, Depe /** * Returns the violations that match the {@link ViolationQuery} parameters. - * + * * @since 2.8 * @param violationQuery * the request parameters specified as a {@link ViolationQuery} @@ -136,7 +137,7 @@ public abstract class SonarIndex implements DirectedGraphAccessor<Resource, Depe * Returns all the active (= non switched-off) violations found on the given resource. Equivalent to * {@link #getViolations(ViolationQuery)} called with <code>ViolationQuery.create().forResource(resource).ignoreSwitchedOff(true)</code> * as a parameter. - * + * * @since 2.7 * @return the list of violations */ |