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

[Maurizio Cimadamore]

On Fri, 19 Jun 2020 12:53:46 GMT, Maurizio Cimadamore <mcimadamore at openjdk.org> wrote:

> This patch addresses some misc issues in the foreign memory access javadoc, following some feedback from Brian
> (thanks!).
> Things to look out for:
> 
> * the package-level javadoc has been tweaked so that we first introduce the entities, then the example - also there's a
>   bit more text to make things clearer
> * the javadoc section in MemorySegment on confinement has been moved at the end - since it's fairly advanced
> * the toplevel javadoc of `MemoryLayout` has been reworked pretty substantially; it now has a leading example which shows
>   how to go from a C decl to a layout; that same example is then reused throughout the javadoc to explain layout paths
> 
> When doing this, I realized that the section on layout paths has several mistakes - from code mistakes to a section
> which was repeated twice (!!) no idea how that could have gone through all the review rounds (it's not a merge
> artifact - same issue is in jdk/jdk).

This pull request has now been integrated.

Changeset: 8ccc74d6
Author:    Maurizio Cimadamore <mcimadamore at openjdk.org>
URL:       https://git.openjdk.java.net/panama-foreign/commit/8ccc74d6
Stats:     144 lines in 4 files changed: 61 ins; 66 del; 17 mod

8247924: Improve javadoc of Foreign Memory Access API (part two)

Reviewed-by: jvernee

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

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