Integrated: 8319323: FFM: Harmonize the @throws tags in the javadocs

Per Minborg pminborg at openjdk.org
Fri Nov 3 12:31:28 UTC 2023


On Thu, 2 Nov 2023 14:46:49 GMT, Per Minborg <pminborg at openjdk.org> wrote:

> This PR proposes to harmonize the @throws tags in the javadocs for the FFM API.
> 
> The @throws tags are using a bit different principles with respect to formatting and ending with a period or not.
> 
> Looking at some prominent Java classes like `List` and `Stream`, they:
> 
> 1) Indent such that multi-line texts align with the beginning of the Exception type
> 2) Do not have a period after the text.
> 
> Some of the tags in the FFM classes already conform to these bullets. This PR proposes to make them all do.

This pull request has now been integrated.

Changeset: be01caf3
Author:    Per Minborg <pminborg at openjdk.org>
URL:       https://git.openjdk.org/jdk/commit/be01caf30de5a70684fab25b02f2c6ab346a60cb
Stats:     455 lines in 10 files changed: 4 ins; 1 del; 450 mod

8319323: FFM: Harmonize the @throws tags in the javadocs

Reviewed-by: jvernee

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

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


More information about the core-libs-dev mailing list