[foreign-memaccess] Tweaks to JavaDoc

[Maurizio Cimadamore]

Many thanks for the thorough pass. Few questions:

--- MemoryLayout::varHandle

"* @param elements the layout paths."

While this is better than what was there before, I think it should be 
"the layout path elements" ?

--- MemorySegment, good catch on the 'close' toplevel doc - seems like 
it was leftover from the previous round.

-- ValueLayout

this sentence:

"+ * When not explicitly provided, a value layout's byte order is 
assumed to be compatible with the platform byte order (see {@link 
ByteOrder#nativeOrder()})."

I think should go away - we don't have implicit endianness anymore.

-- package-info

"A Memory address" -> "A memory address"


Other than that, looks great - feel free to push (if you want, or I can 
do that too)

Maurizio

On 20/11/2019 22:34, Paul Sandoz wrote:
> Hi,
>
> Here are some suggested tweaks to the JavaDoc.
>
> http://cr.openjdk.java.net/~psandoz/panama/foreign-memaccess-javadoc/webrev/ <http://cr.openjdk.java.net/~psandoz/panama/foreign-memaccess-javadoc/webrev/>
>
> —
>
> Some observations:
>
> - IllegalArgumentException is used to indicate out of bounds exceptions rather than IndexOutOfBoundsException
>
> - RuntimeException is occasionally used e.g. "specified size is too large for the system runtime"
>
> - Layout classes state:
>
> * @implSpec
> * This class is immutable and thread-safe.
>
> This seems to be more of a spec requirement than an implementation detail.
>
> Paul.
>