archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-27 14:54:52 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8307911: javadoc for MemorySegment::reinterpret has duplicate restricted method paragraph

Browse source 
Reviewed-by: jvernee
This commit is contained in:
Maurizio Cimadamore 2023-05-12 16:18:00 +00:00
parent 3c68c352fc
commit 6ebea8973f
2 changed files with 3 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/java.base/share/classes/java/lang/foreign/Linker.java
View file

@ -592,7 +592,7 @@ public sealed interface Linker permits AbstractLinker {
}
/**
* {@return A linker option used to save portions of the execution state immediately after
* {@return a linker option used to save portions of the execution state immediately after
* calling a foreign function associated with a downcall method handle,
* before it can be overwritten by the Java runtime, or read through conventional means}
* <p>
@ -640,7 +640,7 @@ public sealed interface Linker permits AbstractLinker {
}
/**
* {@return A struct layout that represents the layout of the capture state segment that is passed
* {@return a struct layout that represents the layout of the capture state segment that is passed
* to a downcall handle linked with {@link #captureCallState(String...)}}.
* <p>
* The capture state layout is <em>platform dependent</em> but is guaranteed to be
@ -668,7 +668,7 @@ public sealed interface Linker permits AbstractLinker {
}
/**
* {@return A linker option used to mark a foreign function as <em>trivial</em>}
* {@return a linker option used to mark a foreign function as <em>trivial</em>}
* <p>
* A trivial function is a function that has an extremely short running time
* in all cases (similar to calling an empty function), and does not call back into Java (e.g. using an upcall stub).

5
src/java.base/share/classes/java/lang/foreign/MemorySegment.java
View file

@ -618,11 +618,6 @@ public sealed interface MemorySegment permits AbstractMemorySegmentImpl {
* if the provided scope is the scope of an {@linkplain Arena#ofAuto() automatic arena}, the cleanup action
* must not prevent the scope from becoming <a href="../../../java/lang/ref/package.html#reachability">unreachable</a>.
* A failure to do so will permanently prevent the regions of memory allocated by the automatic arena from being deallocated.
* <p>
* This method is <a href="package-summary.html#restricted"><em>restricted</em></a>.
* Restricted methods are unsafe, and, if used incorrectly, their use might crash
* the JVM or, worse, silently result in memory corruption. Thus, clients should refrain from depending on
* restricted methods, and use safe and supported functionalities, where possible.
*
* @param arena the arena to be associated with the returned segment.
* @param cleanup the cleanup action that should be executed when the provided arena is closed (can be {@code null}).