stephenc
/
maven-plugin-tools
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fixed javadoc issues that caused warnings 

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1648942 13f79535-47bb-0310-9956-ffa450edef68
master
Herve Boutemy 2015-01-01 21:11:43 +00:00
parent e8dfae0cbc
commit 5ab96a0efb
8 changed files with 18 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Mojo.java
View File

@ -52,13 +52,13 @@ public @interface Mojo
/**
* the required dependency resolution scope.
* @return
* @return the required dependency resolution scope
*/
ResolutionScope requiresDependencyResolution() default ResolutionScope.NONE;
/**
* the required dependency collection scope.
* @return
* @return the required dependency collection scope
*/
ResolutionScope requiresDependencyCollection() default ResolutionScope.NONE;
@ -76,31 +76,31 @@ public @interface Mojo
/**
* does your mojo requires a project to be executed?
* @return
* @return requires a project
*/
boolean requiresProject() default true;
/**
* does your mojo requires a reporting context to be executed?
* @return
* @return requires a reporting context
*/
boolean requiresReports() default false;
/**
* if the Mojo uses the Maven project and its child modules.
* @return
* @return uses the Maven project and its child modules
*/
boolean aggregator() default false;
/**
* can this Mojo be invoked directly only?
* @return
* @return invoked directly only
*/
boolean requiresDirectInvocation() default false;
/**
* does this Mojo need to be online to be executed?
* @return
* @return need to be online
*/
boolean requiresOnline() default false;
@ -108,13 +108,13 @@ public @interface Mojo
/**
* own configurator class.
* @return
* @return own configurator class
*/
String configurator() default "";
/**
* is your mojo thread safe (since Maven 3.x)?
* @return
* @return is thread safe
*/
boolean threadSafe() default false;
}

4
maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/DefaultMojoAnnotationsScanner.java
View File

@ -115,7 +115,7 @@ public class DefaultMojoAnnotationsScanner
* @param archiveFile
* @param artifact
* @param excludeMojo for dependencies, we exclude Mojo annotations found
* @return
* @return annotated classes found
* @throws IOException
* @throws ExtractionException
*/
@ -152,7 +152,7 @@ public class DefaultMojoAnnotationsScanner
* @param includePatterns
* @param artifact
* @param excludeMojo for dependencies, we exclude Mojo annotations found
* @return
* @return annotated classes found
* @throws IOException
* @throws ExtractionException
*/

14
maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/PluginToolsRequest.java
View File

@ -85,7 +85,7 @@ public interface PluginToolsRequest
PluginToolsRequest setSkipErrorNoDescriptorsFound( boolean skipErrorNoDescriptorsFound );
/**
* @return
* @return <code>true</code> if no descriptor found should not cause a failure
* @since 3.0
*/
boolean isSkipErrorNoDescriptorsFound();
@ -93,21 +93,21 @@ public interface PluginToolsRequest
/**
* Returns the list of {@link Artifact} used in class path scanning for annotations
*
* @return
* @return the dependencies
* @since 3.0
*/
Set<Artifact> getDependencies();
/**
* @param dependencies
* @return
* @return This request.
* @since 3.0
*/
PluginToolsRequest setDependencies( Set<Artifact> dependencies );
/**
*
* @return
* @return the remote repositories
* @since 3.0
*/
List<ArtifactRepository> getRemoteRepos();
@ -115,14 +115,14 @@ public interface PluginToolsRequest
/**
*
* @param remoteRepos
* @return
* @return This request.
* @since 3.0
*/
PluginToolsRequest setRemoteRepos( List<ArtifactRepository> remoteRepos );
/**
*
* @return
* @return the local artifact repository
* @since 3.0
*/
ArtifactRepository getLocal();
@ -130,7 +130,7 @@ public interface PluginToolsRequest
/**
*
* @param local
* @return
* @return This request.
* @since 3.0
*/
PluginToolsRequest setLocal( ArtifactRepository local );

3
maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginDescriptorGenerator.java
View File

@ -51,9 +51,6 @@ import org.codehaus.plexus.util.xml.XMLWriter;
* corresponding <code>plugin-help.xml</code> help content for {@link PluginHelpGenerator}.
*
* @version $Id$
* @todo add example usage tag that can be shown in the doco
* @todo need to add validation directives so that systems embedding maven2 can
* get validation directives to help users in IDEs.
*/
public class PluginDescriptorGenerator
implements Generator

1
maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
View File

@ -46,7 +46,6 @@ import java.util.ResourceBundle;
* Generate xdoc documentation for each mojo.
*
* @version $Id$
* @todo add example usage tag that can be shown in the doco
*/
public class PluginXdocGenerator
implements Generator

90
maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/javadoc/JavaJavadocMojoDescriptorExtractor.java
View File

