RFR: 8319324: FFM: Reformat javadocs [v10]
Per Minborg
pminborg at openjdk.org
Thu Nov 9 12:31:18 UTC 2023
On Wed, 8 Nov 2023 09:03:12 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 13 commits:
>
> - 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
> - Reformat javadocs
> - ... and 3 more: https://git.openjdk.org/jdk/compare/8555e0f6...b91beb2a
A specdiff is available here https://cr.openjdk.org/~pminborg/panama/22/specdiff-panamajavadocrework/package-summary.html
The specdiff is from this PR's latest commit (at the time of writing this message) and compares with ee57e731d03 which is a commit just before we started integrating a number of spec updates. This means the diff will include updates from other PRs including @JornVernee 's Linker improvements.
-------------
PR Comment: https://git.openjdk.org/jdk/pull/16518#issuecomment-1803737256
More information about the core-libs-dev
mailing list