[maven] branch master updated: improve documentation

[hb...@apache.org]

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

hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven.git


The following commit(s) were added to refs/heads/master by this push:
     new a5f1bca  improve documentation
a5f1bca is described below

commit a5f1bca9efdb19b6a04db9e31101c55d40a34559
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Sun Oct 24 11:09:07 2021 +0200

    improve documentation
---
 .../src/main/java/org/apache/maven/wrapper/BootstrapMainStarter.java  | 2 ++
 maven-wrapper/src/main/java/org/apache/maven/wrapper/Downloader.java  | 2 ++
 maven-wrapper/src/main/java/org/apache/maven/wrapper/Installer.java   | 2 ++
 .../src/main/java/org/apache/maven/wrapper/MavenWrapperMain.java      | 2 ++
 .../src/main/java/org/apache/maven/wrapper/WrapperExecutor.java       | 3 +++
 maven-wrapper/src/site/apt/index.apt                                  | 4 ++--
 6 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/maven-wrapper/src/main/java/org/apache/maven/wrapper/BootstrapMainStarter.java b/maven-wrapper/src/main/java/org/apache/maven/wrapper/BootstrapMainStarter.java
index 5f81864..720b450 100644
--- a/maven-wrapper/src/main/java/org/apache/maven/wrapper/BootstrapMainStarter.java
+++ b/maven-wrapper/src/main/java/org/apache/maven/wrapper/BootstrapMainStarter.java
@@ -28,6 +28,8 @@ import java.nio.file.Path;
 import java.util.stream.Stream;
 
 /**
+ * Maven starter, from a provided Maven home directory.
+ *
  * @author Hans Dockter
  */
 public class BootstrapMainStarter
diff --git a/maven-wrapper/src/main/java/org/apache/maven/wrapper/Downloader.java b/maven-wrapper/src/main/java/org/apache/maven/wrapper/Downloader.java
index 42bda01..90dc089 100644
--- a/maven-wrapper/src/main/java/org/apache/maven/wrapper/Downloader.java
+++ b/maven-wrapper/src/main/java/org/apache/maven/wrapper/Downloader.java
@@ -44,6 +44,8 @@ import java.net.URI;
 import java.nio.file.Path;
 
 /**
+ * Maven distribution downloader.
+ *
  * @author Hans Dockter
  */
 public interface Downloader
diff --git a/maven-wrapper/src/main/java/org/apache/maven/wrapper/Installer.java b/maven-wrapper/src/main/java/org/apache/maven/wrapper/Installer.java
index 14fe29a..b5c287f 100644
--- a/maven-wrapper/src/main/java/org/apache/maven/wrapper/Installer.java
+++ b/maven-wrapper/src/main/java/org/apache/maven/wrapper/Installer.java
@@ -40,6 +40,8 @@ import java.util.zip.ZipFile;
 
 
 /**
+ * Maven distribution installer, eventually using a {@link Downloader} first.
+ *
  * @author Hans Dockter
  */
 public class Installer
diff --git a/maven-wrapper/src/main/java/org/apache/maven/wrapper/MavenWrapperMain.java b/maven-wrapper/src/main/java/org/apache/maven/wrapper/MavenWrapperMain.java
index 35aebf7..16cf2f8 100644
--- a/maven-wrapper/src/main/java/org/apache/maven/wrapper/MavenWrapperMain.java
+++ b/maven-wrapper/src/main/java/org/apache/maven/wrapper/MavenWrapperMain.java
@@ -28,6 +28,8 @@ import java.nio.file.Paths;
 import java.util.Properties;
 
 /**
+ * Main entry point for the Maven Wrapper, delegating wrapper execution to {@link WrapperExecutor}.
+ *
  * @author Hans Dockter
  */
 public class MavenWrapperMain
diff --git a/maven-wrapper/src/main/java/org/apache/maven/wrapper/WrapperExecutor.java b/maven-wrapper/src/main/java/org/apache/maven/wrapper/WrapperExecutor.java
index ee9ebec..42d5677 100644
--- a/maven-wrapper/src/main/java/org/apache/maven/wrapper/WrapperExecutor.java
+++ b/maven-wrapper/src/main/java/org/apache/maven/wrapper/WrapperExecutor.java
@@ -28,6 +28,9 @@ import java.nio.file.Path;
 import java.util.Properties;
 
 /**
+ * Wrapper executor, running {@link Installer} to get a Maven distribution ready, followed by {@BootstrapMainStarter}
+ * to launch the Maven bootstrap.
+ * 
  * @author Hans Dockter
  */
 public class WrapperExecutor
diff --git a/maven-wrapper/src/site/apt/index.apt b/maven-wrapper/src/site/apt/index.apt
index bf70504..c579786 100644
--- a/maven-wrapper/src/site/apt/index.apt
+++ b/maven-wrapper/src/site/apt/index.apt
@@ -25,6 +25,6 @@
 
 Maven Wrapper
 
- Maven Wrapper dowloads Maven distribution if not already in cache, then launches Maven.
+ Maven Wrapper dowloads Maven distribution if not already in cache, installs it, then launches Maven: Maven distributions installed by Maven Wrapper are stored under <<<~/.m2/wrapper/dists>>> by default.
 
- It is called by {{{../apache-maven-wrapper/}<<<mvnw>>>/<<<mvnw.cmd>>> scripts}} that need to be installed in the project and called instead of <<<mvn>>>/<<<mvn.cmd>>>.
+ Maven Wrapper is called by {{{../apache-maven-wrapper/}<<<mvnw>>>/<<<mvnw.cmd>>> scripts}} that need to be installed in the project source tree and called instead of <<<mvn>>>/<<<mvn.cmd>>>.