-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Motivation: Grouping docs in the DocC index is a useful way to make the docs more approachable. Modifications: - Group the docs - Add a few more docs - Change the visibility of an accidentally public type Result: Better docs
- Loading branch information
Showing
4 changed files
with
39 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
version: 1 | ||
builder: | ||
configs: | ||
- documentation_targets: [GRPCNIOTransportHTTP2, GRPCNIOTransportHTTP2Posix, GRPCNIOTransportHTTP2TransportServices] | ||
- documentation_targets: [GRPCNIOTransportCore, GRPCNIOTransportHTTP2, GRPCNIOTransportHTTP2Posix, GRPCNIOTransportHTTP2TransportServices] | ||
swift_version: 6.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
Sources/GRPCNIOTransportCore/Documentation.docc/Documentation.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# ``GRPCNIOTransportCore`` | ||
|
||
A module containing core components for high-performance HTTP/2 client and server | ||
transport implementations built on top of SwiftNIO. | ||
|
||
## Topics | ||
|
||
### Client and server transports | ||
|
||
- ``HTTP2ClientTransport`` | ||
- ``HTTP2ServerTransport`` | ||
|
||
### Transport extensions | ||
|
||
- ``ListeningServerTransport`` | ||
|
||
### Name resolution | ||
|
||
- ``ResolvableTarget`` | ||
- ``ResolvableTargets`` | ||
- ``NameResolvers`` | ||
- ``NameResolverRegistry`` | ||
- ``NameResolverFactory`` | ||
- ``NameResolver`` | ||
- ``NameResolutionResult`` | ||
|
||
### Addresses | ||
|
||
- ``SocketAddress`` | ||
- ``Endpoint`` | ||
|
||
### TLS | ||
|
||
- ``TLSConfig`` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters