From d22b150f99c2c493e6b372c8820bcb76e82d4a5a Mon Sep 17 00:00:00 2001
From: Arthit Suriyawongkul <arthit@gmail.com>
Date: Tue, 6 May 2025 05:11:44 +0100
Subject: [PATCH 1/2] Add Javadoc to org.spdx.utility.verificationcode

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
---
 .../utility/verificationcode/IFileChecksumGenerator.java  | 2 ++
 .../verificationcode/JavaSha1ChecksumGenerator.java       | 4 +++-
 .../verificationcode/VerificationCodeGenerator.java       | 8 +++++++-
 3 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/spdx/utility/verificationcode/IFileChecksumGenerator.java b/src/main/java/org/spdx/utility/verificationcode/IFileChecksumGenerator.java
index 144b553f..f1b2e299 100644
--- a/src/main/java/org/spdx/utility/verificationcode/IFileChecksumGenerator.java
+++ b/src/main/java/org/spdx/utility/verificationcode/IFileChecksumGenerator.java
@@ -27,6 +27,8 @@
  */
 public interface IFileChecksumGenerator {
 	/**
+	 * Generate a checksum for the file
+	 *
 	 * @param file File to generate the checksum for
 	 * @return the checksum for the file
 	 * @throws IOException on errors reading the file
diff --git a/src/main/java/org/spdx/utility/verificationcode/JavaSha1ChecksumGenerator.java b/src/main/java/org/spdx/utility/verificationcode/JavaSha1ChecksumGenerator.java
index 68299cea..f3195dc0 100644
--- a/src/main/java/org/spdx/utility/verificationcode/JavaSha1ChecksumGenerator.java
+++ b/src/main/java/org/spdx/utility/verificationcode/JavaSha1ChecksumGenerator.java
@@ -24,7 +24,7 @@
 import java.security.NoSuchAlgorithmException;
 
 /**
- * Java sha1 checksum generator using MessageDigest
+ * Java SHA1 checksum generator using MessageDigest
  *
  * @author Gary O'Neall
  */
@@ -35,6 +35,7 @@ public class JavaSha1ChecksumGenerator implements IFileChecksumGenerator {
 
 	/**
 	 * Create a SHA1 based checksum generator
+	 *
 	 * @throws NoSuchAlgorithmException if the SHA1 algorithm does not exist
 	 */
 	public JavaSha1ChecksumGenerator() throws NoSuchAlgorithmException {
@@ -42,6 +43,7 @@ public JavaSha1ChecksumGenerator() throws NoSuchAlgorithmException {
 	}
 
 	/**
+	 * Generate a checksum for the file using SHA1
 	 *
 	 * @param file File to generate the checksum for
 	 * @return file checksum
diff --git a/src/main/java/org/spdx/utility/verificationcode/VerificationCodeGenerator.java b/src/main/java/org/spdx/utility/verificationcode/VerificationCodeGenerator.java
index 6a9e7d1c..1b182e16 100644
--- a/src/main/java/org/spdx/utility/verificationcode/VerificationCodeGenerator.java
+++ b/src/main/java/org/spdx/utility/verificationcode/VerificationCodeGenerator.java
@@ -123,6 +123,8 @@ public SpdxPackageVerificationCode generatePackageVerificationCode(File sourceDi
 	}
 
 	/**
+	 * Generate the SPDX Package Verification Code from a list of file checksums
+	 *
 	 * @param fileChecksums used to create the verification code value
 	 * @param skippedFilePaths list of files skipped when calculating the verification code
 	 * @param modelStore where the resultant VerificationCode is store
@@ -150,8 +152,9 @@ protected SpdxPackageVerificationCode generatePackageVerificationCode(List<Strin
 
 	/**
 	 * Collect the file level checksums and filenames
+	 *
 	 * @param prefixForRelative The portion of the filepath which precedes the relative file path for the archive
-	 * @param sourceDirectory directory to collectd the file data from
+	 * @param sourceDirectory directory to collect the file data from
 	 * @param fileNameAndChecksums resultant list of file names and checksums - added to in this method
 	 * @param skippedFiles files to be ignored in the package verification result
 	 * @throws IOException on IO error reading the directory of file
@@ -229,7 +232,10 @@ private static String convertChecksumToString(byte[] digest) {
         }
 		return sb.toString();
 	}
+
 	/**
+	 * Generate the SPDX Package Verification Code from a directory of files included in the archive
+	 *
 	 * @param sourceDirectory directory to create the verification code for
 	 * @param modelStore where the resultant VerificationCode is store
 	 * @param documentUri document URI where the VerificationCode is stored

From 26af10ef6249d248da34d421625def0b83d4f3b2 Mon Sep 17 00:00:00 2001
From: Arthit Suriyawongkul <arthit@gmail.com>
Date: Tue, 6 May 2025 14:11:34 +0100
Subject: [PATCH 2/2] Add paragraph delimiter

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
---
 src/examples/java/org/spdx/example/Spdx3Example.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/examples/java/org/spdx/example/Spdx3Example.java b/src/examples/java/org/spdx/example/Spdx3Example.java
index 9932d6a2..cce95bf6 100644
--- a/src/examples/java/org/spdx/example/Spdx3Example.java
+++ b/src/examples/java/org/spdx/example/Spdx3Example.java
@@ -30,7 +30,7 @@
 
 /**
  * Example which creates an SBOM from scratch
- *
+ * <p>
  * NOTE: Snippets from this file are used in the GETTING_STARTED.md file - any changes to this file
  * should update the GETTING_STARTED.md file
  */