Added some docs.
git-svn-id: https://svn.apache.org/repos/asf/maven/shared/trunk@1760335 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java b/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java
index 76ab6c1..cbd5318 100644
--- a/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java
+++ b/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java
@@ -33,10 +33,28 @@
* 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;
+ * ..
+ * @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 );
+
}
diff --git a/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java b/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java
index 5e6130a..11c3b38 100644
--- a/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java
+++ b/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java
@@ -110,11 +110,13 @@
}
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" );
}
