RFR: 8319324: FFM: Reformat javadocs [v11]

[Maurizio Cimadamore]

On Thu, 9 Nov 2023 12:31:16 GMT, Per Minborg <pminborg at openjdk.org> wrote:

>> This PR proposes to reformat all the JavaDocs for the FFM API. This would bring the FFM API docs more in line with the existing Java documentation (see below).  Occasional drive-by fixes are also included in this PR (such as spelling and capitalization).
>> 
>> I am aware this PR will (if approved) make a significant mark in the change logs which is regrettable.
>> 
>> Background:
>> 
>> Older classes like `Object` and `List` have a maximum line length of 80 characters whereas newer classes like `ScopedValue` have a maximum line length of 90 characters.
>> 
>> The FFM API currently has javadoc lines that exceed 135 characters per line. It is also customary to use double spaces when starting a new sentence.
>
> Per Minborg has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains 14 commits:
> 
>  - Merge branch 'master' into javadoc-reformat
>  - Merge master
>  - Update after additional reviews
>  - Remove additional redundant full stops
>  - Merge master and update Linker formatting
>  - Harmonize the use of full stops in tags
>  - Remove double spaces after full stops
>  - Review classes not in the foreign package
>  - Update after review
>  - Merge master
>  - ... and 4 more: https://git.openjdk.org/jdk/compare/dd9eab15...b3c4293b

src/java.base/share/classes/java/lang/foreign/MemorySegment.java line 1956:

> 1954:      *
> 1955:      * @param layout the layout of the region of memory to be read
> 1956:      * @param index a logical index, the offset in bytes (relative to this

I think the new text for `index` is not good (here and elsewhere). I suggest:

a logical index _denoting_ the offset in bytes...

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

PR Review Comment: https://git.openjdk.org/jdk/pull/16518#discussion_r1387957764