(maven-release) branch master updated: [DOCS] Correct misleading @return descriptions in Javadoc

[sjaranowski]

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

sjaranowski 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 0ef2b83e [DOCS] Correct misleading @return descriptions in Javadoc
0ef2b83e is described below

commit 0ef2b83e2a13fd23c2575185f676745c0e469b01
Author: Harsh Mehta <harshmehta010...@gmail.com>
AuthorDate: Sun Nov 9 15:19:48 2025 +0530

    [DOCS] Correct misleading @return descriptions in Javadoc
---
 .../org/apache/maven/shared/release/policy/naming/NamingPolicy.java   | 2 +-
 .../org/apache/maven/shared/release/policy/version/VersionPolicy.java | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git 
a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicy.java
 
b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicy.java
index 43c5e8c3..d6964c85 100644
--- 
a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicy.java
+++ 
b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicy.java
@@ -30,7 +30,7 @@ public interface NamingPolicy {
      * <p>getName.</p>
      *
      * @param request the {@code NamingPolicyRequest}
-     * @return the calculation of the name used for branching or tagging
+     * @return the name used for branching or tagging
      * @throws org.apache.maven.shared.release.policy.PolicyException if 
exception in the policy
      */
     NamingPolicyResult getName(NamingPolicyRequest request) throws 
PolicyException;
diff --git 
a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicy.java
 
b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicy.java
index a17c562d..a4a2a62c 100644
--- 
a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicy.java
+++ 
b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicy.java
@@ -31,7 +31,7 @@ public interface VersionPolicy {
      * <p>getReleaseVersion.</p>
      *
      * @param request the {@code VersionPolicyRequest}
-     * @return the calculation of the release version from development state
+     * @return the release version derived from the development state
      * @throws org.apache.maven.shared.release.policy.PolicyException if 
exception in the policy
      * @throws org.apache.maven.shared.release.versions.VersionParseException 
if exception parsing the version
      */
@@ -41,7 +41,7 @@ public interface VersionPolicy {
      * <p>getDevelopmentVersion.</p>
      *
      * @param request the {@code VersionPolicyRequest}
-     * @return the calculation of the next development version from release 
state
+     * @return the next development version derived from release state
      * @throws org.apache.maven.shared.release.policy.PolicyException if 
exception in the policy
      * @throws org.apache.maven.shared.release.versions.VersionParseException 
if exception parsing the version
      */