[foreign-abi] RFR: Misc javadoc fixes [v2]

[Jorn Vernee]

On Thu, 8 Oct 2020 14:00:26 GMT, Maurizio Cimadamore <mcimadamore at openjdk.org> wrote:

>> I did another pass on the ABI-related javadoc; this resulted in a biggie surgery of the javadoc in `CLinker` as well as
>> few minor changes/fixes in several places.
>
> Maurizio Cimadamore has updated the pull request incrementally with four additional commits since the last revision:
> 
>  - Merge branch 'abi-javadoc-fixes' of https://github.com/mcimadamore/panama-foreign into abi-javadoc-fixes
>  - Update src/jdk.incubator.foreign/share/classes/jdk/incubator/foreign/CLinker.java
>    
>    Co-authored-by: Jorn Vernee <JornVernee at users.noreply.github.com>
>  - Update src/jdk.incubator.foreign/share/classes/jdk/incubator/foreign/CLinker.java
>    
>    Co-authored-by: Jorn Vernee <JornVernee at users.noreply.github.com>
>  - Address review comments

Marked as reviewed by jvernee (Committer).

src/jdk.incubator.foreign/share/classes/jdk/incubator/foreign/CLinker.java line 69:

> 67:  * the method type and the function descriptor, respectively, used during the linking process, then it must be that:
> 68:  * <ul>
> 69:  *     <li>The arity of {@code M} is the same as that of {@code M};</li>

Suggestion:

 *     <li>The arity of {@code M} is the same as that of {@code F};</li>

src/jdk.incubator.foreign/share/classes/jdk/incubator/foreign/CLinker.java line 73:

> 71:  *     (see {@link FunctionDescriptor#ofVoid(MemoryLayout...)});</li>
> 72:  *     <li>for each pair of carrier type {@code C} and layout {@code L} in {@code M} and {@code F}, respectively,
> 73:  *     where {@code C} and {@code F} refer to the same argument, or to the return value, the following conditions
> must hold:

Suggestion:

 *     where {@code C} and {@code L} refer to the same argument, or to the return value, the following conditions must hold:

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

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