Fix Javadoc warnings

This commit is contained in:
rfscholte 2013-05-28 23:29:01 +02:00
parent bd6beaa925
commit 4cc6a3fdef
10 changed files with 12 additions and 12 deletions

View File

@ -25,8 +25,7 @@ import org.apache.maven.plugin.MojoFailureException;
* Exception which occurs when a normal (i.e. non-aggregator) mojo fails to * 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 * execute. In this case, the mojo failed while executing against a particular
* project instance, so we can wrap the {@link MojoFailureException} with context * project instance, so we can wrap the {@link MojoFailureException} with context
* information including projectId and the {@link MojoBinding} that caused the * information including projectId that caused the failure.
* failure.
* *
* @author jdcasey * @author jdcasey
* *

View File

@ -64,7 +64,7 @@ public interface ClassRealmManager
/** /**
* Creates a new class realm for the specified build extension. * 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 * @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. * missing file) will automatically be excluded from the realm.
* @return The new extension realm, never {@code null}. * @return The new extension realm, never {@code null}.

View File

@ -74,7 +74,7 @@ public interface BeanConfigurationRequest
/** /**
* Returns configuration element name or {@code null}. * Returns configuration element name or {@code null}.
* *
* @see {@link #setConfiguration(Object, String)} * @see #setConfiguration(Object, String)
* *
* @return Configuration element name or {@code null} * @return Configuration element name or {@code null}
*/ */

View File

@ -54,13 +54,13 @@ public interface EventSpy
/** /**
* Notifies the spy of some build event/operation. * 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.SettingsBuildingRequest
* @see org.apache.maven.settings.building.SettingsBuildingResult * @see org.apache.maven.settings.building.SettingsBuildingResult
* @see org.apache.maven.execution.MavenExecutionRequest * @see org.apache.maven.execution.MavenExecutionRequest
* @see org.apache.maven.execution.MavenExecutionResult * @see org.apache.maven.execution.MavenExecutionResult
* @see org.apache.maven.project.DependencyResolutionRequest * @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.apache.maven.execution.ExecutionEvent
* @see org.eclipse.aether.RepositoryEvent * @see org.eclipse.aether.RepositoryEvent
*/ */

View File

@ -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. * mirrors then it's easier to just replace the whole list with a new list of transformed repositories.
* *
* @param repositories * @param repositories
* @return * @return This request, never {@code null}.
*/ */
MavenExecutionRequest setRemoteRepositories( List<ArtifactRepository> repositories ); MavenExecutionRequest setRemoteRepositories( List<ArtifactRepository> repositories );
List<ArtifactRepository> getRemoteRepositories(); List<ArtifactRepository> getRemoteRepositories();

View File

@ -51,7 +51,8 @@ public class DefaultBuildPluginManager
/** /**
* *
* @param plugin * @param plugin
* @param repositoryRequest * @param repositories
* @param session
* @return PluginDescriptor The component descriptor for the Maven plugin. * @return PluginDescriptor The component descriptor for the Maven plugin.
* @throws PluginNotFoundException The plugin could not be found in any repositories. * @throws PluginNotFoundException The plugin could not be found in any repositories.
* @throws PluginResolutionException The plugin could be found but could not be resolved. * @throws PluginResolutionException The plugin could be found but could not be resolved.

View File

@ -61,7 +61,7 @@ public class DefaultPluginVersionRequest
* has a current project, its plugin repositories will be used as well. * 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 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 ) public DefaultPluginVersionRequest( Plugin plugin, MavenSession session )
{ {

View File

@ -65,7 +65,7 @@ public interface ArtifactMetadataSource
* needed, for instance the following code will work * needed, for instance the following code will work
* <code>artifactFactory.createProjectArtifact( "org.apache.maven", "maven", "" )</code> * <code>artifactFactory.createProjectArtifact( "org.apache.maven", "maven", "" )</code>
* @param localRepository local repository * @param localRepository local repository
* @param deploymentRepository remote repository * @param remoteRepository remote repository
* @return {@link List} $lt; {@link ArtifactVersion} > * @return {@link List} $lt; {@link ArtifactVersion} >
* @throws ArtifactMetadataRetrievalException * @throws ArtifactMetadataRetrievalException
* in case of error while retrieving repository metadata from the repository. * in case of error while retrieving repository metadata from the repository.

View File

@ -48,7 +48,7 @@ public final class SettingsUtils
} }
/** /**
* @param settingsProfile * @param modelProfile
* @return a profile * @return a profile
*/ */
public static Profile convertToSettingsProfile( org.apache.maven.model.Profile modelProfile ) public static Profile convertToSettingsProfile( org.apache.maven.model.Profile modelProfile )

View File

@ -35,7 +35,7 @@ public interface ToolchainPrivate
* Let the toolchain decide if it matches requirements defined * Let the toolchain decide if it matches requirements defined
* in the toolchain plugin configuration. * in the toolchain plugin configuration.
* @param requirements Map<String, String> key value pair * @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 ); boolean matchesRequirements( Map<String, String> requirements );