aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-plugin-api
diff options
context:
space:
mode:
authorsimonbrandhof <simon.brandhof@gmail.com>2011-05-27 15:07:54 +0200
committersimonbrandhof <simon.brandhof@gmail.com>2011-05-27 15:07:54 +0200
commit5bfa0ea11539a3a175532a2eb97fea60c05d5dae (patch)
tree6e3f6d549ce206604dcefbc037f5c18e2f15bac4 /sonar-plugin-api
parent6e3c6469ee84039c669a5040c8770a4e7e56edff (diff)
downloadsonarqube-5bfa0ea11539a3a175532a2eb97fea60c05d5dae.tar.gz
sonarqube-5bfa0ea11539a3a175532a2eb97fea60c05d5dae.zip
Add some javadoc
Diffstat (limited to 'sonar-plugin-api')
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectBuilder.java10
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectDefinition.java6
2 files changed, 12 insertions, 4 deletions
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectBuilder.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectBuilder.java
index bdd90512ede..10e0e9be8f3 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectBuilder.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectBuilder.java
@@ -23,7 +23,15 @@ import org.sonar.api.BatchExtension;
import org.sonar.api.batch.InstantiationStrategy;
/**
- *
+ * This extension point allows to change project structure at runtime. It is executed once during batch startup.
+ * Some use-cases :
+ * <ul>
+ * <li>Add sub-projects which are not defined in batch bootstrapper. For example the C# plugin gets the hierarchy
+ * of sub-projects from the Visual Studio metadata file. The single root pom.xml does not contain any declarations of
+ * modules</li>
+ * <li>Change project metadata like description or source directories.</li>
+ * </ul>
+ *
* @since 2.9
*/
@InstantiationStrategy(InstantiationStrategy.PER_BATCH)
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectDefinition.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectDefinition.java
index 195b886fcbc..37764621c10 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectDefinition.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/bootstrap/ProjectDefinition.java
@@ -30,6 +30,9 @@ import java.util.List;
import java.util.Properties;
/**
+ * Defines project metadata (key, name, source directories, ...). It's generally used by the
+ * {@link org.sonar.api.batch.bootstrap.ProjectBuilder extension point}
+ *
* @since 2.9
*/
public final class ProjectDefinition implements BatchComponent {
@@ -48,9 +51,6 @@ public final class ProjectDefinition implements BatchComponent {
private List<ProjectDefinition> subProjects = Lists.newArrayList();
private List<Object> containerExtensions = Lists.newArrayList();
- /**
- * TODO use factory methods
- */
public ProjectDefinition(File baseDir, File workDir, Properties properties) {
this.baseDir = baseDir;
this.workDir = workDir;