Skip to content

Commit 12d5d8e

Browse files
author
Chris Adamson
committed
Correct placement of doc comments in AsyncSequence
Also remove stray characters in doc comments for Actor, MainActor.
1 parent 6d47d32 commit 12d5d8e

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

stdlib/public/Concurrency/Actor.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import Swift
1515

1616
/// Common protocol to which all actors conform.
1717
///
18-
/// The \c Actor protocol generalizes over all actor types. Actor types
18+
/// The Actor protocol generalizes over all actor types. Actor types
1919
/// implicitly conform to this protocol.
2020
@available(SwiftStdlib 5.5, *)
2121
public protocol Actor: AnyObject, Sendable {
@@ -53,7 +53,7 @@ public func _defaultActorDestroy(_ actor: AnyObject)
5353
internal func _enqueueOnMain(_ job: UnownedJob)
5454

5555
/// A singleton actor whose executor is equivalent to
56-
/// \c DispatchQueue.main, which is the main dispatch queue.
56+
/// DispatchQueue.main, which is the main dispatch queue.
5757
@available(SwiftStdlib 5.5, *)
5858
@globalActor public final actor MainActor: SerialExecutor {
5959
public static let shared = MainActor()

stdlib/public/Concurrency/AsyncSequence.swift

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,15 @@ import Swift
7474
@available(SwiftStdlib 5.5, *)
7575
@rethrows
7676
public protocol AsyncSequence {
77-
/// The type of element produced by this asynchronous sequence.
77+
/// The type of asynchronous iterator produced by this asynchronous sequence.
7878
associatedtype AsyncIterator: AsyncIteratorProtocol where AsyncIterator.Element == Element
79-
/// Creates the asynchronous iterator that produces elements of this
80-
/// asynchronous sequence.
81-
///
82-
/// - Returns: An instance of the `AsyncIterator` type used to produce
83-
/// elements of the asynchronous sequence.
79+
/// The type of element produced by this asynchronous sequence.
8480
associatedtype Element
81+
/// Creates the asynchronous iterator that produces elements of this
82+
/// asynchronous sequence.
83+
///
84+
/// - Returns: An instance of the `AsyncIterator` type used to produce
85+
/// elements of the asynchronous sequence.
8586
__consuming func makeAsyncIterator() -> AsyncIterator
8687
}
8788

0 commit comments

Comments
 (0)