archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-27 23:04:50 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8319324: FFM: Reformat javadocs

Browse source 
Reviewed-by: mcimadamore
This commit is contained in:
Per Minborg 2023-11-09 15:18:43 +00:00
parent a3f1b33b9b
commit f939542104
16 changed files with 3001 additions and 2166 deletions
Download patch file Download diff file Expand all files Collapse all files

25
src/java.base/share/classes/java/lang/foreign/GroupLayout.java
View file

@ -28,13 +28,16 @@ package java.lang.foreign;
import java.util.List;
/**
* A compound layout that is an aggregation of multiple, heterogeneous <em>member layouts</em>. There are two ways in which member layouts
* can be combined: if member layouts are laid out one after the other, the resulting group layout is a
* {@linkplain StructLayout struct layout}; conversely, if all member layouts are laid out at the same starting offset,
* the resulting group layout is a {@linkplain UnionLayout union layout}.
* A compound layout that is an aggregation of multiple, heterogeneous
* <em>member layouts</em>. There are two ways in which member layouts can be combined:
* if member layouts are laid out one after the other, the resulting group layout is a
* {@linkplain StructLayout struct layout}; conversely, if all member layouts are laid
* out at the same starting offset, the resulting group layout is a
* {@linkplain UnionLayout union layout}.
*
* @implSpec
* This class is immutable, thread-safe and <a href="{@docRoot}/java.base/java/lang/doc-files/ValueBased.html">value-based</a>.
* This class is immutable, thread-safe and
* <a href="{@docRoot}/java.base/java/lang/doc-files/ValueBased.html">value-based</a>.
*
* @sealedGraph
* @since 22
@ -44,9 +47,10 @@ public sealed interface GroupLayout extends MemoryLayout permits StructLayout, U
/**
* {@return the member layouts of this group layout}
*
* @apiNote the order in which member layouts are returned in the same order in which member layouts have
* been passed to one of the group layout factory methods (see {@link MemoryLayout#structLayout(MemoryLayout...)},
* {@link MemoryLayout#unionLayout(MemoryLayout...)}).
* @apiNote the order in which member layouts are returned is the same order in which
* member layouts have been passed to one of the group layout factory methods
* (see {@link MemoryLayout#structLayout(MemoryLayout...)} and
* {@link MemoryLayout#unionLayout(MemoryLayout...)}).
*/
List<MemoryLayout> memberLayouts();
@ -65,8 +69,9 @@ public sealed interface GroupLayout extends MemoryLayout permits StructLayout, U
/**
* {@inheritDoc}
* @throws IllegalArgumentException {@inheritDoc}
* @throws IllegalArgumentException if {@code byteAlignment} is less than {@code M}, where {@code M} is
* the maximum alignment constraint in any of the member layouts associated with this group layout
* @throws IllegalArgumentException if {@code byteAlignment} is less than {@code M},
* where {@code M} is the maximum alignment constraint in any of the
* member layouts associated with this group layout
*/
@Override
GroupLayout withByteAlignment(long byteAlignment);