added javadoc build

This commit is contained in:
Brian Long 2021-02-26 19:31:35 -05:00
parent 1f7199511b
commit 9f1f904e38
7 changed files with 20 additions and 7 deletions

17
pom.xml
View File

@ -45,6 +45,23 @@
<build> <build>
<plugins> <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> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId> <artifactId>maven-surefire-plugin</artifactId>

View File

@ -52,7 +52,7 @@ public class CachedGit extends Git {
* {@link CloneCommand} object. The clone will be performed before this * {@link CloneCommand} object. The clone will be performed before this
* method returns. * method returns.
* *
* @param git A JGit Git object * @param clone A JGit Git object
* @throws TransportException A network exception occurred * @throws TransportException A network exception occurred
* @throws InvalidRemoteException The specified remote URL does not reference a Git repository * @throws InvalidRemoteException The specified remote URL does not reference a Git repository
* @throws GitAPIException A JGit exception occurred * @throws GitAPIException A JGit exception occurred

View File

@ -38,7 +38,7 @@ public class CredentialedGit extends ExtendedGit {
private CredentialsProvider credProvider; private CredentialsProvider credProvider;
/** /**
* @param clone A JGit Git object * @param git A JGit Git object
* @param creds A JGit credential provider * @param creds A JGit credential provider
* @see CachedGit#CachedGit(Git) * @see CachedGit#CachedGit(Git)
*/ */

View File

@ -25,7 +25,6 @@ import java.util.Map.Entry;
* @param <K> A key data taype * @param <K> A key data taype
* @param <V> A value data type * @param <V> A value data type
*/ */
@PublicApi
public interface ExpiringMapListener<K, V> extends MapListener<K, V> { public interface ExpiringMapListener<K, V> extends MapListener<K, V> {
/** /**

View File

@ -40,7 +40,6 @@ import org.slf4j.LoggerFactory;
* @param <K> A key data type * @param <K> A key data type
* @param <V> A value data type * @param <V> A value data type
*/ */
@PublicApi
public class LRUExpiringHashMap<K extends Serializable, V> implements ListeningMap<K, V> { public class LRUExpiringHashMap<K extends Serializable, V> implements ListeningMap<K, V> {
private final Logger logger = LoggerFactory.getLogger(LRUExpiringHashMap.class); 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 * This method explicitly expires the specified entry. This will expire
* and remove the entry from the underlying map. This is functionality * and remove the entry from the underlying map. This is functionality
* equivalent to {@link Map#remove(Object)} except it will trigger any * 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 * @param key A map entry key
*/ */

View File

@ -24,7 +24,6 @@ import java.util.Map;
* @param <K> A key data taype * @param <K> A key data taype
* @param <V> A value data type * @param <V> A value data type
*/ */
@PublicApi
public interface ListeningMap<K, V> extends Map<K, V> { public interface ListeningMap<K, V> extends Map<K, V> {
/** /**

View File

@ -25,7 +25,6 @@ import java.util.Map.Entry;
* @param <K> A key data taype * @param <K> A key data taype
* @param <V> A value data type * @param <V> A value data type
*/ */
@PublicApi
public interface MapListener<K, V> { public interface MapListener<K, V> {
/** /**