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

[Roger Riggs]

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.

Nice to see consistency, while respecting English grammar.
If any javadoc text is a full sentence, it should end with a period. If it is a fragment, then the period is omitted.

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

PR Comment: https://git.openjdk.org/jdk/pull/16478#issuecomment-1790966335