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 0df51c575a51069c381ff4bc2e7c0ca7b597b8dc..deb50f63fbab9b08de067d00d0ad74a27757a3bc 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; }