On Mon, 6 Nov 2023 08:08:34 GMT, Per Minborg <[email protected]> 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 incremental webrev excludes the unrelated changes
> brought in by the merge/rebase. The pull request contains five additional
> commits since the last revision:
>
> - Merge master
> - Reformat javadocs
> - FFM: Harmonize the @throws tags in the javadocs
> - Merge branch 'master' into javadoc-throws
> - Harmonize some of the javadoc throws
src/java.base/share/classes/java/lang/foreign/MemorySegment.java line 1910:
> 1908: * in the provided layout
> 1909: * @throws IndexOutOfBoundsException if {@code offset > byteSize()
> - layout.byteSize()}
> 1910: * @throws UnsupportedOperationException if this segment is
one `UOE` went missing
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/16518#discussion_r1382966088
