Generate docs for NIO Transport Services

[tkrajacic]

Currently the Readme suggests

NIOTS provides an alternative EventLoop, EventLoopGroup, and several alternative Channels and Bootstraps

however there are no links to the actual alternative types provided by swift-nio-transport-services.

Using the ClientBootstrap from swift-nio for example would result in a runtime crash.

Could not cast value of type 'NIOTransportServices.NIOTSEventLoop' (0x1007c5a88) to 'NIO.SelectableEventLoop' (0x100513f90).
2018-11-30 20:24:55.782576+0100 NIOTest[24746:16198029] Could not cast value of type 'NIOTransportServices.NIOTSEventLoop' (0x1007c5a88) to 'NIO.SelectableEventLoop' (0x100513f90).

This is not obvious from going through the documentation.

It would be great if

• swift-nio-transport-services would document its own types that augment those of swift-nio
• the swift-nio documentation could add a note on using different types for users of swift-nio-transport-services

[weissi]

@tomerd

[Yasumoto]

🤔 Any chance the docs I was hoping for in apple/swift-nio#674 could come out of this?

[weissi]

yeah, we need to get our act together here.

[weissi]

oh shoot, they're still not even generated for NIOTS. Let's fix that first.