This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-release-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 367a9c0 Javadoc
367a9c0 is described below
commit 367a9c0780c9d35fbd1f2d592f4b971f1817b91b
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:09:12 2026 -0400
Javadoc
---
.../release/plugin/mojos/CommonsDistributionDetachmentMojo.java | 2 +-
.../commons/release/plugin/mojos/CommonsDistributionStagingMojo.java | 4 ++--
.../commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.java | 4 ++--
.../commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.java | 4 ++--
4 files changed, 7 insertions(+), 7 deletions(-)
diff --git
a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.java
b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.java
index d027818..deaf9dc 100644
---
a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.java
+++
b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.java
@@ -204,7 +204,7 @@ public final class CommonsDistributionDetachmentMojo
extends AbstractMojo {
*
* @param directory is the {@link File} for the directory in which to make
the <code>.sha512</code> file.
* @param file the {@link File} whose name we should use to create the
<code>.sha512</code> file.
- * @return a {@link String} that is the absolute path to the
<code>.sha512</code> file.
+ * @return A {@link String} that is the absolute path to the
<code>.sha512</code> file.
*/
private String getSha512FilePath(final File directory, final File file) {
final StringBuilder buffer = new
StringBuilder(directory.getAbsolutePath());
diff --git
a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.java
b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.java
index 2b9c739..9d9dbb6 100644
---
a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.java
+++
b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.java
@@ -286,7 +286,7 @@ public final class CommonsDistributionStagingMojo extends
AbstractMojo {
*
<code>target/commons-release-plugin/scm</code> directory.
* @param provider is the {@link ScmProvider} that we will use for adding
the files we wish to commit.
* @param repository is the {@link ScmRepository} that we will use for
adding the files that we wish to commit.
- * @return a {@link List} of {@link File}'s in the directory for the
purpose of adding them to the maven
+ * @return A {@link List} of {@link File}'s in the directory for the
purpose of adding them to the maven
* {@link ScmFileSet}.
* @throws MojoExecutionException if an {@link IOException} occurs so that
Maven can handle it properly.
*/
@@ -331,7 +331,7 @@ public final class CommonsDistributionStagingMojo extends
AbstractMojo {
*
* @param headerFile The originally created <code>HEADER.html</code> file.
* @param readmeFile The originally created <code>README.html</code> file.
- * @return a {@link List} of created files.
+ * @return A {@link List} of created files.
* @throws MojoExecutionException if the {@link
SharedFunctions#copyFile(Log, File, File)}
* fails.
*/
diff --git
a/src/main/java/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.java
b/src/main/java/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.java
index 56293e7..fe811f2 100644
---
a/src/main/java/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.java
+++
b/src/main/java/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.java
@@ -46,7 +46,7 @@ public final class HeaderHtmlVelocityDelegate {
/**
* Builds up the {@link ReadmeHtmlVelocityDelegate} from the
previously set parameters.
*
- * @return a new {@link ReadmeHtmlVelocityDelegate}.
+ * @return A new {@link ReadmeHtmlVelocityDelegate}.
*/
public HeaderHtmlVelocityDelegate build() {
return new HeaderHtmlVelocityDelegate();
@@ -59,7 +59,7 @@ public final class HeaderHtmlVelocityDelegate {
/**
* For instantiating our {@link HeaderHtmlVelocityDelegate} using the
{@link HeaderHtmlVelocityDelegateBuilder}.
*
- * @return a {@link HeaderHtmlVelocityDelegateBuilder}.
+ * @return A {@link HeaderHtmlVelocityDelegateBuilder}.
*/
public static HeaderHtmlVelocityDelegateBuilder builder() {
return new HeaderHtmlVelocityDelegateBuilder();
diff --git
a/src/main/java/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.java
b/src/main/java/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.java
index cf91b27..58a0407 100644
---
a/src/main/java/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.java
+++
b/src/main/java/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.java
@@ -57,7 +57,7 @@ public final class ReadmeHtmlVelocityDelegate {
/**
* Builds up the {@link ReadmeHtmlVelocityDelegate} from the
previously set parameters.
*
- * @return a new {@link ReadmeHtmlVelocityDelegate}.
+ * @return A new {@link ReadmeHtmlVelocityDelegate}.
*/
public ReadmeHtmlVelocityDelegate build() {
return new ReadmeHtmlVelocityDelegate(this.artifactId,
this.version, this.siteUrl);
@@ -137,7 +137,7 @@ public final class ReadmeHtmlVelocityDelegate {
* {@link ReadmeHtmlVelocityDelegateBuilder}.
*
* @param writer is the {@link Writer} to which we wish to render the
<code>README.vm</code> template.
- * @return a reference to the {@link Writer} passed in.
+ * @return A reference to the {@link Writer} passed in.
*/
public Writer render(final Writer writer) {
final VelocityEngine ve = new VelocityEngine();
