[maven-artifact-transfer] branch master updated: formatting & little typos fixes

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[maven-artifact-transfer] branch master updated: formatting & little typos fixes

hboutemy
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-artifact-transfer.git


The following commit(s) were added to refs/heads/master by this push:
     new 5870803  formatting & little typos fixes
5870803 is described below

commit 587080378bcc2761b5d2e509182a729dca8dfb8c
Author: Hervé Boutemy <[hidden email]>
AuthorDate: Sun Dec 1 15:04:14 2019 +0100

    formatting & little typos fixes
---
 .../shared/transfer/project/deploy/ProjectDeployer.java   | 15 +++++++++------
 .../shared/transfer/project/install/ProjectInstaller.java | 13 ++++++++-----
 src/site/apt/{comparison.apt.vm => comparison.apt}        |  4 ++--
 src/site/apt/index.apt.vm                                 |  3 +++
 4 files changed, 22 insertions(+), 13 deletions(-)

diff --git a/src/main/java/org/apache/maven/shared/transfer/project/deploy/ProjectDeployer.java b/src/main/java/org/apache/maven/shared/transfer/project/deploy/ProjectDeployer.java
index d9058ae..bf67425 100644
--- a/src/main/java/org/apache/maven/shared/transfer/project/deploy/ProjectDeployer.java
+++ b/src/main/java/org/apache/maven/shared/transfer/project/deploy/ProjectDeployer.java
@@ -36,19 +36,22 @@ public interface ProjectDeployer
      * appropriate remote repository.
      *
      * <pre class="java">
-     *  &#64;Parameter( defaultValue = "${session}", required=true, readonly = true)
+     *  &#64;Parameter( defaultValue = "${session}", required = true, readonly = true )
      *  MavenSession session;
-     *  &#64;Parameter( defaultValue = "${project}", required=true, readonly = true)
+     *  &#64;Parameter( defaultValue = "${project}", required = true, readonly = true )
      *  MavenProject project;
      *  ..
      *  &#64;Component
      *  ProjectDeployer deployer;
-     *  
-     *  ProjectDeployerRequest pdr =
+     *  ...
+     *  public void execute()
+     *  {
+     *    ProjectDeployerRequest pdr =
      *      new ProjectDeployerRequest()
-     *        .setProject (project);
+     *        .setProject( project );
      *  
-     *  deployer.deploy (session.getProjectBuildingRequest(), pdr, artifactRepository);
+     *    deployer.deploy( session.getProjectBuildingRequest(), pdr, artifactRepository );
+     *  }
      * </pre>
      *
      * @param buildingRequest {@link ProjectBuildingRequest}
diff --git a/src/main/java/org/apache/maven/shared/transfer/project/install/ProjectInstaller.java b/src/main/java/org/apache/maven/shared/transfer/project/install/ProjectInstaller.java
index 9ad0d02..40e2f63 100644
--- a/src/main/java/org/apache/maven/shared/transfer/project/install/ProjectInstaller.java
+++ b/src/main/java/org/apache/maven/shared/transfer/project/install/ProjectInstaller.java
@@ -37,19 +37,22 @@ public interface ProjectInstaller
      * the appropriate repository.
      *
      * <pre class="java">
-     *  &#64;Parameter( defaultValue = "${session}", required=true, readonly = true)
+     *  &#64;Parameter( defaultValue = "${session}", required = true, readonly = true )
      *  private MavenSession session;
-     *  &#64;Parameter( defaultValue = "${project}", required=true, readonly = true)
+     *  &#64;Parameter( defaultValue = "${project}", required = true, readonly = true )
      *  private MavenProject project;
      *  ..
      *  &#64;Component
      *  private ProjectInstaller installer;
-     *  
+     *  ...
+     *  public void execute()
+     *  {
      *    ProjectInstallerRequest pir =
      *      new ProjectInstallerRequest()
      *         .setProject( mavenProject );
-     *  
-     *  installer.install( session.getProjectBuildingRequest(), pir );
+     *
+     *    installer.install( session.getProjectBuildingRequest(), pir );
+     *  }
      * </pre>
      *
      * To set a different local repository than the current one in the Maven session, you can inject an instance of the
diff --git a/src/site/apt/comparison.apt.vm b/src/site/apt/comparison.apt
similarity index 91%
rename from src/site/apt/comparison.apt.vm
rename to src/site/apt/comparison.apt
index 25a4091..82113d4 100644
--- a/src/site/apt/comparison.apt.vm
+++ b/src/site/apt/comparison.apt
@@ -34,7 +34,7 @@ Comparison: Dependency vs Artifact vs MavenProject
   
   * an Artifact holds a file mapped on a certain coordinate (GAV + classifier + extension),
   
-  * a {{{/ref/current/maven-model/maven.html#class_dependency}}Dependency} contains an artifact and has transitive information,
+  * a {{{/ref/current/maven-model/maven.html#class_dependency}Dependency}} contains an artifact and has transitive information,
   
   * a MavenProject holds a pom-file, an optional main file derived from the packaging, and can have attached files (= with classifier and extension), all using the same GAV.
 
@@ -45,7 +45,7 @@ Comparison: Dependency vs Artifact vs MavenProject
 *--------------------+-------------+----------------+---------------+
 | Has dependencies   | yes         | no             | yes           |
 *--------------------+-------------+----------------+---------------+
-| filetype reference | {{{/ref/current/maven-core/artifact-handlers.html}}type} | file extension | packaging     |
+| filetype reference | {{{/ref/current/maven-core/artifact-handlers.html}type}} | file extension | packaging     |
 *--------------------+-------------+----------------+---------------+
 | version ranges     | yes         | no             | no            |
 *--------------------+-------------+----------------+---------------+
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index 1e09ffe..71d4b93 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -38,6 +38,9 @@ ${project.name}
   how to use this component to make an install of an existing project,
   which makes the handling within plugins much easier.
 
+  The {{{./deploy-project.html} deploy project}} page will show
+  how to use this component to make a deploy of an existing project.
+
   <<Current State Of The Component>>
   Currently this shared component has not yet reached the final 1.0.0 version state, which means the interfaces can
   change.