Author: khmarbaise
Date: Sun Aug 23 16:27:17 2015
New Revision: 1697215
URL: http://svn.apache.org/r1697215
Log:
Fixing some javadoc warnings.
Modified:
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.java
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedDependencies.java
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireEnvironmentVariable.java
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireNoRepositories.java
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequirePluginVersions.java
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseDeps.java
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseVersion.java
Modified:
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.java
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.java?rev=1697215&r1=1697214&r2=1697215&view=diff
==============================================================================
---
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.java
(original)
+++
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.java
Sun Aug 23 16:27:17 2015
@@ -57,7 +57,7 @@ public abstract class AbstractPropertyEn
/**
* 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 )
{
Modified:
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedDependencies.java
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedDependencies.java?rev=1697215&r1=1697214&r2=1697215&view=diff
==============================================================================
---
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedDependencies.java
(original)
+++
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/BannedDependencies.java
Sun Aug 23 16:27:17 2015
@@ -173,7 +173,7 @@ public class BannedDependencies
* 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 @@ public class BannedDependencies
* 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 )
Modified:
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireEnvironmentVariable.java
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireEnvironmentVariable.java?rev=1697215&r1=1697214&r2=1697215&view=diff
==============================================================================
---
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireEnvironmentVariable.java
(original)
+++
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireEnvironmentVariable.java
Sun Aug 23 16:27:17 2015
@@ -39,8 +39,8 @@ public class RequireEnvironmentVariable
/**
* @param variableName the variable name
*
- * @see {@link #setVariableName(String)}
- * @see {@link #getVariableName()}
+ * @see #setVariableName(String)
+ * @see #getVariableName()
*/
public final void setVariableName( String variableName )
{
Modified:
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireNoRepositories.java
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireNoRepositories.java?rev=1697215&r1=1697214&r2=1697215&view=diff
==============================================================================
---
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireNoRepositories.java
(original)
+++
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireNoRepositories.java
Sun Aug 23 16:27:17 2015
@@ -48,35 +48,35 @@ public class RequireNoRepositories
/**
* 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 @@ public class RequireNoRepositories
* @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
)
Modified:
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequirePluginVersions.java
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequirePluginVersions.java?rev=1697215&r1=1697214&r2=1697215&view=diff
==============================================================================
---
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequirePluginVersions.java
(original)
+++
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequirePluginVersions.java
Sun Aug 23 16:27:17 2015
@@ -373,7 +373,7 @@ public class RequirePluginVersions
* @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 @@ public class RequirePluginVersions
*
* @param uncheckedPlugins
* @param uncheckedPluginsList
- * @return
+ * @return List of unchecked plugins.
*/
// CHECKSTYLE_OFF: LineLength
public Collection<String> combineUncheckedPlugins( Collection<String>
uncheckedPlugins, String uncheckedPluginsList )
Modified:
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseDeps.java
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseDeps.java?rev=1697215&r1=1697214&r2=1697215&view=diff
==============================================================================
---
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseDeps.java
(original)
+++
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseDeps.java
Sun Aug 23 16:27:17 2015
@@ -125,7 +125,7 @@ public class RequireReleaseDeps
/**
* @param helper
- * @return
+ * @return The evaluated {@link MavenProject}.
* @throws EnforcerRuleException
*/
private MavenProject getProject( EnforcerRuleHelper helper )
Modified:
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseVersion.java
URL:
http://svn.apache.org/viewvc/maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseVersion.java?rev=1697215&r1=1697214&r2=1697215&view=diff
==============================================================================
---
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseVersion.java
(original)
+++
maven/enforcer/trunk/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireReleaseVersion.java
Sun Aug 23 16:27:17 2015
@@ -79,7 +79,7 @@ public class RequireReleaseVersion
/**
* @param helper
- * @return
+ * @return The evaluated {@link MavenProject}.
* @throws EnforcerRuleException
*/
private MavenProject getProject( EnforcerRuleHelper helper )
