Fixing some javadoc warnings.
git-svn-id: https://svn.apache.org/repos/asf/maven/enforcer/trunk@1697215 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.java b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.java
index 47b9794..afffc55 100755
--- a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.java
@@ -57,7 +57,7 @@
/**
* Set the property value to a given regular expression. Defaults to <code>null</code> (any value is ok).
*
- * @param the regular expression
+ * @param regex The regular expression
*/
public final void setRegex( String regex )
{
diff --git a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedDependencies.java b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedDependencies.java
index 0eb33b3..25ed2dd 100644
--- a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedDependencies.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedDependencies.java
@@ -173,7 +173,7 @@
* The rule will fail if any dependency matches any exclude, unless it also matches an
* include rule.
*
- * @see {@link #getExcludes()}
+ * @see #getExcludes()
* @param theExcludes the excludes to set
*/
public void setExcludes( List<String> theExcludes )
@@ -201,7 +201,7 @@
* For example, to ban all xerces except xerces-api -> exclude "xerces",
* include "xerces:xerces-api"
*
- * @see {@link #setIncludes(List)}
+ * @see #setIncludes(List)
* @param theIncludes the includes to set
*/
public void setIncludes( List<String> theIncludes )
diff --git a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireEnvironmentVariable.java b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireEnvironmentVariable.java
index 4936d30..32845de 100755
--- a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireEnvironmentVariable.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireEnvironmentVariable.java
@@ -39,8 +39,8 @@
/**
* @param variableName the variable name
*
- * @see {@link #setVariableName(String)}
- * @see {@link #getVariableName()}
+ * @see #setVariableName(String)
+ * @see #getVariableName()
*/
public final void setVariableName( String variableName )
{
diff --git a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireNoRepositories.java b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireNoRepositories.java
index 03dea71..bc225b7 100644
--- a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireNoRepositories.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireNoRepositories.java
@@ -48,35 +48,35 @@
/**
* Whether to ban non-plugin repositories. By default they are banned.
*
- * @see {@link #setBanRepositories(boolean)}
+ * @see #setBanRepositories(boolean)
*/
private boolean banRepositories = true;
/**
* Whether to ban plugin repositories. By default they are banned.
*
- * @see {@link #setBanPluginRepositories(boolean)}
+ * @see #setBanPluginRepositories(boolean)
*/
private boolean banPluginRepositories = true;
/**
* Specify explicitly allowed non-plugin repositories. This is a list of ids.
*
- * @see {@link #setAllowedRepositories(List)}
+ * @see #setAllowedRepositories(List)
*/
private List<String> allowedRepositories = Collections.emptyList();
/**
* Specify explicitly allowed plugin repositories. This is a list of ids.
*
- * @see {@link #setAllowedPluginRepositories(List)}
+ * @see #setAllowedPluginRepositories(List)
*/
private List<String> allowedPluginRepositories = Collections.emptyList();
/**
* Whether to allow repositories which only resolve snapshots. By default they are banned.
*
- * @see {@link #setAllowSnapshotRepositories(boolean)}
+ * @see #setAllowSnapshotRepositories(boolean)
*/
private boolean allowSnapshotRepositories = false;
@@ -215,7 +215,7 @@
* @param repos all repositories, never {@code null}
* @param allowedRepos allowed repositories, never {@code null}
* @param allowSnapshots
- * @return
+ * @return List of banned repositoreis.
*/
private static List<String> findBannedRepositories( List<Repository> repos, List<String> allowedRepos,
boolean allowSnapshots )
diff --git a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequirePluginVersions.java b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequirePluginVersions.java
index fcc7be3..fc65fb2 100644
--- a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequirePluginVersions.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequirePluginVersions.java
@@ -373,7 +373,7 @@
* @param uncheckedPlugins
* @param plugins
* @throws MojoExecutionException
- * @return
+ * @return The plugins which have been removed.
*/
public Collection<Plugin> removeUncheckedPlugins( Collection<String> uncheckedPlugins, Collection<Plugin> plugins )
throws MojoExecutionException
@@ -394,7 +394,7 @@
*
* @param uncheckedPlugins
* @param uncheckedPluginsList
- * @return
+ * @return List of unchecked plugins.
*/
// CHECKSTYLE_OFF: LineLength
public Collection<String> combineUncheckedPlugins( Collection<String> uncheckedPlugins, String uncheckedPluginsList )
diff --git a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseDeps.java b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseDeps.java
index d9ad7bf..8e16513 100644
--- a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseDeps.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseDeps.java
@@ -125,7 +125,7 @@
/**
* @param helper
- * @return
+ * @return The evaluated {@link MavenProject}.
* @throws EnforcerRuleException
*/
private MavenProject getProject( EnforcerRuleHelper helper )
diff --git a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseVersion.java b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseVersion.java
index 7a5554f..d800ff4 100644
--- a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseVersion.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseVersion.java
@@ -79,7 +79,7 @@
/**
* @param helper
- * @return
+ * @return The evaluated {@link MavenProject}.
* @throws EnforcerRuleException
*/
private MavenProject getProject( EnforcerRuleHelper helper )
