From 79e6a4b23236e82a325a23128f21973ff1202f1f Mon Sep 17 00:00:00 2001
From: iadgovuser58 <124906646+iadgovuser58@users.noreply.github.com>
Date: Tue, 4 Jun 2024 08:41:52 -0400
Subject: [PATCH] cleaning up comments

---
 .../hirs/utils/tpm/eventlog/TCGEventLog.java     |  2 +-
 .../hirs/utils/tpm/eventlog/TpmPcrEvent.java     |  2 +-
 .../hirs/utils/tpm/eventlog/uefi/UefiGuid.java   | 16 ++++++++++++----
 .../tpm/eventlog/uefi/UefiSignatureList.java     |  4 +++-
 .../utils/tpm/eventlog/uefi/UefiVariable.java    |  2 +-
 5 files changed, 18 insertions(+), 8 deletions(-)

diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/TCGEventLog.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/TCGEventLog.java
index e380bf4a..7c0142f4 100644
--- a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/TCGEventLog.java
+++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/TCGEventLog.java
@@ -86,7 +86,7 @@ public final class TCGEventLog {
      * Default is normal status (normal status is from-filesystem).
      * Status will only change IF there is a UefiVariable event in this log,
      * and if that event causes a different status.
-     * */
+     */
     @Getter
     private String vendorTableFileStatus = FILESTATUS_FROM_FILESYSTEM;
 
diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/TpmPcrEvent.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/TpmPcrEvent.java
index aac18480..1df953f1 100644
--- a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/TpmPcrEvent.java
+++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/TpmPcrEvent.java
@@ -125,7 +125,7 @@ public class TpmPcrEvent {
      * Default is normal status (normal status is from-filesystem).
      * Status will only change IF this is an event that has a UefiVariable,
      * and if that event causes a different status.
-     * */
+     */
     @Getter
     private String vendorTableFileStatus = FILESTATUS_FROM_FILESYSTEM;
 
diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiGuid.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiGuid.java
index 464b5a85..5d37abf9 100644
--- a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiGuid.java
+++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiGuid.java
@@ -27,14 +27,22 @@ public class UefiGuid {
      * used for conversion to uuid time.
      */
     private static final int UUID_EPOCH_DIVISOR = 10000;
-
+    /**
+     * Filesystem path of vendor-table.json
+     */
     private static final Path JSON_PATH = FileSystems.getDefault().getPath("/etc",
             "hirs", "aca", "default-properties", "vendor-table.json");
-
+    /**
+     * Name of vendor-table file in code
+     */
     private static final String JSON_FILENAME = "vendor-table2.json";
-
+    /**
+     * Reference to the vendor-table json object
+     */
     private JsonObject uefiVendorRef;
-    /** Track status of vendor-table.json */
+    /**
+     * Track status of vendor-table.json
+     */
     @Getter
     private String vendorTableFileStatus = FILESTATUS_NOT_ACCESSIBLE;
 
diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiSignatureList.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiSignatureList.java
index e1a00c57..e98e0990 100644
--- a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiSignatureList.java
+++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiSignatureList.java
@@ -71,7 +71,9 @@ public class UefiSignatureList {
      * Type of signature.
      */
     private UefiGuid signatureType = null;
-    /** Track status of vendor-table.json */
+    /**
+     * Track status of vendor-table.json
+     */
     @Getter
     private String vendorTableFileStatus = FILESTATUS_NOT_ACCESSIBLE;
 
diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiVariable.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiVariable.java
index ea01c189..ba6607b2 100644
--- a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiVariable.java
+++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiVariable.java
@@ -71,7 +71,7 @@ public class UefiVariable {
      * The default here is that each list correctly grabbed the file from file system.
      * If any one list has issues, this overall status will change to reflect the
      * problematic list's status.
-     * */
+     */
     @Getter
     private String vendorTableFileStatus = FILESTATUS_FROM_FILESYSTEM;