Skip to content

Commit

Permalink
Group docs and fix visibility (#57)
Browse files Browse the repository at this point in the history
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
glbrntt authored Jan 17, 2025
1 parent 56defe6 commit e4bf649
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .spi.yml
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
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,7 @@ extension Subchannel {
}

extension Subchannel {
/// ```
/// ┌───────────────┐
/// ┌───────▶│ NOT CONNECTED │───────────shutDown─────────────┐
/// │ └───────────────┘ │
Expand All @@ -404,6 +405,7 @@ extension Subchannel {
/// │ ┌───────────────┐ │ ┌───────────────┐ │
/// └────────│ GOING AWAY │──────┘ │ SHUT DOWN │◀─┘
/// └───────────────┘ └───────────────┘
/// ```
private enum State {
/// Not connected and not actively connecting.
case notConnected(NotConnected)
Expand Down
34 changes: 34 additions & 0 deletions Sources/GRPCNIOTransportCore/Documentation.docc/Documentation.md
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``
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
package import GRPCCore
package import NIOCore

public enum ServerConnection {
public enum Stream {
package enum ServerConnection {
package enum Stream {
package struct Outbound: ClosableRPCWriterProtocol {
package typealias Element = RPCResponsePart<GRPCNIOTransportBytes>

Expand Down

0 comments on commit e4bf649

Please sign in to comment.