[foreign-memaccess] RFR: 8247924: Improve javadoc of Foreign Memory Access API (part one)

[Jorn Vernee]

On Fri, 19 Jun 2020 09:57:16 GMT, Maurizio Cimadamore <mcimadamore at openjdk.org> wrote:

> This patch clarifies the role of `MemorySegment::close`, and also mentions the fact that external memory sources
> (arrays/buffers) can be aliased, and that extra care must be taken by clients wanting to share such segments.
> I also fixed the typos in restricted methods which we also fixed in foreign-abi.

Marked as reviewed by jvernee (Committer).

src/jdk.incubator.foreign/share/classes/jdk/incubator/foreign/MemorySegment.java line 290:

> 289:      * or to access any {@link MemoryAddress} instance associated with it will fail with {@link
> IllegalStateException}. 290:      * Depending on the kind of memory segment being closed, calling this method further
> trigger deallocation of all the resources 291:      * associated with the memory segment.

Pre-existing typo:
Suggestion:

     * Depending on the kind of memory segment being closed, calling this method further triggers deallocation of all the
       resources

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

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