svn commit: r1760335 - in /maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy: ProjectDeployer.java internal/DefaultProjectDeployer.java

[khmarbaise]

Author: khmarbaise
Date: Mon Sep 12 11:23:35 2016
New Revision: 1760335

URL: http://svn.apache.org/viewvc?rev=1760335&view=rev
Log:
Added some docs.

Modified:
    
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java
    
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java

Modified: 
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java
URL: 
http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java?rev=1760335&r1=1760334&r2=1760335&view=diff
==============================================================================
--- 
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java
 (original)
+++ 
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java
 Mon Sep 12 11:23:35 2016
@@ -33,10 +33,28 @@ public interface ProjectDeployer
      * This will deploy a single project which may contain several artifacts. 
Those artifacts will be deployed into the
      * appropriate remote repository.
      * 
+     * <pre class="java">
+     *  ..
+     *  MavenSession session;
+     *  MavenProject project;
+     *  ..
+     *  &#64;Inject
+     *  ProjectDeployer deployer;
+     *  
+     *  ProjectBuildingRequest pbr = 
+     *    new ProjectBuildingRequest()
+     *    .setProject (project)
+     *    .setUpdateReleaseInfo( true );
+     *    
+     *  deployer.deploy (session.getProjectBuildingRequest(), pbr, 
artifactRepository);
+     *  
+     * </pre>
+     * 
      * @param buildingRequest {@link ProjectBuildingRequest}
      * @param request {@link ProjectDeployerRequest}
      * @param artifactRepository {@link ArtifactRepository}
      */
     void deployProject( ProjectBuildingRequest buildingRequest, 
ProjectDeployerRequest request,
                         ArtifactRepository artifactRepository );
+
 }

Modified: 
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java
URL: 
http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java?rev=1760335&r1=1760334&r2=1760335&view=diff
==============================================================================
--- 
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java
 (original)
+++ 
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java
 Mon Sep 12 11:23:35 2016
@@ -110,11 +110,13 @@ public class DefaultProjectDeployer impl
                 }
                 else if ( !attachedArtifacts.isEmpty() )
                 {
+                    //TODO: Reconsider this exception? Better Exception type?
                     throw new IllegalArgumentException( "The packaging plugin 
for this project did not assign "
                         + "a main file to the project but it has attachments. 
Change packaging to 'pom'." );
                 }
                 else
                 {
+                    //TODO: Reconsider this exception? Better Exception type?
                     throw new IllegalArgumentException( "The packaging for 
this project did not assign "
                         + "a file to the build artifact" );
                 }