Fixed the javadoc errors (and some warnings)
git-svn-id: https://svn.apache.org/repos/asf/tomcat/maven-plugin/trunk@1854802 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/deployer/TomcatManager.java b/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/deployer/TomcatManager.java
index 5004a2f..93eca7a 100644
--- a/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/deployer/TomcatManager.java
+++ b/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/deployer/TomcatManager.java
@@ -60,7 +60,7 @@
/**
* A Tomcat manager webapp invocation wrapper.
*
- * @author Mark Hobson <markhobson@gmail.com>
+ * @author Mark Hobson (markhobson@gmail.com)
*/
public class TomcatManager
{
@@ -277,7 +277,9 @@
}
/**
- * @param proxy
+ * Sets the proxy to use when communicating with Tomcat manager.
+ *
+ * @param proxy the proxy to use when communicating with Tomcat manager
*/
public void setProxy( Proxy proxy )
{
@@ -422,14 +424,17 @@
}
/**
- * @param path
- * @param war
- * @param update
- * @param tag
- * @param length
- * @return
- * @throws TomcatManagerException
- * @throws IOException
+ * Deploys the specified WAR as a HTTP PUT to the specified context path, optionally undeploying the webapp if it
+ * already exists and using the specified tag name.
+ *
+ * @param path the webapp context path to deploy to
+ * @param war an input stream to the WAR to deploy
+ * @param update whether to first undeploy the webapp if it already exists
+ * @param tag the tag name to use
+ * @param length the size of the war deployed
+ * @return the Tomcat manager response
+ * @throws TomcatManagerException if the Tomcat manager request fails
+ * @throws IOException if an i/o error occurs
* @since 2.0
*/
public TomcatManagerResponse deploy( String path, File war, boolean update, String tag, long length )
diff --git a/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/deployer/TomcatManagerException.java b/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/deployer/TomcatManagerException.java
index b022354..7cda147 100644
--- a/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/deployer/TomcatManagerException.java
+++ b/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/deployer/TomcatManagerException.java
@@ -22,7 +22,7 @@
/**
* Indicates an error received from Tomcat manager.
*
- * @author Mark Hobson <markhobson@gmail.com>
+ * @author Mark Hobson (markhobson@gmail.com)
*/
public class TomcatManagerException
extends Exception
diff --git a/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/messages/DefaultMessagesProvider.java b/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/messages/DefaultMessagesProvider.java
index 69312fc..c5af17c 100644
--- a/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/messages/DefaultMessagesProvider.java
+++ b/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/messages/DefaultMessagesProvider.java
@@ -27,7 +27,6 @@
/**
* @author Olivier Lamy
- * @component role="org.apache.tomcat.maven.common.messages.MessagesProvider" role-hint="default"
* @since 2.0
*/
@Component( role = MessagesProvider.class )
diff --git a/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/run/ClassLoaderEntriesCalculatorResult.java b/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/run/ClassLoaderEntriesCalculatorResult.java
index 48f2345..64247bb 100644
--- a/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/run/ClassLoaderEntriesCalculatorResult.java
+++ b/common-tomcat-maven-plugin/src/main/java/org/apache/tomcat/maven/common/run/ClassLoaderEntriesCalculatorResult.java
@@ -44,9 +44,9 @@
private List<String> buildDirectories;
/**
- * @param classPathEntries
- * @param tmpDirectories
- * @param buildDirectories
+ * @param classPathEntries Classpath entries File .toURI().toString()
+ * @param tmpDirectories List of files to cleanup after execution
+ * @param buildDirectories Directory part of webapp classpath (project.build.directory and reactor projects)
*/
public ClassLoaderEntriesCalculatorResult( List<String> classPathEntries, List<File> tmpDirectories,
List<String> buildDirectories )
diff --git a/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/AbstractCatalinaMojo.java b/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/AbstractCatalinaMojo.java
index feb5847..55938c9 100644
--- a/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/AbstractCatalinaMojo.java
+++ b/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/AbstractCatalinaMojo.java
@@ -38,7 +38,7 @@
/**
* Abstract goal that provides common configuration for Catalina-based goals.
*
- * @author Mark Hobson <markhobson@gmail.com>
+ * @author Mark Hobson (markhobson@gmail.com)
*/
public abstract class AbstractCatalinaMojo
extends AbstractTomcat7Mojo
diff --git a/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/AbstractWarCatalinaMojo.java b/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/AbstractWarCatalinaMojo.java
index c819ea3..8feae66 100644
--- a/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/AbstractWarCatalinaMojo.java
+++ b/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/AbstractWarCatalinaMojo.java
@@ -25,7 +25,7 @@
/**
* Abstract goal that provides common configuration for Catalina-based goals.
*
- * @author Mark Hobson <markhobson@gmail.com>
+ * @author Mark Hobson (markhobson@gmail.com)
*/
public abstract class AbstractWarCatalinaMojo
extends AbstractCatalinaMojo
diff --git a/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/deploy/AbstractDeployMojo.java b/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/deploy/AbstractDeployMojo.java
index 8b4c59c..91e42d1 100644
--- a/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/deploy/AbstractDeployMojo.java
+++ b/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/deploy/AbstractDeployMojo.java
@@ -32,7 +32,7 @@
/**
* Deploy a WAR to Tomcat.
*
- * @author Mark Hobson <markhobson@gmail.com>
+ * @author Mark Hobson (markhobson@gmail.com)
*/
public abstract class AbstractDeployMojo
extends AbstractWarCatalinaMojo
diff --git a/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/deploy/DeployMojo.java b/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/deploy/DeployMojo.java
index 89e6867..2313c1c 100644
--- a/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/deploy/DeployMojo.java
+++ b/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/deploy/DeployMojo.java
@@ -26,7 +26,7 @@
/**
* Deploy a WAR to Tomcat.
*
- * @author Mark Hobson <markhobson@gmail.com>
+ * @author Mark Hobson (markhobson@gmail.com)
*/
@Mojo(name = "deploy", threadSafe = true)
@Execute(phase = LifecyclePhase.PACKAGE)
diff --git a/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/run/AbstractRunWarMojo.java b/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/run/AbstractRunWarMojo.java
index afd7afc..bd8370c 100644
--- a/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/run/AbstractRunWarMojo.java
+++ b/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/run/AbstractRunWarMojo.java
@@ -26,8 +26,8 @@
/**
* Runs the current project as a packaged web application using an embedded Tomcat server.
*
- * @author Mark Hobson <markhobson@gmail.com>
- * @todo depend on war:exploded when MNG-1649 resolved
+ * @author Mark Hobson (markhobson@gmail.com)
+ * TODO depend on war:exploded when MNG-1649 resolved
*/
public abstract class AbstractRunWarMojo
extends AbstractRunMojo
diff --git a/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/run/RunWarMojo.java b/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/run/RunWarMojo.java
index b129fc7..35acda2 100644
--- a/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/run/RunWarMojo.java
+++ b/tomcat7-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat7/run/RunWarMojo.java
@@ -28,8 +28,8 @@
/**
* Runs the current project as a packaged web application using an embedded Tomcat server.
*
- * @author Mark Hobson <markhobson@gmail.com>
- * @todo depend on war:exploded when MNG-1649 resolved
+ * @author Mark Hobson (markhobson@gmail.com)
+ * TODO depend on war:exploded when MNG-1649 resolved
*/
@Mojo( name = "run-war", requiresDependencyResolution = ResolutionScope.RUNTIME, threadSafe = true )
@Execute( phase = LifecyclePhase.PACKAGE )
diff --git a/tomcat7-war-runner/src/main/java/org/apache/tomcat/maven/runner/PasswordUtil.java b/tomcat7-war-runner/src/main/java/org/apache/tomcat/maven/runner/PasswordUtil.java
index 15d8af0..d70dee8 100644
--- a/tomcat7-war-runner/src/main/java/org/apache/tomcat/maven/runner/PasswordUtil.java
+++ b/tomcat7-war-runner/src/main/java/org/apache/tomcat/maven/runner/PasswordUtil.java
@@ -24,14 +24,13 @@
/**
* Password obfuscate utility class. Lifted from Jetty org.mortbay.jetty.security.Password
- * <p/>
- * <p/>
- * Passwords that begin with OBF: are de obfuscated.
- * <p/>
- * Passwords can be obfuscated by running Obfuscate as a main class. Obfuscated password are required if a system needs
- * to recover the full password (eg. so that it may be passed to another system).
- * <p/>
- * They are not secure, but prevent casual observation.
+ *
+ * <p>Passwords that begin with OBF: are de obfuscated.</p>
+ *
+ * <p>Passwords can be obfuscated by running Obfuscate as a main class. Obfuscated password are required if a system needs
+ * to recover the full password (eg. so that it may be passed to another system).</p>
+ *
+ * <p>They are not secure, but prevent casual observation.</p>
*
* @see <a
* href="http://grepcode.com/file_/repo1.maven.org/maven2/org.mortbay.jetty/jetty/6.1.11/org/mortbay/jetty/security/Password.java/?v=source"
diff --git a/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/AbstractCatalinaMojo.java b/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/AbstractCatalinaMojo.java
index aa59bdd..49d26f7 100644
--- a/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/AbstractCatalinaMojo.java
+++ b/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/AbstractCatalinaMojo.java
@@ -37,7 +37,7 @@
/**
* Abstract goal that provides common configuration for Catalina-based goals.
*
- * @author Mark Hobson <markhobson@gmail.com>
+ * @author Mark Hobson (markhobson@gmail.com)
*/
public abstract class AbstractCatalinaMojo
extends AbstractTomcat8Mojo
diff --git a/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/AbstractWarCatalinaMojo.java b/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/AbstractWarCatalinaMojo.java
index a0390cf..881849a 100644
--- a/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/AbstractWarCatalinaMojo.java
+++ b/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/AbstractWarCatalinaMojo.java
@@ -25,7 +25,7 @@
/**
* Abstract goal that provides common configuration for Catalina-based goals.
*
- * @author Mark Hobson <markhobson@gmail.com>
+ * @author Mark Hobson (markhobson@gmail.com)
*/
public abstract class AbstractWarCatalinaMojo
extends AbstractCatalinaMojo
diff --git a/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/deploy/AbstractDeployMojo.java b/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/deploy/AbstractDeployMojo.java
index 1c0bc65..4caeaf0 100644
--- a/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/deploy/AbstractDeployMojo.java
+++ b/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/deploy/AbstractDeployMojo.java
@@ -32,7 +32,7 @@
/**
* Deploy a WAR to Tomcat.
*
- * @author Mark Hobson <markhobson@gmail.com>
+ * @author Mark Hobson (markhobson@gmail.com)
*/
public abstract class AbstractDeployMojo
extends AbstractWarCatalinaMojo
diff --git a/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/deploy/DeployMojo.java b/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/deploy/DeployMojo.java
index 140ecd4..e0de3d5 100644
--- a/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/deploy/DeployMojo.java
+++ b/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/deploy/DeployMojo.java
@@ -26,7 +26,7 @@
/**
* Deploy a WAR to Tomcat.
*
- * @author Mark Hobson <markhobson@gmail.com>
+ * @author Mark Hobson (markhobson@gmail.com)
*/
@Mojo(name = "deploy", threadSafe = true)
@Execute(phase = LifecyclePhase.PACKAGE)
diff --git a/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/run/AbstractRunWarMojo.java b/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/run/AbstractRunWarMojo.java
index 1d5018e..255c56e 100644
--- a/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/run/AbstractRunWarMojo.java
+++ b/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/run/AbstractRunWarMojo.java
@@ -26,8 +26,8 @@
/**
* Runs the current project as a packaged web application using an embedded Tomcat server.
*
- * @author Mark Hobson <markhobson@gmail.com>
- * @todo depend on war:exploded when MNG-1649 resolved
+ * @author Mark Hobson (markhobson@gmail.com)
+ * TODO depend on war:exploded when MNG-1649 resolved
*/
public abstract class AbstractRunWarMojo
extends AbstractRunMojo
diff --git a/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/run/RunWarMojo.java b/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/run/RunWarMojo.java
index 17c3910..fc1d105 100644
--- a/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/run/RunWarMojo.java
+++ b/tomcat8-maven-plugin/src/main/java/org/apache/tomcat/maven/plugin/tomcat8/run/RunWarMojo.java
@@ -28,8 +28,8 @@
/**
* Runs the current project as a packaged web application using an embedded Tomcat server.
*
- * @author Mark Hobson <markhobson@gmail.com>
- * @todo depend on war:exploded when MNG-1649 resolved
+ * @author Mark Hobson (markhobson@gmail.com)
+ * TODO depend on war:exploded when MNG-1649 resolved
*/
@Mojo( name = "run-war", requiresDependencyResolution = ResolutionScope.RUNTIME, threadSafe = true )
@Execute( phase = LifecyclePhase.PACKAGE )
diff --git a/tomcat8-war-runner/src/main/java/org/apache/tomcat/maven/runner/PasswordUtil.java b/tomcat8-war-runner/src/main/java/org/apache/tomcat/maven/runner/PasswordUtil.java
index 15d8af0..d70dee8 100644
--- a/tomcat8-war-runner/src/main/java/org/apache/tomcat/maven/runner/PasswordUtil.java
+++ b/tomcat8-war-runner/src/main/java/org/apache/tomcat/maven/runner/PasswordUtil.java
@@ -24,14 +24,13 @@
/**
* Password obfuscate utility class. Lifted from Jetty org.mortbay.jetty.security.Password
- * <p/>
- * <p/>
- * Passwords that begin with OBF: are de obfuscated.
- * <p/>
- * Passwords can be obfuscated by running Obfuscate as a main class. Obfuscated password are required if a system needs
- * to recover the full password (eg. so that it may be passed to another system).
- * <p/>
- * They are not secure, but prevent casual observation.
+ *
+ * <p>Passwords that begin with OBF: are de obfuscated.</p>
+ *
+ * <p>Passwords can be obfuscated by running Obfuscate as a main class. Obfuscated password are required if a system needs
+ * to recover the full password (eg. so that it may be passed to another system).</p>
+ *
+ * <p>They are not secure, but prevent casual observation.</p>
*
* @see <a
* href="http://grepcode.com/file_/repo1.maven.org/maven2/org.mortbay.jetty/jetty/6.1.11/org/mortbay/jetty/security/Password.java/?v=source"