Skip to content

Commit 57c6bd0

Browse files
committed
=doc apple#82 avoid showcasing internal lock in public docs
1 parent 024f44d commit 57c6bd0

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

Sources/Logging/LogHandler.swift

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,11 @@
5656
/// `LogHandlerWithGlobalLogLevelOverride.overrideGlobalLogLevel = .debug`, for example.
5757
///
5858
/// ```swift
59+
/// import class Foundation.NSLock
60+
///
5961
/// public struct LogHandlerWithGlobalLogLevelOverride: LogHandler {
6062
/// // the static properties hold the globally overridden log level (if overridden)
61-
/// private static let overrideLock = Lock()
63+
/// private static let overrideLock = NSLock()
6264
/// private static var overrideLogLevel: Logger.Level? = nil
6365
///
6466
/// // this holds the log level if not overridden
@@ -74,9 +76,9 @@
7476
/// public var logLevel: Logger.Level {
7577
/// // when we get asked for the log level, we check if it was globally overridden or not
7678
/// get {
77-
/// return LogHandlerWithGlobalLogLevelOverride.overrideLock.withLock {
78-
/// return LogHandlerWithGlobalLogLevelOverride.overrideLogLevel
79-
/// } ?? self._logLevel
79+
/// LogHandlerWithGlobalLogLevelOverride.overrideLock.lock()
80+
/// defer { LogHandlerWithGlobalLogLevelOverride.overrideLock.unlock() }
81+
/// return LogHandlerWithGlobalLogLevelOverride.overrideLogLevel ?? self._logLevel
8082
/// }
8183
/// // we set the log level whenever we're asked (note: this might not have an effect if globally
8284
/// // overridden)
@@ -101,9 +103,9 @@
101103
///
102104
/// // this is the function to globally override the log level, it is not part of the `LogHandler` protocol
103105
/// public static func overrideGlobalLogLevel(_ logLevel: Logger.Level) {
104-
/// LogHandlerWithGlobalLogLevelOverride.overrideLock.withLock {
105-
/// LogHandlerWithGlobalLogLevelOverride.overrideLogLevel = logLevel
106-
/// }
106+
/// LogHandlerWithGlobalLogLevelOverride.overrideLock.lock()
107+
/// defer { LogHandlerWithGlobalLogLevelOverride.overrideLock.unlock() }
108+
/// LogHandlerWithGlobalLogLevelOverride.overrideLogLevel = logLevel
107109
/// }
108110
/// }
109111
/// ```

0 commit comments

Comments
 (0)