(doc) fix javadoc issues
diff --git a/pom.xml b/pom.xml
index ac25fcb..5c2ed5d 100644
--- a/pom.xml
+++ b/pom.xml
@@ -258,6 +258,16 @@
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>3.1.1</version>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-enforcer-plugin</artifactId>
+ <version>3.0.0-M3</version>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>3.2.0</version>
+ </plugin>
</plugins>
</pluginManagement>
<plugins>
diff --git a/src/main/java/org/apache/maven/plugins/ear/AbstractEarModule.java b/src/main/java/org/apache/maven/plugins/ear/AbstractEarModule.java
index 2186b56..05026b0 100644
--- a/src/main/java/org/apache/maven/plugins/ear/AbstractEarModule.java
+++ b/src/main/java/org/apache/maven/plugins/ear/AbstractEarModule.java
@@ -60,6 +60,9 @@
private String artifactId;
+ /**
+ * The type of the artifact
+ */
protected String type;
private String classifier;
diff --git a/src/main/java/org/apache/maven/plugins/ear/ApplicationXmlWriter.java b/src/main/java/org/apache/maven/plugins/ear/ApplicationXmlWriter.java
index 7b2a8b4..23f2806 100644
--- a/src/main/java/org/apache/maven/plugins/ear/ApplicationXmlWriter.java
+++ b/src/main/java/org/apache/maven/plugins/ear/ApplicationXmlWriter.java
@@ -26,7 +26,7 @@
import org.codehaus.plexus.util.xml.XMLWriter;
/**
- * An <code>XmlWriter</code> based implementation used to generate an <tt>application.xml</tt> file.
+ * An <code>XmlWriter</code> based implementation used to generate an {@code application.xml} file.
*
* @author <a href="snicoll@apache.org">Stephane Nicoll</a>
*/
diff --git a/src/main/java/org/apache/maven/plugins/ear/EarModule.java b/src/main/java/org/apache/maven/plugins/ear/EarModule.java
index 4efd962..80b4f56 100644
--- a/src/main/java/org/apache/maven/plugins/ear/EarModule.java
+++ b/src/main/java/org/apache/maven/plugins/ear/EarModule.java
@@ -36,7 +36,7 @@
/**
* Returns the {@link Artifact} representing this module.
*
- * Note that this might return <tt>null</tt> till the module has been resolved.
+ * Note that this might return {@code null} till the module has been resolved.
*
* @return the artifact
* @see #resolveArtifact(java.util.Set)
@@ -44,9 +44,9 @@
Artifact getArtifact();
/**
- * Returns the <tt>URI</tt> for this module.
+ * Returns the {@code URI} for this module.
*
- * @return the <tt>URI</tt>
+ * @return the {@code URI}
*/
String getUri();
@@ -84,10 +84,10 @@
String getAltDeploymentDescriptor();
/**
- * Appends the <tt>XML</tt> representation of this module.
+ * Appends the {@code XML} representation of this module.
*
* @param writer the writer to use
- * @param version the version of the <tt>application.xml</tt> file
+ * @param version the version of the {@code application.xml} file
* @param generateId whether an id should be generated
*/
void appendModule( XMLWriter writer, String version, Boolean generateId );
@@ -129,6 +129,8 @@
/**
* If module should be included into the Class-Path entry of MANIFEST.mf. Doesn't impact Class-Path entry of
* MANIFEST.mf of modules which contain all of their dependencies unless skinnyWars / skinnyModules is turned on.
+ *
+ * @return {@code }True} if module should be included into the Class-Path entry of MANIFEST.mf
*/
boolean isClassPathItem();
diff --git a/src/main/java/org/apache/maven/plugins/ear/EarModuleFactory.java b/src/main/java/org/apache/maven/plugins/ear/EarModuleFactory.java
index f8a1ba9..e52827c 100644
--- a/src/main/java/org/apache/maven/plugins/ear/EarModuleFactory.java
+++ b/src/main/java/org/apache/maven/plugins/ear/EarModuleFactory.java
@@ -28,7 +28,7 @@
import org.apache.maven.plugins.ear.util.JavaEEVersion;
/**
- * Builds an {@link EarModule} based on an <tt>Artifact</tt>.
+ * Builds an {@link EarModule} based on an {@code Artifact}.
*
* @author <a href="snicoll@apache.org">Stephane Nicoll</a>
*/
diff --git a/src/main/java/org/apache/maven/plugins/ear/EjbRef.java b/src/main/java/org/apache/maven/plugins/ear/EjbRef.java
index 622b6ad..2f5ef5f 100644
--- a/src/main/java/org/apache/maven/plugins/ear/EjbRef.java
+++ b/src/main/java/org/apache/maven/plugins/ear/EjbRef.java
@@ -75,7 +75,7 @@
}
/**
- * Appends the <tt>XML</tt> representation of this env-entry.
+ * Appends the {@code XML} representation of this env-entry.
*
* @param writer the writer to use
*/
diff --git a/src/main/java/org/apache/maven/plugins/ear/EnvEntry.java b/src/main/java/org/apache/maven/plugins/ear/EnvEntry.java
index 34046c3..18b44b5 100644
--- a/src/main/java/org/apache/maven/plugins/ear/EnvEntry.java
+++ b/src/main/java/org/apache/maven/plugins/ear/EnvEntry.java
@@ -98,7 +98,7 @@
}
/**
- * Appends the <tt>XML</tt> representation of this env-entry.
+ * Appends the {@code XML} representation of this env-entry.
*
* @param writer the writer to use
*/
diff --git a/src/main/java/org/apache/maven/plugins/ear/GenerateApplicationXmlMojo.java b/src/main/java/org/apache/maven/plugins/ear/GenerateApplicationXmlMojo.java
index bb06f32..8ec99a0 100644
--- a/src/main/java/org/apache/maven/plugins/ear/GenerateApplicationXmlMojo.java
+++ b/src/main/java/org/apache/maven/plugins/ear/GenerateApplicationXmlMojo.java
@@ -99,14 +99,14 @@
private String description;
/**
- * Defines how the <tt>library-directory</tt> element should be written in the application.xml file.
+ * Defines how the {@code library-directory} element should be written in the application.xml file.
* <p/>
* Three special values can be set:
* <ul>
- * <li><code>DEFAULT</code> (default) generates a <tt>library-directory</tt> element with the value of the
- * <tt>defaultLibBundleDir</tt> parameter</li>
- * <li><code>EMPTY</code> generates an empty <tt>library-directory</tt> element. Per spec, this disables the
- * scanning of jar files in the <tt>lib</tt> directory of the ear file</li>
+ * <li><code>DEFAULT</code> (default) generates a {@code library-directory} element with the value of the
+ * {@code defaultLibBundleDir} parameter</li>
+ * <li><code>EMPTY</code> generates an empty {@code library-directory} element. Per spec, this disables the
+ * scanning of jar files in the {@code lib} directory of the ear file</li>
* <li><code>NONE</code> does not write the library-directory element at all. A corner case that can be used in
* Oracle Weblogic to delegate the classloading to the container</li>
* </ul>
@@ -505,7 +505,7 @@
}
/**
- * Returns the value to use for the <tt>library-directory</tt> element, based on the library directory mode.
+ * Returns the value to use for the {@code library-directory} element, based on the library directory mode.
*/
private String getActualLibraryDirectory()
throws EarPluginException
diff --git a/src/main/java/org/apache/maven/plugins/ear/JarModule.java b/src/main/java/org/apache/maven/plugins/ear/JarModule.java
index ccdef84..0a925c8 100644
--- a/src/main/java/org/apache/maven/plugins/ear/JarModule.java
+++ b/src/main/java/org/apache/maven/plugins/ear/JarModule.java
@@ -28,9 +28,9 @@
/**
* The {@link EarModule} implementation for a non J2EE module such as third party libraries.
*
- * <p>Such module is not incorporated in the generated <tt>application.xml</tt>
+ * <p>Such module is not incorporated in the generated {@code application.xml}
* but some application servers support it. To include it in the generated
- * deployment descriptor anyway, set the <tt>includeInApplicationXml</tt> boolean flag.
+ * deployment descriptor anyway, set the {@code includeInApplicationXml} boolean flag.
* </p>
*
* @author <a href="snicoll@apache.org">Stephane Nicoll</a>
diff --git a/src/main/java/org/apache/maven/plugins/ear/JbossAppXmlWriter.java b/src/main/java/org/apache/maven/plugins/ear/JbossAppXmlWriter.java
index e3dd73f..666acbc 100644
--- a/src/main/java/org/apache/maven/plugins/ear/JbossAppXmlWriter.java
+++ b/src/main/java/org/apache/maven/plugins/ear/JbossAppXmlWriter.java
@@ -27,7 +27,7 @@
import org.codehaus.plexus.util.xml.XMLWriter;
/**
- * An <tt>XmlWriter</tt> based implementation used to generate a <tt>jboss-app.xml</tt> file
+ * An {@code XmlWriter} based implementation used to generate a {@code jboss-app.xml} file
*
* @author <a href="snicoll@apache.org">Stephane Nicoll</a>
*/
diff --git a/src/main/java/org/apache/maven/plugins/ear/JbossConfiguration.java b/src/main/java/org/apache/maven/plugins/ear/JbossConfiguration.java
index ef8354f..3f712f5 100644
--- a/src/main/java/org/apache/maven/plugins/ear/JbossConfiguration.java
+++ b/src/main/java/org/apache/maven/plugins/ear/JbossConfiguration.java
@@ -275,7 +275,7 @@
* <module-order>implicit</module-order> The implicit value indicates the deployment would follow the order which
* would be specified in the DeploymentSorter.
* <p/>
- * Returns <tt>null</tt> if no module order is set.
+ * Returns {@code null} if no module order is set.
* <p/>
* Only available in JBoss 4.2 and 4.3. Has no effect in JBoss 5 and is not added when mentioned version is used.
*
@@ -287,7 +287,7 @@
}
/**
- * Returns the list of datasources to include in the <tt>jboss-app.xml</tt> file as services. Each element of the
+ * Returns the list of datasources to include in the {@code jboss-app.xml} file as services. Each element of the
* list is the relative path to the datasource file contained in the EAR archive.
*
* @return the list of datasources paths
@@ -298,7 +298,7 @@
}
/**
- * Returns the library directory to include in the <tt>jboss-app.xml</tt> file. It tells JBoss where to find
+ * Returns the library directory to include in the {@code jboss-app.xml} file. It tells JBoss where to find
* non-Java EE libraries included in the EAR.
*
* @return the library directory
@@ -309,10 +309,10 @@
}
/**
- * Returns the class loader repository configuration to include in the <tt>jboss-app.xml</tt> file. The content of
+ * Returns the class loader repository configuration to include in the {@code jboss-app.xml} file. The content of
* this element is handed to the class loader, thereby altering it's default behaviour.
* <p/>
- * This element is added as a child to the <tt>loader-repository</tt> element. If the element is not present in the
+ * This element is added as a child to the {@code loader-repository} element. If the element is not present in the
* configuration, it will be added.
* <p/>
* Example: <loader-repository-config>java2ParentDelegaton=true</loader-repository-config>
@@ -325,10 +325,10 @@
}
/**
- * Returns the class loader repository class to include in the <tt>jboss-app.xml</tt> file. It tells JBoss which
+ * Returns the class loader repository class to include in the {@code jboss-app.xml} file. It tells JBoss which
* loader repository implementation to use.
* <p/>
- * This element is added as an attribute to the <tt>loader-repository</tt> element, therefore it is not added if no
+ * This element is added as an attribute to the {@code loader-repository} element, therefore it is not added if no
* such element configuration is present.
* <p/>
* Example: <loader-repository-class>org.mindbug.jboss.AlternateLoaderRepository</loader-repository-class>
@@ -341,10 +341,10 @@
}
/**
- * Returns the class loader's configuration parser class to include in the <tt>jboss-app.xml</tt> file. It tells
- * JBoss how to parse the configuration given in the <tt>loader-repository-config</tt> element.
+ * Returns the class loader's configuration parser class to include in the {@code jboss-app.xml} file. It tells
+ * JBoss how to parse the configuration given in the {@code loader-repository-config} element.
* <p/>
- * This element is added as an attribute to the <tt>loader-repository-config</tt> element, therefore it is not added
+ * This element is added as an attribute to the {@code loader-repository-config} element, therefore it is not added
* if no such element configuration is present.
* <p/>
* Example: <config-parser-class>org.mindbug.jboss.AlternateLoaderRepositoryConfigParser</config-parser-class>
diff --git a/src/main/java/org/apache/maven/plugins/ear/JbossEarModule.java b/src/main/java/org/apache/maven/plugins/ear/JbossEarModule.java
index f0c4174..4dedb4a 100644
--- a/src/main/java/org/apache/maven/plugins/ear/JbossEarModule.java
+++ b/src/main/java/org/apache/maven/plugins/ear/JbossEarModule.java
@@ -29,10 +29,10 @@
public interface JbossEarModule
{
/**
- * Appends the <tt>XML</tt> representation of this module for the jboss-app.xml file.
+ * Appends the {@code XML} representation of this module for the jboss-app.xml file.
*
* @param writer the writer to use
- * @param version the version of the <tt>jboss-app.xml</tt> file
+ * @param version the version of the {@code jboss-app.xml} file
*/
void appendJbossModule( XMLWriter writer, String version );
}
diff --git a/src/main/java/org/apache/maven/plugins/ear/ResourceRef.java b/src/main/java/org/apache/maven/plugins/ear/ResourceRef.java
index 7151036..a8d5bf2 100644
--- a/src/main/java/org/apache/maven/plugins/ear/ResourceRef.java
+++ b/src/main/java/org/apache/maven/plugins/ear/ResourceRef.java
@@ -91,7 +91,7 @@
}
/**
- * Appends the <tt>XML</tt> representation of this env-entry.
+ * Appends the {@code XML} representation of this env-entry.
*
* @param writer the writer to use
*/
diff --git a/src/main/java/org/apache/maven/plugins/ear/SecurityRole.java b/src/main/java/org/apache/maven/plugins/ear/SecurityRole.java
index 90ee8f9..1f4a0d8 100644
--- a/src/main/java/org/apache/maven/plugins/ear/SecurityRole.java
+++ b/src/main/java/org/apache/maven/plugins/ear/SecurityRole.java
@@ -86,7 +86,7 @@
}
/**
- * Appends the <tt>XML</tt> representation of this security role.
+ * Appends the {@code XML} representation of this security role.
*
* @param writer the writer to use
*/
diff --git a/src/main/java/org/apache/maven/plugins/ear/WebModule.java b/src/main/java/org/apache/maven/plugins/ear/WebModule.java
index 89f1ae2..9a0796b 100644
--- a/src/main/java/org/apache/maven/plugins/ear/WebModule.java
+++ b/src/main/java/org/apache/maven/plugins/ear/WebModule.java
@@ -108,7 +108,7 @@
/**
* Returns the context root to use for the web module.
*
- * Note that this might return <tt>null</tt> till the artifact has been resolved.
+ * Note that this might return {@code null} till the artifact has been resolved.
*
* @return the context root
*/
@@ -118,7 +118,7 @@
}
/**
- * Generates a default context root for the given artifact, based on the <tt>artifactId</tt>.
+ * Generates a default context root for the given artifact, based on the {@code artifactId}.
*
* @param a the artifact
* @return a context root for the artifact
diff --git a/src/main/java/org/apache/maven/plugins/ear/util/ArtifactTypeMappingService.java b/src/main/java/org/apache/maven/plugins/ear/util/ArtifactTypeMappingService.java
index e8631ae..a3105c4 100644
--- a/src/main/java/org/apache/maven/plugins/ear/util/ArtifactTypeMappingService.java
+++ b/src/main/java/org/apache/maven/plugins/ear/util/ArtifactTypeMappingService.java
@@ -113,7 +113,7 @@
}
/**
- * Specify whether the <tt>customType</tt> could be mapped to the <tt>standardType</tt>.
+ * Specify whether the {@code customType} could be mapped to the {@code standardType}.
*
* @param standardType the standard type (ejb, jar, war, ...)
* @param customType a user-defined type
@@ -131,7 +131,7 @@
}
/**
- * Returns the standard type for the specified <tt>type</tt>. If the specified type is already a standard type, the
+ * Returns the standard type for the specified {@code type}. If the specified type is already a standard type, the
* orignal type is returned.
*
* @param type a type
diff --git a/src/main/java/org/apache/maven/plugins/ear/util/EarMavenArchiver.java b/src/main/java/org/apache/maven/plugins/ear/util/EarMavenArchiver.java
index d0ac62d..e813bef 100644
--- a/src/main/java/org/apache/maven/plugins/ear/util/EarMavenArchiver.java
+++ b/src/main/java/org/apache/maven/plugins/ear/util/EarMavenArchiver.java
@@ -103,10 +103,10 @@
}
/**
- * Generates the <tt>Class-Path</tt> entry of the manifest according to the list of ear modules.
+ * Generates the {@code Class-Path} entry of the manifest according to the list of ear modules.
*
* @param classPathPrefix the classpath prefix to use
- * @return the <tt>Class-Path</tt> entry
+ * @return the {@code Class-Path} entry
*/
protected String generateClassPathEntry( String classPathPrefix )
{
diff --git a/src/main/java/org/apache/maven/plugins/ear/util/InvalidJavaEEVersion.java b/src/main/java/org/apache/maven/plugins/ear/util/InvalidJavaEEVersion.java
index 9a6df3c..f5c886c 100644
--- a/src/main/java/org/apache/maven/plugins/ear/util/InvalidJavaEEVersion.java
+++ b/src/main/java/org/apache/maven/plugins/ear/util/InvalidJavaEEVersion.java
@@ -33,6 +33,9 @@
*/
private static final long serialVersionUID = 3189028517550801372L;
+ /**
+ * The invalid version
+ */
private final String invalidVersion;
/**
diff --git a/src/main/java/org/apache/maven/plugins/ear/util/JavaEEVersion.java b/src/main/java/org/apache/maven/plugins/ear/util/JavaEEVersion.java
index 8283822..c1d500f 100644
--- a/src/main/java/org/apache/maven/plugins/ear/util/JavaEEVersion.java
+++ b/src/main/java/org/apache/maven/plugins/ear/util/JavaEEVersion.java
@@ -115,7 +115,7 @@
* Specifies if this version is greater or equal to the specified version.
*
* @param paramVersion the version to check
- * @return true if this version is greater or equal to <tt>version</tt>
+ * @return true if this version is greater or equal to {@code version}
*/
public boolean ge( JavaEEVersion paramVersion )
{
@@ -126,7 +126,7 @@
* Specifies if this version is greater than the specified version.
*
* @param paramVersion the version to check
- * @return true if this version is greater to <tt>version</tt>
+ * @return true if this version is greater to {@code version}
*/
public boolean gt( JavaEEVersion paramVersion )
{
@@ -137,7 +137,7 @@
* Specifies if this version is equal to the specified version.
*
* @param paramVersion the version to check
- * @return true if this version is equal to <tt>version</tt>
+ * @return true if this version is equal to {@code version}
*/
public boolean eq( JavaEEVersion paramVersion )
{
@@ -148,7 +148,7 @@
* Specifies if this version is less or equal to the specified version.
*
* @param paramVersion the version to check
- * @return true if this version is less or equal to <tt>version</tt>
+ * @return true if this version is less or equal to {@code version}
*/
public boolean le( JavaEEVersion paramVersion )
{
@@ -159,7 +159,7 @@
* Specifies if this version is less than the specified version.
*
* @param paramVersion the version to check
- * @return true if this version is less or equal to <tt>version</tt>
+ * @return true if this version is less or equal to {@code version}
*/
public boolean lt( JavaEEVersion paramVersion )
{
@@ -170,7 +170,7 @@
* Checks if the specified version string is valid.
*
* @param paramVersion the version string to check
- * @return <tt>true</tt> if the version is valid
+ * @return {@code true} if the version is valid
*/
private static boolean isValid( String paramVersion )
{
diff --git a/src/test/java/org/apache/maven/plugins/ear/it/AbstractEarPluginIT.java b/src/test/java/org/apache/maven/plugins/ear/it/AbstractEarPluginIT.java
index 758d023..a9e7229 100644
--- a/src/test/java/org/apache/maven/plugins/ear/it/AbstractEarPluginIT.java
+++ b/src/test/java/org/apache/maven/plugins/ear/it/AbstractEarPluginIT.java
@@ -467,8 +467,8 @@
/**
* Asserts that the deployment descriptors have been generated successfully.
*
- * This test assumes that deployment descriptors are located in the <tt>expected-META-INF</tt> directory of the
- * project. Note that the <tt>MANIFEST.mf</tt> file is ignored and is not tested.
+ * This test assumes that deployment descriptors are located in the {@code expected-META-INF} directory of the
+ * project. Note that the {@code MANIFEST.mf} file is ignored and is not tested.
*
* @param baseDir the directory of the tested project
* @param projectName the name of the project
diff --git a/src/test/java/org/apache/maven/plugins/ear/it/EarMojoIT.java b/src/test/java/org/apache/maven/plugins/ear/it/EarMojoIT.java
index af49067..f81623f 100644
--- a/src/test/java/org/apache/maven/plugins/ear/it/EarMojoIT.java
+++ b/src/test/java/org/apache/maven/plugins/ear/it/EarMojoIT.java
@@ -56,7 +56,7 @@
}
/**
- * Builds an EAR with a default bundle directory for <tt>java</tt> modules.
+ * Builds an EAR with a default bundle directory for {@code java} modules.
*/
public void testProject003()
throws Exception
