Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

improve documentation

This commit is contained in:
Hervé Boutemy 2021-10-24 11:09:07 +02:00
parent 8784812cf6
commit a5f1bca9ef
6 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
maven-wrapper/src/main/java/org/apache/maven/wrapper/BootstrapMainStarter.java
View File

@ -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

2
maven-wrapper/src/main/java/org/apache/maven/wrapper/Downloader.java
View File

@ -44,6 +44,8 @@ import java.net.URI;
import java.nio.file.Path;
/**
* Maven distribution downloader.
*
* @author Hans Dockter
*/
public interface Downloader

2
maven-wrapper/src/main/java/org/apache/maven/wrapper/Installer.java
View File

@ -40,6 +40,8 @@ import java.util.zip.ZipFile;
/**
* Maven distribution installer, eventually using a {@link Downloader} first.
*
* @author Hans Dockter
*/
public class Installer

2
maven-wrapper/src/main/java/org/apache/maven/wrapper/MavenWrapperMain.java
View File

@ -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

3
maven-wrapper/src/main/java/org/apache/maven/wrapper/WrapperExecutor.java
View File

@ -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

4
maven-wrapper/src/site/apt/index.apt
View File

@ -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>>>.