[jdk18] RFR: 8280592: Small javadoc tweaks to foreign API

[Maurizio Cimadamore]

On Tue, 25 Jan 2022 17:00:34 GMT, Paul Sandoz <psandoz at openjdk.org> wrote:

>> This patch fixes some inconsistencies in the foreign API javadoc. The main fix is to make javadoc of all predicate methods consistent, and to use the `@return` tag where appropriate, as to avoid duplication.
>> 
>> There were also minor fixes in the package-level javadoc (one typo) and in `ValueLayout` (where hyphenation in *bit-alignment* has been dropped).
>
> src/jdk.incubator.foreign/share/classes/jdk/incubator/foreign/Addressable.java line 43:
> 
>> 41: 
>> 42:     /**
>> 43:      * {@return the {@linkplain MemoryAddress memory address} associated with this addressable}
> 
> Oh, i just learnt a new JavaDoc trick!

heh - me too - hat tip to @pavelrappo :-)

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

PR: https://git.openjdk.java.net/jdk18/pull/113