[jdk20] RFR: 8299090: Specify coordinate order for additional CaptureCallState parameters on class as well

[Jorn Vernee]

On Wed, 11 Jan 2023 12:33:37 GMT, Maurizio Cimadamore <mcimadamore at openjdk.org> wrote:

>> A small doc clarification that also specifies where the additional MemorySegment parameter of a downcall method handle linked with the captureCallState option appears in the parameter list, on the CaptureCallState class.
>
> src/java.base/share/classes/java/lang/foreign/Linker.java line 328:
> 
>> 326:          * For this purpose, a downcall method handle linked with the {@link #captureCallState(String[])}
>> 327:          * option will feature an additional {@link MemorySegment} parameter directly
>> 328:          * following the target address parameter. This parameter represents the native segment
> 
> Should we also mention the allocator parameter which can occur if the function returns a struct by value?

Hmm yeah. The SegmentAllocator is also specified to be immediately after the address parameter, so it's unclear in which order they would be. I'll update this.

-------------

PR: https://git.openjdk.org/jdk20/pull/95