Skip to content

Commit

Permalink
docs: formatting comments with double slash (#1881)
Browse files Browse the repository at this point in the history
Motivation:

Triple slashes should be for exportable documentation (like functions declarations).

Modification:

Replaced `///` with `//`.

Result:

Better looking code comments.

Co-authored-by: Antoine Cœur <[email protected]>
  • Loading branch information
Coeur and Antoine Cœur authored Jun 21, 2021
1 parent b0effbc commit d79e333
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Sources/NIO/ChannelHandlers.swift
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ public final class AcceptBackoffHandler: ChannelDuplexHandler, RemovableChannelH
}

private func doRead(_ context: ChannelHandlerContext) {
/// Reset the backoff time and read.
// Reset the backoff time and read.
self.nextReadDeadlineNS = nil
self.scheduledRead = nil
context.read()
Expand Down
2 changes: 1 addition & 1 deletion Sources/NIO/SocketChannel.swift
Original file line number Diff line number Diff line change
Expand Up @@ -834,7 +834,7 @@ extension DatagramChannel: MulticastChannel {
return
}

/// Check if the device supports multicast
// Check if the device supports multicast
if let device = device {
guard device.multicastSupported else {
promise?.fail(NIOMulticastNotSupportedError(device: device))
Expand Down

0 comments on commit d79e333

Please sign in to comment.