Skip to content

Commit e4bf649

Browse files
authored
Group docs and fix visibility (#57)
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
1 parent 56defe6 commit e4bf649

File tree

4 files changed

+39
-3
lines changed

4 files changed

+39
-3
lines changed

.spi.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
version: 1
22
builder:
33
configs:
4-
- documentation_targets: [GRPCNIOTransportHTTP2, GRPCNIOTransportHTTP2Posix, GRPCNIOTransportHTTP2TransportServices]
4+
- documentation_targets: [GRPCNIOTransportCore, GRPCNIOTransportHTTP2, GRPCNIOTransportHTTP2Posix, GRPCNIOTransportHTTP2TransportServices]
55
swift_version: 6.0

Sources/GRPCNIOTransportCore/Client/Connection/LoadBalancers/Subchannel.swift

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -380,6 +380,7 @@ extension Subchannel {
380380
}
381381

382382
extension Subchannel {
383+
/// ```
383384
/// ┌───────────────┐
384385
/// ┌───────▶│ NOT CONNECTED │───────────shutDown─────────────┐
385386
/// │ └───────────────┘ │
@@ -404,6 +405,7 @@ extension Subchannel {
404405
/// │ ┌───────────────┐ │ ┌───────────────┐ │
405406
/// └────────│ GOING AWAY │──────┘ │ SHUT DOWN │◀─┘
406407
/// └───────────────┘ └───────────────┘
408+
/// ```
407409
private enum State {
408410
/// Not connected and not actively connecting.
409411
case notConnected(NotConnected)
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# ``GRPCNIOTransportCore``
2+
3+
A module containing core components for high-performance HTTP/2 client and server
4+
transport implementations built on top of SwiftNIO.
5+
6+
## Topics
7+
8+
### Client and server transports
9+
10+
- ``HTTP2ClientTransport``
11+
- ``HTTP2ServerTransport``
12+
13+
### Transport extensions
14+
15+
- ``ListeningServerTransport``
16+
17+
### Name resolution
18+
19+
- ``ResolvableTarget``
20+
- ``ResolvableTargets``
21+
- ``NameResolvers``
22+
- ``NameResolverRegistry``
23+
- ``NameResolverFactory``
24+
- ``NameResolver``
25+
- ``NameResolutionResult``
26+
27+
### Addresses
28+
29+
- ``SocketAddress``
30+
- ``Endpoint``
31+
32+
### TLS
33+
34+
- ``TLSConfig``

Sources/GRPCNIOTransportCore/Server/Connection/ServerConnection.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
package import GRPCCore
1818
package import NIOCore
1919

20-
public enum ServerConnection {
21-
public enum Stream {
20+
package enum ServerConnection {
21+
package enum Stream {
2222
package struct Outbound: ClosableRPCWriterProtocol {
2323
package typealias Element = RPCResponsePart<GRPCNIOTransportBytes>
2424

0 commit comments

Comments
 (0)