commit 587080378bcc2761b5d2e509182a729dca8dfb8c
author Hervé Boutemy <hboutemy@apache.org> Sun Dec 01 15:04:14 2019 +0100
committer Hervé Boutemy <hboutemy@apache.org> Sun Dec 01 15:04:14 2019 +0100
tree 9f4c27bd588be583cee925e25a8a50d1b34e6d0c
parent 01becbd70b331dea1ac7b2b15b7f3532bc706cdd

formatting & little typos fixes

src/main/java/org/apache/maven/shared/transfer/project/deploy/ProjectDeployer.java

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

src/main/java/org/apache/maven/shared/transfer/project/install/ProjectInstaller.java

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

src/site/apt/comparison.apt

diff --git a/src/site/apt/comparison.apt.vm b/src/site/apt/comparison.apt
similarity index 93%
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 @@
   

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

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

 *--------------------+-------------+----------------+---------------+

src/site/apt/index.apt.vm

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