[foreign-abi] RFR: 8253373: Add package-level javadoc for foreign linker support

[Athijegannathan Sundararajan]

On Fri, 18 Sep 2020 20:55:30 GMT, Maurizio Cimadamore <mcimadamore at openjdk.org> wrote:

> This patch modifies the toplevel javadoc of jdk.incubator.foreign to add details about the ABI support.
> 
> I've decided to split the javadoc into two main sections - one about memory access, and one about foreign function
> access; they have subsections for more detailed info.
> There's also a trailing toplevel section on "restricted method". I'm still wordsmithing the definition of "what's it
> like to be a restricted method" together with Alex, but this is a first attempt. It is likely that, once we have this
> done, we can have the various restrcited definitions inside the API refer bakc to this section.
> Link to javadoc:
> http://cr.openjdk.java.net/~mcimadamore/panama/foreign-linker-javadoc/javadoc/jdk/incubator/foreign/package-summary.html

Marked as reviewed by sundar (Committer).

src/jdk.incubator.foreign/share/classes/jdk/incubator/foreign/package-info.java line 101:

> 99:  * <h2>Foreign function access</h2>
> 100:  * The key abstractions introduced to support foreign function access are {@link
> jdk.incubator.foreign.LibraryLookup} and {@link jdk.incubator.foreign.CLinker}. 101:  * The first is used to load
> foreign libraries, as well as to lookup symbols inside said libraries; the latter

The "former" and the "latter"?

src/jdk.incubator.foreign/share/classes/jdk/incubator/foreign/package-info.java line 103:

> 101:  * The first is used to load foreign libraries, as well as to lookup symbols inside said libraries; the latter
> 102:  * provides linking capabilities which allow to model foreign functions as {@link
> jdk.incubator.foreign.MemoryHandles} instance, 103:  * so that clients can perform foreign function calls directly in
> Java, with no need to introduce intermediate

"with no need to introduce" -> "without" ?

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

PR: https://git.openjdk.java.net/panama-foreign/pull/346