fixed/improved javadoc
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk@1791694 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojo.java b/src/main/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojo.java
index dd2bfaf..2f37d00 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojo.java
@@ -395,7 +395,7 @@
* Convert a groupId:artifactId:version to a file system path
*
* @param gav, the groupId:artifactId:version string
- * @return
+ * @return the corresponding path
*/
private String gavToPath( String gav )
{
@@ -422,7 +422,7 @@
*
* @param dependencyArtifacts The dependency artifacts to use as a reference if we're excluding transitive
* dependencies
- * @return
+ * @return the created filter
*/
private TransformableFilter createPurgeArtifactsFilter( Set<Artifact> dependencyArtifacts )
{
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java
index 99d9b45..06605e2 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/AbstractFromConfigurationMojo.java
@@ -128,9 +128,7 @@
* Preprocesses the list of ArtifactItems. This method defaults the outputDirectory if not set and creates the
* output Directory if it doesn't exist.
*
- * @param removeVersion remove the version from the filename.
- * @param prependGroupId prepend the groupId to the filename.
- * @param useBaseVersion use the baseVersion of the artifact instead of version for the filename.
+ * @param processArtifactItemsRequest preprocessing instructions
* @return An ArrayList of preprocessed ArtifactItems
* @throws MojoExecutionException with a message if an error occurs.
* @see ArtifactItem
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java
index 2f89269..5c30b08 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java
@@ -156,7 +156,7 @@
}
/**
- * @param artifactId
+ * @param artifact
* The artifactId to set.
*/
public void setArtifactId( String artifact )
@@ -263,8 +263,8 @@
}
/**
- * @param location
- * The location to set.
+ * @param outputDirectory
+ * The outputDirectory to set.
*/
public void setOutputDirectory( File outputDirectory )
{
@@ -314,8 +314,8 @@
}
/**
- * @param overWriteSnapshots
- * The overWriteSnapshots to set.
+ * @param overWrite
+ * The overWrite to set.
*/
public void setOverWrite( String overWrite )
{
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java
index bfb0d49..a8f6110 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/CopyMojo.java
@@ -125,8 +125,7 @@
*
* @param artifactItem containing the information about the Artifact to copy.
* @throws MojoExecutionException with a message if an error occurs.
- * @see DependencyUtil#copyFile(File, File, Log)
- * @see DependencyUtil#getFormattedFileName(Artifact, boolean)
+ * @see #copyFile(File, File)
*/
protected void copyArtifact( ArtifactItem artifactItem )
throws MojoExecutionException
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java
index 0f3bb47..e796284 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/UnpackMojo.java
@@ -52,9 +52,10 @@
private File markersDirectory;
/**
- * A comma separated list of file patterns to include when unpacking the artifact. i.e. **\/*.xml,**\/*.properties
- * NOTE: Excludes patterns override the includes. (component code = return isIncluded( name ) AND !isExcluded( name
- * );)
+ * A comma separated list of file patterns to include when unpacking the artifact. i.e.
+ * <code>**/*.xml,**/*.properties</code>
+ * NOTE: Excludes patterns override the includes.
+ * (component code = <code>return isIncluded( name ) AND !isExcluded( name );</code>)
*
* @since 2.0-alpha-5
*/
@@ -63,8 +64,9 @@
/**
* A comma separated list of file patterns to exclude when unpacking the artifact. i.e. **\/*.xml,**\/*.properties
- * NOTE: Excludes patterns override the includes. (component code = return isIncluded( name ) AND !isExcluded( name
- * );)
+ * <code>**/*.xml,**/*.properties</code>
+ * NOTE: Excludes patterns override the includes.
+ * (component code = <code>return isIncluded( name ) AND !isExcluded( name );</code>)
*
* @since 2.0-alpha-5
*/
@@ -73,7 +75,7 @@
/**
* The artifact to unpack from command line. A string of the form
- * groupId:artifactId:version[:packaging[:classifier]]. Use {@link #artifactItems} within the
+ * <code>groupId:artifactId:version[:packaging[:classifier]]</code>. Use {@link #artifactItems} within the
* POM configuration.
*/
@SuppressWarnings( "unused" ) //marker-field, setArtifact(String) does the magic
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
index 1f41612..7fd1505 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
@@ -433,7 +433,7 @@
* Filter the marked dependencies
*
* @param artifacts
- * @return
+ * @return status set
* @throws MojoExecutionException
*/
protected DependencyStatusSets filterMarkedDependencies( Set<Artifact> artifacts )
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/BuildClasspathMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/BuildClasspathMojo.java
index 119e898..a441007 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/BuildClasspathMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/BuildClasspathMojo.java
@@ -163,11 +163,10 @@
private RepositoryManager repositoryManager;
/**
- * Main entry into mojo. Gets the list of dependencies and iterates through calling copyArtifact.
+ * Main entry into mojo. Gets the list of dependencies and iterates to create a classpath.
*
* @throws MojoExecutionException with a message if an error occurs.
- * @see #getDependencies
- * @see #copyArtifact(Artifact, boolean)
+ * @see #getResolvedDependencies(boolean)
*/
@Override
protected void doExecute()
@@ -429,7 +428,7 @@
}
/**
- * @param theCpFile the outputFile to set
+ * @param outputFile the outputFile to set
*/
public void setOutputFile( File outputFile )
{
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/CopyDependenciesMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/CopyDependenciesMojo.java
index c1c99ae..563dc8f 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/CopyDependenciesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/CopyDependenciesMojo.java
@@ -108,8 +108,8 @@
* calling copyArtifact.
*
* @throws MojoExecutionException with a message if an error occurs.
- * @see #getDependencies
- * @see #copyArtifact(Artifact, boolean)
+ * @see #getDependencySets(boolean, boolean)
+ * @see #copyArtifact(Artifact, boolean, boolean, boolean, boolean)
*/
@Override
protected void doExecute()
@@ -210,8 +210,7 @@
* @param prependGroupId specifies if the groupId should be prepend to the file while copying.
* @param useBaseVersion specifies if the baseVersion of the artifact should be used instead of the version.
* @throws MojoExecutionException with a message if an error occurs.
- * @see DependencyUtil#copyFile(File, File, Log)
- * @see DependencyUtil#getFormattedFileName(Artifact, boolean)
+ * @see #copyArtifact(Artifact, boolean, boolean, boolean, boolean)
*/
protected void copyArtifact( Artifact artifact, boolean removeVersion, boolean prependGroupId,
boolean useBaseVersion )
@@ -232,8 +231,8 @@
* @param useBaseVersion specifies if the baseVersion of the artifact should be used instead of the version.
* @param removeClassifier specifies if the classifier should be removed from the file name when copying.
* @throws MojoExecutionException with a message if an error occurs.
- * @see DependencyUtil#copyFile(File, File, Log)
- * @see DependencyUtil#getFormattedFileName(Artifact, boolean)
+ * @see #copyFile(File, File)
+ * @see DependencyUtil#getFormattedOutputDirectory(boolean, boolean, boolean, boolean, boolean, File, Artifact)
*/
protected void copyArtifact( Artifact artifact, boolean removeVersion, boolean prependGroupId,
boolean useBaseVersion, boolean removeClassifier )
diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/UnpackDependenciesMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/UnpackDependenciesMojo.java
index 52b684d..32f59b1 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/UnpackDependenciesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/UnpackDependenciesMojo.java
@@ -48,7 +48,7 @@
{
/**
* A comma separated list of file patterns to include when unpacking the
- * artifact. i.e. <code>**\/*.xml,**\/*.properties</code>
+ * artifact. i.e. <code>**/*.xml,**/*.properties</code>
* NOTE: Excludes patterns override the includes.
* (component code = <code>return isIncluded( name ) AND !isExcluded( name );</code>)
*
@@ -59,7 +59,7 @@
/**
* A comma separated list of file patterns to exclude when unpacking the
- * artifact. i.e. <code>**\/*.xml,**\/*.properties</code>
+ * artifact. i.e. <code>**/*.xml,**/*.properties</code>
* NOTE: Excludes patterns override the includes.
* (component code = <code>return isIncluded( name ) AND !isExcluded( name );</code>)
*
@@ -80,9 +80,8 @@
* through each one passing it to DependencyUtil.unpackFile().
*
* @throws MojoExecutionException with a message if an error occurs.
- * @see #getDependencies
- * @see DependencyUtil#unpackFile(Artifact, File, File, ArchiverManager,
- * Log)
+ * @see #getDependencySets(boolean)
+ * @see #unpack(Artifact, File, String)
*/
@Override
protected void doExecute()
diff --git a/src/main/java/org/apache/maven/plugins/dependency/tree/GraphmlDependencyNodeVisitor.java b/src/main/java/org/apache/maven/plugins/dependency/tree/GraphmlDependencyNodeVisitor.java
index bb1e308..da90d0a 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/tree/GraphmlDependencyNodeVisitor.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/tree/GraphmlDependencyNodeVisitor.java
@@ -25,9 +25,9 @@
import org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor;
/**
- * A dependency node visitor that serializes visited nodes to a writer using the graphml format.
- * {@link http://graphml.graphdrawing.org/}
- *
+ * A dependency node visitor that serializes visited nodes to a writer using the
+ * <a href="http://graphml.graphdrawing.org/">graphml format</a>.
+ *
* @author <a href="mailto:jerome.creignou@gmail.com">Jerome Creignou</a>
* @since 2.1
*/
diff --git a/src/main/java/org/apache/maven/plugins/dependency/utils/DependencyUtil.java b/src/main/java/org/apache/maven/plugins/dependency/utils/DependencyUtil.java
index 73c9d63..3feec7c 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/utils/DependencyUtil.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/utils/DependencyUtil.java
@@ -47,7 +47,7 @@
* @param artifact File to be formatted.
* @param removeVersion Specifies if the version should be removed from the file name.
* @return Formatted file name in the format artifactId-[version]-[classifier].[type]
- * @see {@link #getFormattedFileName(Artifact, boolean, boolean)}.
+ * @see #getFormattedFileName(Artifact, boolean, boolean)
*/
public static String getFormattedFileName( Artifact artifact, boolean removeVersion )
{
