Integrated: 8319324: FFM: Reformat javadocs

Per Minborg pminborg at openjdk.org
Thu Nov 9 15:22:11 UTC 2023


On Mon, 6 Nov 2023 07:41:46 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.

This pull request has now been integrated.

Changeset: f9395421
Author:    Per Minborg <pminborg at openjdk.org>
URL:       https://git.openjdk.org/jdk/commit/f9395421047b505b37941acc258114a99df4e11c
Stats:     3025 lines in 16 files changed: 852 ins; 17 del; 2156 mod

8319324: FFM: Reformat javadocs

Reviewed-by: mcimadamore

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

PR: https://git.openjdk.org/jdk/pull/16518


More information about the core-libs-dev mailing list