From f328396c7758c4e92cbe2e45e60bf4c838894323 Mon Sep 17 00:00:00 2001
From: Brandon Clayton <bclayton@usgs.gov>
Date: Wed, 20 Apr 2022 09:00:41 -0600
Subject: [PATCH] add comments, add field
---
.../gov/usgs/earthquake/nshmp/internal/AppVersion.java | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/src/main/java/gov/usgs/earthquake/nshmp/internal/AppVersion.java b/src/main/java/gov/usgs/earthquake/nshmp/internal/AppVersion.java
index 0df51c57..deb50f63 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/internal/AppVersion.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/internal/AppVersion.java
@@ -6,8 +6,14 @@ import com.google.common.base.Charsets;
import com.google.common.io.Resources;
import com.google.gson.Gson;
+/**
+ * Interface for reading in version info JSON files.
+ */
public interface AppVersion {
+ /**
+ * Returns the version info for the repo.
+ */
public VersionInfo getVersionInfo();
static VersionInfo versionInfo(URL resource) {
@@ -20,6 +26,9 @@ public interface AppVersion {
}
}
+ /**
+ * The version info of a repository.
+ */
public static class VersionInfo {
public String branchName;
public int commitDistance;
@@ -27,6 +36,7 @@ public interface AppVersion {
public String gitHashFull;
public boolean isCleanTag;
public String lastTag;
+ public String projectName;
public String url;
public String version;
}
--
GitLab