RFR: 8319324: FFM: Reformat javadocs [v8]

[Maurizio Cimadamore]

On Mon, 6 Nov 2023 17:35:31 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 incrementally with one additional commit since the last revision:
> 
>   Remove additional redundant full stops

Looks good. I found some (few) sentences that still have a full stop in `@param`/`@throws`

src/java.base/share/classes/java/nio/channels/FileChannel.java line 1072:

> 1070:      * @throws  WrongThreadException
> 1071:      *          If {@code arena} is a confined scoped arena, and this method is called
> 1072:      *          from a thread {@code T}, other than the scoped arena's owner thread.

period?

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

PR Review: https://git.openjdk.org/jdk/pull/16518#pullrequestreview-1715840997
PR Review Comment: https://git.openjdk.org/jdk/pull/16518#discussion_r1383737974