You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kh...@apache.org on 2018/03/30 19:00:23 UTC

[maven-help-plugin] 01/01: [MPH-146] - JavaDoc Issues / Code Cleanups o Removed vesion $Id$ o Fixed JavaDoc issues (removed param which does not exist).

This is an automated email from the ASF dual-hosted git repository.

khmarbaise pushed a commit to branch MPH-146
in repository https://gitbox.apache.org/repos/asf/maven-help-plugin.git

commit 6c3b0e512bbba61ef456f5e09cbd6954ab8a8785
Author: Karl Heinz Marbaise <kh...@apache.org>
AuthorDate: Fri Mar 30 20:59:24 2018 +0200

    [MPH-146] - JavaDoc Issues / Code Cleanups
     o Removed vesion $Id$
     o Fixed JavaDoc issues (removed param which does not exist).
---
 .../org/apache/maven/plugins/help/AbstractEffectiveMojo.java  |  2 --
 .../java/org/apache/maven/plugins/help/AbstractHelpMojo.java  |  1 -
 .../org/apache/maven/plugins/help/ActiveProfilesMojo.java     |  1 -
 .../java/org/apache/maven/plugins/help/AllProfilesMojo.java   | 11 +++++------
 src/main/java/org/apache/maven/plugins/help/DescribeMojo.java |  1 -
 .../java/org/apache/maven/plugins/help/EffectivePomMojo.java  | 11 +++++------
 .../org/apache/maven/plugins/help/EffectiveSettingsMojo.java  |  1 -
 src/main/java/org/apache/maven/plugins/help/EvaluateMojo.java |  1 -
 src/main/java/org/apache/maven/plugins/help/SystemMojo.java   |  1 -
 .../java/org/apache/maven/plugins/help/DescribeMojoTest.java  |  1 -
 .../maven/plugins/help/stubs/DefaultMavenProjectStub.java     |  1 -
 11 files changed, 10 insertions(+), 22 deletions(-)

diff --git a/src/main/java/org/apache/maven/plugins/help/AbstractEffectiveMojo.java b/src/main/java/org/apache/maven/plugins/help/AbstractEffectiveMojo.java
index cbcbd5e..6918be4 100644
--- a/src/main/java/org/apache/maven/plugins/help/AbstractEffectiveMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/AbstractEffectiveMojo.java
@@ -46,7 +46,6 @@ import org.jdom.output.XMLOutputter;
  * Base class with common utilities to write effective Pom/settings.
  *
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
  * @since 2.1
  */
 public abstract class AbstractEffectiveMojo
@@ -57,7 +56,6 @@ public abstract class AbstractEffectiveMojo
      *
      * @param output is the wanted output file.
      * @param content contains the XML content to be written to the file.
-     * @param encoding is the wanted encoding to use when writing file.
      * @throws IOException if any
      * @see AbstractHelpMojo#writeFile(File, String) if encoding is null.
      */
diff --git a/src/main/java/org/apache/maven/plugins/help/AbstractHelpMojo.java b/src/main/java/org/apache/maven/plugins/help/AbstractHelpMojo.java
index 888d4f7..5e6c257 100644
--- a/src/main/java/org/apache/maven/plugins/help/AbstractHelpMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/AbstractHelpMojo.java
@@ -47,7 +47,6 @@ import org.codehaus.plexus.util.WriterFactory;
  * Base class with some Help Mojo functionalities.
  *
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
  * @since 2.1
  */
 public abstract class AbstractHelpMojo
diff --git a/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java b/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
index 95be6b5..7ac8e6b 100644
--- a/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java
@@ -32,7 +32,6 @@ import org.apache.maven.project.MavenProject;
 /**
  * Displays a list of the profiles which are currently active for this build.
  *
- * @version $Id$
  * @since 2.0
  */
 @Mojo( name = "active-profiles", aggregator = true )
diff --git a/src/main/java/org/apache/maven/plugins/help/AllProfilesMojo.java b/src/main/java/org/apache/maven/plugins/help/AllProfilesMojo.java
index 5aa819c..18c96b8 100644
--- a/src/main/java/org/apache/maven/plugins/help/AllProfilesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/AllProfilesMojo.java
@@ -19,6 +19,11 @@ package org.apache.maven.plugins.help;
  * under the License.
  */
 
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
 import org.apache.maven.model.Profile;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
@@ -27,11 +32,6 @@ import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.settings.SettingsUtils;
 
-import java.io.IOException;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
 /**
  * Displays a list of available profiles under the current project.
  * <br>
@@ -40,7 +40,6 @@ import java.util.Map;
  * set profile activation switches/property.
  *
  * @author <a href="mailto:rahul.thakur.xdev@gmail.com">Rahul Thakur</a>
- * @version $Id$
  * @since 2.1
  */
 @Mojo( name = "all-profiles", requiresProject = false )
