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 fc0f646 Javadoc
fc0f646 is described below
commit fc0f646a9b52ddeed7736dcadbf1213ea2ff68cd
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:59:20 2026 -0400
Javadoc
---
.../plugin/mojos/CommonsDistributionDetachmentMojo.java | 2 +-
.../plugin/mojos/CommonsDistributionStagingMojo.java | 8 ++++----
.../commons/release/plugin/slsa/v1_2/BuildDefinition.java | 8 ++++----
.../commons/release/plugin/slsa/v1_2/BuildMetadata.java | 6 +++---
.../apache/commons/release/plugin/slsa/v1_2/Builder.java | 6 +++---
.../commons/release/plugin/slsa/v1_2/DsseEnvelope.java | 6 +++---
.../commons/release/plugin/slsa/v1_2/Provenance.java | 4 ++--
.../release/plugin/slsa/v1_2/ResourceDescriptor.java | 14 +++++++-------
.../commons/release/plugin/slsa/v1_2/RunDetails.java | 6 +++---
.../apache/commons/release/plugin/slsa/v1_2/Signature.java | 4 ++--
.../apache/commons/release/plugin/slsa/v1_2/Statement.java | 6 +++---
.../plugin/velocity/HeaderHtmlVelocityDelegate.java | 2 +-
.../plugin/velocity/ReadmeHtmlVelocityDelegate.java | 8 ++++----
13 files changed, 40 insertions(+), 40 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 e94487b..d027818 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
@@ -193,7 +193,7 @@ public final class CommonsDistributionDetachmentMojo
extends AbstractMojo {
* commons-test-1.4-src.tar.gz should have its name as the key.
*
* @param artifact the {@link Artifact} that we wish to generate a key for.
- * @return the generated key
+ * @return The generated key
*/
private String getArtifactKey(final Artifact artifact) {
return artifact.getFile().getName();
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 738fa5f..2b9c739 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
@@ -213,7 +213,7 @@ public final class CommonsDistributionStagingMojo extends
AbstractMojo {
* </li>
* </ul>
*
- * @return the {@link List} of created files above
+ * @return The {@link List} of created files above
* @throws MojoExecutionException if an {@link IOException} occurs in the
creation of these
* files fails.
*/
@@ -359,7 +359,7 @@ public final class CommonsDistributionStagingMojo extends
AbstractMojo {
* A utility method that takes the <code>RELEASE-NOTES.txt</code> file
from the base directory of the
* project and copies it into {@link
CommonsDistributionStagingMojo#workingDirectory}.
*
- * @return the RELEASE-NOTES.txt file that exists in the
<code>target/commons-release-notes/scm</code>
+ * @return The RELEASE-NOTES.txt file that exists in the
<code>target/commons-release-notes/scm</code>
* directory for the purpose of adding it to the scm change set in
the method
* {@link
CommonsDistributionStagingMojo#copyDistributionsIntoScmDirectoryStructureAndAddToSvn(File,
* ScmProvider, ScmRepository)}.
@@ -378,7 +378,7 @@ public final class CommonsDistributionStagingMojo extends
AbstractMojo {
* Copies our <code>signature-validator.sh</code> script into
*
<code>${basedir}/target/commons-release-plugin/scm/signature-validator.sh</code>.
*
- * @return the {@link File} for the signature-validator.sh
+ * @return The {@link File} for the signature-validator.sh
* @throws MojoExecutionException if an error occurs while the resource is
being copied
*/
private File copySignatureValidatorScriptToScmDirectory() throws
MojoExecutionException {
@@ -396,7 +396,7 @@ public final class CommonsDistributionStagingMojo extends
AbstractMojo {
/**
* Copies <code>${basedir}/target/site</code> to
<code>${basedir}/target/commons-release-plugin/scm/site</code>.
*
- * @return the {@link List} of {@link File}'s contained in
+ * @return The {@link List} of {@link File}'s contained in
* <code>${basedir}/target/commons-release-plugin/scm/site</code>,
after the copy is complete.
* @throws MojoExecutionException if the site copying fails for some
reason.
*/
diff --git
a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildDefinition.java
b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildDefinition.java
index ed18d5a..ed855cf 100644
---
a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildDefinition.java
+++
b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildDefinition.java
@@ -93,7 +93,7 @@ public class BuildDefinition {
*
* <p>Determines the meaning of {@code externalParameters} and {@code
internalParameters}.</p>
*
- * @return the build type URI.
+ * @return The build type URI.
*/
public String getBuildType() {
return buildType;
@@ -102,7 +102,7 @@ public class BuildDefinition {
/**
* Gets the inputs passed to the build, such as command-line arguments or
environment variables.
*
- * @return the external parameters map, or {@code null} if not set.
+ * @return The external parameters map, or {@code null} if not set.
*/
public Map<String, Object> getExternalParameters() {
return externalParameters;
@@ -112,7 +112,7 @@ public class BuildDefinition {
* Gets the artifacts the build depends on, such as sources, dependencies,
build tools, and base images,
* specified by URI and digest.
*
- * @return the internal parameters map, or {@code null} if not set.
+ * @return The internal parameters map, or {@code null} if not set.
*/
public Map<String, Object> getInternalParameters() {
return internalParameters;
@@ -123,7 +123,7 @@ public class BuildDefinition {
*
* <p>Considered incomplete unless resolved materials are present.</p>
*
- * @return the list of resolved dependencies, or {@code null} if not set.
+ * @return The list of resolved dependencies, or {@code null} if not set.
*/
public List<ResourceDescriptor> getResolvedDependencies() {
return resolvedDependencies;
diff --git
a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildMetadata.java
b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildMetadata.java
index 022cd98..909c4ea 100644
---
a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildMetadata.java
+++
b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildMetadata.java
@@ -73,7 +73,7 @@ public class BuildMetadata {
/**
* Gets the timestamp of when the build completed, serialized as RFC 3339
in UTC ({@code "Z"} suffix).
*
- * @return the completion timestamp, or {@code null} if not set.
+ * @return The completion timestamp, or {@code null} if not set.
*/
public OffsetDateTime getFinishedOn() {
return finishedOn;
@@ -82,7 +82,7 @@ public class BuildMetadata {
/**
* Gets the identifier for this build invocation.
*
- * @return the invocation identifier, or {@code null} if not set.
+ * @return The invocation identifier, or {@code null} if not set.
*/
public String getInvocationId() {
return invocationId;
@@ -91,7 +91,7 @@ public class BuildMetadata {
/**
* Gets the timestamp of when the build started, serialized as RFC 3339 in
UTC ({@code "Z"} suffix).
*
- * @return the start timestamp, or {@code null} if not set.
+ * @return The start timestamp, or {@code null} if not set.
*/
public OffsetDateTime getStartedOn() {
return startedOn;
diff --git
a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Builder.java
b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Builder.java
index 7d5d89d..7fb8d23 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Builder.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Builder.java
@@ -61,7 +61,7 @@ public class Builder {
* Gets orchestrator dependencies that do not run within the build
workload and do not affect the build output,
* but may affect provenance generation or security guarantees.
*
- * @return the list of builder dependencies, or {@code null} if not set.
+ * @return The list of builder dependencies, or {@code null} if not set.
*/
public List<ResourceDescriptor> getBuilderDependencies() {
return builderDependencies;
@@ -70,7 +70,7 @@ public class Builder {
/**
* Gets the identifier of the builder.
*
- * @return the builder identifier URI.
+ * @return The builder identifier URI.
*/
public String getId() {
return id;
@@ -79,7 +79,7 @@ public class Builder {
/**
* Gets a map of build platform component names to their versions.
*
- * @return the version map, or {@code null} if not set.
+ * @return The version map, or {@code null} if not set.
*/
public Map<String, String> getVersion() {
return version;
diff --git
a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/DsseEnvelope.java
b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/DsseEnvelope.java
index d83eab7..05da9c8 100644
---
a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/DsseEnvelope.java
+++
b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/DsseEnvelope.java
@@ -62,7 +62,7 @@ public class DsseEnvelope {
*
* <p>When serialized to JSON the bytes are Base64-encoded.</p>
*
- * @return the payload bytes, or {@code null} if not set.
+ * @return The payload bytes, or {@code null} if not set.
*/
public byte[] getPayload() {
return payload;
@@ -71,7 +71,7 @@ public class DsseEnvelope {
/**
* Gets the payload type URI.
*
- * @return the payload type, never {@code null} in a valid envelope.
+ * @return The payload type, never {@code null} in a valid envelope.
*/
public String getPayloadType() {
return payloadType;
@@ -80,7 +80,7 @@ public class DsseEnvelope {
/**
* Gets the list of signatures over the PAE-encoded payload.
*
- * @return the signatures, or {@code null} if not set.
+ * @return The signatures, or {@code null} if not set.
*/
public List<Signature> getSignatures() {
return signatures;
diff --git
a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Provenance.java
b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Provenance.java
index bba9689..ab9ef0e 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Provenance.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Provenance.java
@@ -76,7 +76,7 @@ public class Provenance {
*
* <p>Includes source code, dependencies, build tools, base images, and
other materials.</p>
*
- * @return the build definition, or {@code null} if not set.
+ * @return The build definition, or {@code null} if not set.
*/
public BuildDefinition getBuildDefinition() {
return buildDefinition;
@@ -85,7 +85,7 @@ public class Provenance {
/**
* Gets the details about the invocation of the build tool and the
environment in which it was run.
*
- * @return the run details, or {@code null} if not set.
+ * @return The run details, or {@code null} if not set.
*/
public RunDetails getRunDetails() {
return runDetails;
diff --git
a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/ResourceDescriptor.java
b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/ResourceDescriptor.java
index 48442d7..f1c9a0f 100644
---
a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/ResourceDescriptor.java
+++
b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/ResourceDescriptor.java
@@ -85,7 +85,7 @@ public class ResourceDescriptor {
/**
* Gets additional key-value metadata about the resource, such as
filename, size, or builder-specific attributes.
*
- * @return the annotations map, or {@code null} if not set.
+ * @return The annotations map, or {@code null} if not set.
*/
public Map<String, Object> getAnnotations() {
return annotations;
@@ -94,7 +94,7 @@ public class ResourceDescriptor {
/**
* Gets the raw contents of the resource, base64-encoded when serialized
to JSON.
*
- * @return the resource content, or {@code null} if not set.
+ * @return The resource content, or {@code null} if not set.
*/
public byte[] getContent() {
return content;
@@ -105,7 +105,7 @@ public class ResourceDescriptor {
*
* <p>Common keys include {@code "sha256"} and {@code "sha512"}.</p>
*
- * @return the digest map, or {@code null} if not set.
+ * @return The digest map, or {@code null} if not set.
*/
public Map<String, String> getDigest() {
return digest;
@@ -114,7 +114,7 @@ public class ResourceDescriptor {
/**
* Gets the download URI for the resource, if different from {@link
#getUri()}.
*
- * @return the download location URI, or {@code null} if not set.
+ * @return The download location URI, or {@code null} if not set.
*/
public String getDownloadLocation() {
return downloadLocation;
@@ -123,7 +123,7 @@ public class ResourceDescriptor {
/**
* Gets the media type of the resource (e.g., {@code
"application/octet-stream"}).
*
- * @return the media type, or {@code null} if not set.
+ * @return The media type, or {@code null} if not set.
*/
public String getMediaType() {
return mediaType;
@@ -132,7 +132,7 @@ public class ResourceDescriptor {
/**
* Gets the name of the resource.
*
- * @return the resource name, or {@code null} if not set.
+ * @return The resource name, or {@code null} if not set.
*/
public String getName() {
return name;
@@ -141,7 +141,7 @@ public class ResourceDescriptor {
/**
* Gets the URI identifying the resource.
*
- * @return the resource URI, or {@code null} if not set.
+ * @return The resource URI, or {@code null} if not set.
*/
public String getUri() {
return uri;
diff --git
a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/RunDetails.java
b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/RunDetails.java
index b9f5050..ac73d18 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/RunDetails.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/RunDetails.java
@@ -81,7 +81,7 @@ public class RunDetails {
*
* <p>Trusted to have correctly performed the operation and populated this
provenance.</p>
*
- * @return the builder, or {@code null} if not set.
+ * @return The builder, or {@code null} if not set.
*/
public Builder getBuilder() {
return builder;
@@ -90,7 +90,7 @@ public class RunDetails {
/**
* Gets artifacts produced as a side effect of the build that are not the
primary output.
*
- * @return the list of byproduct artifacts, or {@code null} if not set.
+ * @return The list of byproduct artifacts, or {@code null} if not set.
*/
public List<ResourceDescriptor> getByproducts() {
return byproducts;
@@ -99,7 +99,7 @@ public class RunDetails {
/**
* Gets the metadata about the build invocation, including its identifier
and timing.
*
- * @return the build metadata, or {@code null} if not set.
+ * @return The build metadata, or {@code null} if not set.
*/
public BuildMetadata getMetadata() {
return metadata;
diff --git
a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Signature.java
b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Signature.java
index 48b0205..b6ce514 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Signature.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Signature.java
@@ -59,7 +59,7 @@ public class Signature {
/**
* Gets the key identifier hint, or {@code null} if not set.
*
- * @return the key identifier, or {@code null}
+ * @return The key identifier, or {@code null}
*/
public String getKeyid() {
return keyid;
@@ -68,7 +68,7 @@ public class Signature {
/**
* Gets the raw signature bytes.
*
- * @return the signature bytes, or {@code null} if not set.
+ * @return The signature bytes, or {@code null} if not set.
*/
public byte[] getSig() {
return sig;
diff --git
a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Statement.java
b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Statement.java
index 9ac57bf..5647eb7 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Statement.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Statement.java
@@ -71,7 +71,7 @@ public class Statement {
* <p>Unset is treated the same as set-but-empty. May be omitted if {@code
predicateType} fully describes the
* predicate.</p>
*
- * @return the provenance predicate, or {@code null} if not set.
+ * @return The provenance predicate, or {@code null} if not set.
*/
public Provenance getPredicate() {
return predicate;
@@ -80,7 +80,7 @@ public class Statement {
/**
* Gets the URI identifying the type of the predicate.
*
- * @return the predicate type URI, or {@code null} if no predicate has
been set.
+ * @return The predicate type URI, or {@code null} if no predicate has
been set.
*/
public String getPredicateType() {
return predicateType;
@@ -91,7 +91,7 @@ public class Statement {
*
* <p>Each element represents a single artifact. Artifacts are matched
purely by digest, regardless of content type.</p>
*
- * @return the list of subject artifacts, or {@code null} if not set.
+ * @return The list of subject artifacts, or {@code null} if not set.
*/
public List<ResourceDescriptor> getSubject() {
return subject;
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 adb8a21..56293e7 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
@@ -73,7 +73,7 @@ public final class HeaderHtmlVelocityDelegate {
* Builds the HEADER.vm velocity template to the writer passed in.
*
* @param writer any {@link Writer} that we wish to have the filled
velocity template written to.
- * @return the {@link Writer} that we've filled out the template into.
+ * @return The {@link Writer} that we've filled out the template into.
*/
public Writer render(final Writer writer) {
final VelocityEngine ve = new VelocityEngine();
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 1e9758e..cf91b27 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
@@ -67,7 +67,7 @@ public final class ReadmeHtmlVelocityDelegate {
* Adds the artifactId to the {@link ReadmeHtmlVelocityDelegate}.
*
* @param artifactId the {@link String} representing the maven
artifactId.
- * @return the builder to continue building.
+ * @return The builder to continue building.
*/
public ReadmeHtmlVelocityDelegateBuilder setArtifactId(final String
artifactId) {
this.artifactId = artifactId;
@@ -78,7 +78,7 @@ public final class ReadmeHtmlVelocityDelegate {
* Adds the siteUrl to the {@link ReadmeHtmlVelocityDelegate}.
*
* @param siteUrl the site url to be used in the
<code>README.html</code>
- * @return the builder to continue building.
+ * @return The builder to continue building.
*/
public ReadmeHtmlVelocityDelegateBuilder setSiteUrl(final String
siteUrl) {
this.siteUrl = siteUrl;
@@ -89,7 +89,7 @@ public final class ReadmeHtmlVelocityDelegate {
* Adds the version to the {@link ReadmeHtmlVelocityDelegate}.
*
* @param version the maven version.
- * @return the builder to continue building.
+ * @return The builder to continue building.
*/
public ReadmeHtmlVelocityDelegateBuilder setVersion(final String
version) {
this.version = version;
@@ -104,7 +104,7 @@ public final class ReadmeHtmlVelocityDelegate {
/**
* Gets the {@link ReadmeHtmlVelocityDelegateBuilder} for constructing the
{@link ReadmeHtmlVelocityDelegate}.
*
- * @return the {@link ReadmeHtmlVelocityDelegateBuilder}.
+ * @return The {@link ReadmeHtmlVelocityDelegateBuilder}.
*/
public static ReadmeHtmlVelocityDelegateBuilder builder() {
return new ReadmeHtmlVelocityDelegateBuilder();
