You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mnemonic.apache.org by yz...@apache.org on 2021/10/11 06:09:12 UTC
[mnemonic] branch master updated: MNEMONIC-691: Fix javadoc error
exposed by JDK15
This is an automated email from the ASF dual-hosted git repository.
yzhao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mnemonic.git
The following commit(s) were added to refs/heads/master by this push:
new 05991c7 MNEMONIC-691: Fix javadoc error exposed by JDK15
05991c7 is described below
commit 05991c79da09fdcd073bec281f9cbdce608fd40c
Author: Zhen Li <rh...@gmail.com>
AuthorDate: Sat Oct 9 22:55:19 2021 -0700
MNEMONIC-691: Fix javadoc error exposed by JDK15
Signed-off-by: Zhen Li <rh...@gmail.com>
---
mnemonic-common/pom.xml | 3 --
.../mnemonic-utilities-service/pom.xml | 4 --
mnemonic-core/pom.xml | 4 --
.../main/java/org/apache/mnemonic/CachePool.java | 62 +++++++++++-----------
.../main/java/org/apache/mnemonic/EvictFilter.java | 12 ++---
.../src/main/java/org/apache/mnemonic/Reclaim.java | 12 ++---
mnemonic-examples/pom.xml | 3 --
.../mnemonic-java-vmem-service/pom.xml | 4 --
.../mnemonic-nvml-pmem-service/pom.xml | 4 --
.../mnemonic-nvml-vmem-service/pom.xml | 4 --
.../mnemonic-pmalloc-service/pom.xml | 4 --
.../mnemonic-pmdk-pmem-service/pom.xml | 4 --
.../mnemonic-pmdk-vmem-service/pom.xml | 4 --
.../mnemonic-sys-vmem-service/pom.xml | 4 --
mnemonic-sessions/pom.xml | 3 --
pom.xml | 8 +--
16 files changed, 45 insertions(+), 94 deletions(-)
diff --git a/mnemonic-common/pom.xml b/mnemonic-common/pom.xml
index c5f30f5..5f05776 100644
--- a/mnemonic-common/pom.xml
+++ b/mnemonic-common/pom.xml
@@ -110,9 +110,6 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
- </configuration>
<executions>
<execution>
<id>attach-javadocs</id>
diff --git a/mnemonic-computing-services/mnemonic-utilities-service/pom.xml b/mnemonic-computing-services/mnemonic-utilities-service/pom.xml
index df46cf2..1098b58 100644
--- a/mnemonic-computing-services/mnemonic-utilities-service/pom.xml
+++ b/mnemonic-computing-services/mnemonic-utilities-service/pom.xml
@@ -115,10 +115,6 @@
<header>Mnenomic-utilities-service, ${project.version}</header>
<footer>Mnenomic-utilities-service, ${project.version}</footer>
<doctitle>Mnenomic, ${project.version}</doctitle>
- <links>
- <link>http://static.springsource.org/spring/docs/3.0.x/javadoc-api/</link>
- <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
- </links>
</configuration>
<executions>
<execution>
diff --git a/mnemonic-core/pom.xml b/mnemonic-core/pom.xml
index e43c354..a96c492 100644
--- a/mnemonic-core/pom.xml
+++ b/mnemonic-core/pom.xml
@@ -162,10 +162,6 @@
<header>Mnenomic-core, ${project.version}</header>
<footer>Mnenomic-core, ${project.version}</footer>
<doctitle>Mnenomic-core, ${project.version}</doctitle>
- <links>
- <link>http://static.springsource.org/spring/docs/3.0.x/javadoc-api/</link>
- <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
- </links>
</configuration>
<executions>
<execution>
diff --git a/mnemonic-core/src/main/java/org/apache/mnemonic/CachePool.java b/mnemonic-core/src/main/java/org/apache/mnemonic/CachePool.java
index 37a87ee..828f654 100644
--- a/mnemonic-core/src/main/java/org/apache/mnemonic/CachePool.java
+++ b/mnemonic-core/src/main/java/org/apache/mnemonic/CachePool.java
@@ -25,13 +25,13 @@ import java.util.Map;
* This is a abstract CachePool class that is inherited from LinedHashMap class,
* it extends functionalities of its parent class to support some new features
* that is usually requried in data caching usage scenario.
- *
- *
+ *
+ *
*/
public abstract class CachePool<KeyT, ValueT> extends LinkedHashMap<KeyT, ValueT> {
/**
- *
+ *
*/
private static final long serialVersionUID = 1L;
@@ -41,14 +41,14 @@ public abstract class CachePool<KeyT, ValueT> extends LinkedHashMap<KeyT, ValueT
/**
* Return available capacity for new entries.
- *
+ *
* @return available capacity in this cache pool
*/
public abstract long freeCapacity();
/**
* Return the used capacity of cached entries.
- *
+ *
* @return the used size of this cache pool
*/
public abstract long usedCapacity();
@@ -60,36 +60,36 @@ public abstract class CachePool<KeyT, ValueT> extends LinkedHashMap<KeyT, ValueT
* the eldest entry that can be customized by ( {@link DropEvent}). If this
* cache pool previously contained an entry for the key, the old value will be
* replaced by the specified value
- *
+ *
* @param k
* the key whoes associated value is to be put
- *
+ *
* @param v
* the value to be put
- *
+ *
* @param fsop
* the customized operations to free space to hold new entry
- *
+ *
* @param dfilter
* the filter of entries for deletion
- *
- * @return <tt>true</tt> if the entry has been put into this container
- *
+ *
+ * @return <code>true</code> if the entry has been put into this container
+ *
*/
public abstract ValueT put(KeyT k, ValueT v, DropEvent<KeyT, ValueT> fsop, EvictFilter<KeyT, ValueT> dfilter);
/**
* Put all entries into this cache pool and evict eldes entries if necessary.
- *
+ *
* @param m
* the Map object that contains entries to be put
- *
+ *
* @param fsop
* the customized operations to free space to hold new entry
- *
+ *
* @param dfilter
* the filter of entries for deletion
- *
+ *
*/
public abstract void putAll(Map<? extends KeyT, ? extends ValueT> m, DropEvent<KeyT, ValueT> fsop,
EvictFilter<KeyT, ValueT> dfilter);
@@ -97,37 +97,37 @@ public abstract class CachePool<KeyT, ValueT> extends LinkedHashMap<KeyT, ValueT
/**
* Returns a new {@link Set} view of the keys of this cache pool, It contains
* the most recently visited keys
- *
+ *
* @param n
* the number of keys to retrieve
- *
+ *
* @return a set of hot keys
*/
public abstract Set<KeyT> hotKeySet(int n);
/**
* Ensure the free capacity is greater than the specified size
- *
+ *
* @param freesz
* the size of free capacity that needs to be secured
- *
- * @return <tt>true</tt> if the size of free capacity is greater than the
+ *
+ * @return <code>true</code> if the size of free capacity is greater than the
* specified size after evacuation
- *
+ *
* @see #ensureFreeSpace(long, DropEvent, EvictFilter)
*/
public abstract boolean ensureFreeSpace(long freesz);
/**
* Removes a first qualified entry in this cache pool
- *
+ *
* @param fsop
* the customized callback to post-process its evicted entry
- *
+ *
* @param dfilter
* the filter for entry deletion
- *
- * @return <tt>true</tt> if there is one qualified entry that has been dropped
+ *
+ * @return <code>true</code> if there is one qualified entry that has been dropped
*/
public abstract boolean removeFirstEntry(DropEvent<KeyT, ValueT> fsop, EvictFilter<KeyT, ValueT> dfilter);
@@ -135,17 +135,17 @@ public abstract class CachePool<KeyT, ValueT> extends LinkedHashMap<KeyT, ValueT
* Ensure the size of free capacity is greater than the specified size, the
* entries will be filtered by {@link EvictFilter} before dropping, the
* {@link DropEvent} is used for post-processing
- *
+ *
* @param freesz
* the size of free capacity that needs to be secured
- *
+ *
* @param fsop
* the customized operations to free space to hold new entry
- *
+ *
* @param dfilter
* the filter of entries for deletion
- *
- * @return <tt>true</tt> if the size of free capacity is greater than the
+ *
+ * @return <code>true</code> if the size of free capacity is greater than the
* specified size after evication if necessary
*/
public abstract boolean ensureFreeSpace(long freesz, DropEvent<KeyT, ValueT> fsop, EvictFilter<KeyT, ValueT> dfilter);
diff --git a/mnemonic-core/src/main/java/org/apache/mnemonic/EvictFilter.java b/mnemonic-core/src/main/java/org/apache/mnemonic/EvictFilter.java
index 1d48a18..96a7404 100644
--- a/mnemonic-core/src/main/java/org/apache/mnemonic/EvictFilter.java
+++ b/mnemonic-core/src/main/java/org/apache/mnemonic/EvictFilter.java
@@ -19,22 +19,22 @@ package org.apache.mnemonic;
/**
* A listener callback to validate its accepted key-value pair for evacuation.
- *
+ *
*/
public interface EvictFilter<KeyT, ValueT> {
/**
* A call-back validator when an entry will be evicted.
- *
+ *
* @param pool
* the pool which an entry has been evicted from
- *
+ *
* @param k
* the entry's key
- *
+ *
* @param v
* the entry's value
- *
- * @return <tt>true</tt> if the entry is allowed to be dropped from its cache
+ *
+ * @return <code>true</code> if the entry is allowed to be dropped from its cache
* pool.
*/
boolean validate(CachePool<KeyT, ValueT> pool, KeyT k, ValueT v);
diff --git a/mnemonic-core/src/main/java/org/apache/mnemonic/Reclaim.java b/mnemonic-core/src/main/java/org/apache/mnemonic/Reclaim.java
index 84b85ac..05489c7 100644
--- a/mnemonic-core/src/main/java/org/apache/mnemonic/Reclaim.java
+++ b/mnemonic-core/src/main/java/org/apache/mnemonic/Reclaim.java
@@ -19,21 +19,21 @@ package org.apache.mnemonic;
/**
* an interface to reclaim its memory resource.
- *
+ *
*/
public interface Reclaim<MRES> {
/**
* reclaim specified resources.
- *
+ *
* @param mres
* a resource to be reclaimed
- *
+ *
* @param size
* the size of resource, it will be set as null if unknown
- *
- * @return <tt>true</tt> if this resource has been reclaimed by this callback.
- * <tt>false</tt> if this resource needs to be claimed by default
+ *
+ * @return <code>true</code> if this resource has been reclaimed by this callback.
+ * <code>false</code> if this resource needs to be claimed by default
* reclaimer
*/
boolean reclaim(MRES mres, Long size);
diff --git a/mnemonic-examples/pom.xml b/mnemonic-examples/pom.xml
index db037d1..3e9c48b 100644
--- a/mnemonic-examples/pom.xml
+++ b/mnemonic-examples/pom.xml
@@ -149,9 +149,6 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
- </configuration>
<executions>
<execution>
<id>attach-javadocs</id>
diff --git a/mnemonic-memory-services/mnemonic-java-vmem-service/pom.xml b/mnemonic-memory-services/mnemonic-java-vmem-service/pom.xml
index eeb5e91..d730f6e 100644
--- a/mnemonic-memory-services/mnemonic-java-vmem-service/pom.xml
+++ b/mnemonic-memory-services/mnemonic-java-vmem-service/pom.xml
@@ -83,10 +83,6 @@
<header>Mnenomic-JavaVMemAllocator, ${project.version}</header>
<footer>Mnenomic-JavaVMemAllocator, ${project.version}</footer>
<doctitle>Mnenomic, ${project.version}</doctitle>
- <links>
- <link>http://static.springsource.org/spring/docs/3.0.x/javadoc-api/</link>
- <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
- </links>
</configuration>
<executions>
<execution>
diff --git a/mnemonic-memory-services/mnemonic-nvml-pmem-service/pom.xml b/mnemonic-memory-services/mnemonic-nvml-pmem-service/pom.xml
index 772fc09..df7381b 100644
--- a/mnemonic-memory-services/mnemonic-nvml-pmem-service/pom.xml
+++ b/mnemonic-memory-services/mnemonic-nvml-pmem-service/pom.xml
@@ -123,10 +123,6 @@
<header>Mnenomic-PMemAllocator, ${project.version}</header>
<footer>Mnenomic-PMemAllocator, ${project.version}</footer>
<doctitle>Mnenomic, ${project.version}</doctitle>
- <links>
- <link>http://static.springsource.org/spring/docs/3.0.x/javadoc-api/</link>
- <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
- </links>
</configuration>
<executions>
<execution>
diff --git a/mnemonic-memory-services/mnemonic-nvml-vmem-service/pom.xml b/mnemonic-memory-services/mnemonic-nvml-vmem-service/pom.xml
index c60ea1e..178b0a1 100644
--- a/mnemonic-memory-services/mnemonic-nvml-vmem-service/pom.xml
+++ b/mnemonic-memory-services/mnemonic-nvml-vmem-service/pom.xml
@@ -123,10 +123,6 @@
<header>Mnenomic-VMemAllocator, ${project.version}</header>
<footer>Mnenomic-VMemAllocator, ${project.version}</footer>
<doctitle>Mnenomic, ${project.version}</doctitle>
- <links>
- <link>http://static.springsource.org/spring/docs/3.0.x/javadoc-api/</link>
- <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
- </links>
</configuration>
<executions>
<execution>
diff --git a/mnemonic-memory-services/mnemonic-pmalloc-service/pom.xml b/mnemonic-memory-services/mnemonic-pmalloc-service/pom.xml
index 0e5f8cf..046eb43 100644
--- a/mnemonic-memory-services/mnemonic-pmalloc-service/pom.xml
+++ b/mnemonic-memory-services/mnemonic-pmalloc-service/pom.xml
@@ -123,10 +123,6 @@
<header>Mnenomic-PMallocAllocator, ${project.version}</header>
<footer>Mnenomic-PMallocAllocator, ${project.version}</footer>
<doctitle>Mnenomic, ${project.version}</doctitle>
- <links>
- <link>http://static.springsource.org/spring/docs/3.0.x/javadoc-api/</link>
- <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
- </links>
</configuration>
<executions>
<execution>
diff --git a/mnemonic-memory-services/mnemonic-pmdk-pmem-service/pom.xml b/mnemonic-memory-services/mnemonic-pmdk-pmem-service/pom.xml
index 62d97a0..47cc5fe 100644
--- a/mnemonic-memory-services/mnemonic-pmdk-pmem-service/pom.xml
+++ b/mnemonic-memory-services/mnemonic-pmdk-pmem-service/pom.xml
@@ -123,10 +123,6 @@
<header>Mnenomic-PMemAllocator, ${project.version}</header>
<footer>Mnenomic-PMemAllocator, ${project.version}</footer>
<doctitle>Mnenomic, ${project.version}</doctitle>
- <links>
- <link>http://static.springsource.org/spring/docs/3.0.x/javadoc-api/</link>
- <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
- </links>
</configuration>
<executions>
<execution>
diff --git a/mnemonic-memory-services/mnemonic-pmdk-vmem-service/pom.xml b/mnemonic-memory-services/mnemonic-pmdk-vmem-service/pom.xml
index a275ad9..99edc39 100644
--- a/mnemonic-memory-services/mnemonic-pmdk-vmem-service/pom.xml
+++ b/mnemonic-memory-services/mnemonic-pmdk-vmem-service/pom.xml
@@ -123,10 +123,6 @@
<header>Mnenomic-VMemAllocator, ${project.version}</header>
<footer>Mnenomic-VMemAllocator, ${project.version}</footer>
<doctitle>Mnenomic, ${project.version}</doctitle>
- <links>
- <link>http://static.springsource.org/spring/docs/3.0.x/javadoc-api/</link>
- <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
- </links>
</configuration>
<executions>
<execution>
diff --git a/mnemonic-memory-services/mnemonic-sys-vmem-service/pom.xml b/mnemonic-memory-services/mnemonic-sys-vmem-service/pom.xml
index 81103e1..5801fe6 100644
--- a/mnemonic-memory-services/mnemonic-sys-vmem-service/pom.xml
+++ b/mnemonic-memory-services/mnemonic-sys-vmem-service/pom.xml
@@ -123,10 +123,6 @@
<header>Mnenomic-SysVMemAllocator, ${project.version}</header>
<footer>Mnenomic-SysVMemAllocator, ${project.version}</footer>
<doctitle>Mnenomic, ${project.version}</doctitle>
- <links>
- <link>http://static.springsource.org/spring/docs/3.0.x/javadoc-api/</link>
- <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
- </links>
</configuration>
<executions>
<execution>
diff --git a/mnemonic-sessions/pom.xml b/mnemonic-sessions/pom.xml
index efa8318..18fb017 100644
--- a/mnemonic-sessions/pom.xml
+++ b/mnemonic-sessions/pom.xml
@@ -121,9 +121,6 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
- </configuration>
<executions>
<execution>
<id>attach-javadocs</id>
diff --git a/pom.xml b/pom.xml
index efe1113..74a774b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -113,7 +113,6 @@
<slf4j.version>1.7.21</slf4j.version>
<log4j.version>1.2.17</log4j.version>
<logback.version>1.1.11</logback.version>
- <javadoc.opts></javadoc.opts>
</properties>
<repositories>
@@ -388,9 +387,9 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>3.2.0</version>
+ <version>3.3.1</version>
<configuration>
- <source>8</source>
+ <doclint>all,-missing</doclint>
</configuration>
</plugin>
<plugin>
@@ -589,9 +588,6 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <additionalparam>${javadoc.opts}</additionalparam>
- </configuration>
<reportSets>
<reportSet>
<id>non-aggregate</id>