feat: update documentation

Resolves: none.
loay-ashraf · May 17, 2024 · 1770138 · 1770138
1 parent fdb750a
commit 1770138
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 3 deletions.
diff --git a/Docs.docc/Pages/RxNetworkKit.md b/Docs.docc/Pages/RxNetworkKit.md
@@ -36,6 +36,8 @@ RxNetworkKit is a generic reactive networking framework that leverages the stabi
 
 - ``Session``
 - ``SessionConfiguration``
+- ``TLSTrustEvaluatorConfiguration``
+- ``TLSTrustEvaluationPolicy``
 - ``RESTClient``
 - ``HTTPClient``
 

diff --git a/Source/Session/Types/Session.swift b/Source/Session/Types/Session.swift
@@ -8,7 +8,7 @@
 import Foundation
 
 /// Wrapper object for `URLSession` that can be shared between multiple clients.
-public class Session {
+public final class Session {
 
  /// Principal `URLSession`object used to create request tasks.
  let urlSession: URLSession

diff --git a/Source/TLS/Types/TLSTrustEvaluationPolicy.swift b/Source/TLS/Types/TLSTrustEvaluationPolicy.swift
@@ -7,7 +7,7 @@
 
 import Foundation
 
-/// Policy for TLS server trust evaluation.
+/// Policy for TLS server trust evaluation for a specific host.
 public enum TLSTrustEvaluationPolicy {
  /// Use the given certificates to evaluate the TLS server trust.
  case certificates(_ certificates: Set<SecCertificate> = .default)

diff --git a/Source/TLS/Types/TLSTrustEvaluatorConfiguration.swift b/Source/TLS/Types/TLSTrustEvaluatorConfiguration.swift
@@ -7,7 +7,7 @@
 
 import Foundation
 
-/// Configuration object for TLS server trust evaluation.
+/// Configuration object for TLS server trust evaluator.
 public class TLSTrustEvaluatorConfiguration {
 
  /// Default `TLSTrustEvaluatorConfiguration` object.