Skip to content

Commit

Permalink
Group docs and fix visibility
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 committed Jan 16, 2025
1 parent 92ad3c0 commit 2e2f9d6
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 2 deletions.
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
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

Expand Down
30 changes: 30 additions & 0 deletions Sources/GRPCNIOTransportHTTP2/Documentation.docc/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,33 @@ This module, ``GRPCNIOTransportHTTP2``, re-exports the contents of both of these

`GRPCNIOTransportHTTP2Posix` is available on all platforms, while
`GRPCNIOTransportHTTP2TransportServices` is only available on Darwin based platforms.

## Topics

### Client and server transports

- ``HTTP2ClientTransport``
- ``HTTP2ServerTransport``

### Transport extensions

- ``ListeningServerTransport``

### Name resolution

- ``ResolvableTarget``
- ``ResolvableTargets``
- ``NameResolvers``
- ``NameResolverRegistry``
- ``NameResolverFactory``
- ``NameResolver``
- ``NameResolutionResult``

### Addresses

- ``SocketAddress``
- ``Endpoint``

### TLS

- ``TLSConfig``

0 comments on commit 2e2f9d6

Please sign in to comment.