svn commit: r1597305 - /maven/shared/trunk/maven-dependency-tree/src/main/java/org/apache/maven/shared/dependency/graph/DependencyGraphBuilder.java

[hb...@apache.org]

Author: hboutemy
Date: Sat May 24 14:23:15 2014
New Revision: 1597305

URL: http://svn.apache.org/r1597305
Log:
fixed javadoc

Modified:
    maven/shared/trunk/maven-dependency-tree/src/main/java/org/apache/maven/shared/dependency/graph/DependencyGraphBuilder.java

Modified: maven/shared/trunk/maven-dependency-tree/src/main/java/org/apache/maven/shared/dependency/graph/DependencyGraphBuilder.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-dependency-tree/src/main/java/org/apache/maven/shared/dependency/graph/DependencyGraphBuilder.java?rev=1597305&r1=1597304&r2=1597305&view=diff
==============================================================================
--- maven/shared/trunk/maven-dependency-tree/src/main/java/org/apache/maven/shared/dependency/graph/DependencyGraphBuilder.java (original)
+++ maven/shared/trunk/maven-dependency-tree/src/main/java/org/apache/maven/shared/dependency/graph/DependencyGraphBuilder.java Sat May 24 14:23:15 2014
@@ -33,10 +33,7 @@ import java.util.Collection;
 public interface DependencyGraphBuilder
 {
     /**
-     * Build the dependency graph from the repository. This is the same as
-     * {@link #buildDependencyGraph(org.apache.maven.project.MavenProject,
-     *  org.apache.maven.artifact.resolver.filter.ArtifactFilter, java.util.Collection)}
-     * with an empty reactorProjects Map.
+     * Build the dependency graph.
      *
      * @param project the project
      * @param filter artifact filter (can be <code>null</code>)
@@ -47,7 +44,12 @@ public interface DependencyGraphBuilder
         throws DependencyGraphBuilderException;
 
     /**
-     * Build the dependency graph including any dependencies contained in the reactor projects.
+     * Build the dependency graph, with a hack to include dependencies contained in the reactor projects
+     * but that are not yet compiled, which is the minimum prerequisite for Maven core's
+     * ReactorReader to find them. Notice that this hack doesn't work for Maven 2.
+     * <p>Notice: If Maven core did collect instead of resolving dependencies (ie did not try to get the
+     * artifacts but only the poms), probably this hack wouldn't be necessary even for people requiring
+     * the dependency graph before compiling. TODO: for Maven 3, use Aether to collect dependencies.</p>
      *
      * @param project the project
      * @param filter artifact filter (can be <code>null</code>)