diff --git a/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java b/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
index b962b98..7a4e125 100644
--- a/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/DescribeMojo.java
@@ -64,7 +64,6 @@ import org.codehaus.plexus.util.StringUtils;
 /**
  * Displays a list of the attributes for a Maven Plugin and/or goals (aka Mojo - Maven plain Old Java Object).
  *
- * @version $Id$
  * @see <a href="http://maven.apache.org/general.html#What_is_a_Mojo">What is a Mojo?</a>
  * @since 2.0
  */
diff --git a/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java b/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
index 26f29cc..63c9d27 100644
--- a/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
@@ -19,6 +19,11 @@ package org.apache.maven.plugins.help;
  * under the License.
  */
 
+import java.io.IOException;
+import java.io.StringWriter;
+import java.util.List;
+import java.util.Properties;
+
 import org.apache.maven.model.Model;
 import org.apache.maven.model.io.xpp3.MavenXpp3Writer;
 import org.apache.maven.plugin.MojoExecution;
@@ -32,15 +37,9 @@ import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;
 import org.codehaus.plexus.util.xml.XMLWriter;
 import org.codehaus.plexus.util.xml.XmlWriterUtil;
 
-import java.io.IOException;
-import java.io.StringWriter;
-import java.util.List;
-import java.util.Properties;
-
 /**
  * Displays the effective POM as an XML for this build, with the active profiles factored in, or a specified artifact.
  *
- * @version $Id$
  * @since 2.0
  */
 @Mojo( name = "effective-pom", aggregator = true )
diff --git a/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java b/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java
index b24174f..90535d0 100644
--- a/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java
@@ -45,7 +45,6 @@ import org.codehaus.plexus.util.xml.XmlWriterUtil;
  * Displays the calculated settings as XML for this project, given any profile enhancement and the inheritance
  * of the global settings into the user-level settings.
  *
- * @version $Id$
  * @since 2.0
  */
 @Mojo( name = "effective-settings", requiresProject = false )
diff --git a/src/main/java/org/apache/maven/plugins/help/EvaluateMojo.java b/src/main/java/org/apache/maven/plugins/help/EvaluateMojo.java
index 859d654..42c32cf 100644
--- a/src/main/java/org/apache/maven/plugins/help/EvaluateMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/EvaluateMojo.java
@@ -67,7 +67,6 @@ import com.thoughtworks.xstream.io.HierarchicalStreamWriter;
  * Evaluates Maven expressions given by the user in an interactive mode.
  *
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
  * @since 2.1
  */
 @Mojo( name = "evaluate", requiresProject = false )
diff --git a/src/main/java/org/apache/maven/plugins/help/SystemMojo.java b/src/main/java/org/apache/maven/plugins/help/SystemMojo.java
index 4247f9f..85973e9 100644
--- a/src/main/java/org/apache/maven/plugins/help/SystemMojo.java
+++ b/src/main/java/org/apache/maven/plugins/help/SystemMojo.java
@@ -32,7 +32,6 @@ import java.util.Properties;
  * Displays a list of the platform details like system properties and environment variables.
  *
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
  * @since 2.1
  */
 @Mojo( name = "system", requiresProject = false )
diff --git a/src/test/java/org/apache/maven/plugins/help/DescribeMojoTest.java b/src/test/java/org/apache/maven/plugins/help/DescribeMojoTest.java
index 16728aa..af88caa 100644
--- a/src/test/java/org/apache/maven/plugins/help/DescribeMojoTest.java
+++ b/src/test/java/org/apache/maven/plugins/help/DescribeMojoTest.java
@@ -45,7 +45,6 @@ import junit.framework.TestCase;
 import junitx.util.PrivateAccessor;
 /**
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
  */
 public class DescribeMojoTest
     extends TestCase
diff --git a/src/test/java/org/apache/maven/plugins/help/stubs/DefaultMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/help/stubs/DefaultMavenProjectStub.java
index 0f9c64b..ee37ae6 100644
--- a/src/test/java/org/apache/maven/plugins/help/stubs/DefaultMavenProjectStub.java
+++ b/src/test/java/org/apache/maven/plugins/help/stubs/DefaultMavenProjectStub.java
@@ -28,7 +28,6 @@ import org.apache.maven.plugin.testing.stubs.MavenProjectStub;
 
 /**
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
  */
 public class DefaultMavenProjectStub
     extends MavenProjectStub

-- 
To stop receiving notification emails like this one, please contact
khmarbaise@apache.org.