This is an automated email from the ASF dual-hosted git repository.
leerho pushed a commit to branch frank_grimes_java-21-ffm
in repository https://gitbox.apache.org/repos/asf/datasketches-memory.git
The following commit(s) were added to refs/heads/frank_grimes_java-21-ffm by
this push:
new 1de7cdf Fix some Javadoc errors.
1de7cdf is described below
commit 1de7cdfd6b18529d720b02e68a1f550fcf826f80
Author: Lee Rhodes <[email protected]>
AuthorDate: Wed Nov 27 16:43:05 2024 -0800
Fix some Javadoc errors.
---
.github/workflows/javadoc.yml | 3 +--
pom.xml | 2 +-
src/main/java/org/apache/datasketches/memory/Resource.java | 7 +++++--
.../apache/datasketches/memory/internal/NonNativeValueLayouts.java | 3 +++
.../org/apache/datasketches/memory/internal/PositionalImpl.java | 6 ++----
5 files changed, 12 insertions(+), 9 deletions(-)
diff --git a/.github/workflows/javadoc.yml b/.github/workflows/javadoc.yml
index c409c0f..fc14952 100644
--- a/.github/workflows/javadoc.yml
+++ b/.github/workflows/javadoc.yml
@@ -2,7 +2,7 @@ name: JavaDoc
on:
push:
- branches: [ 4.0.X, main ]
+ branches: [ main ]
workflow_dispatch:
jobs:
@@ -31,7 +31,6 @@ jobs:
- name: Deploy JavaDoc
uses: JamesIves/[email protected]
- # uses:
JamesIves/github-pages-deploy-action@5dc1d5a192aeb5ab5b7d5a77b7d36aea4a7f5c92
with:
token: ${{ secrets.GITHUB_TOKEN }}
folder: target/reports/apidocs
diff --git a/pom.xml b/pom.xml
index 14d811e..52252a5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -34,7 +34,7 @@ under the License.
<groupId>org.apache.datasketches</groupId>
<artifactId>datasketches-memory</artifactId>
- <version>4.2.0-SNAPSHOT</version>
+ <version>5.0.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>${project.artifactId}</name>
diff --git a/src/main/java/org/apache/datasketches/memory/Resource.java
b/src/main/java/org/apache/datasketches/memory/Resource.java
index 05cfc16..21ab8dd 100644
--- a/src/main/java/org/apache/datasketches/memory/Resource.java
+++ b/src/main/java/org/apache/datasketches/memory/Resource.java
@@ -19,6 +19,9 @@
package org.apache.datasketches.memory;
+import java.lang.foreign.Arena;
+import java.lang.foreign.FunctionDescriptor;
+import java.lang.foreign.Linker.Option;
import java.lang.foreign.MemorySegment;
import java.lang.foreign.MemorySegment.Scope;
import java.nio.ByteBuffer;
@@ -46,7 +49,7 @@ public interface Resource extends AutoCloseable {
* <p>The user can customize the actions of the MemoryRequestServer by
* implementing the MemoryRequestServer interface and set it using the
* {@link #setMemoryRequestServer(MemoryRequestServer)} method or optionally
with the
- * {@link WritableMemory#allocateDirect(long, long, ByteOrder,
MemoryRequestServer, arena)} method.</p>
+ * {@link WritableMemory#allocateDirect(long, long, ByteOrder,
MemoryRequestServer, Arena)} method.</p>
*
* <p>If the MemoryRequestServer is not set by the user and additional
memory is needed by the sketch,
* null will be returned and the sketch will abort.
@@ -107,7 +110,7 @@ public interface Resource extends AutoCloseable {
*
* @throws IllegalStateException if the arena has already been closed.
* @throws IllegalStateException if a segment associated with this arena is
being accessed concurrently, e.g.
- * by a {@linkplain
java.lang.foreign.Linker#downcallHandle(FunctionDescriptor, Linker.Option...)
downcall method handle}.
+ * by a {@linkplain
java.lang.foreign.Linker#downcallHandle(FunctionDescriptor, Option...) downcall
method handle}.
* @throws WrongThreadException if this arena is confined, and this method
is called from a thread
* other than the arena's owner thread.
* @throws UnsupportedOperationException if this arena cannot be closed
explicitly.
diff --git
a/src/main/java/org/apache/datasketches/memory/internal/NonNativeValueLayouts.java
b/src/main/java/org/apache/datasketches/memory/internal/NonNativeValueLayouts.java
index a9d754e..74325ac 100644
---
a/src/main/java/org/apache/datasketches/memory/internal/NonNativeValueLayouts.java
+++
b/src/main/java/org/apache/datasketches/memory/internal/NonNativeValueLayouts.java
@@ -23,6 +23,9 @@ import static
org.apache.datasketches.memory.internal.ResourceImpl.NON_NATIVE_BY
import java.lang.foreign.ValueLayout;
+/**
+ * Value Layouts for Non-native Endianness
+ */
public final class NonNativeValueLayouts {
private NonNativeValueLayouts() { }
diff --git
a/src/main/java/org/apache/datasketches/memory/internal/PositionalImpl.java
b/src/main/java/org/apache/datasketches/memory/internal/PositionalImpl.java
index 914ce32..c87a222 100644
--- a/src/main/java/org/apache/datasketches/memory/internal/PositionalImpl.java
+++ b/src/main/java/org/apache/datasketches/memory/internal/PositionalImpl.java
@@ -33,8 +33,7 @@ import org.apache.datasketches.memory.Positional;
* <li>Eliminated "mark". Rarely used and confusing with its silent side
effects.</li>
* <li>The invariants are {@code 0 <= start <= position <= end <=
capacity}.</li>
* <li>It always starts up as (0, 0, capacity, capacity).</li>
- * <li>You set (start, position, end) in one call with
- * {@link #setStartPositionEnd(long, long, long)}</li>
+ * <li>You set (start, position, end) in one call with
<i>setStartPositionEnd(long, long, long)</i></li>
* <li>Position can be set directly or indirectly when using the positional
get/put methods.
* <li>Added incrementPosition(long), which is much easier when you know the
increment.</li>
* <li>This approach eliminated a number of methods and checks, and has no
unseen side effects,
@@ -107,8 +106,7 @@ abstract class PositionalImpl extends ResourceImpl
implements Positional {
}
@Override
- public final PositionalImpl setStartPositionEnd(final long start, final long
position,
- final long end) {
+ public final PositionalImpl setStartPositionEnd(final long start, final long
position, final long end) {
checkInvariants(start, position, end, capacity);
this.start = start;
this.end = end;
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
