Skip to content

Correct misleading @return descriptions in Javadoc #1413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 20, 2025
Merged

Correct misleading @return descriptions in Javadoc #1413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
4 changes: 2 additions & 2 deletions ...lease-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand All @@ -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
*/
Expand Down