From 9f1f904e382a3fc62d5c173caf923cd18b4808b9 Mon Sep 17 00:00:00 2001
From: Brian Long <brian@inteligr8.com>
Date: Fri, 26 Feb 2021 19:31:35 -0500
Subject: [PATCH] added javadoc build

---
 pom.xml                                         | 17 +++++++++++++++++
 src/main/java/com/inteligr8/git/CachedGit.java  |  2 +-
 .../java/com/inteligr8/git/CredentialedGit.java |  2 +-
 .../com/inteligr8/git/ExpiringMapListener.java  |  1 -
 .../com/inteligr8/git/LRUExpiringHashMap.java   |  3 +--
 .../java/com/inteligr8/git/ListeningMap.java    |  1 -
 .../java/com/inteligr8/git/MapListener.java     |  1 -
 7 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/pom.xml b/pom.xml
index 4494f47..7c302da 100644
--- a/pom.xml
+++ b/pom.xml
@@ -45,6 +45,23 @@
 
 	<build>
 		<plugins>
+			<plugin>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<executions>
+					<execution>
+						<id>javadoc</id>
+						<phase>package</phase>
+						<goals><goal>jar</goal></goals>
+						<configuration>
+							<detectLinks>true</detectLinks>
+							<show>public</show>
+							<links>
+								<link>https://download.eclipse.org/jgit/site/${jgit.version}/apidocs</link>
+							</links>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-surefire-plugin</artifactId>
diff --git a/src/main/java/com/inteligr8/git/CachedGit.java b/src/main/java/com/inteligr8/git/CachedGit.java
index 35310ad..6344a9d 100644
--- a/src/main/java/com/inteligr8/git/CachedGit.java
+++ b/src/main/java/com/inteligr8/git/CachedGit.java
@@ -52,7 +52,7 @@ public class CachedGit extends Git {
 	 * {@link CloneCommand} object.  The clone will be performed before this
 	 * method returns.
 	 * 
-	 * @param git A JGit Git object
+	 * @param clone A JGit Git object
 	 * @throws TransportException A network exception occurred
 	 * @throws InvalidRemoteException The specified remote URL does not reference a Git repository
 	 * @throws GitAPIException A JGit exception occurred
diff --git a/src/main/java/com/inteligr8/git/CredentialedGit.java b/src/main/java/com/inteligr8/git/CredentialedGit.java
index c37218e..7b5437a 100644
--- a/src/main/java/com/inteligr8/git/CredentialedGit.java
+++ b/src/main/java/com/inteligr8/git/CredentialedGit.java
@@ -38,7 +38,7 @@ public class CredentialedGit extends ExtendedGit {
 	private CredentialsProvider credProvider;
 
 	/**
-	 * @param clone A JGit Git object
+	 * @param git A JGit Git object
 	 * @param creds A JGit credential provider
 	 * @see CachedGit#CachedGit(Git)
 	 */
diff --git a/src/main/java/com/inteligr8/git/ExpiringMapListener.java b/src/main/java/com/inteligr8/git/ExpiringMapListener.java
index 53b5abf..27f7b62 100644
--- a/src/main/java/com/inteligr8/git/ExpiringMapListener.java
+++ b/src/main/java/com/inteligr8/git/ExpiringMapListener.java
@@ -25,7 +25,6 @@ import java.util.Map.Entry;
  * @param <K> A key data taype
  * @param <V> A value data type
  */
-@PublicApi
 public interface ExpiringMapListener<K, V> extends MapListener<K, V> {
 
 	/**
diff --git a/src/main/java/com/inteligr8/git/LRUExpiringHashMap.java b/src/main/java/com/inteligr8/git/LRUExpiringHashMap.java
index 9be93c1..61deac4 100644
--- a/src/main/java/com/inteligr8/git/LRUExpiringHashMap.java
+++ b/src/main/java/com/inteligr8/git/LRUExpiringHashMap.java
@@ -40,7 +40,6 @@ import org.slf4j.LoggerFactory;
  * @param <K> A key data type
  * @param <V> A value data type
  */
-@PublicApi
 public class LRUExpiringHashMap<K extends Serializable, V> implements ListeningMap<K, V> {
 
 	private final Logger logger = LoggerFactory.getLogger(LRUExpiringHashMap.class);
@@ -292,7 +291,7 @@ public class LRUExpiringHashMap<K extends Serializable, V> implements ListeningM
 	 * This method explicitly expires the specified entry.  This will expire
 	 * and remove the entry from the underlying map.  This is functionality
 	 * equivalent to {@link Map#remove(Object)} except it will trigger any
-	 * listener to {@link ExpiringMapListener#expired(java.util.Map.Entry).
+	 * listener to {@link ExpiringMapListener#expired(java.util.Map.Entry)}.
 	 * 
 	 * @param key A map entry key
 	 */
diff --git a/src/main/java/com/inteligr8/git/ListeningMap.java b/src/main/java/com/inteligr8/git/ListeningMap.java
index 4cc0010..7f79287 100644
--- a/src/main/java/com/inteligr8/git/ListeningMap.java
+++ b/src/main/java/com/inteligr8/git/ListeningMap.java
@@ -24,7 +24,6 @@ import java.util.Map;
  * @param <K> A key data taype
  * @param <V> A value data type
  */
-@PublicApi
 public interface ListeningMap<K, V> extends Map<K, V> {
 	
 	/**
diff --git a/src/main/java/com/inteligr8/git/MapListener.java b/src/main/java/com/inteligr8/git/MapListener.java
index d0631c6..3fe2ca5 100644
--- a/src/main/java/com/inteligr8/git/MapListener.java
+++ b/src/main/java/com/inteligr8/git/MapListener.java
@@ -25,7 +25,6 @@ import java.util.Map.Entry;
  * @param <K> A key data taype
  * @param <V> A value data type
  */
-@PublicApi
 public interface MapListener<K, V> {
 	
 	/**