averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-21 12:14:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add missing doc comment requested by Greg Parker and a random typo, NFC

Browse Source 
Not trying to game my patch count! :-)

Swift SVN r31257
This commit is contained in:
Slava Pestov
2015-08-15 23:18:15 +00:00
parent 5f8c122a79
commit f183beb576
2 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
include/swift/Runtime/Metadata.h
View File

@@ -530,12 +530,16 @@ typedef int getExtraInhabitantIndex(const OpaqueValue *src,
const Metadata *self);
/// Given a valid object of this enum type, extracts the tag value indicating
/// which case of the enum is inhabited.
/// which case of the enum is inhabited. The tag value can be used to index
/// into the array returned by the NominalTypeDescriptor's GetCaseTypes
/// function to get the payload type and check if the payload is indirect.
typedef unsigned getEnumTag(const OpaqueValue *src,
const Metadata *self);
/// Given a valid object of this enum type, extracts the tag value indicating
/// which case of the enum is inhabited.
/// Given a valid object of this enum type, destructively strips the tag
/// bits, leaving behind a value of the inhabited case payload type.
/// If the case is indirect, the payload can then be projected from the box
/// with swift_projectBox().
typedef OpaqueValue *destructiveProjectEnumData(OpaqueValue *src,
const Metadata *self);