Quellcode durchsuchen

Fixup various doc issues (#2015)

George Barnett vor 1 Jahr
Ursprung
Commit
53016b3184

+ 2 - 2
Sources/GRPCHTTP2Core/Client/HTTP2ClientTransport.swift

@@ -28,12 +28,12 @@ extension HTTP2ClientTransport.Config {
   public struct Compression: Sendable {
     /// The default algorithm used for compressing outbound messages.
     ///
-    /// This can be overridden on a per-call basis via ``CallOptions``.
+    /// This can be overridden on a per-call basis via `CallOptions`.
     public var algorithm: CompressionAlgorithm
 
     /// Compression algorithms enabled for inbound messages.
     ///
-    /// - Note: ``CompressionAlgorithm/none`` is always supported, even if it isn't set here.
+    /// - Note: `CompressionAlgorithm.none` is always supported, even if it isn't set here.
     public var enabledAlgorithms: CompressionAlgorithmSet
 
     /// Creates a new compression configuration.

+ 2 - 2
Sources/GRPCHTTP2Core/Client/Resolver/NameResolver.swift

@@ -21,11 +21,11 @@ public import GRPCCore
 public struct NameResolver: Sendable {
   /// A sequence of name resolution results.
   ///
-  /// Resolvers may be push or pull based. Resolvers with the ``UpdateMode-swift.enum/push``
+  /// Resolvers may be push or pull based. Resolvers with the ``UpdateMode-swift.struct/push``
   /// update mode have addresses pushed to them by an external source and you should subscribe
   /// to changes in addresses by awaiting for new values in a loop.
   ///
-  /// Resolvers with the ``UpdateMode-swift.enum/pull`` update mode shouldn't be subscribed to,
+  /// Resolvers with the ``UpdateMode-swift.struct/pull`` update mode shouldn't be subscribed to,
   /// instead you should create an iterator and ask for new results as and when necessary.
   public var names: RPCAsyncSequence<NameResolutionResult, any Error>
 

+ 1 - 1
Sources/GRPCHTTP2Core/Server/HTTP2ServerTransport.swift

@@ -29,7 +29,7 @@ extension HTTP2ServerTransport.Config {
   public struct Compression: Sendable {
     /// Compression algorithms enabled for inbound messages.
     ///
-    /// - Note: ``CompressionAlgorithm/none`` is always supported, even if it isn't set here.
+    /// - Note: `CompressionAlgorithm.none` is always supported, even if it isn't set here.
     public var enabledAlgorithms: CompressionAlgorithmSet
 
     /// Creates a new compression configuration.

+ 1 - 1
Sources/GRPCHTTP2TransportNIOPosix/HTTP2ServerTransport+Posix.swift

@@ -294,7 +294,7 @@ extension HTTP2ServerTransport {
 
 @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
 extension HTTP2ServerTransport.Posix {
-  /// Configuration for the ``GRPCHTTP2TransportNIOPosix/GRPCHTTP2Core/HTTP2ServerTransport/Posix``.
+  /// Config for the `Posix` transport.
   public struct Config: Sendable {
     /// Compression configuration.
     public var compression: HTTP2ServerTransport.Config.Compression

+ 1 - 1
Sources/GRPCHTTP2TransportNIOTransportServices/HTTP2ServerTransport+TransportServices.swift

@@ -286,7 +286,7 @@ extension HTTP2ServerTransport {
 
 @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
 extension HTTP2ServerTransport.TransportServices {
-  /// Configuration for the ``GRPCHTTP2TransportNIOTransportServices/GRPCHTTP2Core/HTTP2ServerTransport/TransportServices``.
+  /// Configuration for the `TransportServices` transport.
   public struct Config: Sendable {
     /// Compression configuration.
     public var compression: HTTP2ServerTransport.Config.Compression