diff --git a/jetty-maven-plugin/pom.xml b/jetty-maven-plugin/pom.xml index baa1ba72655..f22015fa0d5 100644 --- a/jetty-maven-plugin/pom.xml +++ b/jetty-maven-plugin/pom.xml @@ -21,6 +21,49 @@ true + + org.apache.maven.plugins + maven-javadoc-plugin + + + + goal + t + Goal: + + + description + a + Description: + + + parameter + f + Parameter: + + + required + f + Required: + + + readonly + f + Read-Only: + + + execute + X + + + + requiresDependencyResolution + X + + + + + org.apache.maven.plugins maven-plugin-plugin diff --git a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/AbstractJettyMojo.java b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/AbstractJettyMojo.java index 652b2087e86..9eed62d44f3 100644 --- a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/AbstractJettyMojo.java +++ b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/AbstractJettyMojo.java @@ -18,7 +18,6 @@ package org.eclipse.jetty.maven.plugin; - import java.io.File; import java.io.FileInputStream; import java.io.InputStream; @@ -50,19 +49,11 @@ import org.eclipse.jetty.util.Scanner; import org.eclipse.jetty.util.resource.Resource; import org.eclipse.jetty.xml.XmlConfiguration; - - /** - * AbstractJettyMojo - * * Common base class for most jetty mojos. - * - * */ public abstract class AbstractJettyMojo extends AbstractMojo { - - /** * Whether or not to include dependencies on the plugin's classpath with <scope>provided</scope> * Use WITH CAUTION as you may wind up with duplicate jars/classes. @@ -72,7 +63,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo */ protected boolean useProvidedScope; - /** * List of goals that are NOT to be used * @@ -81,9 +71,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo */ protected String[] excludedGoals; - - - /** * List of other contexts to set up. Consider using instead * the <jettyXml> element to specify external jetty xml config file. @@ -94,7 +81,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo */ protected ContextHandler[] contextHandlers; - /** * List of security realms to set up. Consider using instead * the <jettyXml> element to specify external jetty xml config file. @@ -104,7 +90,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo * @parameter */ protected LoginService[] loginServices; - /** * A RequestLog implementation to use for the webapp at runtime. @@ -116,7 +101,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo */ protected RequestLog requestLog; - /** * An instance of org.eclipse.jetty.webapp.WebAppContext that represents the webapp. * Use any of its setters to configure the webapp. This is the preferred and most @@ -127,7 +111,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo */ protected JettyWebAppContext webApp; - /** * The interval in seconds to scan the webapp for changes * and restart the context if necessary. Ignored if reload @@ -138,7 +121,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo */ protected int scanIntervalSeconds; - /** * reload can be set to either 'automatic' or 'manual' * @@ -207,8 +189,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo */ protected boolean dumpOnStart; - - /** * Skip this mojo execution. @@ -361,9 +341,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo - /** - * @throws MojoExecutionException - */ public void configurePluginClasspath() throws MojoExecutionException { //if we are configured to include the provided dependencies on the plugin's classpath @@ -403,13 +380,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo } } - - - - /** - * @param artifact - * @return - */ public boolean isPluginArtifact(Artifact artifact) { if (pluginArtifacts == null || pluginArtifacts.isEmpty()) @@ -427,12 +397,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo return isPluginArtifact; } - - - - /** - * @throws Exception - */ public void finishConfigurationBeforeStart() throws Exception { HandlerCollection contexts = (HandlerCollection)server.getChildHandlerByClass(ContextHandlerCollection.class); @@ -445,12 +409,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo } } - - - - /** - * @throws Exception - */ public void applyJettyXml() throws Exception { Server tmp = ServerSupport.applyXmlConfigurations(server, getJettyXmlFiles()); @@ -461,12 +419,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo server = new Server(); } - - - - /** - * @throws MojoExecutionException - */ public void startJetty () throws MojoExecutionException { try @@ -568,7 +520,7 @@ public abstract class AbstractJettyMojo extends AbstractMojo * Subclasses should invoke this to setup basic info * on the webapp * - * @throws MojoExecutionException + * @throws Exception if unable to configure web application */ public void configureWebApplication () throws Exception { @@ -651,6 +603,7 @@ public abstract class AbstractJettyMojo extends AbstractMojo /** * Run a thread that monitors the console input to detect ENTER hits. + * @throws Exception if unable to start the console */ protected void startConsoleScanner() throws Exception { @@ -662,12 +615,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo } } - - - - /** - * - */ protected void printSystemProperties () { // print out which system properties were set up @@ -685,13 +632,10 @@ public abstract class AbstractJettyMojo extends AbstractMojo } } - - - /** * Try and find a jetty-web.xml file, using some * historical naming conventions if necessary. - * @param webInfDir + * @param webInfDir the web inf directory * @return the jetty web xml file */ public File findJettyWebXmlFile (File webInfDir) @@ -713,13 +657,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo return null; } - - - - /** - * @param file - * @throws Exception - */ public void setSystemPropertiesFile(File file) throws Exception { this.systemPropertiesFile = file; @@ -745,12 +682,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo } } - - - - /** - * @param systemProperties - */ public void setSystemProperties(SystemProperties systemProperties) { if (this.systemProperties == null) @@ -764,15 +695,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo } } - - - - - - - /** - * @return - */ public List getJettyXmlFiles() { if ( this.jettyXml == null ) @@ -799,12 +721,6 @@ public abstract class AbstractJettyMojo extends AbstractMojo return jettyXmlFiles; } - - - /** - * @param goal - * @return - */ public boolean isExcluded (String goal) { if (excludedGoals == null || goal == null) diff --git a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/ConsoleScanner.java b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/ConsoleScanner.java index 65a9dc5082c..8aba9775dc0 100644 --- a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/ConsoleScanner.java +++ b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/ConsoleScanner.java @@ -20,9 +20,6 @@ package org.eclipse.jetty.maven.plugin; import java.io.IOException; - - - /** * ConsoleScanner * @@ -30,16 +27,8 @@ import java.io.IOException; */ public class ConsoleScanner extends Thread { - private final AbstractJettyMojo mojo; - - - - - /** - * @param mojo - */ public ConsoleScanner(AbstractJettyMojo mojo) { this.mojo = mojo; @@ -47,12 +36,6 @@ public class ConsoleScanner extends Thread setDaemon(true); } - - - - /** - * @see java.lang.Thread#run() - */ public void run() { try @@ -69,12 +52,6 @@ public class ConsoleScanner extends Thread } } - - - - /** - * - */ private void getSomeSleep() { try @@ -87,12 +64,6 @@ public class ConsoleScanner extends Thread } } - - - - /** - * @throws IOException - */ private void checkSystemInput() throws IOException { while (System.in.available() > 0) { @@ -107,9 +78,6 @@ public class ConsoleScanner extends Thread } } - - - /** * Skip buffered bytes of system console. */ @@ -136,12 +104,6 @@ public class ConsoleScanner extends Thread } } - - - - /** - * - */ private void restartWebApp() { try diff --git a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyRunForkedMojo.java b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyRunForkedMojo.java index a7539305bcc..be33e9bf1bb 100644 --- a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyRunForkedMojo.java +++ b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyRunForkedMojo.java @@ -53,25 +53,20 @@ import org.eclipse.jetty.util.thread.QueuedThreadPool; /** + * This goal is used to deploy your unassembled webapp into a forked JVM. *

- * This goal is used to deploy your unassembled webapp into a forked JVM. - *

- *

- * You need to define a jetty.xml file to configure connectors etc. You can use the normal setters of o.e.j.webapp.WebAppContext on the webApp - * configuration element for this plugin. You may also need context xml file for any particularly complex webapp setup. - * about your webapp. - *

- *

- * Unlike the other jetty goals, this does NOT support the scanIntervalSeconds parameter: the webapp will be deployed only once. - *

- *

- * The stopKey, stopPort configuration elements can be used to control the stopping of the forked process. By default, this plugin will launch - * the forked jetty instance and wait for it to complete (in which case it acts much like the jetty:run goal, and you will need to Cntrl-C to stop). - * By setting the configuration element waitForChild to false, the plugin will terminate after having forked the jetty process. In this case - * you can use the jetty:stop goal to terminate the process. - *

- * See http://www.eclipse.org/jetty/documentation for more information on this and other jetty plugins. - *

+ * You need to define a jetty.xml file to configure connectors etc. You can use the normal setters of o.e.j.webapp.WebAppContext on the webApp + * configuration element for this plugin. You may also need context xml file for any particularly complex webapp setup. + * about your webapp. + *

+ * Unlike the other jetty goals, this does NOT support the scanIntervalSeconds parameter: the webapp will be deployed only once. + *

+ * The stopKey, stopPort configuration elements can be used to control the stopping of the forked process. By default, this plugin will launch + * the forked jetty instance and wait for it to complete (in which case it acts much like the jetty:run goal, and you will need to Cntrl-C to stop). + * By setting the configuration element waitForChild to false, the plugin will terminate after having forked the jetty process. In this case + * you can use the jetty:stop goal to terminate the process. + *

+ * See http://www.eclipse.org/jetty/documentation for more information on this and other jetty plugins. * * @goal run-forked * @requiresDependencyResolution test @@ -415,13 +410,6 @@ public class JettyRunForkedMojo extends JettyRunMojo } } - - - - /** - * @return - * @throws MojoExecutionException - */ public List getProvidedJars() throws MojoExecutionException { //if we are configured to include the provided dependencies on the plugin's classpath @@ -448,13 +436,6 @@ public class JettyRunForkedMojo extends JettyRunMojo return null; } - - - - /** - * @return - * @throws MojoExecutionException - */ public File prepareConfiguration() throws MojoExecutionException { try @@ -602,15 +583,6 @@ public class JettyRunForkedMojo extends JettyRunMojo return warArtifacts; } - - - - - - /** - * @param artifact - * @return - */ public boolean isPluginArtifact(Artifact artifact) { if (pluginArtifacts == null || pluginArtifacts.isEmpty()) @@ -628,13 +600,6 @@ public class JettyRunForkedMojo extends JettyRunMojo return isPluginArtifact; } - - - - /** - * @return - * @throws Exception - */ private Set getExtraJars() throws Exception { @@ -660,15 +625,6 @@ public class JettyRunForkedMojo extends JettyRunMojo return extraJars; } - - - - - - /** - * @return - * @throws Exception - */ public String getContainerClassPath() throws Exception { StringBuilder classPath = new StringBuilder(); @@ -734,13 +690,6 @@ public class JettyRunForkedMojo extends JettyRunMojo return "java"; } - - - - /** - * @param path - * @return - */ public static String fileSeparators(String path) { StringBuilder ret = new StringBuilder(); @@ -758,13 +707,6 @@ public class JettyRunForkedMojo extends JettyRunMojo return ret.toString(); } - - - - /** - * @param path - * @return - */ public static String pathSeparators(String path) { StringBuilder ret = new StringBuilder(); @@ -782,24 +724,11 @@ public class JettyRunForkedMojo extends JettyRunMojo return ret.toString(); } - - - - /** - * @return - */ private String createToken () { return Long.toString(random.nextLong()^System.currentTimeMillis(), 36).toUpperCase(Locale.ENGLISH); } - - - - /** - * @param mode - * @param inputStream - */ private void startPump(String mode, InputStream inputStream) { ConsoleStreamer pump = new ConsoleStreamer(mode,inputStream); @@ -808,13 +737,6 @@ public class JettyRunForkedMojo extends JettyRunMojo thread.start(); } - - - - /** - * @param strings - * @return - */ private String toCSV (List strings) { if (strings == null) diff --git a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyRunMojo.java b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyRunMojo.java index 2e052943ccb..4b8307168fa 100644 --- a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyRunMojo.java +++ b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyRunMojo.java @@ -36,28 +36,22 @@ import org.eclipse.jetty.util.Scanner; import org.eclipse.jetty.util.resource.Resource; import org.eclipse.jetty.webapp.WebAppContext; - /** - *

* This goal is used in-situ on a Maven project without first requiring that the project * is assembled into a war, saving time during the development cycle. + *

* The plugin forks a parallel lifecycle to ensure that the "compile" phase has been completed before invoking Jetty. This means * that you do not need to explicity execute a "mvn compile" first. It also means that a "mvn clean jetty:run" will ensure that * a full fresh compile is done before invoking Jetty. - *

*

* Once invoked, the plugin can be configured to run continuously, scanning for changes in the project and automatically performing a * hot redeploy when necessary. This allows the developer to concentrate on coding changes to the project using their IDE of choice and have those changes * immediately and transparently reflected in the running web container, eliminating development time that is wasted on rebuilding, reassembling and redeploying. - *

*

* You may also specify the location of a jetty.xml file whose contents will be applied before any plugin configuration. * This can be used, for example, to deploy a static webapp that is not part of your maven build. - *

*

* There is a reference guide to the configuration parameters for this plugin. - *

- * * * @goal run * @requiresDependencyResolution test @@ -605,13 +599,6 @@ public class JettyRunMojo extends AbstractJettyMojo return warArtifacts; } - - - /** - * @param o - * @param warArtifacts - * @return - */ protected Artifact getArtifactForOverlay (OverlayConfig o, List warArtifacts) { if (o == null || warArtifacts == null || warArtifacts.isEmpty()) diff --git a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyWebAppContext.java b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyWebAppContext.java index 3a0c05d22d8..517f875d09d 100644 --- a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyWebAppContext.java +++ b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyWebAppContext.java @@ -21,7 +21,6 @@ package org.eclipse.jetty.maven.plugin; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; -import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import java.net.MalformedURLException; import java.util.ArrayList; @@ -207,7 +206,7 @@ public class JettyWebAppContext extends WebAppContext /** * Ordered list of wars to overlay on top of the current project. The list * may contain an overlay that represents the current project. - * @param overlays + * @param overlays the list of overlays */ public void setOverlays (List overlays) { diff --git a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/MavenWebInfConfiguration.java b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/MavenWebInfConfiguration.java index c1336520dfa..95803f6a552 100644 --- a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/MavenWebInfConfiguration.java +++ b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/MavenWebInfConfiguration.java @@ -40,8 +40,7 @@ import org.eclipse.jetty.webapp.WebInfConfiguration; * MavenWebInfConfiguration * * WebInfConfiguration to take account of overlaid wars expressed as project dependencies and - * potentiall configured via the maven-war-plugin. - * + * potential configured via the maven-war-plugin. */ public class MavenWebInfConfiguration extends WebInfConfiguration { @@ -51,9 +50,6 @@ public class MavenWebInfConfiguration extends WebInfConfiguration protected static int COUNTER = 0; protected Resource _originalResourceBase; protected List _unpackedOverlayResources; - - - /** * @see org.eclipse.jetty.webapp.WebInfConfiguration#configure(org.eclipse.jetty.webapp.WebAppContext) @@ -204,7 +200,7 @@ public class MavenWebInfConfiguration extends WebInfConfiguration * Get the jars to examine from the files from which we have * synthesized the classpath. Note that the classpath is not * set at this point, so we cannot get them from the classpath. - * @param context + * @param context the web app context * @return the list of jars found */ @Override diff --git a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/OverlayConfig.java b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/OverlayConfig.java index 287ba131cd7..30a0818ad13 100644 --- a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/OverlayConfig.java +++ b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/OverlayConfig.java @@ -28,8 +28,6 @@ import org.codehaus.plexus.util.xml.Xpp3Dom; /** * OverlayConfig - * - * */ public class OverlayConfig { @@ -270,7 +268,7 @@ public class OverlayConfig * @param gid Artifact groupId * @param aid Artifact artifactId * @param cls Artifact classifier - * @return + * @return true if matched */ public boolean matchesArtifact (String gid, String aid, String cls) { @@ -285,9 +283,9 @@ public class OverlayConfig /** * Check if this overlay configuration matches an Artifact's info * - * @param gid - * @param aid - * @return + * @param gid the group id + * @param aid the artifact id + * @return true if matched */ public boolean matchesArtifact (String gid, String aid) { @@ -298,9 +296,6 @@ public class OverlayConfig return false; } - - - public String toString() { StringBuffer strbuff = new StringBuffer(); diff --git a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/SelectiveJarResource.java b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/SelectiveJarResource.java index 11df37a7c2d..a10e9723e5f 100644 --- a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/SelectiveJarResource.java +++ b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/SelectiveJarResource.java @@ -52,30 +52,20 @@ public class SelectiveJarResource extends JarResource public static final List DEFAULT_INCLUDES = Arrays.asList(new String[]{"**"});// No includes supplied, so set it to 'matches all' public static final List DEFAULT_EXCLUDES = Collections.emptyList(); //No includes, set to no exclusions - List _includes = null; List _excludes = null; boolean _caseSensitive = false; - - /** - * @param url - */ public SelectiveJarResource(URL url) { super(url); } - /** - * @param url - * @param useCaches - */ public SelectiveJarResource(URL url, boolean useCaches) { super(url, useCaches); } - public void setCaseSensitive (boolean caseSensitive) { _caseSensitive = caseSensitive; diff --git a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/ServerSupport.java b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/ServerSupport.java index 83e08d64d06..babfe6830a3 100644 --- a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/ServerSupport.java +++ b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/ServerSupport.java @@ -46,14 +46,14 @@ import org.eclipse.jetty.xml.XmlConfiguration; */ public class ServerSupport { - - /** * Set up the handler structure to receive a webapp. * Also put in a DefaultHandler so we get a nice page * than a 404 if we hit the root and the webapp's * context isn't at root. - * @throws Exception + * @param server the server + * @param requestLog the request log + * @throws Exception if unable to configure the handlers */ public static void configureHandlers (Server server, RequestLog requestLog) throws Exception { @@ -87,8 +87,8 @@ public class ServerSupport /** * Configure at least one connector for the server * - * @param server - * @param connector + * @param server the server + * @param connector the connector */ public static void configureConnectors (Server server, Connector connector) { @@ -122,8 +122,8 @@ public class ServerSupport /** * Set up any security LoginServices provided. * - * @param server - * @param loginServices + * @param server the server + * @param loginServices the login services */ public static void configureLoginServices (Server server, LoginService[] loginServices) { @@ -140,10 +140,6 @@ public class ServerSupport } } - - /** - * @see org.eclipse.jetty.server.handler.HandlerCollection#addHandler(org.eclipse.jetty.server.Handler) - */ public static void addWebApplication(Server server, WebAppContext webapp) throws Exception { if (server == null) @@ -168,8 +164,10 @@ public class ServerSupport * Apply xml files to server startup, passing in ourselves as the * "Server" instance. * - * @param files - * @throws Exception + * @param server the server to apply the xml to + * @param files the list of xml files + * @return the Server implementation, after the xml is applied + * @throws Exception if unable to apply the xml configuration */ public static Server applyXmlConfigurations (Server server, List files) throws Exception diff --git a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/Starter.java b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/Starter.java index 7775e9e3670..20ac0a64c31 100644 --- a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/Starter.java +++ b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/Starter.java @@ -44,10 +44,7 @@ import org.eclipse.jetty.xml.XmlConfiguration; /** - * Starter - * - * Class which is exec'ed to create a new jetty process. Used by the JettyRunForked mojo. - * + * Starter Class which is exec'ed to create a new jetty process. Used by the JettyRunForked mojo. */ public class Starter { @@ -114,9 +111,6 @@ public class Starter - /** - * @throws Exception - */ public void configureJetty () throws Exception { LOG.debug("Starting Jetty Server ..."); @@ -168,10 +162,6 @@ public class Starter } } - - /** - * @throws Exception - */ public void configureWebApp () throws Exception { @@ -318,10 +308,6 @@ public class Starter } - /** - * @param args - * @throws Exception - */ public void getConfiguration (String[] args) throws Exception { @@ -372,9 +358,6 @@ public class Starter } - /** - * @throws Exception - */ public void run() throws Exception { LOG.info("Started Jetty Server"); @@ -382,18 +365,12 @@ public class Starter } - /** - * @throws Exception - */ public void join () throws Exception { server.join(); } - /** - * @param e - */ public void communicateStartupResult (Exception e) { if (token != null) @@ -408,7 +385,7 @@ public class Starter /** * Apply any jetty xml files given - * @throws Exception + * @throws Exception if unable to apply the xml */ public void applyJettyXml() throws Exception { @@ -423,10 +400,6 @@ public class Starter - /** - * @param handler - * @param handlers - */ protected void prependHandler (Handler handler, HandlerCollection handlers) { if (handler == null || handlers == null) @@ -441,11 +414,6 @@ public class Starter - /** - * @param c - * @param wars - * @return - */ protected Artifact getArtifactForOverlayConfig (OverlayConfig c, List wars) { if (wars == null || wars.isEmpty() || c == null) @@ -480,11 +448,6 @@ public class Starter return list; } - - - /** - * @param args - */ public static final void main(String[] args) { if (args == null) diff --git a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/WarPluginInfo.java b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/WarPluginInfo.java index f939a220ccb..f8b12e0f269 100644 --- a/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/WarPluginInfo.java +++ b/jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/WarPluginInfo.java @@ -29,11 +29,9 @@ import org.apache.maven.model.Plugin; import org.apache.maven.project.MavenProject; import org.codehaus.plexus.util.xml.Xpp3Dom; - - /** * WarPluginInfo - * + *

* Information about the maven-war-plugin contained in the pom */ public class WarPluginInfo @@ -45,10 +43,6 @@ public class WarPluginInfo private List _overlayConfigs; - - /** - * @param project - */ public WarPluginInfo (MavenProject project) { _project = project; @@ -59,7 +53,7 @@ public class WarPluginInfo /** * Find the maven-war-plugin, if one is configured - * @return + * @return the plugin */ public Plugin getPlugin() { @@ -86,7 +80,7 @@ public class WarPluginInfo /** * Get value of dependentWarIncludes for maven-war-plugin - * @return + * @return the list of dependent war includes */ public List getDependentMavenWarIncludes() { @@ -115,7 +109,7 @@ public class WarPluginInfo /** * Get value of dependentWarExcludes for maven-war-plugin - * @return + * @return the list of dependent war excludes */ public List getDependentMavenWarExcludes() { @@ -145,7 +139,7 @@ public class WarPluginInfo /** * Get config for any overlays that have been declared for the maven-war-plugin. * - * @return + * @return the list of overlay configs */ public List getMavenWarOverlayConfigs () { diff --git a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/PreconfigureQuickStartWar.java b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/PreconfigureQuickStartWar.java index 134f423d9e8..5a22dd35ee4 100644 --- a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/PreconfigureQuickStartWar.java +++ b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/PreconfigureQuickStartWar.java @@ -30,7 +30,6 @@ public class PreconfigureQuickStartWar private static final Logger LOG = Log.getLogger(PreconfigureQuickStartWar.class); static final boolean ORIGIN=LOG.isDebugEnabled(); - public static void main(String... args) throws Exception { Resource war = null; @@ -80,7 +79,7 @@ public class PreconfigureQuickStartWar * @param war The war (or directory) to preconfigure * @param dir The directory to expand the war into (or null if war is a directory) * @param xml A context XML to apply (or null if none) - * @throws Exception + * @throws Exception if unable to pre configure */ public static void preconfigure(Resource war, Resource dir, Resource xml) throws Exception { diff --git a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartConfiguration.java b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartConfiguration.java index 7dceb10dd48..c82ce144f8a 100644 --- a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartConfiguration.java +++ b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartConfiguration.java @@ -31,10 +31,9 @@ import org.eclipse.jetty.webapp.WebInfConfiguration; /** * QuickStartConfiguration - * + *

* Re-inflate a deployable webapp from a saved effective-web.xml * which combines all pre-parsed web xml descriptors and annotations. - * */ public class QuickStartConfiguration extends WebInfConfiguration { @@ -83,9 +82,9 @@ public class QuickStartConfiguration extends WebInfConfiguration /** * Get the quickstart-web.xml file as a Resource. * - * @param context - * @return - * @throws Exception + * @param context the web app context + * @return the Resource for the quickstart-web.xml + * @throws Exception if unable to find the quickstart xml */ public Resource getQuickStartWebXml (WebAppContext context) throws Exception { diff --git a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorGenerator.java b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorGenerator.java index 3a7cee9626a..9df1c37c9b8 100644 --- a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorGenerator.java +++ b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorGenerator.java @@ -62,11 +62,9 @@ import org.eclipse.jetty.webapp.MetaInfConfiguration; import org.eclipse.jetty.webapp.WebAppContext; import org.eclipse.jetty.xml.XmlAppendable; - - /** * QuickStartDescriptorGenerator - * + *

* Generate an effective web.xml from a WebAppContext, including all components * from web.xml, web-fragment.xmls annotations etc. */ @@ -94,9 +92,9 @@ public class QuickStartDescriptorGenerator /** * Perform the generation of the xml file - * @throws IOException - * @throws FileNotFoundException - * @throws Exception + * @param stream the stream to generate the quickstart-web.xml to + * @throws IOException if unable to generate the quickstart-web.xml + * @throws FileNotFoundException if unable to find the file */ public void generateQuickStartWebXml (OutputStream stream) throws FileNotFoundException, IOException { @@ -668,9 +666,9 @@ public class QuickStartDescriptorGenerator /** * Find the origin (web.xml, fragment, annotation etc) of a web artifact from MetaData. * - * @param md - * @param name - * @return + * @param md the metadata + * @param name the name + * @return the origin map */ public Map origin(MetaData md, String name) { diff --git a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorProcessor.java b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorProcessor.java index 43a0c2e9b18..2c56af43aa5 100644 --- a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorProcessor.java +++ b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorProcessor.java @@ -44,9 +44,6 @@ import org.eclipse.jetty.xml.XmlParser; */ public class QuickStartDescriptorProcessor extends IterativeDescriptorProcessor { - /** - * - */ public QuickStartDescriptorProcessor() { try @@ -74,13 +71,7 @@ public class QuickStartDescriptorProcessor extends IterativeDescriptorProcessor public void end(WebAppContext context, Descriptor descriptor) { } - - /** - * @param context - * @param descriptor - * @param node - */ public void visitContextParam (WebAppContext context, Descriptor descriptor, XmlParser.Node node) throws Exception { diff --git a/tests/pom.xml b/tests/pom.xml index c8ef6f28f0b..4eab3a6f796 100644 --- a/tests/pom.xml +++ b/tests/pom.xml @@ -31,6 +31,13 @@ pom + + org.apache.maven.plugins + maven-javadoc-plugin + + -Xdoclint:none + + org.codehaus.mojo findbugs-maven-plugin diff --git a/tests/test-webapps/test-mock-resources/src/main/java/com/acme/MockTransport.java b/tests/test-webapps/test-mock-resources/src/main/java/com/acme/MockTransport.java index 9848c1a0e69..d3d273b1ca5 100644 --- a/tests/test-webapps/test-mock-resources/src/main/java/com/acme/MockTransport.java +++ b/tests/test-webapps/test-mock-resources/src/main/java/com/acme/MockTransport.java @@ -28,12 +28,9 @@ import javax.mail.URLName; /** * MockTransport - * - * */ public class MockTransport extends Transport { - /** * @param session * @param urlname