[MSHARED-493] Clean up warnings emitted by Javadoc 8 (doclint) and Ch…

…eckstyle

git-svn-id: https://svn.apache.org/repos/asf/maven/shared/trunk@1726703 13f79535-47bb-0310-9956-ffa450edef68

maven-archiver/src/main/java/org/apache/maven/archiver/ManifestConfiguration.java

@@ -24,8 +24,8 @@
  *
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
  * @version $Id$
- * @todo is this general enough to be in Plexus Archiver?
  */
+// TODO Is this general enough to be in Plexus Archiver?
 public class ManifestConfiguration
 {
     /**
@@ -230,7 +230,7 @@ public String getClasspathPrefix()
      * Return the type of layout to use when formatting classpath entries. Default is taken from the constant
      * CLASSPATH_LAYOUT_TYPE_SIMPLE, declared in this class, which has a value of 'simple'. Other values are:
      * 'repository' (CLASSPATH_LAYOUT_TYPE_REPOSITORY, or the same as a maven classpath layout), and 'custom'
-     * (CLASSPATH_LAYOUT_TYPE_CUSTOM). <br/>
+     * (CLASSPATH_LAYOUT_TYPE_CUSTOM). <br>
      * <b>NOTE:</b> If you specify a type of 'custom' you MUST set
      * {@link ManifestConfiguration#setCustomClasspathLayout(String)}.
      * @return The classpath layout type.
@@ -247,7 +247,7 @@ public String getClasspathLayoutType()
      * Set the type of layout to use when formatting classpath entries. Should be one of: 'simple'
      * (CLASSPATH_LAYOUT_TYPE_SIMPLE), 'repository' (CLASSPATH_LAYOUT_TYPE_REPOSITORY, or the same as a maven classpath
      * layout), and 'custom' (CLASSPATH_LAYOUT_TYPE_CUSTOM). The constant names noted here are defined in the
-     * {@link ManifestConfiguration} class. <br/>
+     * {@link ManifestConfiguration} class. <br>
      * <b>NOTE:</b> If you specify a type of 'custom' you MUST set
      * {@link ManifestConfiguration#setCustomClasspathLayout(String)}.
      * @param classpathLayoutType The classpath layout type.
@@ -262,10 +262,10 @@ public void setClasspathLayoutType( String classpathLayoutType )
      * {@link ManifestConfiguration#setClasspathLayoutType(String)} has the value 'custom'. <b>The default value is
      * null.</b> Expressions will be evaluated against the following ordered list of classpath-related objects:
      * <ol>
-     * <li>The current {@link Artifact} instance, if one exists.</li>
-     * <li>The current {@link ArtifactHandler} instance from the artifact above.</li>
+     * <li>The current {@code Artifact} instance, if one exists.</li>
+     * <li>The current {@code ArtifactHandler} instance from the artifact above.</li>
      * </ol>
-     * <br/>
+     * <br>
      * <b>NOTE:</b> If you specify a layout type of 'custom' you MUST set this layout expression.
      * @return The custom classpath layout.
      */
@@ -279,10 +279,10 @@ public String getCustomClasspathLayout()
      * {@link ManifestConfiguration#setClasspathLayoutType(String)} has the value 'custom'. Expressions will be
      * evaluated against the following ordered list of classpath-related objects:
      * <ol>
-     * <li>The current {@link Artifact} instance, if one exists.</li>
-     * <li>The current {@link ArtifactHandler} instance from the artifact above.</li>
+     * <li>The current {@code Artifact} instance, if one exists.</li>
+     * <li>The current {@code ArtifactHandler} instance from the artifact above.</li>
      * </ol>
-     * <br/>
+     * <br>
      * <b>NOTE:</b> If you specify a layout type of 'custom' you MUST set this layout expression.
      * @param customClasspathLayout The custom classpath layout.
      */
@@ -294,7 +294,7 @@ public void setCustomClasspathLayout( String customClasspathLayout )
     /**
      * Retrieve the flag for whether snapshot artifacts should be added to the classpath using the
      * timestamp/buildnumber version (the default, when this flag is true), or using the generic
-     * -SNAPSHOT version (when the flag is false). <br/>
+     * -SNAPSHOT version (when the flag is false). <br>
      * <b>NOTE:</b> If the snapshot was installed locally, this flag will not have an effect on
      * that artifact's inclusion, since it will have the same version either way (i.e. -SNAPSHOT naming).
      *
@@ -308,7 +308,7 @@ public boolean isUseUniqueVersions()
     /**
      * Set the flag for whether snapshot artifacts should be added to the classpath using the timestamp/buildnumber
      * version (the default, when this flag is true), or using the generic -SNAPSHOT version (when the flag is false).
-     * <br/>
+     * <br>
      * <b>NOTE:</b> If the snapshot was installed locally, this flag will not have an effect on that artifact's
      * inclusion, since it will have the same version either way (i.e. -SNAPSHOT naming).
      * @param useUniqueVersions true to use unique versions or not.

maven-archiver/src/main/java/org/apache/maven/archiver/MavenArchiveConfiguration.java

@@ -30,8 +30,8 @@
  *
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
  * @version $Id$
- * @todo is this general enough to be in Plexus Archiver?
  */
+// TODO Is this general enough to be in Plexus Archiver?
 public class MavenArchiveConfiguration
 {
     private boolean compress = true;

maven-archiver/src/main/java/org/apache/maven/archiver/MavenArchiver.java

@@ -25,7 +25,6 @@
 import org.apache.maven.artifact.versioning.OverConstrainedVersionException;
 import org.apache.maven.execution.MavenSession;
 import org.apache.maven.project.MavenProject;
-import org.codehaus.plexus.archiver.ArchiverException;
 import org.codehaus.plexus.archiver.jar.JarArchiver;
 import org.codehaus.plexus.archiver.jar.Manifest;
 import org.codehaus.plexus.archiver.jar.ManifestException;
@@ -167,13 +166,13 @@ public Manifest getManifest( MavenSession session, MavenProject project, MavenAr
     /**
      * Return a pre-configured manifest
      *
-     * @todo Add user attributes list and user groups list
      * @param project {@link MavenProject}
      * @param config {@link ManifestConfiguration}
      * @return {@link Manifest}
      * @throws ManifestException Manifest exception.
      * @throws DependencyResolutionRequiredException Dependency resolution exception.
      */
+    // TODO Add user attributes list and user groups list
     public Manifest getManifest( MavenProject project, ManifestConfiguration config )
         throws ManifestException, DependencyResolutionRequiredException
     {
@@ -529,14 +528,14 @@ public void setOutputFile( File outputFile )
      * @param session {@link MavenSession}
      * @param project {@link MavenProject}
      * @param archiveConfiguration {@link MavenArchiveConfiguration}
-     * @throws ArchiverException Archiver Exception.
+     * @throws org.codehaus.plexus.archiver.ArchiverException Archiver Exception.
      * @throws ManifestException Manifest Exception.
      * @throws IOException IO Exception.
      * @throws DependencyResolutionRequiredException Dependency resolution exception.
      */
     public void createArchive( MavenSession session, MavenProject project,
                                MavenArchiveConfiguration archiveConfiguration )
-                                   throws ArchiverException, ManifestException, IOException,
+                                   throws ManifestException, IOException,
                                    DependencyResolutionRequiredException
     {
         // we have to clone the project instance so we can write out the pom with the deployment version,

maven-archiver/src/main/java/org/apache/maven/archiver/PomPropertiesUtil.java

@@ -30,7 +30,6 @@
 import org.apache.maven.execution.MavenSession;
 import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.archiver.Archiver;
-import org.codehaus.plexus.archiver.ArchiverException;
 import org.apache.maven.shared.utils.io.IOUtil;
 
 /**
@@ -112,12 +111,12 @@ private void createPropertiesFile( MavenSession session, Properties properties,
      * @param archiver {@link Archiver}
      * @param pomPropertiesFile The pom properties file.
      * @param forceCreation force creation true/flas.e
-     * @throws ArchiverException archiver exception.
+     * @throws org.codehaus.plexus.archiver.ArchiverException archiver exception.
      * @throws IOException IO exception.
      */
     public void createPomProperties( MavenSession session, MavenProject project, Archiver archiver,
                                      File pomPropertiesFile, boolean forceCreation )
-        throws ArchiverException, IOException
+        throws IOException
     {
         final String artifactId = project.getArtifactId();
         final String groupId = project.getGroupId();