RFR: 8319324: FFM: Reformat javadocs [v11]
Per Minborg
pminborg at openjdk.org
Thu Nov 9 12:31:16 UTC 2023
> 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
-------------
Changes: https://git.openjdk.org/jdk/pull/16518/files
Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=16518&range=10
Stats: 3026 lines in 16 files changed: 852 ins; 17 del; 2157 mod
Patch: https://git.openjdk.org/jdk/pull/16518.diff
Fetch: git fetch https://git.openjdk.org/jdk.git pull/16518/head:pull/16518
PR: https://git.openjdk.org/jdk/pull/16518
More information about the core-libs-dev
mailing list