@ -59,8 +59,6 @@ import com.thoughtworks.qdox.model.JavaType;
* <a href="http://maven.apache.org/developers/mojo-api-specification.html">
* http://maven.apache.org/developers/mojo-api-specification.html</a>
*
* @todo need to add validation directives so that systems embedding maven2 can
* get validation directives to help users in IDEs.
* @version $Id$
* @see org.apache.maven.plugin.descriptor.MojoDescriptor
*/
@ -69,94 +67,6 @@ public class JavaJavadocMojoDescriptorExtractor
extends AbstractLogEnabled
implements MojoDescriptorExtractor, JavadocMojoAnnotation
{
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#INSTANTIATION_STRATEGY} instead of. */
public static final String MAVEN_PLUGIN_INSTANTIATION = JavadocMojoAnnotation.INSTANTIATION_STRATEGY;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#CONFIGURATOR} instead of. */
public static final String CONFIGURATOR = JavadocMojoAnnotation.CONFIGURATOR;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#PARAMETER} instead of. */
public static final String PARAMETER = JavadocMojoAnnotation.PARAMETER;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#PARAMETER_EXPRESSION} instead of. */
public static final String PARAMETER_EXPRESSION = JavadocMojoAnnotation.PARAMETER_EXPRESSION;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#PARAMETER_DEFAULT_VALUE} instead of. */
public static final String PARAMETER_DEFAULT_VALUE = JavadocMojoAnnotation.PARAMETER_DEFAULT_VALUE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#PARAMETER_ALIAS} instead of. */
public static final String PARAMETER_ALIAS = JavadocMojoAnnotation.PARAMETER_ALIAS;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#SINCE} instead of. */
public static final String SINCE = JavadocMojoAnnotation.SINCE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#PARAMETER_IMPLEMENTATION} instead of. */
public static final String PARAMETER_IMPLEMENTATION = JavadocMojoAnnotation.PARAMETER_IMPLEMENTATION;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#REQUIRED} instead of. */
public static final String REQUIRED = JavadocMojoAnnotation.REQUIRED;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#DEPRECATED} instead of. */
public static final String DEPRECATED = JavadocMojoAnnotation.DEPRECATED;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#READONLY} instead of. */
public static final String READONLY = JavadocMojoAnnotation.READONLY;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#GOAL} instead of. */
public static final String GOAL = JavadocMojoAnnotation.GOAL;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#PHASE} instead of. */
public static final String PHASE = JavadocMojoAnnotation.PHASE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#EXECUTE} instead of. */
public static final String EXECUTE = JavadocMojoAnnotation.EXECUTE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#EXECUTE_LIFECYCLE} instead of. */
public static final String EXECUTE_LIFECYCLE = JavadocMojoAnnotation.EXECUTE_LIFECYCLE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#EXECUTE_PHASE} instead of. */
public static final String EXECUTE_PHASE = JavadocMojoAnnotation.EXECUTE_PHASE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#EXECUTE_GOAL} instead of. */
public static final String EXECUTE_GOAL = JavadocMojoAnnotation.EXECUTE_GOAL;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#DESCRIPTION} instead of. */
public static final String GOAL_DESCRIPTION = JavadocMojoAnnotation.DESCRIPTION;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#REQUIRES_DEPENDENCY_RESOLUTION} instead of. */
public static final String GOAL_REQUIRES_DEPENDENCY_RESOLUTION =
JavadocMojoAnnotation.REQUIRES_DEPENDENCY_RESOLUTION;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#REQUIRES_PROJECT} instead of. */
public static final String GOAL_REQUIRES_PROJECT = JavadocMojoAnnotation.REQUIRES_PROJECT;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#REQUIRES_REPORTS} instead of. */
public static final String GOAL_REQUIRES_REPORTS = JavadocMojoAnnotation.REQUIRES_REPORTS;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#AGGREGATOR} instead of. */
public static final String GOAL_IS_AGGREGATOR = JavadocMojoAnnotation.AGGREGATOR;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#REQUIRES_ONLINE} instead of. */
public static final String GOAL_REQUIRES_ONLINE = JavadocMojoAnnotation.REQUIRES_ONLINE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#INHERIT_BY_DEFAULT} instead of. */
public static final String GOAL_INHERIT_BY_DEFAULT = JavadocMojoAnnotation.INHERIT_BY_DEFAULT;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#MULTI_EXECUTION_STRATEGY} instead of. */
public static final String GOAL_MULTI_EXECUTION_STRATEGY = JavadocMojoAnnotation.MULTI_EXECUTION_STRATEGY;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#REQUIRES_DIRECT_INVOCATION} instead of. */
public static final String GOAL_REQUIRES_DIRECT_INVOCATION = JavadocMojoAnnotation.REQUIRES_DIRECT_INVOCATION;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#COMPONENT} instead of. */
public static final String COMPONENT = JavadocMojoAnnotation.COMPONENT;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#COMPONENT_ROLE} instead of. */
public static final String COMPONENT_ROLE = JavadocMojoAnnotation.COMPONENT_ROLE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#COMPONENT_ROLEHINT} instead of. */
public static final String COMPONENT_ROLEHINT = JavadocMojoAnnotation.COMPONENT_ROLEHINT;
/**
* @param parameter not null
* @param i positive number

4
maven-script/maven-plugin-tools-beanshell/src/main/java/org/apache/maven/tools/plugin/extractor/beanshell/BeanshellMojoDescriptorExtractor.java
View File

@ -41,10 +41,6 @@ import java.util.Set;
* Extracts Mojo descriptors from <a href="http://www.beanshell.org/">BeanShell</a> sources.
*
* @version $Id$
* @todo share constants
* @todo add example usage tag that can be shown in the doco
* @todo need to add validation directives so that systems embedding maven2 can
* get validation directives to help users in IDEs.
*/
@Component( role = MojoDescriptorExtractor.class, hint = "bsh" )
public class BeanshellMojoDescriptorExtractor

2
maven-script/maven-script-beanshell/src/main/java/org/apache/maven/script/beanshell/BeanshellMojoAdapter.java
View File

@ -30,8 +30,6 @@ import org.codehaus.plexus.component.factory.bsh.BshComponent;
/**
* Mojo adapter for a Beanshell Mojo.
*
* @todo should log be passed in, or rely on getLog() ?
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @version $Id$
*/