Skip to content

Commit d129f62

Browse files
loffgrenlorentey
andauthored
Use Markdown code voice for initializer comment
Co-authored-by: Karoy Lorentey <klorentey@apple.com>
1 parent ae6b1f2 commit d129f62

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Sources/System/MachPort.swift

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ public enum Mach {
3030
internal var context: mach_port_context_t
3131

3232
/// Transfer ownership of an existing unmanaged Mach port right into a
33-
/// Mach.Port by name.
33+
/// `Mach.Port` by name.
3434
///
35-
/// This initializer aborts if name is MACH_PORT_NULL, or if name is
36-
/// MACH_PORT_DEAD and the type T of Mach.Port<T> is Mach.ReceiveRight.
35+
/// This initializer traps if `name` is `MACH_PORT_NULL`, or if `name` is
36+
/// `MACH_PORT_DEAD` and the `RightType` is `Mach.ReceiveRight`.
3737
///
38-
/// If the type of the right does not match the type T of Mach.Port<T>
39-
/// being constructed, behavior is undefined.
38+
/// If the type of the right does not match the `RightType` of the
39+
/// `Mach.Port` being constructed, behavior is undefined.
4040
///
4141
/// The underlying port right will be automatically deallocated at the
42-
/// end of the Mach.Port instance's lifetime.
42+
/// end of the `Mach.Port` instance's lifetime.
4343
///
4444
/// This initializer makes a syscall to guard the right.
4545
public init(name: mach_port_name_t) {

0 commit comments

Comments
 (0)