Skip to content

Fix doc comment to make it match code #84367

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

Merged
merged 1 commit into from
Oct 28, 2025
+24 −24
Merged

Fix doc comment to make it match code #84367

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
6 changes: 3 additions & 3 deletions stdlib/public/Synchronization/Atomics/AtomicFloats.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ extension Float16: AtomicRepresentable {
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -101,7 +101,7 @@ extension Float: AtomicRepresentable {
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -153,7 +153,7 @@ extension Double: AtomicRepresentable {
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down
6 changes: 3 additions & 3 deletions stdlib/public/Synchronization/Atomics/AtomicOptional.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public protocol AtomicOptionalRepresentable: AtomicRepresentable {
/// representation used in atomic operations on `Optional` back into the
/// logical type for normal use, `Self?`.
///
/// - Parameter storage: The optional storage representation for `Self?`
/// - Parameter representation: The optional storage representation for `Self?`
/// that's used within atomic operations on `Optional`.
/// - Returns: The newly decoded logical type `Self?`.
static func decodeAtomicOptionalRepresentation(
Expand Down Expand Up @@ -101,7 +101,7 @@ where
/// representation used in atomic operations on `Optional` back into the
/// logical type for normal use, `Self?`.
///
/// - Parameter storage: The optional storage representation for `Self?`
/// - Parameter representation: The optional storage representation for `Self?`
/// that's used within atomic operations on `Optional`.
/// - Returns: The newly decoded logical type `Self?`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -153,7 +153,7 @@ extension Optional: AtomicRepresentable where Wrapped: AtomicOptionalRepresentab
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down
36 changes: 18 additions & 18 deletions stdlib/public/Synchronization/Atomics/AtomicPointers.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ extension UnsafePointer: @unsafe AtomicRepresentable where Pointee: ~Copyable {
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -101,7 +101,7 @@ extension UnsafePointer: @unsafe AtomicOptionalRepresentable where Pointee: ~Cop
/// representation used in atomic operations on `Optional` back into the
/// logical type for normal use, `Self?`.
///
/// - Parameter storage: The optional storage representation for `Self?`
/// - Parameter representation: The optional storage representation for `Self?`
/// that's used within atomic operations on `Optional`.
/// - Returns: The newly decoded logical type `Self?`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -155,7 +155,7 @@ extension UnsafeMutablePointer: @unsafe AtomicRepresentable where Pointee: ~Copy
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -208,7 +208,7 @@ where Pointee: ~Copyable {
/// representation used in atomic operations on `Optional` back into the
/// logical type for normal use, `Self?`.
///
/// - Parameter storage: The optional storage representation for `Self?`
/// - Parameter representation: The optional storage representation for `Self?`
/// that's used within atomic operations on `Optional`.
/// - Returns: The newly decoded logical type `Self?`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -262,7 +262,7 @@ extension UnsafeRawPointer: @unsafe AtomicRepresentable {
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -314,7 +314,7 @@ extension UnsafeRawPointer: @unsafe AtomicOptionalRepresentable {
/// representation used in atomic operations on `Optional` back into the
/// logical type for normal use, `Self?`.
///
/// - Parameter storage: The optional storage representation for `Self?`
/// - Parameter representation: The optional storage representation for `Self?`
/// that's used within atomic operations on `Optional`.
/// - Returns: The newly decoded logical type `Self?`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -368,7 +368,7 @@ extension UnsafeMutableRawPointer: @unsafe AtomicRepresentable {
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -420,7 +420,7 @@ extension UnsafeMutableRawPointer: @unsafe AtomicOptionalRepresentable {
/// representation used in atomic operations on `Optional` back into the
/// logical type for normal use, `Self?`.
///
/// - Parameter storage: The optional storage representation for `Self?`
/// - Parameter representation: The optional storage representation for `Self?`
/// that's used within atomic operations on `Optional`.
/// - Returns: The newly decoded logical type `Self?`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -474,7 +474,7 @@ extension Unmanaged: @unsafe AtomicRepresentable {
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -534,7 +534,7 @@ extension Unmanaged: @unsafe AtomicOptionalRepresentable {
/// representation used in atomic operations on `Optional` back into the
/// logical type for normal use, `Self?`.
///
/// - Parameter storage: The optional storage representation for `Self?`
/// - Parameter representation: The optional storage representation for `Self?`
/// that's used within atomic operations on `Optional`.
/// - Returns: The newly decoded logical type `Self?`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -588,7 +588,7 @@ extension OpaquePointer: @unsafe AtomicRepresentable {
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -640,7 +640,7 @@ extension OpaquePointer: @unsafe AtomicOptionalRepresentable {
/// representation used in atomic operations on `Optional` back into the
/// logical type for normal use, `Self?`.
///
/// - Parameter storage: The optional storage representation for `Self?`
/// - Parameter representation: The optional storage representation for `Self?`
/// that's used within atomic operations on `Optional`.
/// - Returns: The newly decoded logical type `Self?`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -694,7 +694,7 @@ extension ObjectIdentifier: AtomicRepresentable {
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -750,7 +750,7 @@ extension ObjectIdentifier: AtomicOptionalRepresentable {
/// representation used in atomic operations on `Optional` back into the
/// logical type for normal use, `Self?`.
///
/// - Parameter storage: The optional storage representation for `Self?`
/// - Parameter representation: The optional storage representation for `Self?`
/// that's used within atomic operations on `Optional`.
/// - Returns: The newly decoded logical type `Self?`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -813,7 +813,7 @@ extension UnsafeBufferPointer: @unsafe AtomicRepresentable where Element: ~Copya
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -881,7 +881,7 @@ where Element: ~Copyable
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -947,7 +947,7 @@ extension UnsafeRawBufferPointer: @unsafe AtomicRepresentable {
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down Expand Up @@ -1013,7 +1013,7 @@ extension UnsafeMutableRawBufferPointer: @unsafe AtomicRepresentable {
/// representation used in atomic operations back into the logical type for
/// normal use, `Self`.
///
/// - Parameter storage: The storage representation for `Self` that's used
/// - Parameter representation: The storage representation for `Self` that's used
/// within atomic operations.
/// - Returns: The newly decoded logical type `Self`.
@available(SwiftStdlib 6.0, *)
Expand Down