Document 'tableName'

Author: yim-lee

Sources/Basics/SQLiteBackedCache.swift

@@ -29,6 +29,13 @@ public final class SQLiteBackedCache<Value: Codable>: Closable {
     private let jsonEncoder: JSONEncoder
     private let jsonDecoder: JSONDecoder
 
+    /// Creates a SQLite-backed cache.
+    ///
+    /// - Parameters:
+    ///   - tableName: The SQLite table name. Must follow SQLite naming rules (e.g., no spaces).
+    ///   - location: SQLite.Location
+    ///   - configuration: Optional. Configuration for the cache.
+    ///   - diagnosticsEngine: DiagnosticsEngine
     public init(tableName: String, location: SQLite.Location, configuration: SQLiteBackedCacheConfiguration = .init(), diagnosticsEngine: DiagnosticsEngine? = nil) {
         self.tableName = tableName
         self.location = location
@@ -44,6 +51,13 @@ public final class SQLiteBackedCache<Value: Codable>: Closable {
         self.jsonDecoder = JSONDecoder.makeWithDefaults()
     }
 
+    /// Creates a SQLite-backed cache.
+    ///
+    /// - Parameters:
+    ///   - tableName: The SQLite table name. Must follow SQLite naming rules (e.g., no spaces).
+    ///   - path: The path of the SQLite database.
+    ///   - configuration: Optional. Configuration for the cache.
+    ///   - diagnosticsEngine: DiagnosticsEngine
     public convenience init(tableName: String, path: AbsolutePath, configuration: SQLiteBackedCacheConfiguration = .init(), diagnosticsEngine: DiagnosticsEngine? = nil) {
         self.init(tableName: tableName, location: .path(path), configuration: configuration, diagnosticsEngine: diagnosticsEngine)
     }