[maven] 03/31: Added JavaDoc to the method which determines whether a resume-from suggestion should be given or not.

[rf...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rfscholte pushed a commit to branch MNG-5760
in repository https://gitbox.apache.org/repos/asf/maven.git

commit e4e89ff133c19e3e5cf3972ef4132b1524203f04
Author: Martin Kanters <Ma...@infosupport.com>
AuthorDate: Fri May 22 09:06:26 2020 +0200

    Added JavaDoc to the method which determines whether a resume-from suggestion should be given or not.
---
 .../main/java/org/apache/maven/cli/BuildResumptionManager.java    | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/maven-embedder/src/main/java/org/apache/maven/cli/BuildResumptionManager.java b/maven-embedder/src/main/java/org/apache/maven/cli/BuildResumptionManager.java
index ecabc81..900699f 100644
--- a/maven-embedder/src/main/java/org/apache/maven/cli/BuildResumptionManager.java
+++ b/maven-embedder/src/main/java/org/apache/maven/cli/BuildResumptionManager.java
@@ -100,6 +100,14 @@ class BuildResumptionManager
                 .collect( Collectors.toList() );
     }
 
+    /**
+     * Determine the project where the next build can be resumed from.
+     * If the failed project is the first project of the build,
+     * it does not make sense to use --resume-from, so the result will be empty.
+     * @param result The result of the Maven build.
+     * @param failedProject The first failed project of the build.
+     * @return An optional containing the resume-from suggestion.
+     */
     private Optional<String> getResumeFrom( MavenExecutionResult result, MavenProject failedProject )
     {
         List<MavenProject> allSortedProjects = result.getTopologicallySortedProjects();