RFR: 8319324: FFM: Reformat javadocs [v13]

Maurizio Cimadamore mcimadamore at openjdk.org
Thu Nov 9 15:00:06 UTC 2023


On Thu, 9 Nov 2023 14:21:57 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:
> 
>   Change text for logical index

Marked as reviewed by mcimadamore (Reviewer).

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

PR Review: https://git.openjdk.org/jdk/pull/16518#pullrequestreview-1722745325


More information about the core-libs-dev mailing list