Add missing doc for the ChannelOutboundInvoker extension. (#20)

Motivation:

ChannelOutboundInvoker exntesion has no docs.

Modifications:

Add docs.

Result:

More docs FTW.
This commit is contained in:
Norman Maurer 2018-02-22 20:55:31 +01:00 committed by Cory Benfield
parent 95c00129ee
commit 02dae4a452
1 changed files with 4 additions and 0 deletions

View File

@ -132,6 +132,10 @@ public protocol ChannelOutboundInvoker {
var eventLoop: EventLoop { get }
}
/// Default implementations for `ChannelOutboundInvoker` methods. Each method that returns a `EventLoopFuture` will just do the following:
/// - create a new `EventLoopPromise<Void>`
/// - call the corresponding method that takes a `EventLoopPromise<Void>`
/// - return `EventLoopPromise.futureResult`
extension ChannelOutboundInvoker {
public func register() -> EventLoopFuture<Void> {
let promise = newPromise()