Skip to content

Fix Bool then-load return value docs #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fallintoplace wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −14
Open

Fix Bool then-load return value docs #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Sources/Atomics/Conformances/AtomicBool.swift.gyb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,12 +211,12 @@ extension ${construct} where Value == Bool {

extension ${construct} where Value == Bool {
% for (name, iname, op, label, doc) in boolOperations:
/// Perform an atomic ${doc} operation and return the original value, applying
/// Perform an atomic ${doc} operation and return the resulting value, applying
/// the specified memory ordering.
///
/// - Parameter operand: A boolean value.
/// - Parameter ordering: The memory ordering to apply on this operation.
/// - Returns: The original value before the operation.
/// - Returns: The value after the operation.
@_semantics("atomics.requires_constant_orderings")
@_transparent @_alwaysEmitIntoClient
public func ${lowerFirst(name)}ThenLoad(
Expand Down
24 changes: 12 additions & 12 deletions Sources/Atomics/Conformances/autogenerated/AtomicBool.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,12 +281,12 @@ extension UnsafeAtomic where Value == Bool {
}

extension UnsafeAtomic where Value == Bool {
/// Perform an atomic logical AND operation and return the original value, applying
/// Perform an atomic logical AND operation and return the resulting value, applying
/// the specified memory ordering.
///
/// - Parameter operand: A boolean value.
/// - Parameter ordering: The memory ordering to apply on this operation.
/// - Returns: The original value before the operation.
/// - Returns: The value after the operation.
@_semantics("atomics.requires_constant_orderings")
@_transparent @_alwaysEmitIntoClient
public func logicalAndThenLoad(
Expand All @@ -300,12 +300,12 @@ extension UnsafeAtomic where Value == Bool {
return original && operand
}

/// Perform an atomic logical OR operation and return the original value, applying
/// Perform an atomic logical OR operation and return the resulting value, applying
/// the specified memory ordering.
///
/// - Parameter operand: A boolean value.
/// - Parameter ordering: The memory ordering to apply on this operation.
/// - Returns: The original value before the operation.
/// - Returns: The value after the operation.
@_semantics("atomics.requires_constant_orderings")
@_transparent @_alwaysEmitIntoClient
public func logicalOrThenLoad(
Expand All @@ -319,12 +319,12 @@ extension UnsafeAtomic where Value == Bool {
return original || operand
}

/// Perform an atomic logical XOR operation and return the original value, applying
/// Perform an atomic logical XOR operation and return the resulting value, applying
/// the specified memory ordering.
///
/// - Parameter operand: A boolean value.
/// - Parameter ordering: The memory ordering to apply on this operation.
/// - Returns: The original value before the operation.
/// - Returns: The value after the operation.
@_semantics("atomics.requires_constant_orderings")
@_transparent @_alwaysEmitIntoClient
public func logicalXorThenLoad(
Expand Down Expand Up @@ -394,12 +394,12 @@ extension ManagedAtomic where Value == Bool {
}

extension ManagedAtomic where Value == Bool {
/// Perform an atomic logical AND operation and return the original value, applying
/// Perform an atomic logical AND operation and return the resulting value, applying
/// the specified memory ordering.
///
/// - Parameter operand: A boolean value.
/// - Parameter ordering: The memory ordering to apply on this operation.
/// - Returns: The original value before the operation.
/// - Returns: The value after the operation.
@_semantics("atomics.requires_constant_orderings")
@_transparent @_alwaysEmitIntoClient
public func logicalAndThenLoad(
Expand All @@ -413,12 +413,12 @@ extension ManagedAtomic where Value == Bool {
return original && operand
}

/// Perform an atomic logical OR operation and return the original value, applying
/// Perform an atomic logical OR operation and return the resulting value, applying
/// the specified memory ordering.
///
/// - Parameter operand: A boolean value.
/// - Parameter ordering: The memory ordering to apply on this operation.
/// - Returns: The original value before the operation.
/// - Returns: The value after the operation.
@_semantics("atomics.requires_constant_orderings")
@_transparent @_alwaysEmitIntoClient
public func logicalOrThenLoad(
Expand All @@ -432,12 +432,12 @@ extension ManagedAtomic where Value == Bool {
return original || operand
}

/// Perform an atomic logical XOR operation and return the original value, applying
/// Perform an atomic logical XOR operation and return the resulting value, applying
/// the specified memory ordering.
///
/// - Parameter operand: A boolean value.
/// - Parameter ordering: The memory ordering to apply on this operation.
/// - Returns: The original value before the operation.
/// - Returns: The value after the operation.
@_semantics("atomics.requires_constant_orderings")
@_transparent @_alwaysEmitIntoClient
public func logicalXorThenLoad(
Expand Down