📚 Small cleanup to basic plugin documentation.

Author: connor-ricks

Sources/HTTPNetworking/Plugins/Adaptors/Adaptor.swift

@@ -7,7 +7,7 @@ public struct Adaptor: HTTPRequestAdaptor {
 
     // MARK: Properties
 
-    let handler: AdaptationHandler
+    private let handler: AdaptationHandler
 
     // MARK: Initializers
 

Sources/HTTPNetworking/Plugins/Adaptors/HeadersAdaptor.swift

@@ -23,15 +23,18 @@ public struct HeadersAdaptor: HTTPRequestAdaptor {
 
     // MARK: Properties
 
-    let headers: [String: String]
-    let strategy: CollisionStrategy
+    /// The HTTP headers to be appended to an incoming request.
+    public let headers: [String: String]
+    
+    /// The strategy to use when the adaptor encounters a field collision.
+    public let strategy: CollisionStrategy
 
     // MARK: Initializers
 
     /// Creates a ``HeadersAdaptor`` from the provided HTTP headers.
     /// 
     /// - Parameters:
-    ///   - headers: The HTTP headers to append to incoming requests.
+    ///   - headers: The HTTP headers to be appended to an incoming request.
     ///   - strategy: The strategy to use when the adaptor encounters a field collision.
     public init(headers: [String: String], strategy: CollisionStrategy) {
         self.headers = headers

Sources/HTTPNetworking/Plugins/Adaptors/ParametersAdaptor.swift

@@ -7,13 +7,14 @@ public struct ParametersAdaptor: HTTPRequestAdaptor {
 
     // MARK: Properties
 
-    let items: [URLQueryItem]
+    /// The query parameters to append to an incoming request.
+    public let items: [URLQueryItem]
 
     // MARK: Initializers
 
     /// Creates a ``ParametersAdaptor`` from the provided query parameters.
     ///
-    /// - Parameter items: The query parameters to append to incoming requests.
+    /// - Parameter items: The query parameters to append to an incoming request.
     public init(items: [URLQueryItem]) {
         self.items = items
     }

Sources/HTTPNetworking/Plugins/Adaptors/ZipAdaptor.swift

@@ -5,7 +5,8 @@ public struct ZipAdaptor: HTTPRequestAdaptor {
 
     // MARK: Properties
 
-    let adaptors: [any HTTPRequestAdaptor]
+    /// An array of adaptors that make up this adaptor.
+    public let adaptors: [any HTTPRequestAdaptor]
 
     // MARK: Initializers
 

Sources/HTTPNetworking/Plugins/Retriers/Retrier.swift

@@ -7,7 +7,7 @@ public struct Retrier: HTTPRequestRetrier {
 
     // MARK: Properties
 
-    let handler: RetryHandler
+    private let handler: RetryHandler
 
     // MARK: Initializers
 

Sources/HTTPNetworking/Plugins/Retriers/ZipRetrier.swift

@@ -5,7 +5,8 @@ public struct ZipRetrier: HTTPRequestRetrier {
 
     // MARK: Properties
 
-    let retriers: [any HTTPRequestRetrier]
+    /// An array of retriers that make up this retrier.
+    public let retriers: [any HTTPRequestRetrier]
 
     // MARK: Initializers
 

Sources/HTTPNetworking/Plugins/Validators/StatusCodeValidator.swift

@@ -15,7 +15,8 @@ public struct StatusCodeValidator<S: Sequence>: HTTPResponseValidator where S.It
 
     // MARK: Properties
 
-    let acceptableStatusCodes: S
+    /// The sequence of acceptable status codes for this validator.
+    public let acceptableStatusCodes: S
 
     // MARK: Initializers
 

Sources/HTTPNetworking/Plugins/Validators/Validator.swift

@@ -7,7 +7,7 @@ public struct Validator: HTTPResponseValidator {
 
     // MARK: Properties
 
-    let handler: ValidationHandler
+    private let handler: ValidationHandler
 
     // MARK: Initializers
 

Sources/HTTPNetworking/Plugins/Validators/ZipValidator.swift

@@ -5,7 +5,8 @@ public struct ZipValidator: HTTPResponseValidator {
 
     // MARK: Properties
 
-    let validators: [any HTTPResponseValidator]
+    /// An array of validators that make up this validator.
+    public let validators: [any HTTPResponseValidator]
 
     // MARK: Initializers