You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2021/04/11 20:59:58 UTC
[maven-release] branch master updated: Fix JavaDoc
This is an automated email from the ASF dual-hosted git repository.
rfscholte pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-release.git
The following commit(s) were added to refs/heads/master by this push:
new 35d18ed Fix JavaDoc
35d18ed is described below
commit 35d18ed8cbd25b2701850ef6bcf32b6d70fde52d
Author: rfscholte <rf...@apache.org>
AuthorDate: Sun Apr 11 22:59:36 2021 +0200
Fix JavaDoc
---
maven-release-manager/src/main/mdo/release-descriptor.mdo | 10 +++++-----
.../apache/maven/shared/release/phase/IsScmBranchEquals.java | 2 +-
.../shared/release/phase/IsScmBranchParametersEquals.java | 2 ++
.../apache/maven/shared/release/phase/IsScmFileSetEquals.java | 5 +++--
.../org/apache/maven/shared/release/phase/IsScmTagEquals.java | 3 +--
.../maven/shared/release/phase/IsScmTagParametersEquals.java | 2 ++
.../plugins/release/stubs/FlatMultiModuleMavenProjectStub.java | 8 ++++----
.../apache/maven/plugins/release/stubs/MavenProjectStub.java | 9 ++++-----
8 files changed, 22 insertions(+), 19 deletions(-)
diff --git a/maven-release-manager/src/main/mdo/release-descriptor.mdo b/maven-release-manager/src/main/mdo/release-descriptor.mdo
index 7a86868..7238700 100644
--- a/maven-release-manager/src/main/mdo/release-descriptor.mdo
+++ b/maven-release-manager/src/main/mdo/release-descriptor.mdo
@@ -503,7 +503,7 @@
<type>boolean</type>
<defaultValue>false</defaultValue>
<description>
- NOTE : currently only implemented with svn scm. Enable a workaround to prevent issue due to svn client > 1.5.0
+ NOTE : currently only implemented with svn scm. Enable a workaround to prevent issue due to svn client &gt; 1.5.0
(http://jira.codehaus.org/browse/SCM-406)
</description>
</field>
@@ -669,8 +669,8 @@
/**
* Method addReleaseVersion.
*
- * @param key
- * @param value
+ * @param projectId
+ * @param version
*/
public void addReleaseVersion( String projectId, String version )
{
@@ -689,8 +689,8 @@
/**
* Method addDevelopmentVersion.
*
- * @param key
- * @param value
+ * @param projectId
+ * @param version
*/
public void addDevelopmentVersion( String projectId, String version )
{
diff --git a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmBranchEquals.java b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmBranchEquals.java
index 79840d4..31404a8 100644
--- a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmBranchEquals.java
+++ b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmBranchEquals.java
@@ -23,7 +23,7 @@ import org.apache.maven.scm.ScmBranch;
import org.mockito.ArgumentMatcher;
/**
- * JMock constraint to compare tags since it has no equals method.
+ * Mockito constraint to compare tags since it has no equals method.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
*/
diff --git a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmBranchParametersEquals.java b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmBranchParametersEquals.java
index 88c0497..e6aea94 100644
--- a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmBranchParametersEquals.java
+++ b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmBranchParametersEquals.java
@@ -24,6 +24,8 @@ import org.apache.maven.scm.ScmBranchParameters;
import org.mockito.ArgumentMatcher;
/**
+ * Mockito constraint to compare tags since it has no equals method.
+ *
* @author <a href="mailto:olamy@apache.org">olamy</a>
*/
public class IsScmBranchParametersEquals implements ArgumentMatcher<ScmBranchParameters>
diff --git a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmFileSetEquals.java b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmFileSetEquals.java
index 51f32a0..6f0a6b3 100644
--- a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmFileSetEquals.java
+++ b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmFileSetEquals.java
@@ -25,10 +25,9 @@ import org.apache.maven.scm.ScmFileSet;
import org.mockito.ArgumentMatcher;
/**
- * JMock constraint to compare file sets since it has no equals method.
+ * Mockito constraint to compare file sets since it has no equals method.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- * @todo add an equals() method
*/
public class IsScmFileSetEquals implements ArgumentMatcher<ScmFileSet>
{
@@ -55,4 +54,6 @@ public class IsScmFileSetEquals implements ArgumentMatcher<ScmFileSet>
throw new RuntimeException(e.getMessage(), e);
}
}
+
+
}
\ No newline at end of file
diff --git a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmTagEquals.java b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmTagEquals.java
index c559247..6affb41 100644
--- a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmTagEquals.java
+++ b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmTagEquals.java
@@ -23,10 +23,9 @@ import org.apache.maven.scm.ScmTag;
import org.mockito.ArgumentMatcher;
/**
- * JMock constraint to compare tags since it has no equals method.
+ * Mockito constraint to compare tags since it has no equals method.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- * @todo add an equals() method
*/
public class IsScmTagEquals implements ArgumentMatcher<ScmTag>
{
diff --git a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmTagParametersEquals.java b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmTagParametersEquals.java
index 12a2f52..629f7d6 100644
--- a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmTagParametersEquals.java
+++ b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/IsScmTagParametersEquals.java
@@ -23,6 +23,8 @@ import org.apache.maven.scm.ScmTagParameters;
import org.mockito.ArgumentMatcher;
/**
+ * Mockito constraint to compare tags since it has no equals method.
+ *
* @author <a href="mailto:olamy@apache.org">olamy</a>
*/
public class IsScmTagParametersEquals implements ArgumentMatcher<ScmTagParameters>
diff --git a/maven-release-plugin/src/test/java/org/apache/maven/plugins/release/stubs/FlatMultiModuleMavenProjectStub.java b/maven-release-plugin/src/test/java/org/apache/maven/plugins/release/stubs/FlatMultiModuleMavenProjectStub.java
index afb33f8..44ff468 100644
--- a/maven-release-plugin/src/test/java/org/apache/maven/plugins/release/stubs/FlatMultiModuleMavenProjectStub.java
+++ b/maven-release-plugin/src/test/java/org/apache/maven/plugins/release/stubs/FlatMultiModuleMavenProjectStub.java
@@ -28,10 +28,10 @@ import org.apache.maven.model.Model;
import org.apache.maven.model.Scm;
/**
- * Stub for a MavenProject with a flat structure.
- * <p/>
- * TODO: shouldn't need to do this, but the "stub" in the harness just throws away values you set.
- * Just overriding the ones I need for this plugin.
+ * <p>Stub for a MavenProject with a flat structure.</p>
+ *
+ * <p>TODO: shouldn't need to do this, but the "stub" in the harness just throws away values you set.
+ * Just overriding the ones I need for this plugin.</p>
*
* @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
*/
diff --git a/maven-release-plugin/src/test/java/org/apache/maven/plugins/release/stubs/MavenProjectStub.java b/maven-release-plugin/src/test/java/org/apache/maven/plugins/release/stubs/MavenProjectStub.java
index 63eefa4..8e377b7 100644
--- a/maven-release-plugin/src/test/java/org/apache/maven/plugins/release/stubs/MavenProjectStub.java
+++ b/maven-release-plugin/src/test/java/org/apache/maven/plugins/release/stubs/MavenProjectStub.java
@@ -23,13 +23,12 @@ import org.apache.maven.model.DistributionManagement;
import org.apache.maven.model.Model;
/**
- * Stub for MavenProject.
- * <p/>
- * TODO: shouldn't need to do this, but the "stub" in the harness just throws away values you set.
- * Just overriding the ones I need for this plugin.
+ * <p>Stub for MavenProject.</p>
+ *
+ * <p>TODO: shouldn't need to do this, but the "stub" in the harness just throws away values you set.
+ * Just overriding the ones I need for this plugin.</p>
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- * @noinspection ClassNameSameAsAncestorName
*/
public class MavenProjectStub
extends org.apache.maven.plugin.testing.stubs.MavenProjectStub