Fix Javadoc warnings
Project: http://git-wip-us.apache.org/repos/asf/maven/repo Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/4cc6a3fd Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/4cc6a3fd Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/4cc6a3fd Branch: refs/heads/slf4j-logback Commit: 4cc6a3fdef10dc87a81086ad3920b35a0ab31d67 Parents: bd6beaa Author: rfscholte <rfscho...@apache.org> Authored: Tue May 28 23:29:01 2013 +0200 Committer: rfscholte <rfscho...@apache.org> Committed: Tue May 28 23:29:01 2013 +0200 ---------------------------------------------------------------------- .../main/java/org/apache/maven/ProjectBuildFailureException.java | 3 +-- .../main/java/org/apache/maven/classrealm/ClassRealmManager.java | 2 +- .../org/apache/maven/configuration/BeanConfigurationRequest.java | 2 +- maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java | 4 ++-- .../java/org/apache/maven/execution/MavenExecutionRequest.java | 2 +- .../java/org/apache/maven/plugin/DefaultBuildPluginManager.java | 3 ++- .../apache/maven/plugin/version/DefaultPluginVersionRequest.java | 2 +- .../maven/repository/legacy/metadata/ArtifactMetadataSource.java | 2 +- .../src/main/java/org/apache/maven/settings/SettingsUtils.java | 2 +- .../main/java/org/apache/maven/toolchain/ToolchainPrivate.java | 2 +- 10 files changed, 12 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/maven/blob/4cc6a3fd/maven-core/src/main/java/org/apache/maven/ProjectBuildFailureException.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/ProjectBuildFailureException.java b/maven-core/src/main/java/org/apache/maven/ProjectBuildFailureException.java index 480f9c5..66ed3a0 100644 --- a/maven-core/src/main/java/org/apache/maven/ProjectBuildFailureException.java +++ b/maven-core/src/main/java/org/apache/maven/ProjectBuildFailureException.java @@ -25,8 +25,7 @@ import org.apache.maven.plugin.MojoFailureException; * Exception which occurs when a normal (i.e. non-aggregator) mojo fails to * execute. In this case, the mojo failed while executing against a particular * project instance, so we can wrap the {@link MojoFailureException} with context - * information including projectId and the {@link MojoBinding} that caused the - * failure. + * information including projectId that caused the failure. * * @author jdcasey * http://git-wip-us.apache.org/repos/asf/maven/blob/4cc6a3fd/maven-core/src/main/java/org/apache/maven/classrealm/ClassRealmManager.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/classrealm/ClassRealmManager.java b/maven-core/src/main/java/org/apache/maven/classrealm/ClassRealmManager.java index a09f1b0..9391f6a 100644 --- a/maven-core/src/main/java/org/apache/maven/classrealm/ClassRealmManager.java +++ b/maven-core/src/main/java/org/apache/maven/classrealm/ClassRealmManager.java @@ -64,7 +64,7 @@ public interface ClassRealmManager /** * Creates a new class realm for the specified build extension. * - * @param plugin The extension plugin for which to create a realm, must not be {@code null}. + * @param extension The extension plugin for which to create a realm, must not be {@code null}. * @param artifacts The artifacts to add to the class realm, may be {@code null}. Unresolved artifacts (i.e. with a * missing file) will automatically be excluded from the realm. * @return The new extension realm, never {@code null}. http://git-wip-us.apache.org/repos/asf/maven/blob/4cc6a3fd/maven-core/src/main/java/org/apache/maven/configuration/BeanConfigurationRequest.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/configuration/BeanConfigurationRequest.java b/maven-core/src/main/java/org/apache/maven/configuration/BeanConfigurationRequest.java index a79082e..6f3f2fe 100644 --- a/maven-core/src/main/java/org/apache/maven/configuration/BeanConfigurationRequest.java +++ b/maven-core/src/main/java/org/apache/maven/configuration/BeanConfigurationRequest.java @@ -74,7 +74,7 @@ public interface BeanConfigurationRequest /** * Returns configuration element name or {@code null}. * - * @see {@link #setConfiguration(Object, String)} + * @see #setConfiguration(Object, String) * * @return Configuration element name or {@code null} */ http://git-wip-us.apache.org/repos/asf/maven/blob/4cc6a3fd/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java b/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java index 5555ee2..3b4115c 100644 --- a/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java +++ b/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java @@ -54,13 +54,13 @@ public interface EventSpy /** * Notifies the spy of some build event/operation. * - * @param event The event, never {@@code null}. + * @param event The event, never {@code null}. * @see org.apache.maven.settings.building.SettingsBuildingRequest * @see org.apache.maven.settings.building.SettingsBuildingResult * @see org.apache.maven.execution.MavenExecutionRequest * @see org.apache.maven.execution.MavenExecutionResult * @see org.apache.maven.project.DependencyResolutionRequest - * @see org.apache.maven.project.DependencyResolutionResultt + * @see org.apache.maven.project.DependencyResolutionResult * @see org.apache.maven.execution.ExecutionEvent * @see org.eclipse.aether.RepositoryEvent */ http://git-wip-us.apache.org/repos/asf/maven/blob/4cc6a3fd/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java b/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java index 3db6795..a3160fe 100644 --- a/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java +++ b/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java @@ -261,7 +261,7 @@ public interface MavenExecutionRequest * mirrors then it's easier to just replace the whole list with a new list of transformed repositories. * * @param repositories - * @return + * @return This request, never {@code null}. */ MavenExecutionRequest setRemoteRepositories( List<ArtifactRepository> repositories ); List<ArtifactRepository> getRemoteRepositories(); http://git-wip-us.apache.org/repos/asf/maven/blob/4cc6a3fd/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManager.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManager.java b/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManager.java index 5caba5a..178f4c8 100644 --- a/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManager.java +++ b/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManager.java @@ -51,7 +51,8 @@ public class DefaultBuildPluginManager /** * * @param plugin - * @param repositoryRequest + * @param repositories + * @param session * @return PluginDescriptor The component descriptor for the Maven plugin. * @throws PluginNotFoundException The plugin could not be found in any repositories. * @throws PluginResolutionException The plugin could be found but could not be resolved. http://git-wip-us.apache.org/repos/asf/maven/blob/4cc6a3fd/maven-core/src/main/java/org/apache/maven/plugin/version/DefaultPluginVersionRequest.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/plugin/version/DefaultPluginVersionRequest.java b/maven-core/src/main/java/org/apache/maven/plugin/version/DefaultPluginVersionRequest.java index a1f116b..b672090 100644 --- a/maven-core/src/main/java/org/apache/maven/plugin/version/DefaultPluginVersionRequest.java +++ b/maven-core/src/main/java/org/apache/maven/plugin/version/DefaultPluginVersionRequest.java @@ -61,7 +61,7 @@ public class DefaultPluginVersionRequest * has a current project, its plugin repositories will be used as well. * * @param plugin The plugin for which to resolve a version, must not be {@code null}. - * @param repositoryRequest The repository request to copy from, must not be {@code null}. + * @param session The Maven session to use, must not be {@code null}. */ public DefaultPluginVersionRequest( Plugin plugin, MavenSession session ) { http://git-wip-us.apache.org/repos/asf/maven/blob/4cc6a3fd/maven-core/src/main/java/org/apache/maven/repository/legacy/metadata/ArtifactMetadataSource.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/repository/legacy/metadata/ArtifactMetadataSource.java b/maven-core/src/main/java/org/apache/maven/repository/legacy/metadata/ArtifactMetadataSource.java index a3fac63..aaa0ee3 100644 --- a/maven-core/src/main/java/org/apache/maven/repository/legacy/metadata/ArtifactMetadataSource.java +++ b/maven-core/src/main/java/org/apache/maven/repository/legacy/metadata/ArtifactMetadataSource.java @@ -65,7 +65,7 @@ public interface ArtifactMetadataSource * needed, for instance the following code will work * <code>artifactFactory.createProjectArtifact( "org.apache.maven", "maven", "" )</code> * @param localRepository local repository - * @param deploymentRepository remote repository + * @param remoteRepository remote repository * @return {@link List} $lt; {@link ArtifactVersion} > * @throws ArtifactMetadataRetrievalException * in case of error while retrieving repository metadata from the repository. http://git-wip-us.apache.org/repos/asf/maven/blob/4cc6a3fd/maven-core/src/main/java/org/apache/maven/settings/SettingsUtils.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/settings/SettingsUtils.java b/maven-core/src/main/java/org/apache/maven/settings/SettingsUtils.java index aacce44..8da696e 100644 --- a/maven-core/src/main/java/org/apache/maven/settings/SettingsUtils.java +++ b/maven-core/src/main/java/org/apache/maven/settings/SettingsUtils.java @@ -48,7 +48,7 @@ public final class SettingsUtils } /** - * @param settingsProfile + * @param modelProfile * @return a profile */ public static Profile convertToSettingsProfile( org.apache.maven.model.Profile modelProfile ) http://git-wip-us.apache.org/repos/asf/maven/blob/4cc6a3fd/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainPrivate.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainPrivate.java b/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainPrivate.java index 571ed33..b104cd0 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainPrivate.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainPrivate.java @@ -35,7 +35,7 @@ public interface ToolchainPrivate * Let the toolchain decide if it matches requirements defined * in the toolchain plugin configuration. * @param requirements Map<String, String> key value pair - * @return + * @return {@code true} if the requirements match, otherwise {@code false} */ boolean matchesRequirements( Map<String, String> requirements );
