RFR: 8319324: FFM: Reformat javadocs [v3]

[Jorn Vernee]

On Mon, 6 Nov 2023 10:10:41 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:
> 
>   Update after review

FWIW, I've been sticking to a 120 character limit per line when writing javadoc. Why should we use 90 columns specifically?

> It is also customary to use double spaces when starting a new sentence.

I thought this was the exception rather than the rule, to be honest.

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

PR Comment: https://git.openjdk.org/jdk/pull/16518#issuecomment-1794824402