Skip to content

Commit 502c10f

Browse files
committed
Fix doc comment for GenericParameterDescriptor::Offset
This was a little confusing because it is actually the offset to the first generic argument and this isn't well documented anywhere else.
1 parent e7ee507 commit 502c10f

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

include/swift/Runtime/Metadata.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1336,8 +1336,10 @@ using HeapMetadata = TargetHeapMetadata<InProcess>;
13361336
/// structure that describes how to find and parse a generic parameter vector
13371337
/// within the type metadata for an instance of a nominal type.
13381338
struct GenericParameterDescriptor {
1339-
/// The offset of the descriptor in the metadata record. This is
1340-
/// meaningful if either NumGenericRequirements is nonzero or
1339+
/// The offset to the first generic argument from the start of
1340+
/// metadata record.
1341+
///
1342+
/// This is meaningful if either NumGenericRequirements is nonzero or
13411343
/// (for classes) if Flags.hasParent() is true.
13421344
uint32_t Offset;
13431345

0 commit comments

Comments
 (0)