Skip to content

Commit c151138

Browse files
committed
Fix docs
1 parent 464822d commit c151138

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

Sources/AWSLambdaRuntimeCore/Lambda+Codable.swift

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
import NIOCore
1616

1717
/// The protocol a decoder must conform to so that it can be used with ``LambdaCodableAdapter`` to decode incoming
18-
/// ``ByteBuffer`` events.
18+
/// `ByteBuffer` events.
1919
public protocol LambdaEventDecoder {
20-
/// Decode the ``ByteBuffer`` representing the received event into the generic ``Event`` type
20+
/// Decode the `ByteBuffer` representing the received event into the generic `Event` type
2121
/// the handler will receive.
2222
/// - Parameters:
2323
/// - type: The type of the object to decode the buffer into.
@@ -27,14 +27,14 @@ public protocol LambdaEventDecoder {
2727
}
2828

2929
/// The protocol an encoder must conform to so that it can be used with ``LambdaCodableAdapter`` to encode the generic
30-
/// ``Output`` object into a ``ByteBuffer``.
30+
/// ``LambdaOutputEncoder/Output`` object into a `ByteBuffer`.
3131
public protocol LambdaOutputEncoder {
3232
associatedtype Output
3333

34-
/// Encode the generic type `Output` the handler has returned into a ``ByteBuffer``.
34+
/// Encode the generic type `Output` the handler has returned into a `ByteBuffer`.
3535
/// - Parameters:
36-
/// - value: The object to encode into a ``ByteBuffer``.
37-
/// - buffer: The ``ByteBuffer`` where the encoded value will be written to.
36+
/// - value: The object to encode into a `ByteBuffer`.
37+
/// - buffer: The `ByteBuffer` where the encoded value will be written to.
3838
func encode(_ value: Output, into buffer: inout ByteBuffer) throws
3939
}
4040

@@ -62,7 +62,7 @@ public struct LambdaHandlerAdapter<
6262
self.handler = handler
6363
}
6464

65-
/// Passes the generic ``Event`` object to the ``LambdaHandler/handle(_:context:)`` function, and
65+
/// Passes the generic `Event` object to the ``LambdaHandler/handle(_:context:)`` function, and
6666
/// the resulting output is then written to ``LambdaWithBackgroundProcessingHandler``'s `outputWriter`.
6767
/// - Parameters:
6868
/// - event: The received event.
@@ -94,8 +94,8 @@ public struct LambdaCodableAdapter<
9494

9595
/// Initializes an instance given an encoder, decoder, and a handler with a non-`Void` output.
9696
/// - Parameters:
97-
/// - encoder: The encoder object that will be used to encode the generic ``Output`` obtained from the `handler`'s `outputWriter` into a ``ByteBuffer``.
98-
/// - decoder: The decoder object that will be used to decode the received ``ByteBuffer`` event into the generic ``Event`` type served to the `handler`.
97+
/// - encoder: The encoder object that will be used to encode the generic `Output` obtained from the `handler`'s `outputWriter` into a `ByteBuffer`.
98+
/// - decoder: The decoder object that will be used to decode the received `ByteBuffer` event into the generic `Event` type served to the `handler`.
9999
/// - handler: The handler object.
100100
@inlinable
101101
public init(encoder: Encoder, decoder: Decoder, handler: Handler) where Output: Encodable {
@@ -106,7 +106,7 @@ public struct LambdaCodableAdapter<
106106

107107
/// Initializes an instance given a decoder, and a handler with a `Void` output.
108108
/// - Parameters:
109-
/// - decoder: The decoder object that will be used to decode the received ``ByteBuffer`` event into the generic ``Event`` type served to the `handler`.
109+
/// - decoder: The decoder object that will be used to decode the received `ByteBuffer` event into the generic ``Event`` type served to the `handler`.
110110
/// - handler: The handler object.
111111
@inlinable
112112
public init(decoder: Decoder, handler: Handler) where Output == Void, Encoder == VoidEncoder {
@@ -145,7 +145,7 @@ where Output == Encoder.Output {
145145

146146
/// Initializes an instance given an encoder and an underlying ``LambdaResponseStreamWriter``.
147147
/// - Parameters:
148-
/// - encoder: The encoder object that will be used to encode the generic ``Output`` into a ``ByteBuffer``, which will then be passed to `streamWriter`.
148+
/// - encoder: The encoder object that will be used to encode the generic `Output` into a `ByteBuffer`, which will then be passed to `streamWriter`.
149149
/// - streamWriter: The underlying ``LambdaResponseStreamWriter`` that will be wrapped.
150150
@inlinable
151151
public init(encoder: Encoder, streamWriter: Base) {

0 commit comments

Comments
 (0)