feat: update documentation

Resolves: none.
loay-ashraf · Jan 25, 2024 · caa553c · caa553c
1 parent a47ee43
commit caa553c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 7 deletions.
diff --git a/Docs.docc/Pages/RxNetworkKit.md b/Docs.docc/Pages/RxNetworkKit.md
@@ -19,6 +19,7 @@ It makes use of RxSwift's traits at request level to acheive a high level of spe
 ### Foundation
 
 - ``Session``
+- ``SessionConfiguration``
 - ``RESTClient``
 - ``HTTPClient``
 
@@ -45,10 +46,6 @@ It makes use of RxSwift's traits at request level to acheive a high level of spe
 - ``HTTPRequestRetrier``
 - ``HTTPRequestRetryPolicy``
 
-### Event Monitor
-
-- ``HTTPRequestEventMonitor``
-
 ### Network Reachability
 
 - ``NetworkReachability``

diff --git a/Source/Session/Types/SessionConfiguration.swift b/Source/Session/Types/SessionConfiguration.swift
@@ -15,17 +15,17 @@ public class SessionConfiguration {
         .init(urlSessionConfiguration: .default, setUserAgentHeader: true, logRequests: true)
     }
 
-    /// `URLSessionConfiguration`object used to create `URLSession` object.
+    /// `URLSessionConfiguration` object used to create `URLSession` object.
     let urlSessionConfiguration: URLSessionConfiguration
     /// `Bool` flag that indicates wether a `URLSession` should add `User-Agent` header to outgoing requests.
     let setUserAgentHeader: Bool
     /// `Bool` flag that indicates wether a `URLSession` should print outgoing requests to the console.
     let logRequests: Bool
 
-    /// Description
+    /// Creates a `SessionConfiguration` instance.
     ///
     /// - Parameters:
-    ///   - urlSessionConfiguration: `URLSessionConfiguration`object used to create `URLSession` object.
+    ///   - urlSessionConfiguration: `URLSessionConfiguration` object used to create `URLSession` object.
     ///   - setUserAgentHeader: `Bool` flag that indicates wether a `URLSession` should add `User-Agent` header to outgoing requests.
     ///   - logRequests: `Bool` flag that indicates wether a `URLSession` should print outgoing requests to the console.
     public init(urlSessionConfiguration: URLSessionConfiguration, setUserAgentHeader: Bool, logRequests: Bool) {