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 76e6e09 Javadoc
76e6e09 is described below
commit 76e6e09695d55ef5d36b65c3dee25865520b5d78
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 11:22:48 2026 -0400
Javadoc
---
.../org/apache/commons/release/plugin/SharedFunctions.java | 12 ++++++------
.../plugin/mojos/CommonsDistributionDetachmentMojo.java | 4 ++--
.../plugin/mojos/CommonsDistributionStagingMojo.java | 2 +-
.../release/plugin/mojos/CommonsSiteCompressionMojo.java | 12 ++++++------
.../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 | 4 ++--
.../plugin/velocity/ReadmeHtmlVelocityDelegate.java | 6 +++---
14 files changed, 47 insertions(+), 47 deletions(-)
diff --git
a/src/main/java/org/apache/commons/release/plugin/SharedFunctions.java
b/src/main/java/org/apache/commons/release/plugin/SharedFunctions.java
index ffe3ab8..f983c5e 100644
--- a/src/main/java/org/apache/commons/release/plugin/SharedFunctions.java
+++ b/src/main/java/org/apache/commons/release/plugin/SharedFunctions.java
@@ -48,9 +48,9 @@ public final class SharedFunctions {
* Copies a {@link File} from the <code>fromFile</code> to the
<code>toFile</code> and logs the failure
* using the Maven {@link Log}.
*
- * @param log the {@link Log}, the maven logger.
- * @param fromFile the {@link File} from which to copy.
- * @param toFile the {@link File} to which to copy into.
+ * @param log The {@link Log}, the maven logger.
+ * @param fromFile The {@link File} from which to copy.
+ * @param toFile The {@link File} to which to copy into.
* @throws MojoExecutionException if an {@link IOException} or {@link
NullPointerException} is caught.
*/
public static void copyFile(final Log log, final File fromFile, final File
toFile) throws MojoExecutionException {
@@ -104,7 +104,7 @@ public final class SharedFunctions {
*
* </blockquote>
*
- * @param obj the object reference to check for nullity
+ * @param obj The object reference to check for nullity
* @param <T> The type of the reference
* @return {@code obj} if not {@code null}
* @throws MojoExecutionException if {@code obj} is {@code null}
@@ -129,7 +129,7 @@ public final class SharedFunctions {
*
* </blockquote>
*
- * @param obj the object reference to check for nullity
+ * @param obj The object reference to check for nullity
* @param message detail message to be used in the event that a {@code
* NullPointerException} is thrown
* @param <T> The type of the reference
@@ -151,7 +151,7 @@ public final class SharedFunctions {
* message supplier are less than the cost of just creating the string
message directly.
* </p>
*
- * @param obj the object reference to check for nullity
+ * @param obj The object reference to check for nullity
* @param messageSupplier supplier of the detail message to be used in the
event that a {@code NullPointerException} is thrown
* @param <T> The type of the reference
* @return {@code obj} if not {@code null}
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 deaf9dc..f953d95 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
@@ -192,7 +192,7 @@ public final class CommonsDistributionDetachmentMojo
extends AbstractMojo {
* Generates the unique artifact key for storage in our sha512 map. For
example,
* 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.
+ * @param artifact The {@link Artifact} that we wish to generate a key for.
* @return The generated key
*/
private String getArtifactKey(final Artifact artifact) {
@@ -203,7 +203,7 @@ public final class CommonsDistributionDetachmentMojo
extends AbstractMojo {
* A helper method to create a file path for the <code>sha512</code>
signature file from a given file.
*
* @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.
+ * @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.
*/
private String getSha512FilePath(final File directory, final File file) {
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 9d9dbb6..1270d30 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
@@ -502,7 +502,7 @@ public final class CommonsDistributionStagingMojo extends
AbstractMojo {
* Lists all directories and files to a flat list.
*
* @param directory {@link File} containing directory to list
- * @param files a {@link List} of {@link File} to which to append the
files.
+ * @param files A {@link List} of {@link File} to which to append the
files.
*/
private void listNotHiddenFilesAndDirectories(final File directory, final
List<File> files) {
// Get all the files and directories from a directory.
diff --git
a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.java
b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.java
index e50907e..ef2c5fe 100644
---
a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.java
+++
b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.java
@@ -95,10 +95,10 @@ public final class CommonsSiteCompressionMojo extends
AbstractMojo {
* Given the <code>directoryToZip</code> we add the <code>file</code> to
the ZIP archive represented by
* <code>zos</code>.
*
- * @param directoryToZip a {@link File} representing the directory from
which the file exists that we are
+ * @param directoryToZip A {@link File} representing the directory from
which the file exists that we are
* compressing. Generally this is
<code>target/site</code>.
- * @param file a {@link File} to add to the {@link ZipOutputStream}
<code>zos</code>.
- * @param zos the {@link ZipOutputStream} to which to add our
<code>file</code>.
+ * @param file A {@link File} to add to the {@link ZipOutputStream}
<code>zos</code>.
+ * @param zos The {@link ZipOutputStream} to which to add our
<code>file</code>.
* @throws IOException if adding the <code>file</code> doesn't work out
properly.
*/
private void addToZip(final File directoryToZip, final File file, final
ZipOutputStream zos) throws IOException {
@@ -152,8 +152,8 @@ public final class CommonsSiteCompressionMojo extends
AbstractMojo {
* By default this method iterates across the <code>target/site</code>
directory and adds all the files
* to the {@link CommonsSiteCompressionMojo#filesToCompress} {@link List}.
*
- * @param siteDirectory the {@link File} that represents the
<code>target/site</code> directory.
- * @param filesToCompress the {@link List} to which to add all the files.
+ * @param siteDirectory The {@link File} that represents the
<code>target/site</code> directory.
+ * @param filesToCompress The {@link List} to which to add all the files.
*/
private void getAllSiteFiles(final File siteDirectory, final List<File>
filesToCompress) {
final File[] files = siteDirectory.listFiles();
@@ -172,7 +172,7 @@ public final class CommonsSiteCompressionMojo extends
AbstractMojo {
* @param outputDirectory is a {@link File} representing the place to put
the site.zip file.
* @param directoryToZip is a {@link File} representing the directory of
the site (normally
* <code>target/site</code>).
- * @param fileList the list of files to be zipped up, generally generated
by
+ * @param fileList The list of files to be zipped up, generally generated
by
* {@link CommonsSiteCompressionMojo#getAllSiteFiles(File,
List)}.
* @throws IOException when the copying of the files goes incorrectly.
*/
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 ed855cf..c354623 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
@@ -137,7 +137,7 @@ public class BuildDefinition {
/**
* Sets the URI indicating what type of build was performed.
*
- * @param buildType the build type URI.
+ * @param buildType The build type URI.
* @return this for chaining.
*/
public BuildDefinition setBuildType(String buildType) {
@@ -148,7 +148,7 @@ public class BuildDefinition {
/**
* Sets the inputs passed to the build.
*
- * @param externalParameters the external parameters map.
+ * @param externalParameters The external parameters map.
* @return this for chaining.
*/
public BuildDefinition setExternalParameters(Map<String, Object>
externalParameters) {
@@ -159,7 +159,7 @@ public class BuildDefinition {
/**
* Sets the artifacts the build depends on.
*
- * @param internalParameters the internal parameters map.
+ * @param internalParameters The internal parameters map.
* @return this for chaining.
*/
public BuildDefinition setInternalParameters(Map<String, Object>
internalParameters) {
@@ -170,7 +170,7 @@ public class BuildDefinition {
/**
* Sets the materials that influenced the build.
*
- * @param resolvedDependencies the list of resolved dependencies.
+ * @param resolvedDependencies The list of resolved dependencies.
* @return this for chaining.
*/
public BuildDefinition setResolvedDependencies(List<ResourceDescriptor>
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 909c4ea..8825552 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
@@ -105,7 +105,7 @@ public class BuildMetadata {
/**
* Sets the timestamp of when the build completed.
*
- * @param finishedOn the completion timestamp.
+ * @param finishedOn The completion timestamp.
* @return this for chaining.
*/
public BuildMetadata setFinishedOn(OffsetDateTime finishedOn) {
@@ -116,7 +116,7 @@ public class BuildMetadata {
/**
* Sets the identifier for this build invocation.
*
- * @param invocationId the invocation identifier.
+ * @param invocationId The invocation identifier.
* @return this for chaining.
*/
public BuildMetadata setInvocationId(String invocationId) {
@@ -127,7 +127,7 @@ public class BuildMetadata {
/**
* Sets the timestamp of when the build started.
*
- * @param startedOn the start timestamp.
+ * @param startedOn The start timestamp.
* @return this for chaining.
*/
public BuildMetadata setStartedOn(OffsetDateTime 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 7fb8d23..ea03c66 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
@@ -93,7 +93,7 @@ public class Builder {
/**
* Sets the orchestrator dependencies that may affect provenance
generation or security guarantees.
*
- * @param builderDependencies the list of builder dependencies.
+ * @param builderDependencies The list of builder dependencies.
* @return this for chaining.
*/
public Builder setBuilderDependencies(List<ResourceDescriptor>
builderDependencies) {
@@ -104,7 +104,7 @@ public class Builder {
/**
* Sets the identifier of the builder.
*
- * @param id the builder identifier URI.
+ * @param id The builder identifier URI.
* @return this for chaining.
*/
public Builder setId(String id) {
@@ -115,7 +115,7 @@ public class Builder {
/**
* Sets the map of build platform component names to their versions.
*
- * @param version the version map.
+ * @param version The version map.
* @return this for chaining.
*/
public Builder setVersion(Map<String, String> 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 05da9c8..c0ce9cb 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
@@ -94,7 +94,7 @@ public class DsseEnvelope {
/**
* Sets the serialized payload bytes.
*
- * @param payload the payload bytes.
+ * @param payload The payload bytes.
* @return this for chaining.
*/
public DsseEnvelope setPayload(byte[] payload) {
@@ -105,7 +105,7 @@ public class DsseEnvelope {
/**
* Sets the payload type URI.
*
- * @param payloadType the payload type URI.
+ * @param payloadType The payload type URI.
* @return this for chaining.
*/
public DsseEnvelope setPayloadType(String payloadType) {
@@ -116,7 +116,7 @@ public class DsseEnvelope {
/**
* Sets the list of signatures over the PAE-encoded payload.
*
- * @param signatures the signatures.
+ * @param signatures The signatures.
* @return this for chaining.
*/
public DsseEnvelope setSignatures(List<Signature> 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 ab9ef0e..5297898 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
@@ -99,7 +99,7 @@ public class Provenance {
/**
* Sets the build definition describing all inputs that produced the build
output.
*
- * @param buildDefinition the build definition.
+ * @param buildDefinition The build definition.
* @return this for chaining.
*/
public Provenance setBuildDefinition(BuildDefinition buildDefinition) {
@@ -110,7 +110,7 @@ public class Provenance {
/**
* Sets the details about the invocation of the build tool and the
environment in which it was run.
*
- * @param runDetails the run details.
+ * @param runDetails The run details.
* @return this for chaining.
*/
public Provenance setRunDetails(RunDetails 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 f1c9a0f..b710802 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
@@ -155,7 +155,7 @@ public class ResourceDescriptor {
/**
* Sets additional key-value metadata about the resource.
*
- * @param annotations the annotations map.
+ * @param annotations The annotations map.
* @return this for chaining.
*/
public ResourceDescriptor setAnnotations(Map<String, Object> annotations) {
@@ -166,7 +166,7 @@ public class ResourceDescriptor {
/**
* Sets the raw contents of the resource.
*
- * @param content the resource content.
+ * @param content The resource content.
* @return this for chaining.
*/
public ResourceDescriptor setContent(byte[] content) {
@@ -177,7 +177,7 @@ public class ResourceDescriptor {
/**
* Sets the map of cryptographic digest algorithms to their hex-encoded
values.
*
- * @param digest the digest map.
+ * @param digest The digest map.
* @return this for chaining.
*/
public ResourceDescriptor setDigest(Map<String, String> digest) {
@@ -188,7 +188,7 @@ public class ResourceDescriptor {
/**
* Sets the download URI for the resource.
*
- * @param downloadLocation the download location URI.
+ * @param downloadLocation The download location URI.
* @return this for chaining.
*/
public ResourceDescriptor setDownloadLocation(String downloadLocation) {
@@ -199,7 +199,7 @@ public class ResourceDescriptor {
/**
* Sets the media type of the resource.
*
- * @param mediaType the media type.
+ * @param mediaType The media type.
* @return this for chaining.
*/
public ResourceDescriptor setMediaType(String mediaType) {
@@ -210,7 +210,7 @@ public class ResourceDescriptor {
/**
* Sets the name of the resource.
*
- * @param name the resource name.
+ * @param name The resource name.
* @return this for chaining.
*/
public ResourceDescriptor setName(String name) {
@@ -221,7 +221,7 @@ public class ResourceDescriptor {
/**
* Sets the URI identifying the resource.
*
- * @param uri the resource URI.
+ * @param uri The resource URI.
* @return this for chaining.
*/
public ResourceDescriptor setUri(String 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 ac73d18..8ba4a02 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
@@ -113,7 +113,7 @@ public class RunDetails {
/**
* Sets the builder that executed the invocation.
*
- * @param builder the builder.
+ * @param builder The builder.
* @return this for chaining.
*/
public RunDetails setBuilder(Builder builder) {
@@ -124,7 +124,7 @@ public class RunDetails {
/**
* Sets the artifacts produced as a side effect of the build that are not
the primary output.
*
- * @param byproducts the list of byproduct artifacts.
+ * @param byproducts The list of byproduct artifacts.
* @return this for chaining.
*/
public RunDetails setByproducts(List<ResourceDescriptor> byproducts) {
@@ -135,7 +135,7 @@ public class RunDetails {
/**
* Sets the metadata about the build invocation.
*
- * @param metadata the build metadata.
+ * @param metadata The build metadata.
* @return this for chaining.
*/
public RunDetails setMetadata(BuildMetadata 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 b6ce514..be590f5 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
@@ -82,7 +82,7 @@ public class Signature {
/**
* Sets the key identifier hint.
*
- * @param keyid the key identifier, or {@code null} to leave unset.
+ * @param keyid The key identifier, or {@code null} to leave unset.
* @return this for chaining.
*/
public Signature setKeyid(String keyid) {
@@ -93,7 +93,7 @@ public class Signature {
/**
* Sets the raw signature bytes.
*
- * @param sig the signature bytes.
+ * @param sig The signature bytes.
* @return this for chaining.
*/
public Signature setSig(byte[] 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 5647eb7..b3d35b2 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
@@ -105,7 +105,7 @@ public class Statement {
/**
* Sets the provenance predicate and automatically assigns {@code
predicateType} to the SLSA provenance v1 URI.
*
- * @param predicate the provenance predicate.
+ * @param predicate The provenance predicate.
* @return this for chaining.
*/
public Statement setPredicate(Provenance predicate) {
@@ -117,7 +117,7 @@ public class Statement {
/**
* Sets the set of software artifacts that the attestation applies to.
*
- * @param subject the list of subject artifacts.
+ * @param subject The list of subject artifacts.
* @return this for chaining.
*/
public Statement setSubject(List<ResourceDescriptor> subject) {
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 58a0407..999f7e7 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
@@ -66,7 +66,7 @@ public final class ReadmeHtmlVelocityDelegate {
/**
* Adds the artifactId to the {@link ReadmeHtmlVelocityDelegate}.
*
- * @param artifactId the {@link String} representing the maven
artifactId.
+ * @param artifactId The {@link String} representing the maven
artifactId.
* @return The builder to continue building.
*/
public ReadmeHtmlVelocityDelegateBuilder setArtifactId(final String
artifactId) {
@@ -77,7 +77,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>
+ * @param siteUrl The site url to be used in the
<code>README.html</code>
* @return The builder to continue building.
*/
public ReadmeHtmlVelocityDelegateBuilder setSiteUrl(final String
siteUrl) {
@@ -88,7 +88,7 @@ public final class ReadmeHtmlVelocityDelegate {
/**
* Adds the version to the {@link ReadmeHtmlVelocityDelegate}.
*
- * @param version the maven version.
+ * @param version The maven version.
* @return The builder to continue building.
*/
public ReadmeHtmlVelocityDelegateBuilder setVersion(final String
version) {
